Missing code of conduct api endpoints (#656)

Author: acrobat

doc/README.md

@@ -31,6 +31,7 @@ v3 APIs:
   * [Timeline](issue/timeline.md)
 * [Meta](meta.md)
 * Miscellaneous
+  * [Code of conduct](miscellaneous/codeofconduct.md)
   * [Emojis](miscellaneous/emojis.md)
   * [Gitignore](miscellaneous/gitignore.md)
   * [Markdown](miscellaneous/markdown.md)

doc/miscellaneous/codeofconduct.md

@@ -0,0 +1,14 @@
+## CodeOfConduct API
+[Back to the navigation](../README.md)
+
+### Lists all code of conducts.
+
+```php
+$codeOfConducts = $client->api('codeOfConduct')->all();
+```
+
+### Get a code of conduct.
+
+```php
+$codeOfConducts = $client->api('codeOfConduct')->show('contributor_covenant');
+```

doc/repos.md

@@ -303,3 +303,9 @@ $milestones = $client->api('repo')->milestones('ornicar', 'php-github-api');
 ```
 
 Returns a list of milestones.
+
+### Get the contents of a repository's code of conduct
+
+```php
+$codeOfConduct = $client->api('repo')->codeOfConduct('ornicar', 'php-github-api');
+```

lib/Github/Api/Miscellaneous/CodeOfConduct.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Github\Api\Miscellaneous;
+
+use Github\Api\AbstractApi;
+use Github\Api\AcceptHeaderTrait;
+
+class CodeOfConduct extends AbstractApi
+{
+    use AcceptHeaderTrait;
+
+    public function configure()
+    {
+        $this->acceptHeaderValue = 'application/vnd.github.scarlet-witch-preview+json';
+
+        return $this;
+    }
+
+    /**
+     * List all codes of conduct.
+     *
+     * @link https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct
+     *
+     * @return array
+     */
+    public function all()
+    {
+        return $this->get('/codes_of_conduct');
+    }
+
+    /**
+     * Get an individual code of conduct
+     *
+     * @link https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct
+     *
+     * @param string $key
+     *
+     * @return array
+     */
+    public function show($key)
+    {
+        return $this->get('/codes_of_conduct/' . rawurlencode($key));
+    }
+}

lib/Github/Api/Repo.php

@@ -28,6 +28,8 @@
  */
 class Repo extends AbstractApi
 {
+    use AcceptHeaderTrait;
+
     /**
      * Search repositories by keyword.
      *
@@ -601,4 +603,22 @@ public function events($username, $repository, $page = 1)
     {
         return $this->get('/repos/'.rawurldecode($username).'/'.rawurldecode($repository).'/events', ['page' => $page]);
     }
+
+    /**
+     * Get the contents of a repository's code of conduct
+     *
+     * @link https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct
+     *
+     * @param string $username
+     * @param string $repository
+     *
+     * @return array
+     */
+    public function codeOfConduct($username, $repository)
+    {
+        //This api is in preview mode, so set the correct accept-header
+        $this->acceptHeaderValue = 'application/vnd.github.scarlet-witch-preview+json';
+
+        return $this->get('/repos/'.rawurldecode($username).'/'.rawurldecode($repository).'/community/code_of_conduct');
+    }
 }

lib/Github/Client.php

@@ -23,6 +23,7 @@
  * @method Api\CurrentUser me()
  * @method Api\Enterprise ent()
  * @method Api\Enterprise enterprise()
+ * @method Api\Miscellaneous\CodeOfConduct codeOfConduct()
  * @method Api\Miscellaneous\Emojis emojis()
  * @method Api\GitData git()
  * @method Api\GitData gitData()
@@ -169,6 +170,9 @@ public function api($name)
             case 'currentUser':
                 $api = new Api\CurrentUser($this);
                 break;
+            case 'codeOfConduct':
+                $api = new Api\Miscellaneous\CodeOfConduct($this);
+                break;
 
             case 'deployment':
             case 'deployments':

test/Github/Tests/Api/Miscellaneous/CodeOfConductTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Github\Tests\Api\Miscellaneous;
+
+use Github\Api\Miscellaneous\CodeOfConduct;
+use Github\Tests\Api\TestCase;
+
+class CodeOfConductTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAllCodeOfConducts()
+    {
+        $expectedArray = [
+            ['name' => 'CoC1'],
+            ['name' => 'CoC2'],
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('/codes_of_conduct')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->all());
+    }
+
+    /**
+     * @test
+     */
+    public function shouldGetSingleCodeOfConducts()
+    {
+        $expectedArray = [
+            'name' => 'CoC',
+        ];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('/codes_of_conduct/contributor_covenant')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->show('contributor_covenant'));
+    }
+
+    /**
+     * @return string
+     */
+    protected function getApiClass()
+    {
+        return CodeOfConduct::class;
+    }
+}

test/Github/Tests/Api/RepoTest.php

@@ -535,6 +535,22 @@ public function shouldGetRepositoryEvents()
         $this->assertEquals($expectedArray, $api->events('KnpLabs', 'php-github-api', 3));
     }
 
+    /**
+     * @test
+     */
+    public function shouldGetRepositoryCodeOfConduct()
+    {
+        $expectedArray = array('name' => 'Contributor Covenant', 'url' => 'http://...');
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('/repos/KnpLabs/php-github-api/community/code_of_conduct')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->codeOfConduct('KnpLabs', 'php-github-api'));
+    }
+
     /**
      * @return string
      */