Merge pull request #53 from misantron/documentation-patch

README and usage example update

Author: thinkingserious

README.md

@@ -106,30 +106,48 @@ Here is a quick example:
 ```php
 // include __DIR__ . '/loader.php';
 require 'vendor/autoload.php';
-$global_headers = array('Authorization: Basic XXXXXXX');
-$client = new SendGrid\Client('base_url', $global_headers);
+$apiKey = YOUR_SENDGRID_API_KEY;
+$authHeaders = [
+    'Authorization: Bearer ' . $apiKey
+];
+$client = new SendGrid\Client('https://api.sendgrid.com', $authHeaders);
+$param = 'foo';
 $response = $client->your()->api()->_($param)->call()->get();
-print $response->statusCode();
-print $response->headers();
-print $response->body();
+
+var_dump(
+    $response->statusCode(),
+    $response->headers(),
+    $response->body()
+);
 ```
 
 `POST /your/api/{param}/call` with headers, query parameters and a request body with versioning.
 
 ```php
 // include __DIR__ . '/loader.php';
 require 'vendor/autoload.php';
-$global_headers = array('Authorization: Basic XXXXXXX');
-$client = new SendGrid\Client('base_url', $global_headers);
-$query_params = array('hello' => 0, 'world' => 1);
-$request_headers = array('X-Test' => 'test');
-$data = array('some' => 1, 'awesome' => 2, 'data' => 3);
-$response = $client->your()->api()->_($param)->call()->post('data',
-                                                            'query_params',
-                                                            'request_headers');
-print $response->statusCode();
-print $response->headers();
-print $response->body();
+$apiKey = YOUR_SENDGRID_API_KEY;
+$authHeaders = [
+    'Authorization: Bearer ' . $apiKey
+];
+$client = new SendGrid\Client('https://api.sendgrid.com', $authHeaders);
+$queryParams = [
+    'hello' => 0, 'world' => 1
+];
+$requestHeaders = [
+    'X-Test' => 'test'
+];
+$data = [
+    'some' => 1, 'awesome' => 2, 'data' => 3
+];
+$param = 'bar';
+$response = $client->your()->api()->_($param)->call()->post($data, $queryParams, $requestHeaders);
+
+var_dump(
+    $response->statusCode(),
+    $response->headers(),
+    $response->body()
+);
 ```
 
 <a name="usage"></a>

composer.json

@@ -3,10 +3,6 @@
     "description": "HTTP REST client, simplified for PHP",
     "type": "library",
     "version": "3.8.0",
-    "require-dev": {
-        "phpunit/phpunit": "~4.4",
-        "squizlabs/php_codesniffer": "~2.0"
-    },
     "homepage": "http://github.com/sendgrid/php-http-client",
     "keywords": ["SendGrid", "HTTP", "REST", "API", "Fluent"],
     "license": "MIT",
@@ -23,6 +19,10 @@
     "require": {
         "php": ">=5.6"
     },
+    "require-dev": {
+        "phpunit/phpunit": "~4.4",
+        "squizlabs/php_codesniffer": "~2.0"
+    },
     "autoload": {
         "psr-4": {
             "SendGrid\\": "lib/"

examples/example.php

@@ -10,69 +10,51 @@
 $headers = ['Authorization: Bearer ' . $apiKey];
 $client = new SendGrid\Client('https://api.sendgrid.com', $headers, '/v3');
 
-// GET Collection
-$query_params = ['limit' => 100, 'offset' => 0];
-$request_headers = ['X-Mock: 200'];
-$response = $client->api_keys()->get(null, $query_params, $request_headers);
+// GET /v3/api_keys - retrieve all API Keys that belong to the user
+$queryParams = ['limit' => 100, 'offset' => 0];
+$requestHeaders = ['X-Mock: 200'];
+$response = $client->api_keys()->get(null, $queryParams, $requestHeaders);
 echo $response->statusCode();
 echo $response->body();
 echo $response->headers();
 
-// GET with auto retry on rate limit
-$query_params = ['limit' => 100, 'offset' => 0];
-$request_headers = ['X-Mock: 200'];
-$retryOnLimit = true;
-$response = $client->api_keys()->get(null, $query_params, $request_headers, $retryOnLimit);
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
+// GET /v3/api_keys - retrieve all API Keys that belong to the user
+$queryParams = ['limit' => 100, 'offset' => 0];
+$requestHeaders = ['X-Mock: 200'];
+$retryOnLimit = true; // with auto retry on rate limit
+$response = $client->api_keys()->get(null, $queryParams, $requestHeaders, $retryOnLimit);
 
-// POST
-$request_body = [
+// POST /v3/api_keys - create a new user API Key
+$requestBody = [
     'name' => 'My PHP API Key',
     'scopes' => [
         'mail.send',
         'alerts.create',
         'alerts.read'
     ]
 ];
-$response = $client->api_keys()->post($request_body);
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
-$response_body = json_decode($response->body());
-$api_key_id = $response_body->api_key_id;
+$response = $client->api_keys()->post($requestBody);
+$responseBody = json_decode($response->body(), true);
+$apiKeyId = $responseBody['api_key_id'];
 
-// GET Single
-$response = $client->version('/v3')->api_keys()->_($api_key_id)->get();
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
+// GET /v3/api_keys/{api_key_id} - retrieve a single API Key
+$response = $client->api_keys()->_($apiKeyId)->get();
 
-// PATCH
-$request_body = [
+// PATCH /v3/api_keys/{api_key_id} - update the name of an existing API Key
+$requestBody = [
     'name' => 'A New Hope'
 ];
-$response = $client->api_keys()->_($api_key_id)->patch($request_body);
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
+$response = $client->api_keys()->_($apiKeyId)->patch($requestBody);
 
-// PUT
-$request_body = [
+// PUT /v3/api_keys/{api_key_id} - update the name and scopes of a given API Key
+$requestBody = [
     'name' => 'A New Hope',
     'scopes' => [
         'user.profile.read',
         'user.profile.update'
     ]
 ];
-$response = $client->api_keys()->_($api_key_id)->put($request_body);
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
+$response = $client->api_keys()->_($apiKeyId)->put($requestBody);
 
-// DELETE
-$response = $client->api_keys()->_($api_key_id)->delete();
-echo $response->statusCode();
-echo $response->body();
-echo $response->headers();
+// DELETE /v3/api_keys/{api_key_id} - revoke an existing API Key
+$response = $client->api_keys()->_($apiKeyId)->delete();