Merge pull request #10 from answear/ANS-9289-increase-number-of-retur…

…n-products-br

ANS-9289 added param to SearchByFeatureRequest - max number of return products

.github/workflows/phpunit.yml

@@ -45,4 +45,4 @@ jobs:
  if: "${{ matrix.deps == 'low' }}"
 
  - name: "Run PHPUnit"
- run: "vendor/bin/phpunit"
+ run: "SYMFONY_DEPRECATIONS_HELPER=weak vendor/bin/phpunit"

README.md

@@ -63,14 +63,15 @@ To search products with previously found feature use `searchByFeature`
 ```php
 use Answear\WideEyesBundle\Service\SearchByImageClient;
 
-$detectAndFeturesResponse = $searchByImageClient->searchByFeature('featureId', 'label', 'gender', 'filters');
+$detectAndFeturesResponse = $searchByImageClient->searchByFeature('featureId', 'label', 'gender', 'filters', 'maxNumResults');
 ```
 
 Your agruments are:
  * `featureId` - featureId you got form DetectAndFeatures
  * `label` - label you got form DetectAndFeatures
  * `gender` - gender you got from DetectAndFeatures (optional)
  * `filters` - result filters (optional)
+ * `maxNumResults` - maximal number of return products (optional)
 
 In result you're getting `SearchByFeatureResponse` that contains all found products uids meeting your criteria.
 

src/Request/SearchByFeatureRequest.php

@@ -10,13 +10,15 @@ class SearchByFeatureRequest implements Request
  private string $label;
  private ?string $gender;
  private ?string $filters;
+ private ?int $maxNumResults;
 
- public function __construct(string $featureId, string $label, ?string $gender = null, ?string $filters = null)
+ public function __construct(string $featureId, string $label, ?string $gender = null, ?string $filters = null, ?int $maxNumResults = null)
  {
  $this->featureId = $featureId;
  $this->label = $label;
  $this->gender = $gender;
  $this->filters = $filters;
+ $this->maxNumResults = $maxNumResults;
  }
 
  public function toJson(): string
@@ -28,6 +30,7 @@ public function toJson(): string
  'label' => $this->label,
  'gender' => $this->gender,
  'filters' => $this->filters,
+ 'maxNumResults' => $this->maxNumResults,
  ]
  )
  );

tests/Unit/Request/SearchByFeatureRequestTest.php

@@ -34,4 +34,17 @@ public function requestWithGenderAndCountryIsCorrect(): void
  $request->toJson()
  );
  }
+
+ /**
+ * @test
+ */
+ public function requestWithMaxNumResultsIsCorrect(): void
+ {
+ $request = new SearchByFeatureRequest('featureId', 'label', null, null, 30);
+
+ self::assertSame(
+ '{"featureId":"featureId","label":"label","maxNumResults":30}',
+ $request->toJson()
+ );
+ }
 }