Merge pull request #114 from 5am-code/feature/allow-filter-collections

Still allow filter collections

Author: johguentner

src/Endpoints/Database.php

@@ -8,6 +8,7 @@
 use FiveamCode\LaravelNotionApi\Notion;
 use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
 use FiveamCode\LaravelNotionApi\Query\Filters\FilterBag;
+use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
 use Illuminate\Support\Collection;
 
@@ -60,6 +61,18 @@ public function __construct(string $databaseId, Notion $notion)
      * @throws \FiveamCode\LaravelNotionApi\Exceptions\NotionException
      */
     public function query(): PageCollection
+    {
+        $response = $this
+            ->post(
+                $this->url(Endpoint::DATABASES."/{$this->databaseId}/query"),
+                $this->getPostData()
+            )
+            ->json();
+
+        return new PageCollection($response);
+    }
+
+    public function getPostData(): array
     {
         $postData = [];
 
@@ -81,28 +94,20 @@ public function query(): PageCollection
             $postData['page_size'] = $this->pageSize;
         }
 
-        $response = $this
-            ->post(
-                $this->url(Endpoint::DATABASES."/{$this->databaseId}/query"),
-                $postData
-            )
-            ->json();
-
-        return new PageCollection($response);
+        return $postData;
     }
 
     /**
      * @param $filter
      * @return Database $this
      *
      * @throws HandlingException
-     *
-     * @todo As soon as this package drops PHP 7.4 support, we can use union types here (FilterBag and Filter)
      */
-    public function filterBy($filter): Database // TODO that's a breaking change
+    public function filterBy(Collection|Filter|FilterBag $filter): Database
     {
-        $this->checkFilterType($filter);
-
+        if ($filter instanceof Collection) {
+            return $this->filterByCollection($filter);
+        }
         if ($filter instanceof FilterBag) {
             return $this->filterByBag($filter);
         }
@@ -113,6 +118,12 @@ public function filterBy($filter): Database // TODO that's a breaking change
         return $this;
     }
 
+    /**
+     * @param  Filter  $filter
+     * @return $this
+     *
+     * @throws HandlingException
+     */
     public function filterBySingleFilter(Filter $filter): Database
     {
         $this->filter = $filter;
@@ -123,7 +134,7 @@ public function filterBySingleFilter(Filter $filter): Database
 
     /**
      * @param  FilterBag  $filterBag
-     * @return $this
+     * @return Database $this
      */
     public function filterByBag(FilterBag $filterBag): Database
     {
@@ -133,6 +144,18 @@ public function filterByBag(FilterBag $filterBag): Database
         return $this;
     }
 
+    /**
+     * @param  Collection  $filterCollection
+     * @return Database $this
+     */
+    public function filterByCollection(Collection $filterCollection): Database
+    {
+        $filterBag = new FilterBag(Operators::OR);
+        $filterBag->addFilters($filterCollection);
+
+        return $this->filterByBag($filterBag);
+    }
+
     /**
      * @param  Collection|Sorting  $sorts
      * @return Database $this
@@ -150,7 +173,7 @@ public function sortBy(Sorting|Collection $sorts): Database
                 $this->sorts = $sorts;
                 break;
             default:
-                throw new HandlingException("The parameter 'sorts' must be either a instance of the class Sorting or a Collection of Sortings.");
+                throw new HandlingException("The parameter 'sorts' must be either a instance of the class Sorting or a Collection of sortings.");
         }
 
         return $this;
@@ -166,11 +189,4 @@ public function offsetByResponse(EntityCollection $entityCollection): Database
 
         return $this;
     }
-
-    private function checkFilterType($filter): void
-    {
-        if (! ($filter instanceof Filter || $filter instanceof FilterBag)) {
-            throw new HandlingException('Please provide either a filter bag or a single filter.');
-        }
-    }
 }

src/Query/Filters/FilterBag.php

@@ -69,6 +69,18 @@ public function addFilter(Filter $filter): self
         return $this;
     }
 
+    public function addFilters(Collection $filters): self
+    {
+        foreach ($filters as $filter) {
+            if (! $filter instanceof Filter) {
+                throw new HandlingException('The filter bag must only contain filter objects.');
+            }
+            $this->addFilter($filter);
+        }
+
+        return $this;
+    }
+
     /**
      * @throws HandlingException|Throwable
      */

tests/EndpointDatabaseTest.php

@@ -3,8 +3,11 @@
 use FiveamCode\LaravelNotionApi\Endpoints\Database;
 use FiveamCode\LaravelNotionApi\Entities\Collections\PageCollection;
 use FiveamCode\LaravelNotionApi\Entities\Page;
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
 use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
+use FiveamCode\LaravelNotionApi\Query\Filters\FilterBag;
+use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
 use FiveamCode\LaravelNotionApi\Query\StartCursor;
 use Illuminate\Support\Collection;
@@ -33,6 +36,24 @@
     $this->assertInstanceOf(Database::class, $endpoint);
 });
 
+it('allows a filter, filter bag or collection of filters inside the filterBy method', function () {
+    $filter = Filter::textFilter('Name', Operators::CONTAINS, 'Grace');
+    $filterCollection = (new Collection)->add($filter);
+    $filterBag = (new FilterBag(Operators::AND))->addFilter($filter);
+
+    $endpoint = Notion::database('8284f3ff77e24d4a939d19459e4d6bdc');
+
+    $endpoint->filterBy($filter);
+    $endpoint->filterBy($filterCollection);
+    $endpoint->filterBy($filterBag);
+
+    $this->expectException(HandlingException::class);
+    $this->expectExceptionMessage('The filter bag must only contain filter objects.');
+
+    $filterCollection->add(1);
+    $endpoint->filterBy($filterCollection);
+});
+
 it('queries a database with filter and sorting and processes result', function ($limit) {
     // success /v1/databases/DATABASE_DOES_EXIST/query
     Http::fake([
@@ -92,7 +113,7 @@
         ),
     ]);
 
-    // Let's search for something that doesn't exists
+    // Let's search for something that doesn't exist
     $filters = new Collection();
 
     $filter = Filter::rawFilter(

tests/FilterTest.php

@@ -3,6 +3,7 @@
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
 use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
+use Illuminate\Support\Collection;
 
 it('creates a text filter with the given data', function () {
     $filter = Filter::textFilter('Name', Operators::EQUALS, 'Ada Lovelace');
@@ -39,3 +40,22 @@
     $this->expectExceptionMessage('Invalid filter definition.');
     $filter->toArray();
 });
+
+it('converts a collection of filters to a filter bag with an OR operator', function () {
+    $filter = Filter::textFilter('Name', Operators::CONTAINS, 'Grace');
+    $filterCollection = (new Collection())->add($filter);
+
+    $endpoint = Notion::database('8284f3ff77e24d4a939d19459e4d6bdc');
+
+    $endpoint->filterBy($filterCollection);
+
+    $queryData = $endpoint->getPostData();
+
+    $this->assertArrayHasKey('filter', $queryData);
+    $this->assertArrayHasKey('or', $queryData['filter']);
+    $this->assertArrayHasKey('property', $queryData['filter']['or'][0]);
+    $this->assertEquals('Name', $queryData['filter']['or'][0]['property']);
+    $this->assertArrayHasKey('text', $queryData['filter']['or'][0]);
+    $this->assertArrayHasKey('contains', $queryData['filter']['or'][0]['text']);
+    $this->assertEquals('Grace', $queryData['filter']['or'][0]['text']['contains']);
+});