PushEvent - Updated the validateRequest() method

+ Added ability to skip secret key validation, which is useful for newer version of gitea (as its depreciated now)

src/Api/Repositories.php

@@ -112,28 +112,73 @@ class Repositories extends AbstractAllApiRequester
     }
 
     /**
-     * Get the raw contents of a file stored inside a repository
+     * Get a repository using its ID
+     *
+     * Example:
+     * ```
+     * $client->repositories()->getByID($repoId);
+     * ```
+     *
+     * @param string repoId The ID of the repository
+     * @return Repository
+     */
+    public function getById(int $repoId)
+    {
+        $client = $this->getClient();
+        try {
+            $response = $this->get("repositories/$repoId");
+            $statusCode = $response->getStatusCode();
+            $body = (string) $response->getBody();
+            if ($statusCode == 200) {
+                return Repository::fromJson(
+                    $client,
+                    $this,
+                    json_decode($body)
+                );
+            }
+            return false;
+
+        } catch (ServerException $serverError) {
+            return false;
+        }
+    }
+
+    /**
+     * Get the contents of a file in a certain in repository commit/branch/tag
      * using the repository's name and owner
      *
      * Example:
      * ```
-     * $client->repositories()->getRawFile($owner, $repoName, "README.md");
+     * $client->repositories()->getFileContents($owner, $repoName, "README.md", "v2.0.0");
      * ```
      *
      * @param string $owner The owner of the repository
      * @param string $repoName The name of the repository
-     * @param string $filepath The path to the raw file (relative to the repository root)
+     * @param string $filepath The path to the file (relative to the repository root)
+     * @param string $ref The name of the commit/branch/tag. Default the repository’s default branch (usually master)
      * @return string
      */
