Idempotency key (#41)

* ✨ Handle idempotency key for draft and booked invoice * ✅ Update tests * Fix styling --------- Co-authored-by: SimonJnsson <[email protected]>
Morning-Train · Nov 25, 2024 · a0b63e4 · a0b63e4
1 parent e54f8bb
commit a0b63e4
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 31 deletions.
diff --git a/src/Interfaces/EconomicDriver.php b/src/Interfaces/EconomicDriver.php
@@ -8,9 +8,9 @@ interface EconomicDriver
 {
     public function get(string $url, array $queryArgs = []): EconomicResponse;
 
-    public function post(string $url, array $body = []): EconomicResponse;
+    public function post(string $url, array $body = [], ?string $idempotencyKey = null): EconomicResponse;
 
-    public function put(string $url, array $body = []): EconomicResponse;
+    public function put(string $url, array $body = [], ?string $idempotencyKey = null): EconomicResponse;
 
     public function delete(string $url): EconomicResponse;
 

diff --git a/src/Resources/Invoice/BookedInvoice.php b/src/Resources/Invoice/BookedInvoice.php
@@ -13,12 +13,12 @@ class BookedInvoice extends Invoice
 {
     public ?int $bookedInvoiceNumber = null;
 
-    public static function createFromDraft(int|DraftInvoice $draft)
+    public static function createFromDraft(int|DraftInvoice $draft, ?string $idempotencyKey = null)
     {
         return static::createRequest([
             'draftInvoice' => [
                 'draftInvoiceNumber' => is_int($draft) ? $draft : $draft->draftInvoiceNumber,
             ],
-        ]);
+        ], [], $idempotencyKey);
     }
 }
diff --git a/src/Resources/Invoice/DraftInvoice.php b/src/Resources/Invoice/DraftInvoice.php
@@ -47,7 +47,8 @@ public static function create(
         ?float $exchangeRate = null,
         ?Note $notes = null,
         Project|int|null $project = null,
-        ?Reference $references = null
+        ?Reference $references = null,
+        ?string $idempotencyKey = null,
     ): ?static {
         return static::createRequest(compact(
             'currency',
@@ -62,7 +63,7 @@ public static function create(
             'notes',
             'project',
             'references',
-        ));
+        ), [], $idempotencyKey);
     }
 
     public static function new(
@@ -96,7 +97,7 @@ public static function new(
         )));
     }
 
-    public function save(): ?static
+    public function save(?string $idempotencyKey = null): ?static
     {
         if (empty($this->draftInvoiceNumber)) {
             $new = static::create(
@@ -111,7 +112,8 @@ public function save(): ?static
                 exchangeRate: $this->exchangeRate,
                 notes: $this->notes,
                 project: $this->project,
-                references: $this->references
+                references: $this->references,
+                idempotencyKey: $idempotencyKey
             );
 
             $this->populate($new->toArray());
@@ -122,8 +124,8 @@ public function save(): ?static
         return $this->saveRequest();
     }
 
-    public function book(): ?BookedInvoice
+    public function book(?string $idempotencyKey = null): ?BookedInvoice
     {
-        return BookedInvoice::createFromDraft($this);
+        return BookedInvoice::createFromDraft($this, $idempotencyKey);
     }
 }
diff --git a/src/Services/EconomicApiService.php b/src/Services/EconomicApiService.php
@@ -42,14 +42,14 @@ public static function get(string $endpoint, array $queryArgs = []): EconomicRes
         return static::getDriver()->get(static::createURL($endpoint), $queryArgs);
     }
 
-    public static function post(string $endpoint, array $body = []): EconomicResponse
+    public static function post(string $endpoint, array $body = [], ?string $idempotencyKey = null): EconomicResponse
     {
-        return static::getDriver()->post(static::createURL($endpoint), static::castParameters($body));
+        return static::getDriver()->post(static::createURL($endpoint), static::castParameters($body), $idempotencyKey);
     }
 
-    public static function put(string $endpoint, array $body = []): EconomicResponse
+    public static function put(string $endpoint, array $body = [], ?string $idempotencyKey = null): EconomicResponse
     {
-        return static::getDriver()->put(static::createURL($endpoint), static::castParameters($body));
+        return static::getDriver()->put(static::createURL($endpoint), static::castParameters($body), $idempotencyKey);
     }
 
     public static function delete(string $endpoint): EconomicResponse

diff --git a/src/Traits/Resources/Creatable.php b/src/Traits/Resources/Creatable.php
@@ -12,13 +12,17 @@ trait Creatable
     /**
      * @param  static|array  $args
      */
