Merge pull request #38 from guywithnose/master

Allow passing parameters to GET requests

Author: chadicus

src/Client.php

@@ -196,22 +196,27 @@ public function index($resource, array $filters = [])
      *
      * @param string $resource
      * @param string $id
+     * @param array  $parameters
      *
      * @return mixed opaque handle to be given to endGet()
      */
-    public function startGet($resource, $id)
+    public function startGet($resource, $id, array $parameters = [])
     {
         Util::throwIfNotType(['string' => [$resource, $id]], true);
         $url = "{$this->_baseUrl}/" . urlencode($resource) . '/' . urlencode($id);
+        if (!empty($parameters)) {
+            $url .= '?' . Http::buildQueryString($parameters);
+        }
+
         return $this->_start($url, 'GET');
     }
 
     /**
      * @see startGet()
      */
-    public function get($resource, $id)
+    public function get($resource, $id, array $parameters = [])
     {
-        return $this->end($this->startGet($resource, $id));
+        return $this->end($this->startGet($resource, $id, $parameters));
     }
 
     /**

src/ClientInterface.php

@@ -33,15 +33,16 @@ function index($resource, array $filters = []);
      *
      * @param string $resource
      * @param string $id
+     * @param array  $parameters
      *
      * @return mixed opaque handle to be given to endGet()
      */
-    function startGet($resource, $id);
+    function startGet($resource, $id, array $parameters);
 
     /**
      * @see startGet()
      */
-    function get($resource, $id);
+    function get($resource, $id, array $parameters);
 
     /**
      * Create a new instance of an API resource using the provided $data

tests/ClientTest.php

@@ -232,6 +232,24 @@ public function get()
         $this->assertSame(['Content-Type' => ['application/json']], $response->getResponseHeaders());
     }
 
+    /**
+     * @test
+     * @covers ::get
+     * @covers ::startGet
+     * @uses \DominionEnterprises\Api\Client::end
+     */
+    public function getWithParameters()
+    {
+        $authentication = Authentication::createClientCredentials('not under test', 'not under test');
+        $client = new Client(new GetWithParametersAdapter(), $authentication, 'baseUrl/v1');
+
+        $response = $client->get('resource name', 'the id', ['foo' => 'bar']);
+
+        $this->assertSame(200, $response->getHttpCode());
+        $this->assertSame(['key' => 'value'], $response->getResponse());
+        $this->assertSame(['Content-Type' => ['application/json']], $response->getResponseHeaders());
+    }
+
     /**
      * @test
      * @covers ::put
@@ -668,6 +686,29 @@ public function end($handle)
     }
 }
 
+final class GetWithParametersAdapter implements Adapter
+{
+    private $_request;
+
+    public function start(Request $request)
+    {
+        $this->_request = $request;
+    }
+
+    public function end($handle)
+    {
+        if (substr($this->_request->getUrl(), -5) === 'token') {
+            return new Response(200, ['Content-Type' => ['application/json']], ['access_token' => 'a token', 'expires_in' => 1]);
+        }
+
+        if ($this->_request->getMethod() === 'GET' && $this->_request->getUrl() === 'baseUrl/v1/resource+name/the+id?foo=bar') {
+            return new Response(200, ['Content-Type' => ['application/json']], ['key' => 'value']);
+        }
+
+        throw new \Exception('Unexpected request');
+    }
+}
+
 final class PutAdapter implements Adapter
 {
     private $_request;