-    public function getRawFile(string $owner, string $repoName, string $filepath)
+    public function getFileContents(string $owner, string $repoName, string $filepath, string $ref="")
     {
         $client = $this->getClient();
         try {
-            $response = $this->get("repos/$owner/$repoName/raw/$filepath");
+            if ($ref !== "") {
+                $response = $this->get("repos/$owner/$repoName/contents/$filepath",[
+                    "ref" => $ref
+                ]);
+            } else {
+                $response = $this->get("repos/$owner/$repoName/contents/$filepath");
+            }
+
             $statusCode = $response->getStatusCode();
-            $body = (string) $response->getBody();
             if ($statusCode == 200) {
-                return $body;
+                $body = (string) $response->getBody();
+                $jsonObj = json_decode($body, true);
+                if (array_key_exists("content", $jsonObj)) {
+                    $base64FileContents = $jsonObj["content"];
+                    $fileContents = base64_decode($base64FileContents);
+                    return $fileContents;
+                }
             }
             return false;
 

src/Client.php

@@ -66,7 +66,7 @@ class Client implements RequestChainableInterface
     {
         // Append a slash to any URL that doesn't end in '/'
         if (!$this->endsWith($giteaURL, '/')) {
-            $giteaURL += "/";
+            $giteaURL .= "/";
         }
         $this->giteaURL = $giteaURL;
         $this->authToken = $authToken;

src/Model/Tag.php

@@ -44,9 +44,9 @@ class Tag extends AbstractApiModel {
         if (count($args) >= 2) {
             $id = $args[0];
             $name = $args[1];
-            if (!is_numeric($id)) {
+            if (!is_string($id)) {
                 $argumentType = gettype($id);
-                throw new InvalidArgumentException("The \"__construct()\" function requires the 3rd parameter to be of the integer type, but a \"$argumentType\" was passed in");
+                throw new InvalidArgumentException("The \"__construct()\" function requires the 3rd parameter to be of the string type, but a \"$argumentType\" was passed in");
             }
             if (!is_string($name)) {
                 $argumentType = gettype($name);
@@ -71,7 +71,7 @@ class Tag extends AbstractApiModel {
         $newTag = new static(
             $client,
             $caller,
-            isset($map->id) && is_numeric($map->id) ? $map->id : -1,
+            isset($map->id) && is_string($map->id) ? $map->id : -1,
             isset($map->name) && is_string($map->name) ? $map->name : ''
         );
         $newTag->setTarballURL(isset($map->tarball_url) && is_string($map->tarball_url) ? new Uri($map->tarball_url) : null);
@@ -104,7 +104,7 @@ class Tag extends AbstractApiModel {
      * Gets the tag identifier.
      * @return int The tag identifier.
      */
-    function getId(): int {
+    function getId(): string {
         return $this->id;
     }
 

src/PushEvent.php

@@ -59,9 +59,10 @@ class PushEvent extends AbstractApiModel {
      * @param array $server The HTTP SERVER array for the push event
      * @param string $body The raw data from the request body
      * @param string $secretKey The secret key to from your server
-     * @return void
+     * @param bool $skipSecretValidation If set to true, secret key validation will be skipped (used for newer versions of Gitea)
+     * @return bool
      */
-    public static function validateRequest(array $server, string $body, string $secretKey)
+    public static function validateRequest(array $server, string $body, string $secretKey, bool $skipSecretValidation = false)
     {
         // Validate request protocol
         if ($server['REQUEST_METHOD'] != 'POST') {
@@ -80,18 +81,20 @@ class PushEvent extends AbstractApiModel {
             throw new \RuntimeException("FAILED: Empty Body - The request has an empty body");
         }
 
-        // Validate header signature
+        if (!$skipSecretValidation) {
-        $headerSignature = isset($server['HTTP_X_GITEA_SIGNATURE']) ? $server['HTTP_X_GITEA_SIGNATURE'] : '';
+            // Validate header signature
-        if (empty($headerSignature)) {
+            $headerSignature = isset($server['HTTP_X_GITEA_SIGNATURE']) ? $server['HTTP_X_GITEA_SIGNATURE'] : '';
-            throw new \RuntimeException("FAILED: Signature Missing - The request is missing the Gitea signature");
+            if (empty($headerSignature)) {
-        }
+                throw new \RuntimeException("FAILED: Signature Missing - The request is missing the Gitea signature");
-
+            }
-        // calculate payload signature
+    
-        $payload_signature = hash_hmac('sha256', $rawContent, $secretKey, false);
+            // calculate payload signature
-
+            $payload_signature = hash_hmac('sha256', $rawContent, $secretKey, false);
-        // check payload signature against header signature
+    
-        if ($headerSignature != $payload_signature) {
+            // check payload signature against header signature
-            throw new \RuntimeException("FAILED: Access Denied - The push event's secret does not match the expected secret");
+            if ($headerSignature != $payload_signature) {
+                throw new \RuntimeException("FAILED: Access Denied - The push event's secret does not match the expected secret");
+            }
         }
 
         return true;

src/TestRun.php

@@ -82,7 +82,7 @@ if ($repository) {
 }
 
 // print("Getting contents of \"composer.json\" file \n\n");
-// $rawFile = $giteaClient->repositories()->getRawFile("Sitelease", "sl-theme-recipe", "composer.json");
+// $rawFile = $giteaClient->repositories()->getFileContents("Sitelease", "sl-theme-recipe", "composer.json");
 // if ($rawFile) {
 //     var_dump(json_encode($rawFile));
 //     print("\n\n");
@@ -91,7 +91,7 @@ if ($repository) {
 // }
 
 // print("Getting contents of \"composer.json\" file \n\n");
-// $rawFile = $giteaClient->repositories()->getRawFile("Sitelease", "sl-theme-recipe", "composer.json");
+// $rawFile = $giteaClient->repositories()->getFileContents("Sitelease", "sl-theme-recipe", "composer.json");
 // if ($rawFile) {
 //     var_dump($rawFile);
 //     print("\n\n");