Merge pull request #5 from answear/search-with-image2

Add searchByFeature endpoint

README.md

@@ -56,6 +56,23 @@ $detectAndFeturesResponse = $searchByImageClient->getSimilar('url');
 Your agrument is: `url` - url to the image on which you want to detect products and features.
 In result you're getting `DetectAndFeaturesResponse` that contains all detection returned by api.
 
+#### Search by feature
+
+To search products with previously found feature use `searchByFeature`
+
+```php
+use Answear\WideEyesBundle\Service\SearchByImageClient;
+
+$detectAndFeturesResponse = $searchByImageClient->searchByFeature('featureId', 'label', 'gender', 'filters');
+```
+
+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)
+
+In result you're getting `SearchByFeatureResponse` that contains all found products uids meeting your criteria.
 
 Final notes
 ------------

src/DependencyInjection/AnswearWideEyesExtension.php

@@ -26,11 +26,11 @@ public function load(array $configs, ContainerBuilder $container): void
  $definition = $container->getDefinition(ConfigProvider::class);
  $definition->setArguments(
  [
- $config['similarApiUrl'],
- $config['searchByImageApiUrl'],
+ $config['similar']['apiUrl'],
+ $config['searchByImage']['apiUrl'],
  $config['publicKey'],
- $config['similarRequestTimeout'],
- $config['searchByImageRequestTimeout'],
+ $config['similar']['requestTimeout'],
+ $config['searchByImage']['requestTimeout'],
  $config['connectionTimeout'],
  ]
  );

src/DependencyInjection/Configuration.php

@@ -21,12 +21,20 @@ public function getConfigTreeBuilder(): TreeBuilder
 
  $treeBuilder->getRootNode()
  ->children()
- ->scalarNode('similarApiUrl')->defaultValue(self::SIMILAR_API_URL)->end()
- ->scalarNode('searchByImageApiUrl')->defaultValue(self::SEARCH_BY_IMAGE_API_URL)->end()
- ->scalarNode('publicKey')->cannotBeEmpty()->end()
- ->floatNode('connectionTimeout')->defaultValue(self::CONNECTION_TIMEOUT)->end()
- ->floatNode('similarRequestTimeout')->defaultValue(self::SIMILAR_REQUEST_TIMEOUT)->end()
- ->floatNode('searchByImageRequestTimeout')->defaultValue(self::SEARCH_BY_IMAGE_REQUEST_TIMEOUT)->end()
+ ->scalarNode('publicKey')->cannotBeEmpty()->end()
+ ->floatNode('connectionTimeout')->defaultValue(self::CONNECTION_TIMEOUT)->end()
+ ->arrayNode('similar')->addDefaultsIfNotSet()
+ ->children()
+ ->scalarNode('apiUrl')->defaultValue(self::SIMILAR_API_URL)->end()
+ ->floatNode('requestTimeout')->defaultValue(self::SIMILAR_REQUEST_TIMEOUT)->end()
+ ->end()
+ ->end()
+ ->arrayNode('searchByImage')->addDefaultsIfNotSet()
+ ->children()
+ ->scalarNode('apiUrl')->defaultValue(self::SEARCH_BY_IMAGE_API_URL)->end()
+ ->floatNode('requestTimeout')->defaultValue(self::SEARCH_BY_IMAGE_REQUEST_TIMEOUT)->end()
+ ->end()
+ ->end()
  ->end();
 
  return $treeBuilder;

src/Request/SearchByFeatureRequest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\WideEyesBundle\Request;
+
+class SearchByFeatureRequest implements Request
+{
+ private string $featureId;
+ private string $label;
+ private ?string $gender;
+ private ?string $filters;
+
+ public function __construct(string $featureId, string $label, ?string $gender = null, ?string $filters = null)
+ {
+ $this->featureId = $featureId;
+ $this->label = $label;
+ $this->gender = $gender;
+ $this->filters = $filters;
+ }
+
+ public function toJson(): string
+ {
+ return json_encode(
+ array_filter(
+ [
+ 'featureId' => $this->featureId,
+ 'label' => $this->label,
+ 'gender' => $this->gender,
+ 'filters' => $this->filters,
+ ]
+ )
+ );
+ }
+}

