Filters

routes/api.php

@@ -2,6 +2,7 @@
 
 use Binaryk\LaravelRestify\Http\Controllers\GlobalSearchController;
 use Binaryk\LaravelRestify\Http\Controllers\RepositoryDestroyController;
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryFilterController;
 use Binaryk\LaravelRestify\Http\Controllers\RepositoryIndexController;
 use Binaryk\LaravelRestify\Http\Controllers\RepositoryShowController;
 use Binaryk\LaravelRestify\Http\Controllers\RepositoryStoreController;
@@ -11,6 +12,9 @@
 // Global Search...
 Route::get('/search', '\\'.GlobalSearchController::class);
 
+// Filters
+Route::get('/{repository}/filters', '\\'.RepositoryFilterController::class);
+
 // API CRUD
 Route::get('/{repository}', '\\'.RepositoryIndexController::class);
 Route::post('/{repository}', '\\'.RepositoryStoreController::class);

src/BooleanFilter.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Binaryk\LaravelRestify;
+
+use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
+
+abstract class BooleanFilter extends Filter
+{
+    public $type = 'boolean';
+
+    public function resolve(RestifyRequest $request, $filter)
+    {
+        $keyValues = collect($this->options($request))->mapWithKeys(function ($key) use ($filter) {
+            return [$key => data_get($filter, $key)];
+        })->toArray();
+
+        $this->value = $keyValues;
+    }
+}

src/Filter.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Binaryk\LaravelRestify;
+
+use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
+use Binaryk\LaravelRestify\Traits\Make;
+use Closure;
+use Illuminate\Http\Request;
+use JsonSerializable;
+
+abstract class Filter implements JsonSerializable
+{
+    use Make;
+
+    public $type;
+
+    public $value;
+
+    public $canSeeCallback;
+
+    public function __construct()
+    {
+        $this->booted();
+    }
+
+    protected function booted()
+    {
+        //
+    }
+
+    abstract public function filter(RestifyRequest $request, $query, $value);
+
+    public function canSee(Closure $callback)
+    {
+        $this->canSeeCallback = $callback;
+
+        return $this;
+    }
+
+    public function authorizedToSee(RestifyRequest $request)
+    {
+        return $this->canSeeCallback ? call_user_func($this->canSeeCallback, $request) : true;
+    }
+
+    public function key()
+    {
+        return static::class;
+    }
+
+    protected function getType()
+    {
+        return $this->type;
+    }
+
+    public function options(Request $request)
+    {
+        // noop
+    }
+
+    public function invalidPayloadValue(Request $request, $value)
+    {
+        if (is_array($value)) {
+            return count($value) < 1;
+        } elseif (is_string($value)) {
+            return trim($value) === '';
+        }
+
+        return is_null($value);
+    }
+
+    public function resolve(RestifyRequest $request, $filter)
+    {
+        $this->value = $filter;
+    }
+
+    public function jsonSerialize()
+    {
+        return [
+            'class' => static::class,
+            'type' => $this->getType(),
+            'options' => collect($this->options(app(Request::class)))->map(function ($value, $key) {
+                return is_array($value) ? ($value + ['property' => $key]) : ['label' => $key, 'property' => $value];
+            })->values()->all(),
+        ];
+    }
+}

src/Http/Controllers/RepositoryFilterController.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Http\Controllers;
+
+use Binaryk\LaravelRestify\Http\Requests\RepositoryFiltersRequest;
+
+class RepositoryFilterController extends RepositoryController
+{
+    public function __invoke(RepositoryFiltersRequest $request)
+    {
+        $repository = $request->repository();
+
+        return $this->response()->data($repository->availableFilters($request));
+    }
+}

src/Http/Requests/RepositoryFiltersRequest.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Http\Requests;
+
+class RepositoryFiltersRequest extends RestifyRequest
+{
+}

src/Repositories/Repository.php

@@ -7,6 +7,7 @@
 use Binaryk\LaravelRestify\Exceptions\InstanceOfException;
 use Binaryk\LaravelRestify\Fields\Field;
 use Binaryk\LaravelRestify\Fields\FieldCollection;
+use Binaryk\LaravelRestify\Filter;
 use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
 use Binaryk\LaravelRestify\Restify;
 use Binaryk\LaravelRestify\Services\Search\RepositorySearchService;
