Merge pull request #19 from answear/dev

Must filters.
answear · Jun 16, 2020 · 6178fa9 · 6178fa9
2 parents 2f2c06c + 60c9ede
commit 6178fa9
Show file tree

Hide file tree

Showing 8 changed files with 180 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -158,7 +158,7 @@ use Answear\LuigisBoxBundle\ValueObject\SearchUrlBuilder;
 // ...
 
 $page = 3;
-$urlBuilder = new SearchUrlBuilder('tracker-id', $page);
+$urlBuilder = new SearchUrlBuilder($page);
 $urlBuilder
     ->setQuery('nice top')
     ->addFilter('type', 'product')
@@ -168,7 +168,7 @@ $urlBuilder
     ->addPrefer('brand', 'Answear')
     ->setSort('size', 'asc');
 
-//the above code produces a url query like `size=10&tracker_id=tracker-id&page=3&q=nice+top&f%5B0%5D=type%3Aproduct&f%5B1%5D=category%3Atop&f%5B2%5D=brand%3AMedicine&f%5B3%5D=brand%3AAnswear&sort=size%3Aasc&prefer%5B0%5D=brand%3AAnswear`
+//the above code produces a url query like `size=10&page=3&q=nice+top&f%5B0%5D=type%3Aproduct&f%5B1%5D=category%3Atop&f%5B2%5D=brand%3AMedicine&f%5B3%5D=brand%3AAnswear&sort=size%3Aasc&prefer%5B0%5D=brand%3AAnswear`
 
 /** @var \Answear\LuigisBoxBundle\Service\SearchRequest $request **/
 $searchResponse = $request->search($urlBuilder);

diff --git a/src/LuigisBoxBundle/Factory/SearchFactory.php b/src/LuigisBoxBundle/Factory/SearchFactory.php
@@ -8,6 +8,7 @@
 use Answear\LuigisBoxBundle\ValueObject\SearchUrlBuilder;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Uri;
+use Webmozart\Assert\Assert;
 
 class SearchFactory
 {
@@ -25,9 +26,19 @@ public function __construct(ConfigProvider $configProvider)
 
     public function prepareRequest(SearchUrlBuilder $searchUrlBuilder): Request
     {
+        $urlQuery = $searchUrlBuilder->toUrlQuery();
+        Assert::notEmpty($urlQuery);
+
         return new Request(
             'GET',
-            new Uri($this->configProvider->getHost() . self::ENDPOINT . '?' . $searchUrlBuilder->toUrlQuery())
+            new Uri(
+                sprintf(
+                    '%s?tracker_id=%s&%s',
+                    $this->configProvider->getHost() . self::ENDPOINT,
+                    $this->configProvider->getPublicKey(),
+                    $urlQuery
+                )
+            )
         );
     }
 }
diff --git a/src/LuigisBoxBundle/Service/ConfigProvider.php b/src/LuigisBoxBundle/Service/ConfigProvider.php
@@ -65,6 +65,11 @@ public function getHost(): string
         return $this->host;
     }
 
