No need for a special header on deployment API requests

Author: lol768

lib/Github/Api/Deployment.php

@@ -4,20 +4,33 @@
 
 use Github\Exception\MissingArgumentException;
 
+/**
+ * Listing, creating and updating deployments.
+ *
+ * @link https://developer.github.com/v3/repos/deployments/
+ */
 class Deployment extends AbstractApi
 {
-
+    /**
+     * List deployments for a particular repository
+     * @link https://developer.github.com/v3/repos/deployments/#list-deployments
+     *
+     * @param  string $username   the username of the user who owns the repository
+     * @param  string $repository the name of the repository
+     * @param  array $params      query parameters to filter deployments by (see link)
+     * @return array              the deployments requested
+     */
     public function all($username, $repository, array $params = array())
     {   
-        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments', array(),
-          array('Accept' => 'application/vnd.github.cannonball-preview+json')
-        );
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments', $params);
     }
 
-
-
     /**
      * Create a new deployment for the given username and repo.
+     * @link https://developer.github.com/v3/repos/deployments/#create-a-deployment
+     *
+     * Important: Once a deployment is created, it cannot be updated. Changes are indicated by creating new statuses.
+     * @see updateStatus
      *
      * @param  string $username   the username
      * @param  string $repository the repository
@@ -32,22 +45,40 @@ public function create($username, $repository, array $params)
              throw new MissingArgumentException(array('ref'));
          }
 
-         return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments', $params, ['Accept' => 'application/vnd.github.cannonball-preview+json']);
+         return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments', $params);
     }
 
     /**
-     * Update deployment information's by username, repo and deployment number. Requires authentication.
+     * Updates a deployment by creating a new status update.
+     * @link https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
      *
-     * @param string $username   the username
+     * @param string $username the username
      * @param string $repository the repository
-     * @param string $id         the deployment number
+     * @param string $id the deployment number
+     * @param array $params The information about the deployment update.
+     *                       Must include a "state" field of pending, success, error, or failure.
+     *                       May also be given a target_url and description, ßee link for more details.
      * @return array information about the deployment
+     *
+     * @throws MissingArgumentException
      */
-    public function update($username, $repository, $id, array $params)
+    public function updateStatus($username, $repository, $id, array $params)
     {
          if (!isset($params['state'])) {
            throw new MissingArgumentException(array('state'));
          }
-         return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments/'.rawurlencode($id).'/statuses', $params, ['Accept' => 'application/vnd.github.cannonball-preview+json']);
+         return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments/'.rawurlencode($id).'/statuses', $params);
+    }
+
+    /**
+     * Gets all of the status updates tied to a given deployment.
+     *
+     * @param  string $username the username
+     * @param  string $repository the repository
+     * @param  int $id the deployment identifier
+     * @return array the deployment statuses
+     */
+    public function getStatuses($username, $repository, $id) {
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/deployments/'.rawurlencode($id).'/statuses');
     }
 }

test/Github/Tests/Api/DeploymentTest.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Github\Tests\Api;
+
+class DeploymentTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldCreateDeployment()
+    {
+        /** @var \Github\Api\Deployment $api */
+        $api = $this->getApiMock();
+        $deploymentData = array("ref" => "fd6a5f9e5a430dddae8d6a8ea378f913d3a766f9");
+        $api->expects($this->once())
+            ->method('post')
+            ->with('/repos/KnpLabs/php-github-api/deployments', $deploymentData);
+
+        $api->create("KnpLabs", "php-github-api", $deploymentData);
+    }
+
+    protected function getApiClass()
+    {
+        return 'Github\Api\Deployment';
+    }
+}