Skip to content

Commit

Permalink
fixed conflict in keen-io-3_0.json
Browse files Browse the repository at this point in the history
  • Loading branch information
keith kirk committed Dec 9, 2013
2 parents 4b8daa6 + 870835a commit 433e7a5
Show file tree
Hide file tree
Showing 4 changed files with 815 additions and 816 deletions.
122 changes: 44 additions & 78 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,37 @@ The Keen IO API lets developers build analytics features directly into their app
[![Build Status](https://travis-ci.org/keenlabs/KeenClient-PHP.png?branch=master)](https://travis-ci.org/keenlabs/KeenClient-PHP)

Installation with Composer
------------
--------------------------
1. Install composer via via `curl -s http://getcomposer.org/installer | php` (on windows, download
http://getcomposer.org/installer and execute it with PHP)
1. Edit your `composer.json` file with following contents:
2. Edit your `composer.json` file with following contents:

```json
"require": {
"keen-io/keen-io": "dev-master"
"keen-io/keen-io": "~1.1"
}
```
3. Run `php composer.phar install`

Usage
---
-----

This client was built using [Guzzle](http://guzzlephp.org/), a PHP HTTP client & framework for building RESTful web service clients.

When you first create a new `KeenIOClient` instance you can pass configuration settings like your Project Id and API Keys in an array
to the factory method. These are optional and can be later specified through Setter methods.

For certain API Resources, the Master API Key is required and can also be passed to the factory method in the configuration array.
For certain API Resources, the Master API Key is required and can also be passed to the factory method in the configuration array.
Please read the [Security Documentation](https://keen.io/docs/security/) regarding this Master API key.

For Requests, the `KeenIOClient` will determine what API Key should be passed based on the type of Request and configuration in the
[Service Description](/src/KeenIO/Resources/config/keen-io-3_0.json). The API Key is passed in the `Authorization` header of the request.

For a list of required and available parameters for the different API Endpoints, please consult the Keen IO
For a list of required and available parameters for the different API Endpoints, please consult the Keen IO
[API Reference Docs](https://keen.io/docs/api/reference/).


####Configuring the Client
#### Configuring the Client

The factory method accepts an array of configuration settings for the Keen IO Webservice Client.

Expand All @@ -47,41 +47,41 @@ Read API Key | `readKey` | The Read API Key - used for access to read only (GET|
Write API Key | `writeKey` | The Write API Key - used for write (PUT|POST Requests) operations of the API
API Version | `version` | The API Version. Currently used to version the API URL and Service Description

When passing `version` to the factory method or using the `setVersion()` method, the Client will try to load a client Service Description
When passing `version` to the factory method or using the `setVersion()` method, the Client will try to load a client Service Description
that matches that version. That Service Description defines the operations available to the Webservice Client.

Currently the Keen IO Webservice Client only supports - and automatically defaults - to the current version (`3.0`) of the API.

######Example
###### Example
```php
use KeenIO\Client\KeenIOClient;

$client = KeenIOClient::factory([
$client = KeenIOClient::factory([
'projectId' => $projectId,
'writeKey' => $writeKey,
'readKey' => $readKey
'writeKey' => $writeKey,
'readKey' => $readKey
]);
```

####Configuration can be updated to reuse the same Client:
#### Configuration can be updated to reuse the same Client:
You can reconfigure the Keen IO Client configuration options through available getters and setters. You can get and set the following options:
`projectId`, `readKey`, `writeKey`, `masterKey`, & `version`.

######Example
###### Example
```php

//Get the current Project Id
$client->getProjectId();

//Set a new Project Id
$client->setProjectId( $someNewProjectId );
$client->setProjectId($someNewProjectId);

//Get the current Read Key
$client->getReadKey();

//Set a new Read Key
$newReadKey = $client->getScopedKey( $masterKey, $filters, $allowed_operations );
$client->setReadKey( $newReadKey );
$newReadKey = $client->getScopedKey($masterKey, $filters, $allowedOperations);
$client->setReadKey($newReadKey);

```

Expand All @@ -90,108 +90,74 @@ Once you've created a `KeenIOClient`, sending events is simple:

######Example
```php
$event = [ 'purchase' => [ 'item' => 'Golden Elephant' ] ];
$event = ['purchase' => ['item' => 'Golden Elephant']];

$client->addEvent( 'purchases', [ 'data' => $event ] );
$client->addEvent('purchases', ['data' => $event]);
```

####Send batched events to Keen
You can upload multiple Events to multiple Event Collections at once!
#### Send batched events to Keen
You can upload multiple Events to multiple Event Collections at once!

In the example below, we will create two new purchase events in the `purchases` event collection and a single
In the example below, we will create two new purchase events in the `purchases` event collection and a single
new event in the `sign_ups` event collection. Note that the keys of the `data` array specify the `event_collection`
where those events should be stored.

######Example
###### Example
```php
$purchases = [
[ 'purchase' => [ 'item' => 'Golden Elephant' ] ],
[ 'purchase' => [ 'item' => 'Magenta Elephant' ] ]
['purchase' => ['item' => 'Golden Elephant']],
['purchase' => ['item' => 'Magenta Elephant']]
];
$signUps = [
[ 'name' => 'foo', 'email' => '[email protected]' ]
['name' => 'foo', 'email' => '[email protected]']
];

$client->addEvents([ 'data' => [ 'purchases' => $purchases, 'sign_ups' => $signUps ] ]);
```

####Send batched events in Parallel
Useful for large batch processing jobs. The client will serialize each request and send them all in parallel.

If an error is encountered during the transfer, then a `KeenIO\Exception\CommandTransferException` is thrown, which allows
you to retrieve a list of commands that succeeded and a list of commands that failed.

For more information on parallel commands, you can check the [Guzzle docs](http://guzzlephp.org/webservice-client/webservice-client.html#executing-commands-in-parallel).

######Example:
```php
// Split the events into chunks
$eventChunks = array_chunk( $events, 500 );

$commands = [];
foreach( $eventChunks as $eventChunk )
{
// Using getCommand will create the command with out immediately executing it
// versus using the magic methods
$commands[] = $this->getCommand( "sendEvents", [ 'data' => [ 'purchases' => $eventChunk ] ] );
}

try
{
// The commands can then be passed to the client's execute method to be run
// in parallel
$result = $this->execute( $commands );
}
catch( \KeenIO\Exception\CommandTransferException $e )
{
// Handle any errored commands...
$failedCommands = $e->getFailedCommands();
}
$client->addEvents(['data' => ['purchases' => $purchases, 'sign_ups' => $signUps]]);
```

####Get Analysis on Events
#### Get Analysis on Events
All Analysis Endpoints should be supported. See the [API Reference Docs](https://keen.io/docs/api/reference/) for required parameters.
You can also check the [Service Description](/src/KeenIO/Resources/config/keen-io-3_0.json) for configured API Endpoints.

Below are a few example calls to some of the Analysis methods available.

######Example
```php
###### Example

```php
//Count
$totalPurchases = $client->count( 'purchases' );
$totalPurchases = $client->count('purchases');

//Count Unqiue
$totalItems = $client->countUnique( 'purchases', [ 'target_property' => 'purchase.item' ]);
$totalItems = $client->countUnique('purchases', ['target_property' => 'purchase.item']);

//Select Unique
$items = $client->selectUnique( 'purchases', [ 'target_property' => 'purchase.item' ]);
$items = $client->selectUnique('purchases', ['target_property' => 'purchase.item']);

//Multi Analysis
$analyses = [
'clicks' => [ "analysis_type" => "count" ],
'average price' => [ "analysis_type" => "average", "target_property" => "purchase.price" ]
'clicks' => ['analysis_type' => 'count'],
'average price' => ['analysis_type' => 'average', 'target_property' => 'purchase.price']
];
$stats = $client->multiAnalysis( 'purchases', [ 'analyses' => $analyses ]);
$stats = $client->multiAnalysis('purchases', ['analyses' => $analyses]);
```

###Create a Scoped Key
### Create a Scoped Key

Scoped keys allow you to secure the requests to the API Endpoints and are especially useful when you are providing
access to multiple clients or applications. You should read the Keen IO docs concerning [Scoped Keys](https://keen.io/docs/security/#scoped-key)
access to multiple clients or applications. You should read the Keen IO docs concerning [Scoped Keys](https://keen.io/docs/security/#scoped-key)
for more details.

######Example
```php
$filter = [
'property_name' => 'user_id',
'operator' => 'eq',
'property_value' => '123'
'property_name' => 'user_id',
'operator' => 'eq',
'property_value' => '123'
];

$filters = [ $filter ];
$allowed_operations = [ 'read' ];
$filters = [$filter];
$allowed_operations = ['read'];

$scopedKey = $client->getScopedKey( $masterKey, $filters, $allowed_operations );
$scopedKey = $client->getScopedKey($masterKey, $filters, $allowedOperations);
```

Loading

0 comments on commit 433e7a5

Please sign in to comment.