Prepare update + change dockerfile

.github/workflows/php.yml

@@ -16,10 +16,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up php 8.1
+    - name: Set up php 8.2
       uses: shivammathur/setup-php@v2
       with:
-        php-version: '8.1'
+        php-version: '8.2'
     - name: Validate composer.json and composer.lock
       run: composer validate --strict
 
@@ -37,6 +37,8 @@ jobs:
 
     # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
     # Docs: https://getcomposer.org/doc/articles/scripts.md
+    - name: RectorPHP Refactoring
+      run: vendor/bin/rector process src
 
     - name: Run test suite
       env:

.travis.yml

@@ -1,7 +1,7 @@
 dist: trusty
 language: php
 php:
-  - '8.1'
+  - '8.2'
   - nightly
 before_script: composer install
 script:

README.md

@@ -31,10 +31,10 @@
  * [Authors](#authors)
  * [Licence](#licence)
 
-Version 2.5.2
+Version 2.6.0
 
 ## Requirements
-* PHP 8.1 min or superior (oldest versions are no longer supported)
+* PHP 8.2 min or superior (oldest versions are no longer supported)
 * API Key and API Secret from [Astrobin](https://www.astrobin.com/api/request-key/)
 
 ## Introduction
@@ -53,17 +53,20 @@ You can install this package in 2 different ways.
 Update to the newest version :
 > `composer update hamhamfonfon/astrobin-ws`
 
-* If you just want to make some issues, make some simple tests etc, juste clone the repository
-
-> `git clone [email protected]:HamHamFonFon/Astrobin-Webservices.git`
 
 If you're using old PHP versions:
+- PHP 8.1
+> `composer require hamhamfonfon/astrobin-ws:2.5`
 - PHP 7.4 | 8.0
 > `composer require hamhamfonfon/astrobin-ws:2.4`
 - PHP 7.3
 > `composer require hamhamfonfon/astrobin-ws:2.3`
 
-Caution, these versions are not maintained anymore. Only 2.5.* will be maintained and will have new features.
+Caution, these versions are not maintained anymore. Only 2.6.* will be maintained and will have new features.
+
+* If you just want to make some issues, make some simple tests etc, juste clone the repository
+
+> `git clone [email protected]:HamHamFonFon/Astrobin-Webservices.git`
 
 ### Usage
 

composer.json

@@ -15,11 +15,11 @@
   },
   "config": {
     "platform": {
-      "php": "8.1"
+      "php": "8.2"
     }
   },
   "require" : {
-    "php": ">=8.1.0",
+    "php": ">=8.2.0",
     "guzzlehttp/guzzle": "^7.5",
     "ext-ctype": "*",
     "ext-json": "*"

docker/php/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1.0-fpm
+FROM php:8.2.0-fpm
 
 ARG USERNAME=site
 ARG USER_UID

rector.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector;
 use Rector\Config\RectorConfig;
 use Rector\Set\ValueObject\LevelSetList;
 use Rector\Set\ValueObject\SetList;
@@ -14,9 +15,16 @@
     ]);
 
     // register a single rule
-     $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+    $rectorConfig->rule(InlineArrayReturnAssignRector::class);
 
-    $rectorConfig->sets([LevelSetList::UP_TO_PHP_81]);
-    $rectorConfig->sets([SetList::CODE_QUALITY]);
-//    $rectorConfig->sets([SetList::CODING_STYLE]);
+
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_82,
+        SetList::CODE_QUALITY,
+        SetList::CODING_STYLE,
+        SetList::TYPE_DECLARATION,
+//        SetList::DEAD_CODE,
+        SetList::EARLY_RETURN,
+    ]);
 };

src/AbstractWebService.php

@@ -22,7 +22,14 @@
  */
 abstract class AbstractWebService
 {
+    /**
+     * @var int
+     */
     final public const LIMIT_MAX = 20;
+
+    /**
+     * @var int
+     */
     final public const TIMEOUT = 30;
 
     protected int $timeout = self::TIMEOUT;
@@ -32,9 +39,6 @@
         'Content-Type' => GuzzleSingleton::APPLICATION_JSON
     ];
 
