Merge pull request #33 from yoanbernabeu/features/edit-record

Features/edit record

Author: Snowbaha

README.md

@@ -1,4 +1,4 @@
-Airtable Client Bundle (Work In Progress)
+Airtable Client Bundle
 ==================
 
 [![Static code analysis](https://github.com/yoanbernabeu/Airtable-Client-Bundle/actions/workflows/code_analysis.yml/badge.svg)](https://github.com/yoanbernabeu/Airtable-Client-Bundle/actions/workflows/code_analysis.yml)
@@ -116,6 +116,36 @@ class FooController
     // ...
 }
 ```
+### Edit
+
+```php
+
+use Yoanbernabeu\AirtableClientBundle\AirtableClientInterface;
+
+class Foo
+{
+    public int $id;
+    public string $bar;
+}
+
+class FooController
+{
+    public function bar(AirtableClientInterface $airtableClient)
+    {
+        $airtableClient->update(
+            'tableName',
+            'recordId',
+            [
+                'id' => 1,
+                'bar' => 'lorem ipsum',
+                Foo::class
+            ]
+        );
+    }
+
+    // ...
+}
+```
 
 ### Create Form
 

composer.json

@@ -32,11 +32,11 @@
   "require-dev": {
     "ext-json": "*",
     "friendsofphp/php-cs-fixer": "^3.0",
-    "phpstan/phpstan": "^0.12",
-    "phpstan/phpstan-beberlei-assert": "^0.12",
-    "phpstan/phpstan-deprecation-rules": "^0.12",
-    "phpstan/phpstan-phpunit": "^0.12",
-    "phpstan/phpstan-strict-rules": "^0.12",
+    "phpstan/phpstan": "^1.0",
+    "phpstan/phpstan-beberlei-assert": "^1.0",
+    "phpstan/phpstan-deprecation-rules": "^1.0",
+    "phpstan/phpstan-phpunit": "^1.0",
+    "phpstan/phpstan-strict-rules": "^1.0",
     "symfony/framework-bundle": "^5.0|^6.0",
     "symfony/phpunit-bridge": "^5.0|^6.0"
   },

src/AirtableClient.php

@@ -120,28 +120,19 @@ public function findLast(string $table, $field, ?string $dataClass = null): ?Air
      */
     public function add(string $table, array $fields, ?string $dataClass = null): ?AirtableRecord
     {
-        $url = sprintf(
-            '%s',
-            $table
-        );
-
-        $response = $this->airtableTransport->request(
-            'POST',
-            $url,
-            ['json' => [
-                'fields' => $fields, ],
-            ]
-        );
+        $url = sprintf('%s', $table);
 
-        $recordData = $response->toArray();
-
-        if ([] === $recordData) {
-            return null;
-        }
+        return $this->createOrUpdateRecord('POST', $url, $fields, $dataClass);
+    }
 
-        $recordData = $this->createRecordFromResponse($dataClass, $recordData);
+    /**
+     * {@inheritdoc}
+     */
+    public function update(string $table, string $recordId, array $fields, ?string $dataClass = null): ?AirtableRecord
+    {
+        $url = sprintf('%s/%s', $table, $recordId);
 
-        return AirtableRecord::createFromRecord($recordData);
+        return $this->createOrUpdateRecord('PATCH', $url, $fields, $dataClass);
     }
 
     /**
@@ -221,4 +212,33 @@ private function createRecordFromResponse(?string $dataClass, array $recordData)
 
         return $recordData;
     }
+
+    /**
+     * @throws Exception\MissingRecordDataException
+     * @throws \Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface
+     * @throws \Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface
+     * @throws \Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface
+     * @throws \Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface
+     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
+     */
+    private function createOrUpdateRecord(string $method, string $url, array $fields, ?string $dataClass): ?AirtableRecord
+    {
+        $response = $this->airtableTransport->request(
+            $method,
+            $url,
+            [
+                'json' => ['fields' => $fields],
+            ]
+        );
+
+        $recordData = $response->toArray();
+
+        if ([] === $recordData) {
+            return null;
+        }
+
+        $recordData = $this->createRecordFromResponse($dataClass, $recordData);
+
+        return AirtableRecord::createFromRecord($recordData);
+    }
 }

src/AirtableClientInterface.php

@@ -67,6 +67,16 @@ public function findLast(string $table, $field, ?string $dataClass = null): ?Air
      */
     public function add(string $table, array $fields, ?string $dataClass = null): ?AirtableRecord;
 
+    /**
+     * Update a record and return the record.
+     *
+     * @param string      $table     Table name
+     * @param string      $recordId  Record Id of the element
+     * @param array       $fields    Table fields
+     * @param string|null $dataClass The name of the class which will hold fields data
+     */
+    public function update(string $table, string $recordId, array $fields, ?string $dataClass = null): ?AirtableRecord;
+
     /**
      * Create form from an array of fields.
      *

src/Resources/config/services.php

@@ -3,8 +3,10 @@
 declare(strict_types=1);
 
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
 use function Symfony\Component\DependencyInjection\Loader\Configurator\param;
 use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
+
 use Yoanbernabeu\AirtableClientBundle\AirtableClient;
 use Yoanbernabeu\AirtableClientBundle\AirtableClientInterface;
 use Yoanbernabeu\AirtableClientBundle\AirtableTransport;

tests/Unit/AirtableRecordTest.php

@@ -15,6 +15,7 @@ class AirtableRecordTest extends TestCase
 {
     /**
      * @test
+     *
      * @dataProvider invalidRecordArrayProvider
      */
     public function createFromRecordWillThrowIfADataIsMissingInArray(array $recordData, string $message)