Merge pull request #116 from zalando-incubator/115-reco-type

feat(Recos): Type param for getRecommendations() added

Author: artdaw

src/api/__tests__/data/recommendation_service_response_for_brand.json

@@ -0,0 +1,68 @@
+{
+  "brand": [ {
+      "id" : "SO254J000-C00",
+      "tracking_string" : "TRACKING_STRING",
+      "name" : "6 PACK - Socken - anthracite/grey",
+      "brand" : {
+        "name" : "s.Oliver"
+      },
+      "lowest_price" : {
+        "amount" : 15.95,
+        "currency" : "EUR"
+      },
+      "media" : {
+        "media_items" : [
+        {
+          "type" : "IMAGE_PARTNER",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@1.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        },
+        {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@1.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        }, {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@2.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        }, {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@3.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        }, {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@4.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        }, {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@5.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        }, {
+          "type" : "IMAGE",
+          "path" : "SO/25/4J/00/0C/00/SO254J000-C00@6.1.jpg",
+          "media_character" : "UNSPECIFIED"
+        } ]
+      }
+    }, {
+      "id" : "BU182F003-Q11",
+      "name" : "6 PACK - Füßlinge - black",
+      "brand" : {
+        "name" : "Bugatti"
+      },
+      "lowest_price" : {
+        "amount" : 13.95,
+        "currency" : "EUR"
+      },
+      "media" : {
+        "media_items" : [ {
+          "type" : "IMAGE",
+          "path" : "BU/18/2F/00/3Q/11/BU182F003-Q11@4.jpg",
+          "media_character" : "NON_MODEL"
+        }, {
+          "type" : "IMAGE",
+          "path" : "BU/18/2F/00/3Q/11/BU182F003-Q11@3.jpg",
+          "media_character" : "NON_MODEL"
+        } ]
+      }
+    }]
+}

src/api/__tests__/recommendation_models_tests.js

@@ -6,15 +6,17 @@ import AtlasSDK from '../../index';
 const fs = require('fs');
 const path = require('path');
 
-const RecommendedJSON = fs.readFileSync(path.join(__dirname, 'data/recommendation_service_response.json'), 'utf8');
+const recommendedJSON = fs.readFileSync(path.join(__dirname, 'data/recommendation_service_response.json'), 'utf8');
+const recommendedBrandJSON = fs.readFileSync(path.join(__dirname,
+  'data/recommendation_service_response_for_brand.json'), 'utf8');
 const configJson = fs.readFileSync(path.join(__dirname, 'data/config_service_response.json'), 'utf8');
 
-test('Article should be initialized from JSON object', async t => {
+test('Recommended articles should be initialized from JSON object', async t => {
   fetchMock.get('https://atlas-config-api.dc.zalan.do/api/config/CLIENT_ID-staging.json', configJson);
 
   const url = 'https://catalog_api.com/api/articles/AD112B0F6-A11/recommendations/?client_id=CLIENT_ID&anon_id=1234';
 
-  fetchMock.get(url, RecommendedJSON);
+  fetchMock.get(url, recommendedJSON);
 
   const sdk = await AtlasSDK.configure({
     client_id: 'CLIENT_ID',
@@ -45,3 +47,42 @@ test('Article should be initialized from JSON object', async t => {
   t.is(recommendedArticles[0].images[1].resolutions.large, imgURL);
   t.falsy(recommendedArticles[recommendedArticles.length - 1].trackingString);
 });
+
+test('Recommended same brand articles should be initialized from JSON object', async t => {
+  fetchMock.get('https://atlas-config-api.dc.zalan.do/api/config/CLIENT_ID-staging.json', configJson);
+
+  const url = 'https://catalog_api.com/api/articles/AD112B0F6-A11/recommendations/?client_id=CLIENT_ID&anon_id=12345';
+
+  fetchMock.get(url, recommendedBrandJSON);
+
+  const sdk = await AtlasSDK.configure({
+    client_id: 'CLIENT_ID',
+    sales_channel: 'SALES_CHANNEL',
+    is_sandbox: true
+  });
+
+  const recommendedArticles = await sdk.getRecommendations('AD112B0F6-A11',
+    {
+      type: 'brand',
+      reco_id: '12345',
+      tracking_String: 'TRACKING_STRING'
+    }
+  );
+
+  const imgURL = 'https://mosaic01.ztat.net/vgs/media/large/SO/25/4J/00/0C/00/SO254J000-C00@1.1.jpg';
+
+  t.is(recommendedArticles[0].id, 'SO254J000-C00');
+  t.is(recommendedArticles[0].brand.name, 's.Oliver');
+  t.is(recommendedArticles[0].name, '6 PACK - Socken - anthracite/grey');
+  t.is(recommendedArticles[0].lowestPrice.amount, 15.95);
+  t.is(recommendedArticles[0].lowestPrice.currency, 'EUR');
+  t.is(recommendedArticles[0].images.length, 7);
+  t.is(recommendedArticles[0].images[0].type, 'IMAGE_PARTNER');
+  t.is(recommendedArticles[0].images[0].mediaCharacter, 'UNSPECIFIED');
+  t.is(recommendedArticles[0].images[0].resolutions.large, imgURL);
+  t.is(recommendedArticles[0].images[1].type, 'IMAGE');
+  t.is(recommendedArticles[0].images[1].mediaCharacter, 'UNSPECIFIED');
+  t.is(recommendedArticles[0].images[1].resolutions.large, imgURL);
+  t.falsy(recommendedArticles[recommendedArticles.length - 1].trackingString);
+});
+

src/api/atlas_sdk_client.js

@@ -338,11 +338,12 @@ class AtlasSDKClient {
    */
   getRecommendations(sku, options = {
     reco_id: '',
-    tracking_string: ''
+    tracking_string: '',
+    type: ''
   }) {
     const config = this.config;
     const catalogUrl = config.catalogApi.url;
-    const type = config.recommendations[0].type;
+    const type = options.type ? options.type : config.recommendations[0].type;
     const url = `${catalogUrl}/articles/${sku}/recommendations/?client_id=${config.clientId}&anon_id=${options.reco_id}`; /* eslint max-len: 0 */
     const GetRecommendationsEndpoint = {
       url: url,