Merge pull request #14 from gregorip02/2.x

[2.x] new permissive authorizer

.github/workflows/test.yml

@@ -37,5 +37,6 @@ jobs:
       - name: Install dependencies
         run: |
           composer update --prefer-stable --prefer-dist --no-interaction --no-suggest
+
       - name: Execute tests
-        run: vendor/bin/phpunit
+        run: composer test

NEXT.md

@@ -3,12 +3,14 @@
 - [x] Add commands for make **authorizers** and **resolvers.**
 - [ ] Add mutation **clausule** for update resources.
 - [ ] Add mutation **clausule** for delete resources.
+- [ ] Allow to add multiple where clausules and document it.
 - [ ] Create **orWhere** clausule.
 - [ ] Create **whereBetween** clausule.
 - [x] Create **whereIn** clausule.
 - [x] Create **whereNotIn** clausule.
-- [ ] Add **pagination** support.
-- [ ] Add **pagination** documentation.
+- [ ] Create **orWhere** clausule.
+- [ ] Allow to select attributes from resolvers.
+- [ ] Add **pagination** support and documentation.
 - [x] Move all testing for SQLite.
 - [x] Update the wiki and write documentation about the **RestQL.**
-- [x] Implement `orchestra/testbench` testing for "real world" situations.
+- [x] Implement `orchestra/testbench` testing for "real world" situations.

composer.json

@@ -2,7 +2,7 @@
   "name": "gregorip02/restql",
   "description": "A data resolution package for Laravel",
   "type": "library",
-  "keywords": ["restql", "eloquent", "laravel", "graphql", "drp"],
+  "keywords": ["restql", "eloquent", "laravel", "graphql"],
   "url": "https://github.com/gregorip02/restql",
   "license": "LGPL-3.0",
   "authors": [

config/restql.php

@@ -41,7 +41,7 @@
         // Uncoment this and get the currently authenticated user.
         // 'whoami' => [
         //   'class' => 'Restql\Resolvers\WhoamiResolver',
-        //   'authorizer'  => 'Restql\Authorizers\WhoamiAuthorizer',
+        //   'authorizer'  => 'Restql\Authorizers\PermissiveAuthorizer',
         //   'middlewares' => ['auth']
         // ]
     ],

src/Arguments/WhereArgument.php

@@ -2,8 +2,8 @@
 
 namespace Restql\Arguments;
 
-use Restql\Contracts\ArgumentContract;
 use Restql\ModelArgument;
+use Restql\Contracts\ArgumentContract;
 
 class WhereArgument extends ModelArgument implements ArgumentContract
 {
@@ -22,11 +22,11 @@ class WhereArgument extends ModelArgument implements ArgumentContract
     public function values(): array
     {
         if ($this->isImplicitValue()) {
-            $value = $this->first();
-
             /// When an implicit type value is received, it will be assumed that
             /// it corresponds to the value of the primary column of the model.
-            return compact('value');
+            return [
+                'value' => $this->first()
+            ];
         }
 
         return parent::values();
@@ -42,7 +42,8 @@ public function getDefaultArgumentValues(): array
         return [
             'column'   => $this->getKeyName(),
             'operator' => '=',
-            'value'    => null
+            'value'    => null,
+            'boolean'  => 'and'
         ];
     }
 }

src/Arguments/WhereInOrNotInArgument.php

@@ -2,10 +2,36 @@
 
 namespace Restql\Arguments;
 
-use Restql\Arguments\WhereArgument;
+use Restql\ModelArgument;
+use Restql\Contracts\ArgumentContract;
 
-class WhereInOrNotInArgument extends WhereArgument
+class WhereInOrNotInArgument extends ModelArgument implements ArgumentContract
 {
+    /**
+     * Determines if the argument accepts implicit values.
+     *
+     * @var boolean
+     */
+    protected $hasImplicitValues = true;
+
+    /**
+     * Get the argument values as array.
+     *
+     * @return array
+     */
+    public function values(): array
+    {
+        if ($this->isImplicitValue()) {
+            /// When an implicit type value is received, it will be assumed that
+            /// it corresponds to the value of the primary column of the model.
+            return [
+                'value' => (array) $this->first()
+            ];
+        }
+
+        return parent::values();
+    }
+
     /**
      * Get default argument values.
      *

src/Arguments/WithArgument.php

@@ -2,13 +2,13 @@
 
 namespace Restql\Arguments;
 
-use Illuminate\Database\Eloquent\Relations\HasMany;
-use Illuminate\Database\Eloquent\Relations\Relation;
-use Illuminate\Support\Collection;
-use Restql\ClausuleExecutor;
-use Restql\Contracts\ArgumentContract;
 use Restql\ModelArgument;
+use Restql\ClausuleExecutor;
 use Restql\Support\ReflectionSupport;
+use Restql\Contracts\ArgumentContract;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\Relation;
 
 class WithArgument extends ModelArgument implements ArgumentContract
 {

src/Authorizers/PermissiveAuthorizer.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Restql\Authorizers;
+
+use Restql\Authorizer;
+
+final class PermissiveAuthorizer extends Authorizer
+{
+    /**
+     * Can get one or more resources.
+     *
+     * @param  array $clausules
+     * @return bool
+     */
+    public static function get($clausules = []): bool
+    {
+        return true;
+    }
+}

src/Clausules/SelectClausule.php

@@ -2,14 +2,13 @@
 
 namespace Restql\Clausules;
 
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Illuminate\Support\Collection;
 use Restql\Argument;
-use Restql\Arguments\SelectArgument;
 use Restql\Clausule;
