Merge pull request #52 from christofdamian/authorizations

Implement Authorizations API

Author: Evgeniy Guseletov

doc/authorizations.md

@@ -0,0 +1,52 @@
+## Authorizations API
+[Back to the navigation](index.md)
+
+Creating, deleting and listing authorizations. Wraps [GitHub Authorizations API](http://developer.github.com/v3/oauth/).
+
+#### List all authorizations.
+
+```php
+$authorizations = $github->api('authorizations')->all();
+```
+
+#### Get a single authorization
+
+```php
+$authorization = $github->api('authorizations')->show(1);
+```
+
+#### Create an authorization
+
+```php
+$data = array(
+    'note' => 'This is an optional description'
+);
+
+$authorization = $github->api('authorizations')->create($data);
+```
+
+Creates and returns an authorization.
+
+#### Update an authorization
+
+You can update ``note``.
+
+```php
+$data = array(
+    'note' => 'This is new note'
+);
+
+$authorization = $github->api('authorizations')->update(1234, $data);
+```
+
+#### Delete an authorization
+
+```php
+$authorization = $github->api('authorizations')->remove(1234);
+```
+
+#### Check an authorization
+
+```php
+$authorization = $github->api('authorizations')->check(1234, 'token');
+```

doc/index.md

@@ -2,6 +2,7 @@ Navigation
 ==========
 
 APIs:
+* [Authorizations](authorizations.md)
 * [Commits](commits.md)
 * [Gists](gists.md)
 * [Issues](issues.md)

lib/Github/Api/Authorizations.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Github\Api;
+
+use Github\Api\AbstractApi;
+
+/**
+ * Creating, deleting and listing authorizations
+ *
+ * @link   http://developer.github.com/v3/oauth/
+ */
+class Authorizations extends AbstractApi
+{
+    public function all()
+    {
+        return $this->get('authorizations');
+    }
+
+    public function show($number)
+    {
+        return $this->get('authorizations/'.urlencode($number));
+    }
+
+    public function create(array $params)
+    {
+        return $this->post('authorizations', $params);
+    }
+
+    public function update($id, array $params)
+    {
+        return $this->patch('authorizations/'.urlencode($id), $params);
+    }
+
+    public function remove($id)
+    {
+        return $this->delete('authorizations/'.urlencode($id));
+    }
+
+    public function check($id, $token)
+    {
+        return $this->get('authorizations/'.urlencode($id).'/tokens/'.urlencode($token));
+    }
+}

lib/Github/Client.php

@@ -134,6 +134,11 @@ public function api($name)
                 $api = new Api\User($this);
                 break;
 
+            case 'authorization':
+            case 'authorizations':
+                $api = new Api\Authorizations($this);
+                break;
+
             default:
                 throw new InvalidArgumentException(sprintf('Undefined api instance called: "%s"', $name));
         }

test/Github/Tests/Api/AuthorizationsTest.php

@@ -0,0 +1,111 @@
+<?php
+
+namespace Github\Tests\Api;
+
+class AuthorizationsTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAllAuthorizations()
+    {
+        $expectedArray = array(array('id' => '123'));
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('authorizations')
+            ->will($this->returnValue($expectedArray));
+
+       $this->assertEquals($expectedArray, $api->all());
+    }
+
+    /**
+     * @test
+     */
+    public function shouldShowAuthorization()
+    {
+        $id = 123;
+        $expectedArray = array('id' => $id);
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('authorizations/'.$id)
+            ->will($this->returnValue($expectedArray));
+
+       $this->assertEquals($expectedArray, $api->show($id));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldCheckAuthorization()
+    {
+        $id = 123;
+        $token = 'abc';
+        $expectedArray = array('id' => $id);
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('authorizations/'.$id.'/tokens/'.$token)
+            ->will($this->returnValue($expectedArray));
+
+       $this->assertEquals($expectedArray, $api->check($id, $token));
+    }
+
+    /**
+     * @test
+     */
+    public function shouldAuthorization()
+    {
+        $input = array(
+            'note' => '',
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('authorizations', $input);
+
+        $api->create($input);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldUpdateAuthorization()
+    {
+        $id = 123;
+        $input = array(
+            'note' => '',
+        );
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('patch')
+            ->with('authorizations/'.$id, $input);
+
+        $api->update($id, $input);
+    }
+
+    /**
+     * @test
+     */
+    public function shouldDeleteAuthorization()
+    {
+        $id = 123;
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('authorizations/'.$id);
+
+        $api->remove($id);
+    }
+
+    protected function getApiClass()
+    {
+        return 'Github\Api\Authorizations';
+    }
+}

test/Github/Tests/ClientTest.php

@@ -165,6 +165,9 @@ public function getApiClassesProvider()
             array('pr', 'Github\Api\PullRequest'),
             array('pull_request', 'Github\Api\PullRequest'),
             array('pull_requests', 'Github\Api\PullRequest'),
+
+            array('authorization', 'Github\Api\Authorizations'),
+            array('authorizations', 'Github\Api\Authorizations'),
         );
     }