Make the model interface more fluent

Author: kitar

README.md

@@ -26,7 +26,9 @@ This package provides QueryBuilder for DynamoDB.
     - [Using Global Secondary Indexes in DynamoDB](#using-global-secondary-indexes-in-dynamodb)
         - [Querying a Global Secondary Index](#querying-a-global-secondary-index)
 - [Models](#models)
-    - [Binding model to the QueryBuilder](#binding-model-to-the-querybuilder)
+    - [Basic Usage of Model](#basic-usage-of-model)
+        - [Calling Builder methods through model](#calling-builder-methods-through-model)
+        - [CRUD operations](#crud-operations)
 - [Authentication](#authentication)
     - [Make user model](#make-user-model)
     - [Make custom user provider](#make-custom-user-provider)
@@ -290,15 +292,17 @@ $response = DB::table('Reply')
 
 ## Models
 
-`Kitar\Dynamodb\Model\Model` is a experimental Model implementation for this package.
+`Kitar\Dynamodb\Model\Model` is an experimental Model implementation for this package.
 
-It works like Eloquent Model, but there is no model querying features. Model's features to interact DynamoDB is only `save`, `update` and `delete`.
+It works like Eloquent Model, but instead of forwarding calls to "Model" Query, we forward call directly to "DynamoDB" Query.
 
-Instead we don't have model query, we'll tell the QueryBuilder to instantiate DynamoDB response with the specified model.
+Because there is no "Model" Query, we can't use handy methods like `find` `create` `firstOrCreate` or something like that. We only have `save` `update` and `delete` for the Model methods to interact with DynamoDB. However, when we query through Model, DynamoDB's response items will be automatically converted to the model instance.
 
-### Binding model to the QueryBuilder
+### Basic Usage of Model
 
-For example, we have some user model below.
+Let's say we have some Authenticatable User model. (we'll use this example in the Authentication section as well)
+
+Most attributes are the same as the original Eloquent Model, but there are few DynamoDB specific attributes. `table` `primaryKey` `sortKey` and `sortKeyDefault`.
 
 ```php
 <?php
@@ -349,35 +353,52 @@ class User extends Model implements AuthenticatableContract
 }
 ```
 
-Then, let QueryBuilder know model class by `usingModel`.
+#### Calling Builder methods through model
 
 ```php
-$response = DB::table('table_name')
-                ->usingModel(App\User::class)
-                ->getItem([
-                    'id' => '[email protected]',
-                    'type' => 'profile'
-                ]);
-```
+$response = User::getItem([
+    'id' => '[email protected]',
+    'type' => 'profile'
+]);
 
-`$response['Item']` will be the User model instance.
+$user = $response['Item'];
+```
 
-> behind the scene when specifying `usingModel`, Query Processor is converting each items to model instance with `(new $modelClass)-newFromBuilder($item)`.
+```php
+$response = User::filter('type', '=', 'profile')
+                  ->scan();
 
-After retrieving the model instance, we can `save`, `update` and `delete` in the same manner as Eloquent Model.
+$users = $response['Items'];
+```
 
-Also, we can create new instance like below.
+#### CRUD operations
 
 ```php
-$user = new App\User([
+// create
+$newUser = new User([
     'id' => '[email protected]',
     'type' => 'profile'
 ]);
 
-$user->save();
-```
+$newUser->save();
+
+// read
+$existingUser = User::getItem([
+    'id' => '[email protected]',
+    'type' => 'profile'
+])['Item'];
 
-However, because we don't have model query, we can't use `create` or `firstOrCreate` or things like that.
+// update
+$existingUser->foo = 'bar';
+$existingUser->save();
+
+$existingUser->update([
+    'foo' => 'barbar'
+]);
+
+// delete
+$existingUser->delete();
+```
 
 ## Authentication
 

src/Kitar/Dynamodb/Model/AuthUserProvider.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Auth\UserProvider as BaseUserProvider;
-use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Hash;
 
 class AuthUserProvider implements BaseUserProvider
@@ -28,9 +27,9 @@ public function retrieveById($identifier)
 
         $this->model->$identifierName = $identifier;
 
-        $response = DB::table($this->model->getTable())
-                        ->usingModel(get_class($this->model))
-                        ->getItem($this->model->getKey());
+        $response = $this->model->getItem(
+            $this->model->getKey()
+        );
 
         return $response['Item'];
     }

src/Kitar/Dynamodb/Model/Model.php

@@ -71,7 +71,7 @@ public function getKey()
      */
     public function newQuery()
     {
-        return $this->getConnection()->table($this->table);
+        return $this->getConnection()->table($this->table)->usingModel(static::class);
     }
 
     /**
@@ -238,4 +238,38 @@ public function delete()
 
         return true;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function __call($method, $parameters)
+    {
+        $allowedBuilderMethods = [
+            "index",
+            "key",
+            "exclusiveStartKey",
+            "consistentRead",
+            "dryRun",
+            "getItem",
+            "putItem",
+            "deleteItem",
+            "updateItem",
+            "scan",
+            "filter",
+            "filterIn",
+            "filterBetween",
+            "condition",
+            "conditionIn",
+            "conditionBetween",
+            "keyCondition",
+            "keyConditionIn",
+            "keyConditionBetween",
+        ];
+
+        if (! in_array($method, $allowedBuilderMethods)) {
+            static::throwBadMethodCallException($method);
+        }
+
+        return $this->forwardCallTo($this->newQuery(), $method, $parameters);
+    }
 }