Add tests, add more release apis, add assets api, update docs

Evgeniy Guseletov · Evgeniy Guseletov · commit 5bae94f348be · 2013-10-17T17:18:05.000+03:00
diff --git a/composer.json b/composer.json
@@ -21,6 +21,9 @@
         "ext-curl":           "*",
         "kriswallsmith/buzz": ">=0.7"
     },
+    "require-dev": {
+        "phpunit/phpunit":  ">=3.6.0"
+    },
     "autoload": {
         "psr-0": { "Github\\": "lib/" }
     },
diff --git a/doc/index.md b/doc/index.md
@@ -15,6 +15,7 @@ APIs:
   * [Comments](pull_request/comments.md)
 * [Repositories](repos.md)
   * [Releases](repo/releases.md)
+    * [Assets](repo/assets.md)
 * [Users](users.md)
 
 Additional features:
diff --git a/doc/repo/assets.md b/doc/repo/assets.md
@@ -0,0 +1,30 @@
+## Repo / Releases API
+[Back to the "Repos API"](../repos.md) | [Back to the navigation](../index.md)
+
+### List all assets by release
+
+```php
+$assets = $client->api('repo')->releases()->assets()->all('twbs', 'bootstrap', $releaseId);
+```
+
+### List one asset
+
+```php
+$asset = $client->api('repo')->releases()->assets()->show('twbs', 'bootstrap', $assetId);
+```
+
+### Create an asset
+
+This feature is not implemented because require usage of `uploads.github.com` subdomain.
+
+### Edit an asset
+
+```php
+$asset = $client->api('repo')->releases()->assets()->edit('twbs', 'bootstrap', $assetId, array('name' => 'New name'));
+```
+
+### Remove an asset
+
+```php
+$asset = $client->api('repo')->releases()->assets()->remove('twbs', 'bootstrap', $assetId);
+```
diff --git a/doc/repo/releases.md b/doc/repo/releases.md
@@ -16,6 +16,16 @@ $releases = $client->api('repo')->releases()->all('twbs', 'bootstrap');
 $release = $client->api('repo')->releases()->show('twbs', 'bootstrap', $id);
 ```
 
+### Create a release
+```php
+$release = $client->api('repo')->releases()->create('twbs', 'bootstrap', array('tag_name' => 'v1.1'));
+```
+
+### Edit a release
+```php
+$release = $client->api('repo')->releases()->edit('twbs', 'bootstrap', $id, array('name' => 'New release name'));
+```
+
 ### Remove a release
 
 This works, but isn't thoroughly tested, use at your own risk.
diff --git a/lib/Github/Api/Repository/Assets.php b/lib/Github/Api/Repository/Assets.php
@@ -0,0 +1,80 @@
+<?php
+
+namespace Github\Api\Repository;
+
+use Github\Api\AbstractApi;
+use Github\Exception\MissingArgumentException;
+
+/**
+ * @link   http://developer.github.com/v3/repos/releases/
+ * @author Evgeniy Guseletov <d46k16@gmail.com>
+ */
+class Assets extends AbstractApi
+{
+    /**
+     * Get all release's assets in selected repository
+     * GET /repos/:owner/:repo/releases/:id/assets
+     *
+     * @param  string  $username         the user who owns the repo
+     * @param  string  $repository       the name of the repo
+     * @param  integer $id               the id of the release
+     *
+     * @return array
+     */
+    public function all($username, $repository, $id)
+    {
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/'.rawurlencode($id).'/assets');
+    }
+
+    /**
+     * Get an asset in selected repository's release
+     * GET /repos/:owner/:repo/releases/assets/:id
+     *
+     * @param  string  $username         the user who owns the repo
+     * @param  string  $repository       the name of the repo
+     * @param  integer $id               the id of the asset
+     *
+     * @return array
+     */
+    public function show($username, $repository, $id)
+    {
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/assets/'.rawurlencode($id));
+    }
+
+    /**
+     * Edit an asset in selected repository's release
+     * PATCH /repos/:owner/:repo/releases/assets/:id
+     *
+     * @param  string  $username         the user who owns the repo
+     * @param  string  $repository       the name of the repo
+     * @param  integer $id               the id of the asset
+     * @param  array   $params           request parameters
+     *
+     * @throws MissingArgumentException
+     *
+     * @return array
+     */
+    public function edit($username, $repository, $id, array $params)
+    {
+        if (!isset($params['name'])) {
+            throw new MissingArgumentException('name');
+        }
+
+        return $this->patch('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/assets/'.rawurlencode($id), $params);
+    }
+
+    /**
+     * Delete an asset in selected repository's release
+     * DELETE /repos/:owner/:repo/releases/assets/:id
+     *
+     * @param  string  $username         the user who owns the repo
+     * @param  string  $repository       the name of the repo
+     * @param  integer $id               the id of the asset
+     *
+     * @return array
+     */
+    public function remove($username, $repository, $id)
+    {
+        return $this->delete('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/assets/'.rawurlencode($id));
+    }
+}
diff --git a/lib/Github/Api/Repository/Releases.php b/lib/Github/Api/Repository/Releases.php
@@ -3,9 +3,12 @@
 namespace Github\Api\Repository;
 
 use Github\Api\AbstractApi;
+use Github\Exception\MissingArgumentException;
 
 /**
+ * @link   http://developer.github.com/v3/repos/releases/
  * @author Matthew Simo <matthew.a.simo@gmail.com>
+ * @author Evgeniy Guseletov <d46k16@gmail.com>
  */
 class Releases extends AbstractApi
 {
@@ -19,25 +22,60 @@ class Releases extends AbstractApi
      */
     public function all($username, $repository)
     {
-        return $this->get('repos/'.urlencode($username).'/'.urlencode($repository).'/releases');
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases');
     }
 
     /**
      * Get a release in selected repository
      *
      * @param  string  $username         the user who owns the repo
      * @param  string  $repository       the name of the repo
-     * @param  integer $id               the id of the release 
+     * @param  integer $id               the id of the release
      *
      * @return array
      */
     public function show($username, $repository, $id)
     {
-        return $this->get('repos/'.urlencode($username).'/'.urlencode($repository).'/releases/'.urlencode($id));
+        return $this->get('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/'.rawurlencode($id));
+    }
+
+    /**
+     * Create new release in selected repository
+     *
+     * @param  string  $username
+     * @param  string  $repository
+     * @param  array   $params
+     *
+     * @throws MissingArgumentException
+     *
+     * @return array
+     */
+    public function create($username, $repository, array $params)
+    {
+        if (!isset($params['tag_name'])) {
+            throw new MissingArgumentException('tag_name');
+        }
+
+        return $this->post('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases', $params);
+    }
+
+    /**
+     * Edit release in selected repository
+     *
+     * @param  string  $username
+     * @param  string  $repository
+     * @param  integer $id
+     * @param  array   $params
+     *
+     * @return array
+     */
+    public function edit($username, $repository, $id, array $params)
+    {
+        return $this->patch('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/'.rawurlencode($id), $params);
     }
 
     /**
-     * Delete a download in selected repository (Not thoroughly tested!)
+     * Delete a release in selected repository (Not thoroughly tested!)
      *
      * @param  string  $username         the user who owns the repo
      * @param  string  $repository       the name of the repo
@@ -47,6 +85,14 @@ public function show($username, $repository, $id)
      */
     public function remove($username, $repository, $id)
     {
-        return $this->delete('repos/'.urlencode($username).'/'.urlencode($repository).'/releases/'.urlencode($id));
+        return $this->delete('repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/releases/'.rawurlencode($id));
+    }
+
+    /**
+     * @return Assets
+     */
+    public function assets()
+    {
+        return new Assets($this->client);
     }
 }
diff --git a/test/Github/Tests/Api/RepoTest.php b/test/Github/Tests/Api/RepoTest.php
@@ -407,6 +407,16 @@ public function shouldGetStatusesApiObject()
         $this->assertInstanceOf('Github\Api\Repository\Statuses', $api->statuses());
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetReleasesApiObject()
+    {
+        $api = $this->getApiMock();
+
+        $this->assertInstanceOf('Github\Api\Repository\Releases', $api->releases());
+    }
+
     protected function getApiClass()
     {
         return 'Github\Api\Repo';
diff --git a/test/Github/Tests/Api/Repository/AssetsTest.php b/test/Github/Tests/Api/Repository/AssetsTest.php
@@ -0,0 +1,98 @@
+<?php
+
+namespace Github\Tests\Api\Repository;
+
+use Github\Tests\Api\TestCase;
+
+class AssetsTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAllReleaseAssets()
+    {
+        $expectedValue = array(array('asset1data'), array('asset2data'));
+        $id = 76;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('repos/KnpLabs/php-github-api/releases/'.$id.'/assets')
+            ->will($this->returnValue($expectedValue));
+
+        $this->assertEquals($expectedValue, $api->all('KnpLabs', 'php-github-api', $id));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetSingleReleaseAsset()
+    {
+        $expectedValue = array('assetData');
+        $assetId = 2;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('repos/KnpLabs/php-github-api/releases/assets/'.$assetId)
+            ->will($this->returnValue($expectedValue));
+
+        $this->assertEquals($expectedValue, $api->show('KnpLabs', 'php-github-api', $assetId));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldEditReleaseAsset()
+    {
+        $expectedValue = array('assetUpdatedData');
+        $assetId = 5;
+        $data = array('name' => 'asset111_name_qweqwe');
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('patch')
+            ->with('repos/KnpLabs/php-github-api/releases/assets/'.$assetId)
+            ->will($this->returnValue($expectedValue));
+
+        $this->assertEquals($expectedValue, $api->edit('KnpLabs', 'php-github-api', $assetId, $data));
+    }
+
+    /**
+     * @test
+     * @expectedException Github\Exception\MissingArgumentException
+     */
+    public function shouldNotEditReleaseAssetWithoutName()
+    {
+        $assetId = 5;
+        $data = array('not_a_name' => 'just a value');
+
+        $api = $this->getApiMock();
+        $api->expects($this->never())
+            ->method('patch');
+
+        $api->edit('KnpLabs', 'php-github-api', $assetId, $data);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldRemoveReleaseAsset()
+    {
+        $expectedValue = array('assetUpdatedData');
+        $assetId = 5;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('repos/KnpLabs/php-github-api/releases/assets/'.$assetId)
+            ->will($this->returnValue($expectedValue));
+
+        $this->assertEquals($expectedValue, $api->remove('KnpLabs', 'php-github-api', $assetId));
+    }
+
+    protected function getApiClass()
+    {
+        return 'Github\Api\Repository\Assets';
+    }
+}
diff --git a/test/Github/Tests/Api/Repository/ReleasesTest.php b/test/Github/Tests/Api/Repository/ReleasesTest.php
