Add documentation to set user-agent for all requests (and also a test)

hussainweb · hussainweb · commit 28c0147ac730 · 2016-08-13T22:50:58.000+05:30
diff --git a/README.md b/README.md
@@ -23,7 +23,15 @@ The library provides a single client and multiple request classes to send reques
 
     // Retrieve user with uid 314031.
     $client = new Client();
-    $user_request = new UserRequest(314031);
+    $user_request = new UserRequest('314031');
     $user = $client->getEntity($user_request);
 
 There are various request classes to retrieve different types of entities and entity listings. Many of the entity request classes have a corresponding list request class as well, e.g. `CommentRequest` and `CommentCollectionRequest`.
+
+### User Agent
+
+In accordance with responsible usage of Drupal.org API, it is important to set the user-agent header to indicate your application. You may set this request once globally using the static property on the `Request` class.
+
+    Request::$userAgent = 'Drupal Statistics Collector';
+
+You have to do this only once as this user-agent is applied to all child requests as well. See the test in `\Hussainweb\DrupalApi\Tests\Request\RequestTest::testRequestUserAgent` for verifying the behaviour.
diff --git a/tests/Request/RequestTest.php b/tests/Request/RequestTest.php
@@ -3,6 +3,7 @@
 namespace Hussainweb\DrupalApi\Tests\Request;
 
 use Hussainweb\DrupalApi\Request\Request;
+use Hussainweb\DrupalApi\Request\UserRequest;
 
 class RequestTest extends \PHPUnit_Framework_TestCase
 {
@@ -29,7 +30,9 @@ public function testRequestWithHeaders()
     public function testRequestUserAgent()
     {
         Request::$userAgent = 'Drupal.org API client Test Suite';
-        $req = new Request("test.json");
+        // Test with a child request class to ensure the user-agent is used
+        // globally.
+        $req = new UserRequest('314031');
         $this->assertEquals('Drupal.org API client Test Suite', $req->getHeaderLine('User-Agent'));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`namespace Hussainweb\DrupalApi\Tests\Request;`
`4`	`4`
`5`	`5`	`use Hussainweb\DrupalApi\Request\Request;`
	`6`	`+use Hussainweb\DrupalApi\Request\UserRequest;`
`6`	`7`
`7`	`8`	`class RequestTest extends \PHPUnit_Framework_TestCase`
`8`	`9`	`{`
`@@ -29,7 +30,9 @@ public function testRequestWithHeaders()`
`29`	`30`	`public function testRequestUserAgent()`
`30`	`31`	`{`
`31`	`32`	`Request::$userAgent = 'Drupal.org API client Test Suite';`
`32`		`- $req = new Request("test.json");`
	`33`	`+ // Test with a child request class to ensure the user-agent is used`
	`34`	`+ // globally.`
	`35`	`+ $req = new UserRequest('314031');`
`33`	`36`	`$this->assertEquals('Drupal.org API client Test Suite', $req->getHeaderLine('User-Agent'));`
`34`	`37`	`}`
`35`	`38`	`}`