+    public function getPublicKey(): string
+    {
+        return $this->publicKey;
+    }
+
     public function getConnectionTimeout(): float
     {
         return $this->connectionTimeout;

diff --git a/src/LuigisBoxBundle/ValueObject/SearchUrlBuilder.php b/src/LuigisBoxBundle/ValueObject/SearchUrlBuilder.php
@@ -14,6 +14,7 @@ class SearchUrlBuilder
     public const ARRAY_ITEM_SEPARATOR = ':';
     public const LIST_SEPARATOR = ',';
     public const DEFAULT_SIZE = 10;
+    public const RANGE_SEPARATOR = '|';
     private const AVAILABLE_ORDER_DIRECTIONS = ['asc', 'desc'];
 
     /**
@@ -31,6 +32,11 @@ class SearchUrlBuilder
      */
     private $filters;
 
+    /**
+     * @var array|null
+     */
+    private $mustFilters;
+
     /**
      * @var int
      */
@@ -41,11 +47,6 @@ class SearchUrlBuilder
      */
     private $sort;
 
-    /**
-     * @var string
-     */
-    private $trackerId;
-
     /**
      * @var string|null
      */
@@ -86,9 +87,8 @@ class SearchUrlBuilder
      */
     private $userId;
 
-    public function __construct(string $trackerId, int $page = 1)
+    public function __construct(int $page = 1)
     {
-        $this->trackerId = $trackerId;
         $this->page = $page;
     }
 
@@ -125,6 +125,10 @@ public function addFilter(string $key, string $value): self
 
     public function setFilters(array $filters): self
     {
+        if (\count($this->filters ?? []) > 0) {
+            throw new \LogicException('You already have the filters set. Use resetFilters() method to clear them first.');
+        }
+
         $keys = array_keys($filters);
         Assert::allString($keys, 'All filters keys must be string.');
 
@@ -133,6 +137,47 @@ public function setFilters(array $filters): self
         return $this;
     }
 
+    public function addMustFilter(string $key, string $value): self
+    {
+        $this->mustFilters[$key] = $this->mustFilters[$key] ?? [];
+        if (\is_string($this->mustFilters[$key])) {
+            $this->mustFilters[$key] = [$this->mustFilters[$key]];
+        }
+        $this->mustFilters[$key][] = $value;
+
+        $this->mustFilters[$key] = array_unique($this->mustFilters[$key]);
+
+        return $this;
+    }
+
+    public function setMustFilters(array $filters): self
+    {
+        if (\count($this->mustFilters ?? []) > 0) {
+            throw new \LogicException('You already have the must filters set. Use resetMustFilters() method to clear them first.');
+        }
+
+        $keys = array_keys($filters);
+        Assert::allString($keys, 'All must filters keys must be string.');
+
+        $this->mustFilters = $filters;
+
+        return $this;
+    }
+
+    public function resetFilters(): self
+    {
+        $this->filters = null;
+
+        return $this;
+    }
+
+    public function resetMustFilters(): self
+    {
+        $this->mustFilters = null;
+
+        return $this;
+    }
+
     public function setSize(int $size): self
     {
         $this->size = $size;
@@ -223,7 +268,6 @@ public function toUrlQuery(): string
     {
         $queryFields = [
             'size' => $this->size,
-            'tracker_id' => $this->trackerId,
             'page' => $this->page,
         ];
 
@@ -253,6 +297,20 @@ public function toUrlQuery(): string
             $queryFields['f'] = $filtersFields;
         }
 
+        if (null !== $this->mustFilters) {
+            $filtersFields = [];
+            foreach ($this->mustFilters as $key => $values) {
+                if (\is_array($values)) {
+                    foreach ($values as $value) {
+                        $filtersFields[] = $key . self::ARRAY_ITEM_SEPARATOR . $value;
+                    }
+                } else {
+                    $filtersFields[] = $key . self::ARRAY_ITEM_SEPARATOR . $values;
+                }
+            }
+            $queryFields['f_must'] = $filtersFields;
+        }
+
         if (null !== $this->sort) {
             $queryFields['sort'] = $this->sort;
         }
@@ -309,7 +367,7 @@ public function toUrlQuery(): string
             }
         }
 
-        return http_build_query($queryFields);
+        return preg_replace('/%5B(\d+)%5D=/', '%5B%5D=', http_build_query($queryFields));
     }
 
     public function __toString(): string

diff --git a/tests/DataProvider/SearchDataProvider.php b/tests/DataProvider/SearchDataProvider.php
@@ -10,7 +10,7 @@ class SearchDataProvider
 {
     public static function provideSuccessObjects(): iterable
     {
-        $urlBuilder = new SearchUrlBuilder('111111-222222', 2);
+        $urlBuilder = new SearchUrlBuilder(2);
         $urlBuilder->addFilter('type', 'product');
         $urlBuilder->setQuicksearchTypes(['category']);
 
@@ -158,7 +158,7 @@ public static function provideSuccessObjects(): iterable
             ],
         ];
 
-        $urlBuilder = new SearchUrlBuilder('111111-222222');
+        $urlBuilder = new SearchUrlBuilder();
         $urlBuilder->setQuery('fila');
 
         yield [
@@ -198,7 +198,7 @@ public static function provideSuccessObjects(): iterable
             ],
         ];
 
-        $urlBuilder = new SearchUrlBuilder('111111-222222');
+        $urlBuilder = new SearchUrlBuilder();
         $urlBuilder->setQuery('fila');
         $urlBuilder->addFilter('price', '5|2');
 

diff --git a/tests/Unit/Factory/SearchFactoryTest.php b/tests/Unit/Factory/SearchFactoryTest.php
@@ -23,7 +23,7 @@ public function prepareRequestSuccessfully(): void
 
         $this->assertSame('GET', $request->getMethod());
         $this->assertSame('host/search', $request->getUri()->getPath());
-        $this->assertSame('size=10&tracker_id=tracker-id&page=34&q=query-string', $request->getUri()->getQuery());
+        $this->assertSame('tracker_id=key&size=10&page=34&q=query-string', $request->getUri()->getQuery());
 
         $this->assertSame('', $request->getBody()->getContents());
     }
@@ -37,7 +37,7 @@ private function getFactory(): SearchFactory
 
     private function getBuilderUrl(): SearchUrlBuilder
     {
-        $builder = new SearchUrlBuilder('tracker-id', 34);
+        $builder = new SearchUrlBuilder(34);
         $builder->setQuery('query-string');
 
         return $builder;

diff --git a/tests/Unit/Service/SearchRequestTest.php b/tests/Unit/Service/SearchRequestTest.php
@@ -44,7 +44,7 @@ public function searchWithErrors(): void
     {
         $this->expectException(BadRequestException::class);
 
-        $urlBuilder = new SearchUrlBuilder('111111-222222', 2);
+        $urlBuilder = new SearchUrlBuilder(2);
         $context = new Context();
         $context->setGeoLocationField('geo_location');
         $urlBuilder->setContext($context);