Merge pull request #31 from chadicus/fea/optional-id-delete

Allow null id with delete request

Author: chadicus

src/Client.php

@@ -272,8 +272,13 @@ public function put($resource, $id, array $data)
      */
     public function startDelete($resource, $id, array $data = null)
     {
-        Util::throwIfNotType(['string' => [$resource, $id]], true);
-        $url = "{$this->_baseUrl}/" . urlencode($resource) . '/' . urlencode($id);
+        Util::throwIfNotType(['string' => [$resource]], true);
+        $url = "{$this->_baseUrl}/" . urlencode($resource);
+        if ($id !== null) {
+            Util::throwIfNotType(['string' => [$id]], true);
+            $url .= '/' . urlencode($id);
+        }
+
         $json = $data !== null ? json_encode($data) : null;
         return $this->_start($url, 'DELETE', $json, ['Content-Type' => 'application/json']);
     }

tests/ClientTest.php

@@ -286,6 +286,25 @@ public function delete()
         $this->assertSame(['Content-Type' => ['application/json']], $response->getResponseHeaders());
     }
 
+    /**
+     * Verify behavior of startDelete when no id is given.
+     *
+     * @test
+     * @covers ::startDelete
+     *
+     * @return void
+     */
+    public function deleteWithoutId()
+    {
+        $adapter = new DeleteAdapter();
+        $authentication = Authentication::createClientCredentials('not under test', 'not under test');
+        $client = new Client($adapter, $authentication, 'baseUrl/v1');
+        $client->startDelete('resource', null, ['foo' => 'bar']);
+        $this->assertSame('baseUrl/v1/resource', $adapter->request->getUrl());
+        $this->assertSame('DELETE', $adapter->request->getMethod());
+        $this->assertSame(json_encode(['foo' => 'bar']), $adapter->request->getBody());
+    }
+
     /**
      * Verfiy delete creates the request body properly
      *
@@ -715,29 +734,29 @@ public function end($handle)
 
 final class DeleteAdapter implements Adapter
 {
-    private $_request;
+    public $request;
 
     public function start(Request $request)
     {
-        $this->_request = $request;
+        $this->request = $request;
     }
 
     public function end($handle)
     {
-        if (substr($this->_request->getUrl(), -5) === 'token') {
+        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() === 'DELETE' &&
-            $this->_request->getUrl() === 'baseUrl/v1/resource+name/the+id' &&
-            $this->_request->getHeaders() === [
+            $this->request->getMethod() === 'DELETE' &&
+            $this->request->getUrl() === 'baseUrl/v1/resource+name/the+id' &&
+            $this->request->getHeaders() === [
                 'Content-Type' => 'application/json',
                 'Accept-Encoding' => 'gzip',
                 'Authorization' => 'Bearer a token',
             ]
         ) {
-            $body = $this->_request->getBody();
+            $body = $this->request->getBody();
 
             if ($body === null || $body === '{"the key":"the value"}') {
                 return new Response(204, ['Content-Type' => ['application/json']]);