-    /**
-     * @var Client
-     */
     private Client $client;
 
     /**
@@ -130,7 +134,8 @@
             $options['body'] = $body;
         }
 
-        $guzzleResponse = $msgErr = null;
+        $guzzleResponse = null;
+        $msgErr = null;
         try {
             $guzzleResponse = $this->client->request($method, $endPoint, $options);
         } catch (GuzzleException $guzzleException) {
@@ -144,7 +149,6 @@
         throw new WsException($msgErr, 500, null);
     }
 
-
     /**
      * Check response and jsondecode object
      * @throws WsException|JsonException
@@ -174,17 +178,20 @@
             throw new WsResponseException(WsException::RESP_EMPTY, 500, null);
         }
 
-        if (
-            property_exists($jsonContent, "objects")
-            && property_exists($jsonContent, "meta")
-            && 0 === $jsonContent->meta->total_count
-        ) {
-            throw new WsResponseException(WsException::RESP_EMPTY, 500, null);
+        if (!property_exists($jsonContent, "objects")) {
+            return $contents;
         }
 
-        return $contents;
-    }
+        if (!property_exists($jsonContent, "meta")) {
+            return $contents;
+        }
 
+        if (0 !== $jsonContent->meta->total_count) {
+            return $contents;
+        }
+
+        throw new WsResponseException(WsException::RESP_EMPTY, 500, null);
+    }
 
     /**
      * @throws JsonException

src/Exceptions/WsException.php

@@ -11,22 +11,49 @@
  */
 class WsException extends \Exception implements \Stringable
 {
+    /**
+     * @var string
+     */
     public const KEYS_ERROR = 'API key or API secret are null';
 
+    /**
+     * @var string
+     */
     public const GUZZLE_RESPONSE = 'Error response Guzzle: %s';
 
+    /**
+     * @var string
+     */
     public const ERR_READABLE = 'Response not readable';
 
+    /**
+     * @var string
+     */
     public const ERR_EMPTY = 'Empty response from endPoint "%s"';
 
+    /**
+     * @var string
+     */
     public const ERR_JSON = 'Not a JSON valid format :\n %s';
 
-    public const RESP_EMPTY = 'Astrobin doesn\'t find any objects, check your params';
+    /**
+     * @var string
+     */
+    public const RESP_EMPTY = "Astrobin doesn't find any objects, check your params";
 
+    /**
+     * @var string
+     */
     public const EMPTY_ID = '%s is not a correct value, alphanumeric expected';
 
+    /**
+     * @var string
+     */
     public const ERR_DATE_FORMAT = 'Format "%s" is not a correct format for a date, please use YYYY-mm-dd instead';
 
+    /**
+     * @var string
+     */
     public const ERR_DATE = 'Error date format : \n';
 
     /**
@@ -37,11 +64,8 @@ public function __construct(string $message, int $code, ?\Exception $previous)
         parent::__construct(...func_get_args());
     }
 
-    /**
-     * @return string
-     */
     public function __toString(): string
     {
-        return self::class . "[{$this->getCode()}]: {$this->getMessage()}\n";
+        return self::class . sprintf('[%d]: %s%s', $this->getCode(), $this->getMessage(), PHP_EOL);
     }
 }

src/Filters/CollectionFilters.php

@@ -12,5 +12,5 @@ enum CollectionFilters: string
 {
     use EnumToArray;
 
-    case USER_FILTER = 'user';
+    case USER_FILTER = 'username';
 }

src/GuzzleSingleton.php

@@ -13,13 +13,34 @@
  */
 class GuzzleSingleton
 {
+    /**
+     * @var string
+     */
     final public const ASTROBIN_URL = 'https://www.astrobin.com';
+
+    /**
+     * @var string
+     */
     final public const TIMEOUT = '0';
 
+    /**
+     * @var string
+     */
     final public const APPLICATION_JSON = 'application/json';
 
+    /**
+     * @var string
+     */
     final public const METHOD_GET = 'GET';
+
+    /**
+     * @var string
+     */
     final public const METHOD_POST = 'POST';
+
+    /**
+     * @var string
+     */
     final public const METHOD_PUT = 'PUT';
 
     private static ?Client $_instance = null;

src/Response/DTO/AstrobinError.php

@@ -8,12 +8,9 @@
  * Class AstrobinError
  * @package AstrobinWs\Response
  */
-final class AstrobinError implements AstrobinResponse
+final readonly class AstrobinError implements AstrobinResponse
 {
-    /**
-     * AstrobinError constructor.
-     */
-    public function __construct(private readonly ?string $message)
+    public function __construct(private ?string $message)
     {
     }
 

src/Response/DTO/Collection/ListCollection.php

@@ -17,7 +17,7 @@ final class ListCollection extends AbstractResponse implements \IteratorAggregat
     public array $listCollection;
 
     /**
-     * @return CollectionIterator|\Traversable
+     * @return CollectionIterator
      */
     public function getIterator(): CollectionIterator
     {

src/Response/DTO/Collection/ListImages.php

@@ -15,6 +15,7 @@
 final class ListImages implements \IteratorAggregate, AstrobinResponse
 {
     public array $listImages = [];
+
     public int $count = 0;
 
     public function getIterator(): ImageIterator

src/Response/DTO/Collection/ListToday.php

@@ -15,6 +15,7 @@
 class ListToday extends AbstractResponse implements \IteratorAggregate, AstrobinResponse
 {
     public array $listToday;
+
     public int $count = 0;
 
     /**

src/Response/DTO/Item/Collection.php

@@ -16,23 +16,29 @@
 final class Collection extends AbstractResponse implements AstrobinResponse
 {
     public int $id;
+
     public string $name;
+
     public ?string $description = null;
 
+
     public string $user;
-    public string|\DateTime $date_created;
-    public string|\DateTime $date_updated;
+
+    public string|null|\DateTime $date_created = null;
+
+    public string|null|\DateTime $date_updated = null;
+
     public ListImages|array|null $images = null;
 
-    public function setDateCreated(string $dateCreated): self
+    public function setDateCreated(?string $dateCreated): self
     {
-        $this->date_created = \DateTime::createFromFormat(QueryFilters::DATE_FORMAT->value, $dateCreated);
+        $this->date_created = ((is_null($dateCreated)) ? null : \DateTime::createFromFormat(QueryFilters::DATE_FORMAT->value, $dateCreated)) ?: null;
         return $this;
     }
 
-    public function setDateUpdated(string $dateUpdated): self
+    public function setDateUpdated(?string $dateUpdated): self
     {
-        $this->date_updated = \DateTime::createFromFormat(QueryFilters::DATE_FORMAT->value, $dateUpdated);
+        $this->date_updated = ((is_null($dateUpdated)) ? null : \DateTime::createFromFormat(QueryFilters::DATE_FORMAT->value, $dateUpdated)) ?: null;
         return $this;
     }
 }