@@ -185,7 +186,7 @@ public static function query(): Builder
     }
 
     /**
-     * Resolvable attributes before storing/updating.
+     * Resolvable attributes.
      *
      * @param RestifyRequest $request
      * @return array
@@ -195,6 +196,17 @@ public function fields(RestifyRequest $request)
         return [];
     }
 
+    /**
+     * Resolvable filters for the repository.
+     *
+     * @param RestifyRequest $request
+     * @return array
+     */
+    public function filters(RestifyRequest $request)
+    {
+        return [];
+    }
+
     /**
      * @param RestifyRequest $request
      * @return FieldCollection
@@ -678,4 +690,10 @@ public static function uriTo(Model $model)
     {
         return Restify::path().'/'.static::uriKey().'/'.$model->getKey();
     }
+
+    public function availableFilters(RestifyRequest $request)
+    {
+        return collect($this->filter($this->filters($request)))->each(fn (Filter $filter) => $filter->authorizedToSee($request))
+            ->values();
+    }
 }

src/SelectFilter.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Binaryk\LaravelRestify;
+
+abstract class SelectFilter extends Filter
+{
+    public $type = 'select';
+}

src/Services/Search/RepositorySearchService.php

@@ -3,6 +3,7 @@
 namespace Binaryk\LaravelRestify\Services\Search;
 
 use Binaryk\LaravelRestify\Contracts\RestifySearchable;
+use Binaryk\LaravelRestify\Filter;
 use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
 use Binaryk\LaravelRestify\Repositories\Repository;
 use Illuminate\Database\Eloquent\Builder;
@@ -17,6 +18,8 @@ public function search(RestifyRequest $request, Repository $repository)
 
         $query = $this->prepareMatchFields($request, $this->prepareSearchFields($request, $repository::query(), $this->fixedInput), $this->fixedInput);
 
+        $query = $this->applyFilters($request, $repository, $query);
+
         return tap($this->prepareRelations($request, $this->prepareOrders($request, $query), $this->fixedInput), $this->applyIndexQuery($request, $repository));
     }
 
@@ -175,4 +178,35 @@ protected function applyIndexQuery(RestifyRequest $request, Repository $reposito
     {
         return fn ($query) => $repository::indexQuery($request, $query);
     }
+
+    protected function applyFilters(RestifyRequest $request, Repository $repository, $query)
+    {
+        if (! empty($request->filters)) {
+            $filters = json_decode(base64_decode($request->filters), true);
+
+            collect($filters)
+                ->map(function ($filter) use ($request, $repository) {
+                    /** * @var Filter $matchingFilter */
+                    $matchingFilter = $repository->availableFilters($request)->first(function ($availableFilter) use ($filter) {
+                        return $filter['class'] === $availableFilter->key();
+                    });
+
+                    if (is_null($matchingFilter)) {
+                        return false;
+                    }
+
+                    if ($matchingFilter->invalidPayloadValue($request, $filter['value'])) {
+                        return false;
+                    }
+
+                    $matchingFilter->resolve($request, $filter['value']);
+
+                    return $matchingFilter;
+                })
+                ->filter()
+                ->each(fn (Filter $filter) => $filter->filter($request, $query, $filter->value));
+        }
+
+        return $query;
+    }
 }

src/TimestampFilter.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Binaryk\LaravelRestify;
+
+use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
+use Carbon\Carbon;
+
+abstract class TimestampFilter extends Filter
+{
+    public $type = 'timestamp';
+
+    public function resolve(RestifyRequest $request, $value)
+    {
+        $this->value = Carbon::parse($value);
+    }
+}

tests/Controllers/RepositoryFilterControllerTest.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Controllers;
+
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\ActiveBooleanFilter;
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\CreatedAfterDateFilter;
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\Post;
+use Binaryk\LaravelRestify\Tests\Fixtures\Post\SelectCategoryFilter;
+use Binaryk\LaravelRestify\Tests\Fixtures\User\UserRepository;
+use Binaryk\LaravelRestify\Tests\IntegrationTest;
+
+class RepositoryFilterControllerTest extends IntegrationTest
+{
+    public function test_can_get_available_filters()
+    {
+        $response = $this
+            ->withoutExceptionHandling()
+            ->getJson('restify-api/posts/filters')
+            ->dump()
+            ->assertStatus(200);
+
+        $this->assertCount(3, $response->json('data'));
+    }
+
+    public function test_the_boolean_filter_is_applied()
+    {
+        factory(Post::class)->create(['is_active' => false]);
+        factory(Post::class)->create(['is_active' => true]);
+
+        $filters = base64_encode(json_encode([
+            [
+                'class' => ActiveBooleanFilter::class,
+                'value' => [
+                    'is_active' => false,
+                ],
+            ],
+        ]));
+
+        $response = $this
+            ->withoutExceptionHandling()
+            ->getJson('restify-api/posts?filters='.$filters)
+            ->dump()
+            ->assertStatus(200);
+
+        $this->assertCount(1, $response->json('data'));
+    }
+
+    public function test_the_select_filter_is_applied()
+    {
+        factory(Post::class)->create(['category' => 'movie']);
+        factory(Post::class)->create(['category' => 'article']);
+
+        $filters = base64_encode(json_encode([
+            [
+                'class' => SelectCategoryFilter::class,
+                'value' => 'article',
+            ],
+        ]));
+
+        $response = $this
+            ->withExceptionHandling()
+            ->getJson('restify-api/posts?filters='.$filters)
+            ->assertStatus(200);
+
+        $this->assertCount(1, $response->json('data'));
+    }
+
+    public function test_the_timestamp_filter_is_applied()
+    {
+        factory(Post::class)->create(['created_at' => now()->addYear()]);
+        factory(Post::class)->create(['created_at' => now()->subYear()]);
+
+        $filters = base64_encode(json_encode([
+            [
+                'class' => UserRepository::class,
+                'value' => now()->addWeek()->timestamp,
+            ],
+            [
+                'class' => CreatedAfterDateFilter::class,
+                'value' => now()->addWeek()->timestamp,
+            ],
+        ]));
+
+        $response = $this
+            ->withExceptionHandling()
+            ->getJson('restify-api/posts?filters='.$filters)
+            ->assertStatus(200);
+
+        $this->assertCount(1, $response->json('data'));
+    }
+}

tests/Fixtures/Post/ActiveBooleanFilter.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Binaryk\LaravelRestify\Tests\Fixtures\Post;
+
+use Binaryk\LaravelRestify\BooleanFilter;
+use Binaryk\LaravelRestify\Http\Requests\RestifyRequest;
+use Illuminate\Http\Request;
+
+class ActiveBooleanFilter extends BooleanFilter
+{
+    public function filter(RestifyRequest $request, $query, $value)
+    {
+        $query->where('is_active', $value['is_active']);
+    }
+
+    public function options(Request $request)
+    {
+        return [
+            'Is Active' => 'is_active',
+        ];
+    }
+}