Merge pull request #135 from Sysix/interfaces

added ApiInterface, make request protected and use getRequest() instead

Author: Sysix

.php-cs-fixer.dist.php

@@ -14,6 +14,7 @@
         'multiline_comment_opening_closing' => true,
         'multiline_whitespace_before_semicolons' => true,
         'native_type_declaration_casing' => true,
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
         'no_alias_functions' => true,
         'no_alias_language_construct_call' => true,
         'no_alternative_syntax' => true,

src/Api.php

@@ -4,7 +4,13 @@
 
 namespace Sysix\LexOffice;
 
+use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Uri;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\UriInterface;
+use SensitiveParameter;
 use Sysix\LexOffice\Clients\Contact;
 use Sysix\LexOffice\Clients\Country;
 use Sysix\LexOffice\Clients\CreditNote;
@@ -21,30 +27,22 @@
 use Sysix\LexOffice\Clients\RecurringTemplate;
 use Sysix\LexOffice\Clients\Voucher;
 use Sysix\LexOffice\Clients\VoucherList;
-use GuzzleHttp\Psr7\Request;
-use Psr\Http\Client\ClientInterface;
-use Psr\Http\Message\RequestInterface;
-use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\UriInterface;
-use SensitiveParameter;
+use Sysix\LexOffice\Interfaces\ApiInterface;
 
-class Api
+class Api implements ApiInterface
 {
     public string $apiUrl = 'https://api.lexoffice.io';
 
     protected string $apiVersion = 'v1';
 
-    public RequestInterface $request;
+    protected RequestInterface $request;
 
     public function __construct(
         #[SensitiveParameter] protected string $apiKey,
         protected ClientInterface $client
     ) {
     }
 
-    /**
-     * @param string[] $headers
-     */
     public function newRequest(string $method, string $resource, array $headers = []): self
     {
         $this->setRequest(
@@ -71,16 +69,21 @@ public function setRequest(RequestInterface $request): self
         return $this;
     }
 
-    protected function createApiUri(string $resource): UriInterface
+    public function getRequest(): RequestInterface
     {
-        return new Uri($this->apiUrl . '/' . $this->apiVersion . '/' . $resource);
+        return $this->request;
     }
 
     public function getResponse(): ResponseInterface
     {
         return $this->client->sendRequest($this->request);
     }
 
+    protected function createApiUri(string $resource): UriInterface
+    {
+        return new Uri($this->apiUrl . '/' . $this->apiVersion . '/' . $resource);
+    }
+
     public function contact(): Contact
     {
         return new Contact($this);

src/BaseClient.php

@@ -5,13 +5,15 @@
 namespace Sysix\LexOffice;
 
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\Interfaces\ApiInterface;
+use Sysix\LexOffice\Interfaces\ClientInterface;
 
 abstract class BaseClient implements ClientInterface
 {
     protected string $resource;
 
     public function __construct(
-        protected Api $api
+        protected ApiInterface $api
     ) {
     }
 

src/ClientInterface.php

@@ -4,8 +4,8 @@
 
 namespace Sysix\LexOffice\Clients;
 
-use Sysix\LexOffice\BaseClient;
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\BaseClient;
 
 class Country extends BaseClient
 {

src/Clients/Country.php

@@ -4,10 +4,10 @@
 
 namespace Sysix\LexOffice\Clients;
 
+use Psr\Http\Message\ResponseInterface;
 use Sysix\LexOffice\BaseClient;
 use Sysix\LexOffice\Clients\Traits\CreateTrait;
 use Sysix\LexOffice\Clients\Traits\DeleteTrait;
-use Psr\Http\Message\ResponseInterface;
 
 class Event extends BaseClient
 {

src/Clients/Event.php

@@ -4,10 +4,10 @@
 
 namespace Sysix\LexOffice\Clients;
 
-use Sysix\LexOffice\BaseClient;
-use Sysix\LexOffice\Exceptions\LexOfficeApiException;
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\BaseClient;
 use Sysix\LexOffice\Config\FileClientConfig;
+use Sysix\LexOffice\Exceptions\LexOfficeApiException;
 use Sysix\LexOffice\Utils;
 
 class File extends BaseClient
@@ -18,7 +18,7 @@ public function get(string $id, string $acceptHeader = '*/*'): ResponseInterface
     {
         $this->api->newRequest('GET', $this->resource . '/' . rawurlencode($id));
 
-        $this->api->request = $this->api->request->withHeader('Accept', $acceptHeader);
+        $this->api->setRequest($this->api->getRequest()->withHeader('Accept', $acceptHeader));
 
         return $this->api->getResponse();
     }
@@ -44,7 +44,7 @@ public function upload(string $filepath, string $type): ResponseInterface
             'Content-Type' => 'multipart/form-data; boundary=' . $body->getBoundary()
         ]);
 
-        $api->request = $api->request->withBody($body);
+        $api->setRequest($api->getRequest()->withBody($body));
 
         return $api->getResponse();
     }

src/Clients/File.php

@@ -4,8 +4,8 @@
 
 namespace Sysix\LexOffice\Clients;
 
-use Sysix\LexOffice\BaseClient;
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\BaseClient;
 
 class PaymentCondition extends BaseClient
 {

src/Clients/PaymentCondition.php

@@ -4,8 +4,8 @@
 
 namespace Sysix\LexOffice\Clients;
 
-use Sysix\LexOffice\BaseClient;
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\BaseClient;
 
 class PostingCategory extends BaseClient
 {

src/Clients/PostingCategory.php

@@ -4,8 +4,8 @@
 
 namespace Sysix\LexOffice\Clients;
 
-use Sysix\LexOffice\BaseClient;
 use Psr\Http\Message\ResponseInterface;
+use Sysix\LexOffice\BaseClient;
 
 class Profile extends BaseClient
 {