Add the ability to download raw file, needed when size > 1MB

Author: genintho

lib/Github/Api/Repository/Contents.php

@@ -65,10 +65,11 @@ public function readme($username, $repository, $reference = null)
      * @param string      $repository the name of the repository
      * @param string|null $path       path to file or directory
      * @param string|null $reference  reference to a branch or commit
+     * @param array  $requestHeaders request headers
      *
      * @return array|string information for file | information for each item in directory
      */
-    public function show($username, $repository, $path = null, $reference = null)
+    public function show($username, $repository, $path = null, $reference = null, $requestHeaders = [])
     {
         $url = '/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/contents';
         if (null !== $path) {
@@ -77,7 +78,7 @@ public function show($username, $repository, $path = null, $reference = null)
 
         return $this->get($url, [
             'ref' => $reference,
-        ]);
+        ], $requestHeaders);
     }
 
     /**
@@ -272,9 +273,11 @@ public function archive($username, $repository, $format, $reference = null)
      *
      * @return string|null content of file, or null in case of base64_decode failure
      */
-    public function download($username, $repository, $path, $reference = null)
+    public function download($username, $repository, $path, $reference = null, $bodyType = null)
     {
-        $file = $this->show($username, $repository, $path, $reference);
+        $file = $this->show($username, $repository, $path, $reference,[
+            'Accept' => 'application/vnd.github.VERSION.raw'
+        ]);
 
         if (!isset($file['type']) || !in_array($file['type'], ['file', 'symlink'], true)) {
             throw new InvalidArgumentException(sprintf('Path "%s" is not a file or a symlink to a file.', $path));
@@ -294,4 +297,24 @@ public function download($username, $repository, $path, $reference = null)
 
         return base64_decode($file['content']) ?: null;
     }
+
+    /**
+     * Get the raw content of a file in a repository
+     *
+     * Use this method instead of the download method if your file is bigger than 1MB
+     *
+     * @see https://docs.github.com/en/rest/repos/contents
+     *
+     * @param string      $username   the user who owns the repository
+     * @param string      $repository the name of the repository
+     * @param string      $path       path to file
+     * @param string|null $reference  reference to a branch or commit
+     *
+     * @return array|string
+     */
+    public function rawDownload($username, $repository, $path, $reference = null) {
+        return $this->show($username, $repository, $path, $reference, [
+            'Accept' => 'application/vnd.github.VERSION.raw'
+        ]);
+    }
 }

test/Github/Tests/Api/Repository/ContentsTest.php

@@ -319,6 +319,24 @@ public function shouldDownloadForSpacedPath()
         $this->assertEquals($expectedValue, $api->download('mads379', 'scala.tmbundle', 'Syntaxes/Simple Build Tool.tmLanguage'));
     }
 
+    /**
+     * @test
+     */
+    public function shouldRawDownloadForGivenPath()
+    {
+        // The show() method return
+        $getValue = include __DIR__.'/fixtures/ContentsDownloadFixture.php';
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with('/repos/KnpLabs/php-github-api/contents/test%2FGithub%2FTests%2FApi%2FRepository%2FContentsTest.php', ['ref' => null])
+            ->will($this->returnValue($getValue));
+
+        $this->assertEquals($getValue, $api->rawDownload('KnpLabs', 'php-github-api', 'test/Github/Tests/Api/Repository/ContentsTest.php'));
+    }
+
+
     /**
      * @return string
      */