Feature Upgrades (#25)

Implemented Laravel Saloon

Author: RhysLees

README.md

@@ -294,6 +294,44 @@ $content = Zammad::attachment()->download(
 );
 ```
 
+## Expanding response payloads
+
+You can use the `expand()` method to expand the response with additional data.
+
+See documentation on this in the [Zammad API Docs](https://docs.zammad.org/en/latest/api/intro.html?highlight=expand#response-payloads-expand).
+
+```php
+$ticket = Zammad::ticket()->expand()->show(20);
+$user = Zammad::user()->expand()->show(20);
+$me = Zammad::user()->expand()->me();
+```
+
+## Limit search response payloads
+
+You can use the `limit(int $limit = 1)` method to expand the response with additional data.
+
+See documentation on this in the [Zammad API Docs](https://docs.zammad.org/en/latest/api/user.html#search).
+
+```php
+$ticket = Zammad::ticket()->limit(1)->search();
+$user = Zammad::user()->limit(1)->search();
+```
+
+## Paginate list response payloads
+
+You can use the `perPage(int $perPage)` and `page(int $page)` methods to set the page and per page values for the response
+Alternatively you can use the `paginate(int $page, int $perPage):` method to set both at once.
+
+See documentation on this in the [Zammad API Docs](https://docs.zammad.org/en/latest/api/intro.html#pagination).
+
+```php
+$ticket = Zammad::ticket()->perPage(1)->page(1)->list();
+$user = Zammad::user()->perPage(1)->page(1)->list();
+
+$ticket = Zammad::ticket()->paginate(1, 1)->list();
+$user = Zammad::user()->paginate(1, 1)->list();
+```
+
 ## 🏋️ DTO showcase
 
 ```php
@@ -369,6 +407,7 @@ CodebarAg\Zammad\DTO\ObjectAttribute {
 }
 ```
 
+
 ## 🔧 Configuration file
 
 You can publish the config file with:
@@ -469,6 +508,25 @@ return [
     'ticket' => [
         // 'note' => 'string',
     ],
+    
+    /*
+    |--------------------------------------------------------------------------
+    | Ticket States
+    |--------------------------------------------------------------------------
+    | 
+    | The ticket states are used to determine if a ticket is open, closed,
+    | active or inactive. You can use this information to filter tickets
+    | by their state. The following states are supported by default.
+    | https://docs.zammad.org/en/latest/api/ticket/states.html
+    |
+    */
+
+    'ticket_states' => [
+        'open' => [1, 2, 3, 7],
+        'closed' => [4],
+        'active' => [1, 2, 3, 4, 7],
+        'inactive' => [5, 6],
+    ],
 
 ];
 ```

composer.json

@@ -21,7 +21,9 @@
         "php": "^8.2",
         "guzzlehttp/guzzle": "^7.5",
         "illuminate/contracts": "^10.0",
-        "spatie/laravel-package-tools": "^1.9.2"
+        "spatie/laravel-package-tools": "^1.9.2",
+        "sammyjo20/saloon": "^2.0",
+        "sammyjo20/saloon-laravel": "^2.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",

config/zammad.php

@@ -88,4 +88,23 @@
         // 'note' => 'string',
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Ticket States
+    |--------------------------------------------------------------------------
+    |
+    | The ticket states are used to determine if a ticket is open, closed,
+    | active or inactive. You can use this information to filter tickets
+    | by their state. The following states are supported by default.
+    | https://docs.zammad.org/en/latest/api/ticket/states.html
+    |
+    */
+
+    'ticket_states' => [
+        'open' => [1, 2, 3, 7],
+        'closed' => [4],
+        'active' => [1, 2, 3, 4, 7],
+        'inactive' => [5, 6],
+    ],
+
 ];

src/Classes/RequestClass.php

@@ -3,9 +3,12 @@
 namespace CodebarAg\Zammad\Classes;
 
 use CodebarAg\Zammad\Events\ZammadResponseLog;
-use Illuminate\Http\Client\Response;
-use Illuminate\Support\Facades\Http;
+use CodebarAg\Zammad\ZammadConnector;
 use Illuminate\Support\Str;
