Add download repository zip method

Author: vermakhushboo

src/VCS/Adapter/Git/GitHub.php

@@ -119,7 +119,9 @@ public function getUser(): array
      */
     public function listRepositoriesForGitHubApp(): array
     {
-        $response = $this->call(self::METHOD_GET, '/installation/repositories', ["Authorization" => "Bearer $this->accessToken"]);
+        $url = '/installation/repositories';
+
+        $response = $this->call(self::METHOD_GET, $url, ["Authorization" => "Bearer $this->accessToken"]);
 
         return $response['body']['repositories'];
     }
@@ -132,7 +134,10 @@ public function listRepositoriesForGitHubApp(): array
      */
     public function addComment($repoName, $pullRequestNumber)
     {
-        $this->call(self::METHOD_POST, '/repos/' . $this->user . '/' . $repoName . '/issues/' . $pullRequestNumber . '/comments', ["Authorization" => "Bearer $this->accessToken"], ["body" => "hello from Utopia!"]);
+        $url = '/repos/' . $this->user . '/' . $repoName . '/issues/' . $pullRequestNumber . '/comments';
+
+        $this->call(self::METHOD_POST, $url, ["Authorization" => "Bearer $this->accessToken"], ["body" => "hello from Utopia!"]);
+
         return;
     }
 
@@ -144,7 +149,34 @@ public function addComment($repoName, $pullRequestNumber)
      */
     public function updateComment($repoName, $commentId)
     {
-        $this->call(self::METHOD_PATCH, '/repos/' . $this->user . '/' . $repoName . '/issues/comments/' . $commentId, ["Authorization" => "Bearer $this->accessToken"], ["body" => "update from Utopia!"]);
+        $url = '/repos/' . $this->user . '/' . $repoName . '/issues/comments/' . $commentId;
+
+        $this->call(self::METHOD_PATCH, $url, ["Authorization" => "Bearer $this->accessToken"], ["body" => "update from Utopia!"]);
+
         return;
     }
+
+    /**
+     * Downloads a ZIP archive of a repository.
+     *
+     * @param string $repo The name of the repository.
+     * @param string $ref The name of the commit, branch, or tag to download.
+     * @param string $path The path of the file or directory to download. Optional.
+     * @return string The contents of the ZIP archive as a string.
+     */
+    public function downloadRepositoryZip(string $repoName, string $ref, string $path = ''): string
+    {
+        // Build the URL for the API request
+        $url = "/repos/" . $this->user . "/{$repoName}/zipball/{$ref}";
+
+        // Add the path parameter to the URL query parameters, if specified
+        if (!empty($path)) {
+            $url .= "?path={$path}";
+        }
+
+        $response = $this->call(self::METHOD_GET, $url, ["Authorization" => "Bearer $this->accessToken"]);
+
+        // Return the contents of the ZIP archive
+        return $response['body'];
+    }
 }

tests/VCS/GitHubTest.php

@@ -28,11 +28,6 @@ public function testListRepositoriesForGitHubApp(): void
         $repos = $this->github->listRepositoriesForGitHubApp();
     }
 
-    public function testGetRepository(): void
-    {
-        $this->github->getRepository("TodoApp");
-    }
-
     public function testAddComment(): void
     {
         $this->github->addComment("basic-js-crud", 1);
@@ -42,4 +37,13 @@ public function testUpdateComment(): void
     {
         $this->github->updateComment("basic-js-crud", 1431560395);
     }
+
+    public function testDownloadRepositoryZip(): void
+    {
+        // download the zip archive of the repo
+        $zipContents = $this->github->downloadRepositoryZip("gatsby-ecommerce-theme", "main");
+
+        // Save the ZIP archive to a file
+        file_put_contents('hello-world.zip', $zipContents);
+    }
 }