Changed namespace & added filter tests

Author: mechelon

src/Endpoints/Database.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Collection;
 use FiveamCode\LaravelNotionApi\Notion;
-use FiveamCode\LaravelNotionApi\Query\Filter;
+use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
 use FiveamCode\LaravelNotionApi\Entities\Collections\PageCollection;
 
@@ -68,7 +68,6 @@ public function query(): PageCollection
         if ($this->pageSize !== null)
             $postData['page_size'] = $this->pageSize;
 
-
         $response = $this
             ->post(
                 $this->url(Endpoint::DATABASES . "/{$this->databaseId}/query"),

src/Query/Filter/CompoundFilter.php renamed to src/Query/Filters/CompoundFilter.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace FiveamCode\LaravelNotionApi\Query\Filter;
+namespace FiveamCode\LaravelNotionApi\Query\Filters;
 
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use FiveamCode\LaravelNotionApi\Query\QueryHelper;

src/Query/Filter/Filter.php renamed to src/Query/Filters/Filter.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace FiveamCode\LaravelNotionApi\Query\Filter;
+namespace FiveamCode\LaravelNotionApi\Query\Filters;
 
-use FiveamCode\LaravelNotionApi\Query\Filter\Operators;
+use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
 use FiveamCode\LaravelNotionApi\Query\QueryHelper;
 use Illuminate\Support\Collection;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
@@ -50,7 +50,7 @@ public function __construct(
     }
 
     /**
-     * Returns a text filter instance.
+     * Creates a number filter instance after checking validity.
      *
      * @see https://developers.notion.com/reference/post-database-query#text-filter-condition
      *
@@ -65,7 +65,18 @@ public static function textFilter(string $property, string $comparisonOperator,
         return new Filter($property, 'text', [$comparisonOperator => $value]);
     }
 
-    public static function numberFilter(string $property, string $comparisonOperator, float|int|double $number): Filter
+    /**
+     * Creates a number filter instance after checking validity.
+     *
+     * @see https://developers.notion.com/reference/post-database-query#number-filter-condition
+     *
+     * @param string $property
+     * @param string $comparisonOperator
+     * @param float|int $number
+     * @return Filter
+     * @throws HandlingException
+     */
+    public static function numberFilter(string $property, string $comparisonOperator, float|int $number): Filter
     {
         self::isValidComparisonOperatorFor('number', $comparisonOperator);
         return new Filter($property, 'number', [$comparisonOperator => $number]);
@@ -112,6 +123,17 @@ public function toArray(): array
 
     }
 
+    /**
+     * Semantic wrapper for toArray()
+     *
+     * @return array
+     * @throws HandlingException
+     */
+    public function toQuery(): array
+    {
+        return $this->toArray();
+    }
+
 
     /**
      * @param Collection $filter
@@ -124,14 +146,21 @@ public static function filterQuery(Collection $filter): array
         $queryFilter = new Collection();
 
         $filter->each(function (Filter $filter) use ($queryFilter) {
-            $queryFilter->add($filter->toArray());
+            $queryFilter->add($filter->toQuery());
         });
 
         return $queryFilter->toArray();
 
     }
 
 
+    /**
+     * Checks if the given comparison operator is valid for the given filter type.
+     *
+     * @param $filterType
+     * @param $operator
+     * @throws HandlingException
+     */
     private static function isValidComparisonOperatorFor($filterType, $operator)
     {
         $validOperators = Operators::getValidComparisonOperators($filterType);

src/Query/Filter/Operators.php renamed to src/Query/Filters/Operators.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace FiveamCode\LaravelNotionApi\Query\Filter;
+namespace FiveamCode\LaravelNotionApi\Query\Filters;
 
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 

tests/EndpointDatabaseTest.php

@@ -2,10 +2,10 @@
 
 namespace FiveamCode\LaravelNotionApi\Tests;
 
+use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
 use Notion;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Http;
-use FiveamCode\LaravelNotionApi\Query\Filter;
 use FiveamCode\LaravelNotionApi\Entities\Page;
 use FiveamCode\LaravelNotionApi\Query\Sorting;
 use FiveamCode\LaravelNotionApi\Endpoints\Database;

tests/FilterTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Tests;
+
+use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
+use FiveamCode\LaravelNotionApi\Query\Filters\Filter;
+use FiveamCode\LaravelNotionApi\Query\Filters\Operators;
+use Notion;
+use Illuminate\Support\Facades\Http;
+
+/**
+ * Class HandlingExceptionTest
+ * @package FiveamCode\LaravelNotionApi\Tests
+ */
+class FilterTest extends NotionApiTest
+{
+
+    /** @test */
+    public function it_creates_a_text_filter_with_the_given_data()
+    {
+        $filter = Filter::textFilter("Name", Operators::EQUALS, "Ada Lovelace");
+
+        $this->assertInstanceOf(Filter::class, $filter);
+        $this->assertArrayHasKey("property", $filter->toQuery());
+        $this->assertEquals("Name", $filter->toQuery()["property"]);
+        $this->assertArrayHasKey("text", $filter->toQuery());
+        $this->assertArrayHasKey("equals", $filter->toQuery()["text"]);
+        $this->assertEquals("Ada Lovelace", $filter->toQuery()["text"]["equals"]);
+    }
+
+    /** @test */
+    public function it_creates_a_number_filter_with_the_given_data()
+    {
+        $filter = Filter::numberFilter("Awesomeness Level", Operators::GREATER_THAN_OR_EQUAL_TO, 9000);
+
+        $this->assertInstanceOf(Filter::class, $filter);
+        $this->assertArrayHasKey("property", $filter->toQuery());
+        $this->assertEquals("Awesomeness Level", $filter->toQuery()["property"]);
+        $this->assertArrayHasKey("number", $filter->toQuery());
+        $this->assertArrayHasKey("greater_than_or_equal_to", $filter->toQuery()["number"]);
+        $this->assertEquals("9000", $filter->toQuery()["number"]["greater_than_or_equal_to"]);
+    }
+
+    /** @test */
+    public function it_throws_an_exception_for_an_invalid_comparison_operator()
+    {
+        $this->expectException(HandlingException::class);
+        $this->expectExceptionMessage("Invalid comparison operator");
+        $filter = Filter::numberFilter("Awesomeness Level", "non_existing_operator", 9000);
+    }
+
+    /** @test */
+    public function it_throws_an_exception_for_an_invalid_filter_definition() {
+        $filter = new Filter("Test");
+
+        $this->expectException(HandlingException::class);
+        $this->expectExceptionMessage("Invalid filter definition.");
+        $filter->toArray();
+    }
+
+    /** @test */
+    public function it_throws_an_exception_for_an_invalid_filter_type() {
+        $filter = new Filter("Test", "non_existing_filter_type");
+
+//        $this->expectException(HandlingException::class);
+//        $this->expectExceptionMessage("Invalid filter definition.");
+        $filter->toArray();
+    }
+}