Merge pull request #9 from Harrk/release/2.0

Upgrade packages. Remove support for PHP7. Add return types.
Harrk · Feb 19, 2023 · 488c2c6 · 488c2c6
2 parents 413484b + d9c3173
commit 488c2c6
Show file tree

Hide file tree

Showing 27 changed files with 294 additions and 350 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,25 +1,17 @@
 version: 2
 
 jobs:
-  "php-7.2":
-    docker:
-      - image: circleci/php:7.2
-    steps:
-      - checkout
-      - run: composer install
-      - run: ./vendor/bin/phpunit
-
-  "php-8.0":
+  "php-8.1":
     docker:
-      - image: circleci/php:8.0
+      - image: cimg/php:8.1
     steps:
       - checkout
       - run: composer install
       - run: ./vendor/bin/phpunit
 
-  "php-8.1":
+  "php-8.2":
     docker:
-      - image: cimg/php:8.1
+      - image: cimg/php:8.2
     steps:
       - checkout
       - run: composer install
@@ -29,6 +21,5 @@ workflows:
     version: 2
     build:
         jobs:
-            - "php-7.2"
-            - "php-8.0"
             - "php-8.1"
+            - "php-8.2"
diff --git a/README.md b/README.md
@@ -19,9 +19,12 @@ Create an instance of GamejoltApi and provide a GamejoltConfig
 to begin making API calls to Game Jolt.
 
 ```php
+$gameId = 0; // Your game's ID
+$gamePrivaykey = "Your game's private key";
+
 $api = new GamejoltApi(new GamejoltConfig(
-    'mygameid',
-    'mygameprivatekey'
+    $gameId,
+    $gamePrivaykey
 ));
 ```
 

diff --git a/composer.json b/composer.json
@@ -4,7 +4,7 @@
     "authors": [
         {
             "name": "Harry Kirkman",
-            "homepage": "https://harrykirkman.co.uk"
+            "homepage": "https://harrk.dev"
         }
     ],
     "description": "A PHP library for the Game Jolt API.",
@@ -23,16 +23,16 @@
         }
     },
     "require": {
-        "php": "^7.2|^8.0",
-        "guzzlehttp/guzzle": "^6.5.7|^7.4.5",
+        "php": "^8.1|8.2",
+        "guzzlehttp/guzzle": "^7.5",
         "ext-json": "*"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5|^9.3.3",
-        "phpstan/phpstan": "^0.11.0|^0.12.0"
+        "phpunit/phpunit": "^10.0",
+        "phpstan/phpstan": "^1.9.18"
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "analyse": "vendor/bin/phpstan analyse ./src --level=5"
+        "analyse": "vendor/bin/phpstan analyse ./src --level 5"
     }
 }
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,27 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap = "vendor/autoload.php"
-         backupGlobals               = "false"
-         backupStaticAttributes      = "false"
-         colors                      = "true"
-         convertErrorsToExceptions   = "true"
-         convertNoticesToExceptions  = "true"
-         convertWarningsToExceptions = "true"
-         processIsolation            = "false"
-         stopOnFailure               = "false">
-
-    <testsuites>
-        <testsuite name="Project Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-
-    <php>
-        <env name="APP_ENV" value="testing"/>
-    </php>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Project Test Suite">
+      <directory>tests</directory>
+      <exclude>tests/GamejoltApiBaseTest.php</exclude>
+    </testsuite>
+  </testsuites>
+  <php>
+    <env name="APP_ENV" value="testing"/>
+  </php>
 </phpunit>
diff --git a/src/ApiCallService.php b/src/ApiCallService.php
@@ -3,6 +3,7 @@
 namespace Harrk\GameJoltApi;
 
 use GuzzleHttp\Client;
+use GuzzleHttp\Exception\GuzzleException;
 use Harrk\GameJoltApi\Exceptions\TimeOutException;
 use Harrk\GameJoltApi\Callers\AbstractCaller;
 use GuzzleHttp\Exception\ConnectException;
@@ -35,11 +36,10 @@ public function __construct(AbstractCaller $caller) {
     }
 
     /**
-     * @return array
      * @throws TimeOutException
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
-    public function execute() {
+    public function execute(): array {
         try {
             $request = $this->client->request(
                 $this->method,

diff --git a/src/Callers/AbstractCaller.php b/src/Callers/AbstractCaller.php
@@ -6,28 +6,18 @@
 use Harrk\GameJoltApi\GamejoltConfig;
 
 class AbstractCaller {
+    protected string $uri;
+    protected array $params;
+    protected GamejoltConfig $gameJoltConfig;
 
-    /**
-     * @var string
-     */
-    protected $uri;
 
