Merge pull request #5 from scottgrayson/where-method

testing and add methods: where, firstOrCreate, updateOrCreate

Author: scottgrayson

.gitignore

@@ -2,4 +2,6 @@ build
 composer.lock
 docs
 vendor
-coverage
+coverage
+.env
+.ac-php-conf.json

README.md

@@ -35,16 +35,34 @@ AIRTABLE_TABLE=
 
 ## Usage
 
-Get all records from that table.
-
+#### Get all records from that table.
 ``` php
 Airtable::table('tasks')->get();
 ```
 
-Get one record from the default table.
-
+#### Get one record from the default table.
 ``` php
 Airtable::find('id_string');
+
+```
+
+#### Filter records
+``` php
+Airtable::where('name', 'myName')->get();
+```
+
+#### First or Create
+- First argument will be used for finding existing
+- Second argument is additional data to save if no results are found and we are creating (will not be saved used if item already exists)
+``` php
+Airtable::firstOrCreate(['name' => 'myName'], ['field' => 'myField']);
+```
+
+#### Update or Create
+- First argument will be used to find existing
+- Second argument is additional data to save when we create or update
+``` php
+Airtable::createOrUpdate(['name' => 'myName'], ['field' => 'myField']);
 ```
 
 ### Testing

composer.json

@@ -18,7 +18,8 @@
     "require": {
         "php": "^7.1",
         "guzzlehttp/guzzle": "~6.0",
-        "illuminate/support": "5.7.* || 5.8.*"
+        "illuminate/support": "5.7.* || 5.8.*",
+        "symfony/dotenv": "^4.2"
     },
     "require-dev": {
         "mockery/mockery": "^1.0",

config/config.php

@@ -47,4 +47,6 @@
 
     ],
 
+    'log_http' => env('AIRTABLE_LOG_HTTP', false),
+    'log_http_format' => env('AIRTABLE_LOG_HTTP_FORMAT', '{request} >>> {res_body}'),
 ];

env.example

@@ -0,0 +1,4 @@
+# TEST_AIRTABLE_API=true
+AIRTABLE_KEY=
+AIRTABLE_BASE=
+AIRTABLE_TABLE=

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
+<phpunit bootstrap="tests/autoload.php"
          backupGlobals="false"
          backupStaticAttributes="false"
          colors="true"
@@ -9,21 +9,24 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
+  <php>
+    <env name="APP_ENV" value="test" />
+  </php>
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <filter>
+    <whitelist>
+      <directory suffix=".php">src/</directory>
+    </whitelist>
+  </filter>
+  <logging>
+    <log type="tap" target="build/report.tap"/>
+    <log type="junit" target="build/report.junit.xml"/>
+    <log type="coverage-html" target="build/coverage"/>
+    <log type="coverage-text" target="build/coverage.txt"/>
+    <log type="coverage-clover" target="build/logs/clover.xml"/>
+  </logging>
 </phpunit>

src/Airtable.php

@@ -6,15 +6,8 @@ class Airtable
 {
     private $api;
 
-    /** @var string */
-    protected $base;
-
-    /** @var string */
-    protected $table;
-
-    public function __construct($client, $table)
+    public function __construct($client)
     {
-        $this->table = $table;
         $this->api = $client;
     }
 
@@ -40,11 +33,69 @@ public function destroy(string $id)
 
     public function get()
     {
-        return $this->api->get();
+        return $this->toCollection($this->api->get());
     }
 
     public function all()
     {
-        return $this->api->getAllPages();
+        return $this->toCollection($this->api->getAllPages());
+    }
+
+    public function table($table)
+    {
+        $this->api->setTable($table);
+
+        return $this;
+    }
+
+    public function where($column, $value)
+    {
+        return $this->api->addFilter($column, '=', $value);
+    }
+
+    public function firstOrCreate(array $idData, array $createData = [])
+    {
+        foreach ($idData as $key => $value) {
+            $this->where($key, $value);
+        }
+
+        $results = $this->get();
+
+        // first
+        if ($results->isNotEmpty()) {
+            return $results->first();
+        }
+
+        // create
+        $data = array_merge($idData, $createData);
+
+        return $this->create($data);
+    }
+
+    public function updateOrCreate(array $idData, array $updateData = [])
+    {
+        foreach ($idData as $key => $value) {
+            $this->where($key, $value);
+        }
+
+        $results = $this->get();
+
+        // first
+        if ($results->isNotEmpty()) {
+            $item = $results->first();
+
+            //update
+            return $this->update($item['id'], $updateData);
+        }
+
+        // create
+        $data = array_merge($idData, $updateData);
+
+        return $this->create($data);
+    }
+
+    private function toCollection($object)
+    {
+        return isset($object['records']) ? collect($object['records']) : $object;
     }
 }

src/AirtableManager.php

@@ -36,14 +36,12 @@ public function __construct($app)
     /**
      * Get a airtable table instance.
      *
-     * @param  string  $name
+     * @param  string  $table
      * @return \Airtable\Table
      */
-    public function table($name = null)
+    public function table(string $table)
     {
-        $name = $name ?: $this->getDefaultTable();
-
-        return $this->tables[$name] = $this->get($name);
+        return $this->resolve($table);
     }
 
     /**
@@ -91,41 +89,6 @@ public function setDefaultTable($name)
         $this->app['config']['airtable.default'] = $name;
     }
 
-    /**
-     * Return all of the created connections.
-     *
-     * @return array
-     */
-    public function getTables()
-    {
-        return $this->tables;
-    }
-
-    /**
-     * Set the given table instance.
-     *
-     * @param  string  $name
-     * @param  mixed  $table
-     * @return $this
-     */
-    public function set($name, $table)
-    {
-        $this->tables[$name] = $table;
-
-        return $this;
-    }
-
-    /**
-     * Attempt to get the table from the local cache.
-     *
-     * @param  string  $name
-     * @return \Tapp\Airtable
-     */
-    protected function get($name)
-    {
-        return $this->tables[$name] ?? $this->resolve($name);
-    }
-
     /**
      * Resolve the given table.
      *
@@ -139,20 +102,26 @@ protected function resolve($name)
         $config = $this->getConfig($name);
 
         if ($config) {
-            return $this->createAirtable($config);
+            return $this->createAirtable($config['name']);
         } else {
             throw new InvalidArgumentException("Table [{$name}] is not configured.");
         }
     }
 
-    protected function createAirtable($config)
+    protected function createAirtable($table)
     {
         $base = $this->app['config']['airtable.base'];
         $access_token = $this->app['config']['airtable.key'];
 
-        $client = new AirtableApiClient($base, $config, $access_token);
+        if ($this->app['config']['airtable.log_http']) {
+            $httpLogFormat = $this->app['config']['airtable.log_http_format'];
+        } else {
+            $httpLogFormat = null;
+        }
+
+        $client = new AirtableApiClient($base, $table, $access_token, $httpLogFormat);
 
-        return new Airtable($client, $config);
+        return new Airtable($client, $table);
     }
 
     /**