Add the repository transfer endpoint (#699)

* Add the repository transfer endpoint

* cs

* Add tests

* cs

* Fix tests

* typo

* Update changelog

* Update documentation

* CamelCase

* Doc fix

Author: m1guelpf

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
 
+## 2.9.0
+
+### Added
+
+- API endpoint `Github\Api\Repo::transfer()`
+
 ## 2.8.0
 
 ### Added

doc/repos.md

@@ -329,3 +329,14 @@ $topics = $client->api('repo')->topics('ornicar', 'php-github-api');
 ```php
 $currentTopics = $client->api('repo')->replaceTopics('ornicar', 'php-github-api', ['new', 'topics']);
 ```
+
+### Transfer a repo to another user
+
+```php
+$repo = $client->api('repo')->transfer('KnpLabs', 'php-github-api', 'github');
+```
+You can optionally assign some teams by passing an array with their ID's if you're transferring the repo to an organization:
+
+```php
+$repo = $client->api('repo')->transfer('KnpLabs', 'php-github-api', 'github', [1234]);
+```

lib/Github/Api/Repo.php

@@ -659,4 +659,24 @@ public function replaceTopics($username, $repository, array $topics)
 
         return $this->put('/repos/'.rawurldecode($username).'/'.rawurldecode($repository).'/topics', ['names' => $topics]);
     }
+
+    /**
+     * Transfer a repository.
+     *
+     * @link https://developer.github.com/v3/repos/#transfer-a-repository
+     *
+     * @param string $username
+     * @param string $repository
+     * @param string $newOwner
+     * @param array  $teamId
+     *
+     * @return array
+     */
+    public function transfer($username, $repository, $newOwner, $teamId = [])
+    {
+        //This api is in preview mode, so set the correct accept-header
+        $this->acceptHeaderValue = 'application/vnd.github.nightshade-preview+json';
+
+        return $this->post('/repos/'.rawurldecode($username).'/'.rawurldecode($repository).'/transfer', ['new_owner' => $newOwner, 'team_id' => $teamId]);
+    }
 }

test/Github/Tests/Api/RepoTest.php

@@ -585,6 +585,25 @@ public function shouldReplaceRepositoryTopics()
         $this->assertEquals($expectedArray, $api->replaceTopics('KnpLabs', 'php-github-api', ['octocat', 'atom', 'electron', 'API']));
     }
 
+    /**
+     * @test
+     */
+    public function shouldTransferRepository()
+    {
+        $expectedArray = ['id' => 1, 'name' => 'php-github-api'];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('/repos/KnpLabs/php-github-api/transfer', [
+                'new_owner' => 'github',
+                'team_id' => [1234, 1235],
+            ])
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->transfer('KnpLabs', 'php-github-api', 'github', [1234, 1235]));
+    }
+
     /**
      * @return string
      */