src/Response/SearchByFeatureResponse.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\WideEyesBundle\Response;
+
+use Answear\WideEyesBundle\Exception\MalformedResponse;
+use Webmozart\Assert\Assert;
+
+class SearchByFeatureResponse
+{
+ private array $uids;
+
+ private function __construct(array $uids)
+ {
+ Assert::allString($uids);
+ $this->uids = $uids;
+ }
+
+ public static function fromArray(array $response): SearchByFeatureResponse
+ {
+ try {
+ $products = $response['products'];
+ $responseUids = array_map(
+ static function ($item) {
+ Assert::keyExists($item, 'uid');
+
+ return $item['uid'];
+ },
+ $products,
+ );
+
+ return new self($responseUids);
+ } catch (\Throwable $e) {
+ throw new MalformedResponse($e->getMessage(), $response, $e);
+ }
+ }
+
+ public function getUids(): array
+ {
+ return $this->uids;
+ }
+}

src/Service/AbstractClient.php

@@ -13,9 +13,6 @@
 
 abstract class AbstractClient
 {
- protected const SEARCH_BY_ID_ENDPOINT = 'v4/SearchById';
- protected const DETECT_AND_FEATURES_ENDPOINT = 'v4/DetectAndFeatures';
-
  protected ConfigProvider $configProvider;
  protected ClientInterface $guzzle;
 

src/Service/SearchByImageClient.php

@@ -5,12 +5,17 @@
 namespace Answear\WideEyesBundle\Service;
 
 use Answear\WideEyesBundle\Request\DetectAndFeaturesRequest;
+use Answear\WideEyesBundle\Request\SearchByFeatureRequest;
 use Answear\WideEyesBundle\Response\DetectAndFeaturesResponse;
+use Answear\WideEyesBundle\Response\SearchByFeatureResponse;
 use GuzzleHttp\Client;
 use GuzzleHttp\ClientInterface;
 
 class SearchByImageClient extends AbstractClient
 {
+ private const DETECT_AND_FEATURES_ENDPOINT = 'v4/DetectAndFeatures';
+ private const SEARCH_BY_FEATURE = 'v4/SearchByFeature';
+
  public function __construct(ConfigProvider $configProvider, ?ClientInterface $client = null)
  {
  parent::__construct(
@@ -30,4 +35,15 @@ public function detectAndFeatures(string $image): DetectAndFeaturesResponse
  $this->request(self::DETECT_AND_FEATURES_ENDPOINT, new DetectAndFeaturesRequest($image))
  );
  }
+
+ public function searchByFeature(
+ string $featureId,
+ string $label,
+ ?string $gender = null,
+ ?string $filters = null
+ ): SearchByFeatureResponse {
+ return SearchByFeatureResponse::fromArray(
+ $this->request(self::SEARCH_BY_FEATURE, new SearchByFeatureRequest($featureId, $label, $gender, $filters))
+ );
+ }
 }

src/Service/SimilarClient.php

@@ -11,6 +11,8 @@
 
 class SimilarClient extends AbstractClient
 {
+ private const SEARCH_BY_ID_ENDPOINT = 'v4/SearchById';
+
  public function __construct(ConfigProvider $configProvider, ?ClientInterface $client = null)
  {
  parent::__construct(

tests/Unit/Request/SearchByFeatureRequestTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\WideEyesBundle\Tests\Unit\Request;
+
+use Answear\WideEyesBundle\Request\SearchByFeatureRequest;
+use PHPUnit\Framework\TestCase;
+
+class SearchByFeatureRequestTest extends TestCase
+{
+ /**
+ * @test
+ */
+ public function requestWithoutGenderAndCountryIsCorrect(): void
+ {
+ $request = new SearchByFeatureRequest('featureId', 'label');
+
+ self::assertSame(
+ '{"featureId":"featureId","label":"label"}',
+ $request->toJson()
+ );
+ }
+
+ /**
+ * @test
+ */
+ public function requestWithGenderAndCountryIsCorrect(): void
+ {
+ $request = new SearchByFeatureRequest('featureId', 'label', 'female', 'pl.inStock == true');
+
+ self::assertSame(
+ '{"featureId":"featureId","label":"label","gender":"female","filters":"pl.inStock == true"}',
+ $request->toJson()
+ );
+ }
+}

tests/Unit/Response/SearchByFeatureResponseTest.php

@@ -0,0 +1,107 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Answear\WideEyesBundle\Tests\Unit\Response;
+
+use Answear\WideEyesBundle\Exception\MalformedResponse;
+use Answear\WideEyesBundle\Response\SearchByFeatureResponse;
+use PHPUnit\Framework\TestCase;
+
+class SearchByFeatureResponseTest extends TestCase
+{
+ /**
+ * @test
+ */
+ public function correctlyReturnsUids(): void
+ {
+ $responseData = [
+ 'products' => [
+ [
+ 'uid' => 'uid1',
+ ],
+ [
+ 'uid' => 'uid2',
+ ],
+ [
+ 'uid' => 'uid3',
+ ],
+ ],
+ ];
+
+ $response = SearchByFeatureResponse::fromArray($responseData);
+
+ self::assertEquals(
+ [
+ 'uid1',
+ 'uid2',
+ 'uid3',
+ ],
+ $response->getUids()
+ );
+ }
+
+ /**
+ * @test
+ */
+ public function malformedResponseWithoutUidInOneItem(): void
+ {
+ $responseData = [
+ 'products' => [
+ [
+ 'uid' => 'uid1',
+ ],
+ [
+ 'id' => 'uid2',
+ ],
+ [
+ 'uid' => 'uid3',
+ ],
+ ],
+ ];
+
+ $this->expectException(MalformedResponse::class);
+ SearchByFeatureResponse::fromArray($responseData);
+ }
+
+ /**
+ * @test
+ */
+ public function malformedResponseWithoutUid(): void
+ {
+ $responseData = [
+ 'products' => [
+ [
+ 'result' => 'uid1',
+ ],
+ [
+ 'result' => 'uid2',
+ ],
+ ],
+ ];
+
+ $this->expectException(MalformedResponse::class);
+ SearchByFeatureResponse::fromArray($responseData);
+ }
+
+ /**
+ * @test
+ */
+ public function malformedResponseWithoutProducts(): void
+ {
+ $responseData = [
+ [
+ 'uid' => 'uid1',
+ ],
+ [
+ 'uid' => 'uid2',
+ ],
+ [
+ 'uid' => 'uid3',
+ ],
+ ];
+
+ $this->expectException(MalformedResponse::class);
+ SearchByFeatureResponse::fromArray($responseData);
+ }
+}

tests/Unit/Service/SearchByImageClientTest.php → tests/Unit/Service/SearchByImageClientDetectAndFeatureTest.php

@@ -9,7 +9,7 @@
 use Answear\WideEyesBundle\Service\SearchByImageClient;
 use GuzzleHttp\Psr7\Response;
 
-class SearchByImageClientTest extends AbstractClientTest
+class SearchByImageClientDetectAndFeatureTest extends AbstractClientTest
 {
  private const IMAGE_PATH = 'path';
 
@@ -58,7 +58,7 @@ public function successfulDetectAndFeatures(): void
  /**
  * @test
  */
- public function responeWithWrongPropertiesInDetecions(): void
+ public function responseWithWrongPropertiesInDetections(): void
  {
  $this->guzzleHandler->append(new Response(200, [], $this->prepareNotProperResponse()));