-    /**
-     * @var array
-     */
-    protected $params;
-
-    /**
-     * @var GamejoltConfig
-     */
-    protected $gameJoltConfig;
-
-
-    public function __construct(GamejoltConfig $gamejoltConfig) {
+    public function __construct(GamejoltConfig $gamejoltConfig)
+    {
         $this->gameJoltConfig = $gamejoltConfig;
     }
 
-    protected function getSignature(string $url, array $params = []) {
+    protected function getSignature(string $url, array $params = []): string
+    {
         $urlWithPrivateKey = $url . $this->gameJoltConfig->getPrivateKey();
         $toHashString = $urlWithPrivateKey;
 
@@ -46,7 +36,8 @@ protected function getSignature(string $url, array $params = []) {
         return sha1($toHashString);
     }
 
-    public function getFullUrl($withSignature = false) {
+    public function getFullUrl(bool $withSignature = false)
+    {
         $url = $this->gameJoltConfig->getEndpoint() . $this->uri . '/';
 
         $url .= '?' . http_build_query($this->getParams());
@@ -58,23 +49,18 @@ public function getFullUrl($withSignature = false) {
         return $url;
     }
 
-    public function call($uri, $params = []) {
+    public function call(string $uri, array $params = []): array
+    {
         $this->uri = $uri;
-        $this->params = array_merge(
-            [
-                'game_id' => $this->gameJoltConfig->getGameId()
-            ],
-            $params
-        );
-
-        $apiCallService = new ApiCallService($this);
+        $this->params = array_merge([
+            'game_id' => $this->gameJoltConfig->getGameId()
+        ], $params);
 
-        return $apiCallService->execute();
+        return (new ApiCallService($this))->execute();
     }
 
-    public function getParams() {
-        return array_filter((array) $this->params, function ($param) {
-            return ! empty($param);
-        });
+    public function getParams(): array
+    {
+        return array_filter($this->params, static fn ($param) => ! empty($param));
     }
 }
diff --git a/src/Callers/DataStore.php b/src/Callers/DataStore.php
@@ -5,14 +5,14 @@
 use Harrk\GameJoltApi\Exceptions\InvalidParameterException;
 
 class DataStore extends AbstractCaller {
-    const OPERATION_ADD = 'add';
-    const OPERATION_SUBTRACT = 'subtract';
-    const OPERATION_MULTIPLY = 'multiply';
-    const OPERATION_DIVIDE = 'divide';
-    const OPERATION_APPEND = 'append';
-    const OPERATION_PREPEND = 'prepend';
+    public const OPERATION_ADD = 'add';
+    public const OPERATION_SUBTRACT = 'subtract';
+    public const OPERATION_MULTIPLY = 'multiply';
+    public const OPERATION_DIVIDE = 'divide';
+    public const OPERATION_APPEND = 'append';
+    public const OPERATION_PREPEND = 'prepend';
 
-    CONST OPERATIONS = [
+    public const OPERATIONS = [
         self::OPERATION_ADD,
         self::OPERATION_SUBTRACT,
         self::OPERATION_MULTIPLY,
@@ -23,44 +23,29 @@ class DataStore extends AbstractCaller {
 
     /**
      * @link https://gamejolt.com/game-api/doc/data-store/fetch
-     *
-     * @param string $key
-     * @param null|string $username
-     * @param null|string $user_token
-     *
-     * @return array
      */
-    public function fetch($key, $username = null, $user_token = null) {
+    public function fetch(string $key, ?string $username = null, ?string $user_token = null): array
+    {
         return $this->call('data-store', compact(
             'key', 'username', 'user_token'
         ));
     }
 
     /**
      * @link https://gamejolt.com/game-api/doc/data-store/get-keys
-     *
-     * @param null|string $pattern
-     * @param null|string $username
-     * @param null|string $user_token
-     *
-     * @return array
      */
-    public function getKeys($pattern = null, $username = null, $user_token = null) {
+    public function getKeys(?string $pattern = null, ?string $username = null, ?string $user_token = null): array
+    {
         return $this->call('data-store/get-keys', compact(
             'pattern', 'username', 'user_token'
         ));
     }
 
     /**
      * @link https://gamejolt.com/game-api/doc/data-store/remove
-     *
-     * @param string $key
-     * @param null|string $username
-     * @param null|string $user_token
-     *
-     * @return array
      */
-    public function remove($key, $username = null, $user_token = null) {
+    public function remove(string $key, ?string $username = null, ?string $user_token = null): array
+    {
         return $this->call('data-store/remove', compact(
             'key', 'username', 'user_token'
         ));

diff --git a/src/Callers/Friends.php b/src/Callers/Friends.php
@@ -6,13 +6,9 @@ class Friends extends AbstractCaller {
 
     /**
      * @link https://gamejolt.com/game-api/doc/friends/fetch
-     *
-     * @param string $username
-     * @param string $user_token
-     *
-     * @return array
      */
-    public function fetch($username, $user_token) {
+    public function fetch(string $username, string $user_token): array
+    {
         return $this->call('friends', compact(
             'username', 'user_token'
         ));