Add mass update feature (#35)

* Add mass update method to client

* Change `update` and `patch` methods to support mass update

* Use delay between subsequent requests

* Update readme

* Fix cs

* Fix issue when fetching records in all pages (#32)

* Support offset in query params

* Fix getAllPages() to send handle response with offset correctly

Co-authored-by: Yassine Bourakba <bourakbayassine@gmail.com>

* Add mass update method to client

* Change `update` and `patch` methods to support mass update

* Use delay between subsequent requests

* Update readme

* Fix cs

Co-authored-by: Yassine Bourakba <bourakbayassine@gmail.com>

Author: yassinebourakba

README.md

@@ -124,6 +124,23 @@ Airtable::table('companies')->update('rec5N7fr8GhDtdNxx', [ 'name' => 'Google',
 Airtable::table('companies')->patch('rec5N7fr8GhDtdNxx', ['country' => 'US']);
 ```
 
+#### Mass Update or Patch
+- Array of data to be updated or patched
+
+``` php
+Airtable::table('companies')->patch([
+    [
+        'id' => 'rec5N7fr8GhDtdNxx',
+        'fields' => ['country' => 'US']
+    ],
+    [
+        'id' => 'rec8BhDt4fs2',
+        'fields' => ['country' => 'UK']
+    ],
+    ...
+]);
+```
+
 ### Testing
 
 ``` bash

config/config.php

@@ -47,8 +47,26 @@
 
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Default Airtable Client Settings
+    |--------------------------------------------------------------------------
+    |
+    | This value can be found on the API docs page:
+    | https://airtable.com/[BASE_ID]/api/docs#curl/table:tasks
+    | The value will be hilighted at the beginning of each table section.
+    | Example:
+    | Each record in the `Tasks` contains the following fields
+    |
+     */
+
     'log_http' => env('AIRTABLE_LOG_HTTP', false),
     'log_http_format' => env('AIRTABLE_LOG_HTTP_FORMAT', '{request} >>> {res_body}'),
 
     'typecast' => env('AIRTABLE_TYPECAST', false),
+
+    // The API is limited to 5 requests per second per base.
+    // If you exceed this rate, you will receive a 429 status code and will need to wait 30 seconds before a successful request.
+    // This value is the delay in microseconds between subsequent requests.
+    'delay_between_requests' => env('AIRTABLE_DELAY_BETWEEN_REQUESTS', 200000),
 ];

src/Airtable.php

@@ -2,6 +2,8 @@
 
 namespace Tapp\Airtable;
 
+use InvalidArgumentException;
+
 class Airtable
 {
     private $api;
@@ -21,14 +23,46 @@ public function create($data)
         return $this->api->post($data);
     }
 
-    public function update(string $id, $data)
+    /**
+     * @param  dynamic $args (string) $id, $data | (array) $data
+     * @return mixed
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function update(...$args)
     {
-        return $this->api->put($id, $data);
+        if (is_string($args[0])) {
+            if (! isset($args[1])) {
+                throw new InvalidArgumentException('$data argument is required.');
+            }
+
+            return $this->api->put($args[0], $args[1]);
+        } elseif (is_array($args[0])) {
+            return $this->api->massUpdate('put', $args[0]);
+        }
+
+        throw new InvalidArgumentException('Update accepts either an array or an id and array of data.');
     }
 
-    public function patch(string $id, $data)
+    /**
+     * @param  dynamic $args (string) $id, $data | (array) $data
+     * @return mixed
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function patch(...$args)
     {
-        return $this->api->patch($id, $data);
+        if (is_string($args[0])) {
+            if (! isset($args[1])) {
+                throw new InvalidArgumentException('$data argument is required.');
+            }
+
+            return $this->api->patch($args[0], $args[1]);
+        } elseif (is_array($args[0])) {
+            return $this->api->massUpdate('patch', $args[0]);
+        }
+
+        throw new InvalidArgumentException('Patch accepts either an array or an id and array of data.');
     }
 
     public function destroy(string $id)

src/AirtableManager.php

@@ -120,8 +120,9 @@ protected function createAirtable($table)
         }
 
         $airtableTypeCast = $this->app['config']['airtable.typecast'];
+        $delay = $this->app['config']['airtable.delay_between_requests'];
 
-        $client = new AirtableApiClient($base, $table, $access_token, $httpLogFormat, null, $airtableTypeCast);
+        $client = new AirtableApiClient($base, $table, $access_token, $httpLogFormat, null, $airtableTypeCast, $delay);
 
         return new Airtable($client, $table);
     }

src/Api/AirtableApiClient.php

@@ -12,18 +12,20 @@ class AirtableApiClient implements ApiClient
     private $typecast;
     private $base;
     private $table;
+    private $delay;
 
     private $filters = [];
     private $fields = [];
     private $offset = false;
     private $pageSize = 100;
     private $maxRecords = 100;
 
-    public function __construct($base, $table, $access_token, $httpLogFormat = null, Client $client = null, $typecast = false)
+    public function __construct($base, $table, $access_token, $httpLogFormat = null, Client $client = null, $typecast = false, $delayBetweenRequests = 200000)
     {
         $this->base = $base;
         $this->table = $table;
         $this->typecast = $typecast;
+        $this->delay = $delayBetweenRequests;
 
         $stack = \GuzzleHttp\HandlerStack::create();
 
@@ -121,6 +123,27 @@ public function patch(string $id, $contents = null)
         return $this->decodeResponse($this->client->patch($url, $params));
     }
 
+    public function massUpdate(string $method, array $data)
+    {
+        $url = $this->getEndpointUrl();
+        $records = [];
+
+        // Update & Patch request body can include an array of up to 10 record objects
+        $chunks = array_chunk($data, 10);
+        foreach ($chunks as $key => $data_chunk) {
+            $params = ['json' => ['records' => $data_chunk, 'typecast' => $this->typecast]];
+
+            $response = $this->decodeResponse($this->client->$method($url, $params));
+            $records += $response['records'];
+
+            if (isset($chunks[$key + 1])) {
+                usleep($this->delay);
+            }
+        }
+
+        return ['records' => $records];
+    }
+
     public function delete(string $id)
     {
         $url = $this->getEndpointUrl($id);