+use Saloon\Exceptions\Request\RequestException;
+use Saloon\Http\Request;
+use Saloon\Http\Response;
+use Throwable;
 
 abstract class RequestClass
 {
@@ -17,65 +20,46 @@ abstract class RequestClass
 
     protected $objectHasReferenceError;
 
+    protected $connector;
+
     public function __construct()
     {
         $this->httpRetryMaxium = config('zammad.http_retry_maximum');
         $this->httpRetryDelay = config('zammad.http_retry_delay');
 
         $this->ignoreReferenceErrorIngore = config('zammad.object_reference_error_ignore');
         $this->objectHasReferenceError = config('zammad.objet_reference_error');
-    }
 
-    /**
-     * @throws \Illuminate\Http\Client\RequestException
-     */
-    public function getRequest($url): Response
-    {
-        $response = Http::withToken(config('zammad.token'))
-            ->retry($this->httpRetryMaxium, $this->httpRetryDelay)
-            ->get($url);
-
-        event(new ZammadResponseLog($response));
-
-        return $response->throw();
+        $this->connector = new ZammadConnector();
     }
 
-    /**
-     * @throws \Illuminate\Http\Client\RequestException
-     */
-    public function postRequest($url, $data = null): Response
+    private function performRequest(Request $request): Response
     {
-        $response = Http::withToken(config('zammad.token'))
-            ->retry($this->httpRetryMaxium, $this->httpRetryDelay)
-            ->post($url, $data);
-
-        event(new ZammadResponseLog($response));
-
-        return $response->throw();
+        return $this->connector->sendAndRetry(
+            $request,
+            $this->httpRetryMaxium,
+            $this->httpRetryDelay,
+        );
     }
 
     /**
-     * @throws \Illuminate\Http\Client\RequestException
+     * @throws RequestException|Throwable
      */
-    public function putRequest($url, $data): Response
+    public function request(Request $request): Response
     {
-        $response = Http::withToken(config('zammad.token'))
-            ->retry($this->httpRetryMaxium, $this->httpRetryDelay)
-            ->put($url, $data);
+        $response = $this->performRequest($request);
 
         event(new ZammadResponseLog($response));
 
-        return $response->throw();
+        return $response;
     }
 
     /**
-     * @throws \Illuminate\Http\Client\RequestException
+     * @throws RequestException|Throwable
      */
-    public function deleteRequest($url): Response
+    public function deleteRequest(Request $request): Response
     {
-        $response = Http::withToken(config('zammad.token'))
-            //->retry($this->httpRetryMaxium, $this->httpRetryDelay)
-            ->delete($url);
+        $response = $this->performRequest($request);
 
         $ignoreReferenceError = [
             'ignore' => $this->ignoreReferenceErrorIngore ? true : false,

src/DTO/Attachment.php

@@ -43,12 +43,12 @@ public function url(): string
     }
 
     public static function fake(
-        ?int $id = null,
-        ?int $ticketId = null,
-        ?int $commentId = null,
-        ?int $size = null,
-        ?string $name = null,
-        ?string $type = null,
+        int $id = null,
+        int $ticketId = null,
+        int $commentId = null,
+        int $size = null,
+        string $name = null,
+        string $type = null,
     ): self {
         return new self(
             id: $id ?? random_int(1, 9999),

src/DTO/Comment.php

@@ -93,22 +93,22 @@ public function __construct(
     }
 
     public static function fake(
-        ?int $id = null,
-        ?int $type_id = null,
-        ?int $ticket_id = null,
-        ?int $sender_id = null,
-        ?string $sender = null,
-        ?string $subject = null,
-        ?string $body = null,
-        ?string $content_type = null,
-        ?string $from = null,
-        ?string $to = null,
-        ?bool $internal = null,
-        ?int $created_by_id = null,
-        ?int $updated_by_id = null,
-        ?int $origin_by_id = null,
-        ?Carbon $updated_at = null,
-        ?Carbon $created_at = null,
+        int $id = null,
+        int $type_id = null,
+        int $ticket_id = null,
+        int $sender_id = null,
+        string $sender = null,
+        string $subject = null,
+        string $body = null,
+        string $content_type = null,
+        string $from = null,
+        string $to = null,
+        bool $internal = null,
+        int $created_by_id = null,
+        int $updated_by_id = null,
+        int $origin_by_id = null,
+        Carbon $updated_at = null,
+        Carbon $created_at = null,
     ): self {
         return new self(
             id: $id ?? random_int(1, 1000),
@@ -131,4 +131,14 @@ public static function fake(
             created_at: $created_at ?? now()->subDay(),
         );
     }
+
+    public function fromName(): string
+    {
+        return Str::before(Str::between($this->from, '"', '"'), '<');
+    }
+
+    public function fromEmail(): string
+    {
+        return Str::between($this->from, '<', '>');
+    }
 }

src/DTO/ObjectAttribute.php

@@ -35,14 +35,14 @@ public function __construct(
     }
 
     public static function fake(
-        ?int $id = null,
-        ?int $name = null,
-        ?int $object_lookup_id = null,
-        ?string $display = null,
-        ?string $data_type = null,
-        ?int $position = null,
-        ?array $data_option = null,
-        ?array $data_option_new = null,
+        int $id = null,
+        int $name = null,
+        int $object_lookup_id = null,
+        string $display = null,
+        string $data_type = null,
+        int $position = null,
+        array $data_option = null,
+        array $data_option_new = null,
     ): self {
         return new self(
             id: $id ?? random_int(1, 1000),
@@ -61,7 +61,7 @@ public static function fakeCreateToArray(
         ?string $object = 'Ticket',
         ?string $display = 'Sample Object',
         ?bool $active = true,
-        ?int $position = null,
+        int $position = null,
         ?string $data_type = 'select',
         ?array $data_options = [
             'options' => [