-    public static function createRequest($args, array $endpointReferences = []): ?static
+    public static function createRequest($args, array $endpointReferences = [], ?string $idempotencyKey = null): ?static
     {
         // TODO: add validation method to check if required properties are set and primary key is not set - throw exception if not
 
         $args = static::resolveArgs($args, true); // We need to convert objects to an array to avoid issues with the API
 
-        $response = EconomicApiService::post(static::getEndpoint(Create::class, ...$endpointReferences), $args);
+        $response = EconomicApiService::post(
+            static::getEndpoint(Create::class, ...$endpointReferences),
+            $args,
+            $idempotencyKey
+        );
 
         if ($response->getStatusCode() !== 201) {
             EconomicLoggerService::error('Economic API Service returned a non 201 status code when creating a resource',

diff --git a/src/Traits/Resources/Updatable.php b/src/Traits/Resources/Updatable.php
@@ -11,18 +11,22 @@ trait Updatable
 {
     use EndpointResolvable;
 
-    public function save(): static
+    public function save(?string $idempotencyKey = null): static
     {
         // TODO: add validation method to check if required properties are set and primary key is set - throw exception if not
-
-        $response = EconomicApiService::put(static::getEndpoint(Update::class, $this), $this->toArray(true));
+        $response = EconomicApiService::put(
+            static::getEndpoint(Update::class, $this),
+            $this->toArray(true),
+            $idempotencyKey
+        );
 
         if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201) { // 201 is for created, 200 is for updated -> both are valid here
             EconomicLoggerService::error('Economic API Service returned a non 200 or 201 status code when updating a resource', [
                 'status_code' => $response->getStatusCode(),
                 'response_body' => $response->getBody(),
                 'resource' => static::class,
                 'args' => $this->toArray(true),
+                'idempotency_key' => $idempotencyKey,
             ]);
 
             throw new Exception('Economic API Service returned a non 200 status code when updating a resource');

diff --git a/tests/DummyEconomicDriver.php b/tests/DummyEconomicDriver.php
@@ -23,13 +23,13 @@ public function get(string $url, array $queryArgs = []): EconomicResponse
         ray('GET', func_get_args());
     }
 
-    public function post(string $url, array $body = []): EconomicResponse
+    public function post(string $url, array $body = [], ?string $idempotencyKey = null): EconomicResponse
     {
         // TODO: Implement post() method.
         ray('POST', func_get_args());
     }
 
-    public function put(string $url, array $body = []): EconomicResponse
+    public function put(string $url, array $body = [], ?string $idempotencyKey = null): EconomicResponse
     {
         // TODO: Implement put() method.
         ray('PUT', func_get_args());

diff --git a/tests/Unit/CustomerContactTest.php b/tests/Unit/CustomerContactTest.php
@@ -38,7 +38,8 @@
 it('creates a customer contact', function () {
     $this->driver->expects()->post(
         'https://restapi.e-conomic.com/customers/1/contacts',
-        fixture('Customers/Contacts/create-request')
+        fixture('Customers/Contacts/create-request'),
+        null
     )->andReturn(new EconomicResponse(201, fixture('Customers/Contacts/create-response')));
 
     $contact = Contact::create(
@@ -60,7 +61,8 @@
 it('updates a customer contact', function () {
     $this->driver->expects()->put(
         'https://restapi.e-conomic.com/customers/1/contacts/140',
-        fixture('Customers/Contacts/update-request')
+        fixture('Customers/Contacts/update-request'),
+        null
     )->andReturn(new EconomicResponse(200, fixture('Customers/Contacts/update-response')));
 
     $contact = new Contact([

diff --git a/tests/Unit/CustomerTest.php b/tests/Unit/CustomerTest.php
@@ -50,7 +50,8 @@
 it('creates customer', function () {
     $this->driver->expects()->post(
         'https://restapi.e-conomic.com/customers',
-        fixture('Customers/create-request')
+        fixture('Customers/create-request'),
+        null
     )
         ->once()
         ->andReturn(new EconomicResponse(201, fixture('Customers/create-response')));
@@ -131,7 +132,8 @@
 it('filters null values', function () {
     $this->driver->expects()->post(
         'https://restapi.e-conomic.com/customers',
-        fixture('Customers/create-request')
+        fixture('Customers/create-request'),
+        null
     )
         ->once()
         ->andReturn(new EconomicResponse(201, fixture('Customers/create-response')));
@@ -149,7 +151,8 @@
 it('does not filter falsy values', function () {
     $this->driver->expects()->post(
         'https://restapi.e-conomic.com/customers',
-        fixture('Customers/create-request-with-falsy-values')
+        fixture('Customers/create-request-with-falsy-values'),
+        null
     )
         ->once()
         ->andReturn(new EconomicResponse(201, fixture('Customers/create-request')));

diff --git a/tests/Unit/InvoiceTest.php b/tests/Unit/InvoiceTest.php
@@ -71,7 +71,8 @@
 it('creates a draft invoice using create', function () {
     $this->driver->expects()->post()->with(
         'https://restapi.e-conomic.com/invoices/drafts',
-        fixture('Invoices/draft/create-request')
+        fixture('Invoices/draft/create-request'),
+        null
     )->andReturn(new EconomicResponse(201, fixture('Invoices/draft/create-response')));
 
     $invoice = DraftInvoice::create(
@@ -109,7 +110,8 @@
 it('creates a draft invoice using new and save', function () {
     $this->driver->expects()->post()->with(
         'https://restapi.e-conomic.com/invoices/drafts',
-        fixture('Invoices/draft/create-request')
+        fixture('Invoices/draft/create-request'),
+        null
     )->andReturn(new EconomicResponse(201, fixture('Invoices/draft/create-response')));
 
     $invoice = DraftInvoice::new(
@@ -150,7 +152,8 @@
 it('creates a draft invoice with full customer and currency object', function () {
     $this->driver->expects()->post()->with(
         'https://restapi.e-conomic.com/invoices/drafts',
-        fixture('Invoices/draft/create-request')
+        fixture('Invoices/draft/create-request'),
+        null
     )->andReturn(new EconomicResponse(201, fixture('Invoices/draft/create-response')));
 
     $invoice = DraftInvoice::new(
@@ -204,7 +207,8 @@
 it('books draft invoice', function () {
     $this->driver->expects()->post(
         'https://restapi.e-conomic.com/invoices/booked',
-        fixture('Invoices/draft/book-request')
+        fixture('Invoices/draft/book-request'),
+        null
     )
         ->once()
         ->andReturn(new EconomicResponse(
@@ -300,3 +304,71 @@
         ->textLine1->toBe('Text line 1')
         ->textLine2->toBe('Text line 2');
 });
+
+it('can set idempotency key when creating a draft', function () {
+    $this->driver->expects()->post()->with(
+        'https://restapi.e-conomic.com/invoices/drafts',
+        fixture('Invoices/draft/create-request'),
+        'test-idempotency-key'
+    )->andReturn(new EconomicResponse(201, fixture('Invoices/draft/create-response')));
+
+    $invoice = DraftInvoice::new(
+        new Currency([
+            'code' => 'DKK',
+            'isoNumber' => 'DKK',
+            'name' => 'Danish Krone',
+        ]),
+        Customer::new(
+            name: 'John Doe',
+            customerNumber: 1,
+            currency: 'DKK',
+            email: '[email protected]',
+            address: 'Test Street 1',
+            vatZone: 1,
+            customerGroup: 1,
+            paymentTerms: 1,
+        ),
+        new DateTime('2024-02-13T12:20:18+00:00'),
+        14,
+        1,
+        Recipient::new(
+            'John Doe',
+            new VatZone(1),
+        ),
+        notes: Note::new(
+            heading: 'Heading',
+            textLine1: 'Text line 1',
+            textLine2: 'Text line 2'
+        )
+    );
+
+    $invoice->addLine(
+        ProductLine::new(
+            description: 'T-shirt - Size L',
+            product: new Product([
+                'productNumber' => 1,
+            ]),
+            quantity: 1,
+            unitNetPrice: 500
+        )
+    );
+
+    $invoice->save('test-idempotency-key');
+});
+
+it('books draft invoice with idempotency key', function () {
+    $this->driver->expects()->post(
+        'https://restapi.e-conomic.com/invoices/booked',
+        fixture('Invoices/draft/book-request'),
+        'test-idempotency-key'
+    )
+        ->once()
+        ->andReturn(new EconomicResponse(
+            201,
+            fixture('Invoices/draft/book-response')
+        ));
+
+    $invoice = new DraftInvoice(424);
+
+    $bookedInvoice = $invoice->book('test-idempotency-key');
+});
diff --git a/tests/Unit/ProductTest.php b/tests/Unit/ProductTest.php
@@ -142,7 +142,7 @@
 
 it('creates a product', function () {
     $this->driver->expects()->post()
-        ->with('https://restapi.e-conomic.com/products', fixture('Products/create-request'))
+        ->with('https://restapi.e-conomic.com/products', fixture('Products/create-request'), null)
         ->andReturn(new EconomicResponse(201, fixture('Products/create-response')));
 
     $product = Product::create('Product 1', 1, 'p-1', barCode: '1234567890', costPrice: 100.0, recommendedPrice: 150.0, salesPrice: 199.95, description: 'test', unit: 1);