+use Restql\Arguments\SelectArgument;
 use Restql\Support\ReflectionSupport;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 class SelectClausule extends Clausule
 {

src/Clausules/WhereClausule.php

@@ -2,11 +2,11 @@
 
 namespace Restql\Clausules;
 
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 use Restql\Argument;
-use Restql\Arguments\WhereArgument;
 use Restql\Clausule;
+use Restql\Arguments\WhereArgument;
 use Restql\Exceptions\MissingArgumentException;
+use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 class WhereClausule extends Clausule
 {

src/Clausules/WhereInClausule.php

@@ -20,7 +20,7 @@ public function build(QueryBuilder $builder): void
     {
         $args = array_values($this->arguments->data());
 
-        $builder->whereIn($args[0], (array) $args[1]);
+        $builder->whereIn(...$args);
     }
 
     /**

src/Clausules/WhereNotInClausule.php

@@ -18,6 +18,17 @@ public function build(QueryBuilder $builder): void
     {
         $args = array_values($this->arguments->data());
 
-        $builder->whereNotIn($args[0], (array) $args[1]);
+        $builder->whereNotIn(...$args);
+    }
+
+    /**
+     * Throw a exception if can't build this clausule.
+     *
+     * @return void
+     */
+    protected function canBuild(): void
+    {
+        parent::throwIfMethodIsNotAllowed('whereNotIn');
+        $this->throwIfArgumentIsMissing('whereNotIn');
     }
 }

src/Clausules/WithClausule.php

@@ -2,15 +2,10 @@
 
 namespace Restql\Clausules;
 
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
-use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\HasMany;
-use Illuminate\Database\Eloquent\Relations\Relation;
-use Illuminate\Support\Collection;
+use Restql\Clausule;
 use Restql\Argument;
 use Restql\Arguments\WithArgument;
-use Restql\Clausule;
-use Restql\Support\ReflectionSupport;
+use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 class WithClausule extends Clausule
 {

src/MutationClausule.php

@@ -9,7 +9,6 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 abstract class MutationClausule extends Clausule
 {

src/RequestParser.php

@@ -4,8 +4,6 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
-use Restql\Exceptions\InvalidEncodingValue;
-use Restql\Services\ConfigService;
 use Restql\Traits\HasConfigService;
 
 final class RequestParser

src/Resolvers/QueryBuilderResolver.php

@@ -8,7 +8,6 @@
 use Restql\Resolver;
 use Restql\SchemaDefinition;
 use Restql\Traits\ModelResolver;
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 final class QueryBuilderResolver extends Resolver implements SchemaHandlerContract
 {

src/Resolvers/WhoamiResolver.php

@@ -20,9 +20,6 @@ public function handle(SchemaDefinition $schema): Collection
     {
         $user = Auth::user();
 
-        /// Uncoment this for testing...
-        /// $user = factory('App\Author', 1)->make();
-
         return Collection::make($user);
     }
 }

src/Restql.php

@@ -9,7 +9,6 @@
 use Illuminate\Http\Response;
 use Illuminate\Support\Collection;
 use Illuminate\Contracts\Support\Responsable;
-use Illuminate\Database\Eloquent\Builder as QueryBuilder;
 
 final class Restql implements Responsable
 {

tests/App/config/restql.php

@@ -52,7 +52,7 @@
     'resolvers' => [
         'whoami' => [
            'class' => 'Restql\Resolvers\WhoamiResolver',
-           'authorizer'  => 'Restql\Authorizers\WhoamiAuthorizer',
+           'authorizer'  => 'Restql\Authorizers\PermissiveAuthorizer',
            'middlewares' => ['auth']
         ]
     ],

tests/Feature/Clausules/WhereInClausuleTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Testing\Feature\Clausules;
+
+use Testing\TestCase;
+
+final class WhereInClausuleTest extends TestCase
+{
+    /**
+     * Fake in articles id.
+     *
+     * @var array
+     */
+    protected $articles = [1, 3, 10, 14];
+
+    /**
+     * @test Get articles where id in (1, 14, 3, 10)
+     */
+    public function getArticlesWhereIdInUsingImplicitMethod(): void
+    {
+        $response = $this->json('get', 'restql', [
+            'articles' => [
+                'whereIn' => [$this->articles],
+                'select'  => 'id'
+            ]
+        ]);
+
+        $response->assertJsonCount(count($this->articles), 'data.articles');
+
+        $response->assertExactJson([
+            'data' => [
+                'articles' => array_map(function (int $id) {
+                    return ['id' => $id];
+                }, $this->articles)
+            ]
+        ]);
+
+        $articles = $response->decodeResponseJson('data.articles.*.id');
+
+        $this->assertEquals($this->articles, $articles);
+    }
+}

tests/Feature/Clausules/WhereNotInClausuleTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Testing\Feature\Clausules;
+
+use Testing\TestCase;
+
+final class WhereNotInClausuleTest extends TestCase
+{
+    /**
+     * Fake not in articles.
+     *
+     * @var array
+     */
+    protected $articles = [4, 5, 9, 10];
+
+    /**
+     * @test Exclude articles where id not in (4, 5, 9, 10)
+     */
+    public function excludeArticlesWhereIdNotInUsingImplicitMethod(): void
+    {
+        $response = $this->json('get', 'restql', [
+            'articles' => [
+                'select'     => 'id',
+                'whereNotIn' => [$this->articles]
+            ]
+        ]);
+
+        /// We get 15 by default because we are excluding [$this->articles]
+        /// and this is rejected with others articles.
+        $response->assertJsonCount(15, 'data.articles');
+
+        $articles = $response->decodeResponseJson('data.articles.*.id');
+
+        /// Don't see any article id defined in $this->articles in
+        /// $articles responsed by RestQL.
+        foreach ($this->articles as $article) {
+            $this->assertFalse(
+                in_array($article, $articles)
+            );
+        }
+    }
+}