aboutyou-sdk 0.0.15 → 0.0.16

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDI2YWFmYTE1OWEzMDIxM2ZiYzgxN2IwNWExOTc1MjM5MjI3MWRkNw==
+    NjE0NzJjNmJjNzUxMWEyMzA4OGE4NDUxYzFjMDc1NzhmNTI1MTE0Yg==
   data.tar.gz: !binary |-
-    OTMyZGRkNjUzOWRiZDAwMGFmMTczMTJjZWMxMDdiOTYxY2IzNThmYg==
+    NDdhMzIxNzM5OTdmMmMxZGI2YzBiOThkNTk5OTc2NDkyMThjMjMzNA==
 SHA512:
   metadata.gz: !binary |-
-    ZDQ4N2MwZjIzODI4NWVmNzUyZDhhZGM3ZTI3ZWM4NWE4MzMxMzI3MTVkNzA3
-    MjMwNDk2NmZlYzBhNjhmOGJhZjRjMDAzN2FhODhkODkwNDQyYjU3Y2QzODRi
-    NTFlMzM2MjU4MDZiNDBjZGU2YzI1NDQ5NzhmYjI3MDVkOTI4NTI=
+    MjRkMWY0ODQyNWYzOTFlMTY5MjhhOWMxNmRjN2I2N2EyMTMxMmZjY2Y0NDBl
+    OGRmYTI0YmJiNmIwZWQzOWZjZmM3MTJhM2E0M2M1OTZkMDg1NWMyZDliNDcz
+    MzdkY2Y1YWEyOGZlNWIzZGIzOGQ1Y2I5OGM1MzE1OTFlNDk2N2E=
   data.tar.gz: !binary |-
-    OWZiNzIxNWNiOWNlMTRlZjY3OTE0Y2ZlYzI2ZGE1ZmZhYTRmZjUwZDM4ZGVh
-    NTg2YTljMzM3NGQyYTViM2FjNTBiMjkyMTFmYzQ3OTQxY2U5MjAwODU2NDM1
-    MTYzYWViOWMzNTM2NTNmZTgzNzlhOGQwODVlNmY2YTM1MzZiYTE=
+    Njk4Mjg0MDJlMThjNDdiZmNiZjRhODFlMmEzZjc1NTc5MjQ4NWQwNDFlYWY3
+    ZDY4YTBmM2QwYzRlNmY1MWUzYTA5ZDZhNmFkNjcyODdmMGEzYWY5MmU1NGQw
+    MDY5ODIwZmYzMDI2M2EwNWQzZTYxNjQyNjUzYjY4ZmNhYWQ4OWU=

data/lib/aboutyou-sdk.rb

@@ -303,7 +303,7 @@ class AY
     # we allow to pass a single ID instead of an array
     ids = Array(ids)
     result = query.fetchProductsByIds(ids, fields).executeSingle
-    productsNotFound = result.getProductsNotFound
+    productsNotFound = result.productsNotFound
     
     if !productsNotFound.empty? && self.logger
       self.logger.warning('products not found: appid=' + self.appId + ' product ids=[' + productsNotFound.join(',') + ']')

data/lib/aboutyou-sdk/Factory/DefaultModelFactory.rb

@@ -561,23 +561,18 @@ module AboutYou
         #   - a Hash containing pairs of category_id => category
         ###
         def createCategoriesFacets(jsonArray)
-          counts = []
+          categoryManager =self.categoryManager
+
+          flattenCategories = {}
           jsonArray.each do |item|
-            counts[item["term"]] = item["count"]
-          end
+            id = item["term"]
+            category = categoryManager.category(id)
+            next unless category
 
-          # fetch all categories from API
-          flattenCategories = self.shopApi.fetchCategoriesByIds.categories
-          flattenCategories.each do |id ,category|
-            if counts[category.id]
-              category.productCount = counts[category.id]
-              if flattenCategories[String(category.parentId)]
-                category.parent = flattenCategories[String(category.parentId)].addChild(category)
-              end
-            else
-              flattenCategories.delete(id)
-            end
+            category.productCount = item["count"]
+            flattenCategories[id] = category
           end
+
           flattenCategories
         end
         

data/lib/aboutyou-sdk/Model/CategoryManager/DefaultCategoryManager.rb

@@ -29,11 +29,13 @@ module AboutYou
           # * *Args*    :
           #   - +cache+ -> The cache client set on the AY class
           #   - +appId+ -> The App-Id of the App
+          #   - +shopApi+ -> an Instance of AY
           #
           # * *Returns* :
           #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
           ###
           def initialize(cache = nil, appId = '', shopApi)
+              self.categories = {} 
               self.shopApi = shopApi
               self.cache    = cache
               self.cacheKey = 'AY:SDK:' + String(appId) + ':categories'
@@ -73,15 +75,11 @@ module AboutYou
           #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
           ###
           def parseJson(jsonObject, factory)
-            unless self.categories
-              self.categories = {} 
-            
-              if jsonObject
-                self.cacheCategories(jsonObject)
-                self.parentChildIds = jsonObject["parent_child"]
-                jsonObject["ids"].each do |id, jsonCategory|
-                    self.categories[id] = factory.createCategory(jsonCategory)
-                end
+            if jsonObject && self.categories.empty?
+              self.cacheCategories(jsonObject) if self.cache
+              self.parentChildIds = jsonObject["parent_child"]
+              jsonObject["ids"].each do |id, jsonCategory|
+                  self.categories[id] = factory.createCategory(jsonCategory)
               end
             end
           end
@@ -91,10 +89,10 @@ module AboutYou
           # categories or not
           #
           # * *Returns* :
-          #   - a boolean which determines whether this catManager has read-in categories or not
+          #   - a boolean which determines whether this Category Manager has read-in categories or not
           ###
           def isEmpty
-            self.categories == nil
+            self.categories.empty?
           end
 
           ###

data/lib/aboutyou-sdk/Model/FacetGroupSet.rb

@@ -25,8 +25,8 @@ module AboutYou
           def initialize(ids)
               self.facets = Hash.new
               self.groups = Hash.new
-              ids.each do |facetIds|
-                  if !(facetIds.is_a? Hash)
+              ids.each do |key, facetIds|
+                  unless facetIds.is_a? Array
                       raise '\InvalidArgumentException! ids must be an associative array of array: [$groupId => [$facetId,...],...]'
                   end
               end
@@ -67,30 +67,27 @@ module AboutYou
           end
 
           def fetch
-          
-              unless self.facets 
-                return
-              end
-              self.ids.each do |idPair|
-
-                  idPair.each do |groupId, facetIds|
-                      facet = self.class.facetManager.facet(groupId, facetIds[0])
+            unless self.facets && self.facets.empty?
+              return
+            end
+            
+            self.ids.each do |groupId, facetIds|
+              facet = self.class.facetManager.facet(groupId, facetIds[0])
 
-                      unless facet
-                        # TODO: error handling
-                          next
-                      end
+              unless facet
+                # TODO: error handling
+                  next
+              end
 
-                      if @groups[groupId]
-                          group = @groups[groupId]
-                      else
-                          group = AboutYou::SDK::Model::FacetGroup.new(groupId, facet.groupName)
-                          @groups[groupId] = group
-                      end
-                      group.addFacet(facet);
-                      self.facets[facet.uniqueKey] = facet;
-                  end
+              if @groups[groupId]
+                  group = @groups[groupId]
+              else
+                  group = AboutYou::SDK::Model::FacetGroup.new(groupId, facet.groupName)
+                  @groups[groupId] = group
               end
+              group.addFacet(facet);
+              self.facets[facet.uniqueKey] = facet;
+            end
           end
 
            ###
@@ -217,11 +214,11 @@ module AboutYou
 
           def self.mergeFacetIds(facetIdsArray)
           
-              ids = Array(nil);
-              facetIdsArray.each do |facetIds|
-                  facetIds.each do |groupId,facetIds|
+              ids = {}
+              facetIdsArray.each do |facetIdsHash|
+                  facetIdsHash.each do |groupId, facetIds|
                       if (ids[Integer(groupId)]) 
-                          ids[Integer(groupId)] = ids[Integer(groupId)] + facetIds;
+                          ids[Integer(groupId)] = (ids[Integer(groupId)] + facetIds).uniq
                       else 
                           ids[Integer(groupId)] = facetIds;
                       end

data/lib/aboutyou-sdk/Model/FacetManager/DefaultFacetManager.rb

@@ -2,73 +2,123 @@ module AboutYou
   module SDK
     module Model
       module FacetManager
+        ###
+        # This class is responsible for handling all the logic when working with
+        # Facets
+        #
+        # author:: Collins GmbH & Co KG
+        ###
         class DefaultFacetManager
-        
-            DEFAULT_CACHE_DURATION = 7200;
+          # the duration for the cached values to live
+          DEFAULT_CACHE_DURATION = 7200;
 
-            # @var Facet[][] */
-            @facets
-            attr_accessor :facets
+          # a Hash containing instances of AboutYou::SDK::Model::Facet
+          attr_accessor :facets
+          # an Instance of a class of AboutYou::SDK::CacheProvider
+          attr_accessor :cache
+          # The key for which the values are stored in the cache
+          attr_accessor :cacheKey
+          # an Instance of AY
+          attr_accessor :shopApi
 
-            # @var Cache */
-            @cache;
-            attr_accessor :cache
-            
-            # @var string */
-            attr_accessor :cacheKey
-            attr_accessor :shopApi
+          ###
+          # the Constructor for the DefaultFacetManager class
+          #
+          # * *Args*    :
+          #   - +cache+ -> The cache client set on the AY class
+          #   - +appId+ -> The App-Id of the App
+          #   - +shopApi+ -> an Instance of AY
+          #
+          # * *Returns* :
+          #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultFacetManager
+          ###
+          def initialize(cache = nil, appId = '', shopApi)
+            self.cache    = cache
+            self.facets   = {}
+            self.shopApi  = shopApi
+            self.cacheKey = 'AY:SDK:' + String(appId) + ':facets'
 
-             ###
-             # @param Cache $cache
-             # @param string $appId
-             ###
-            def initialize(cache = nil, appId = '', shopApi)
-            
-                self.cache    = cache;
-                self.shopApi  = shopApi
-                self.cacheKey = 'AY:SDK:' + String(appId) + ':facets';
+            self.loadCachedFacets
+          end
 
-                self.loadCachedFacets
+          ###
+          # Gets the cached Facets for this app
+          ###
+          def loadCachedFacets
+            parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
+          end
+          
+          ###
+          # This method caches the currently read-in Facets
+          ###
+          def cacheFacets(jsonObject)
+            self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
+          end
+          
+          ###
+          # This method clears the cache
+          ###
+          def clearCache
+            self.cache.delete(self.cacheKey)
+          end
+          
+          ###
+          # this method parses a json object received from the api and 
+          # creates models from it
+          #
+          # * *Args*    :
+          #   - +jsonObject+ -> the jsonObject received from the api
+          #   - +factory+ -> the model factory used for creating the models
+          #
+          # * *Returns* :
+          #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultFacetManager
+          ###
+          def parseJson(jsonObject, factory, query=nil)
+            if self.facets.empty? && jsonObject
+              self.cacheFacets(jsonObject) if self.cache
+              self.facets = factory.createFacetsList(jsonObject, query)
             end
+          end
+          
+          ###
+          # this method checks whether this facet manager has read-in
+          # facets or not
+          #
+          # * *Returns* :
+          #   - a boolean which determines whether this facet Manager has read-in facets or not
+          ###
+          def isEmpty
+            self.facets.empty?
+          end
 
-            def loadCachedFacets
-              parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
-            end
-
-            def cacheFacets(jsonObject)
-              self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
-            end
-
-            def clearCache
-              self.cache.delete(self.cacheKey)
-            end
-            
-            def parseJson(jsonObject, factory, query=nil)
-              unless self.facets
-                if jsonObject
-                  self.cacheFacets(jsonObject)
-                  self.facets = factory.createFacetsList(jsonObject, query)
-                end
-              end
-            end
-
-            def isEmpty
-                return (self.facets.empty?)
-            end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def facet(groupId, id)
-            
-                lookupKey = AboutYou::SDK::Model::Facet.new(0, "", [], 0, "").uniqueKey(groupId, id);
-                return (self.facets[lookupKey]) ? self.facets[lookupKey] : nil;
-            end
-            
-            def facetsByGroupIds(groupIds = [])
-              groupIds = groupIds.map { |gId| Integer(gId) }
-              self.facets.select { |key, facet| groupIds.include?(facet.groupId) }
-            end
+          ###
+          # This method is used for getting a facet model by a given groupId and facetId
+          # 
+          # * *Args*    :
+          #   - +groupId+ -> the group id for which a facet model should be returned
+          #   - +id+ -> the facet id for which a facet model should be returned
+          #
+          # * *Returns* :
+          #   - either an instance of AboutYou::SDK::Model::Facet or nil if +groupId+ or +id+ is not found
+          ###
+          def facet(groupId, id)
+            lookupKey = AboutYou::SDK::Model::Facet.new(0, "", [], 0, "").uniqueKey(groupId, id);
+            self.facets[lookupKey] ? self.facets[lookupKey] : nil
+          end
+          
+          ###
+          # This method is used for getting all facets for an Array of group ids
+          # 
+          # * *Args*    :
+          #   - +groupIds+ -> an Array containing group ids for which facet models should be returned
+          #
+          # * *Returns* :
+          #   - a Hash containing pairs of facetId => instance of AboutYou::SDK::Model::Facet
+          ###
+          def facetsByGroupIds(groupIds = [])
+            groupIds = groupIds.map { |gId| Integer(gId) }
+            self.facets.select { |key, facet| groupIds.include?(facet.groupId) }
+          end
         end
       end
     end

data/lib/aboutyou-sdk/Model/Product.rb

@@ -79,7 +79,6 @@ module AboutYou
       end
 
       def self.parseVariants(jsonObject, factory, product, attributeName = 'variants')
-
           variants = Array(nil);
           if (jsonObject[attributeName]) 
               jsonObject[attributeName].each do |jsonVariant|
@@ -124,7 +123,6 @@ module AboutYou
           if (ids === nil) 
               ids = self.parseFacetIdsInBrand(jsonObject);
           end
-
           return (ids != nil) ? ids : Array(nil);
       end
 
@@ -139,7 +137,7 @@ module AboutYou
 
       def parseAttributesJson(attributesJsonObject)
       
-          ids = Hash.new
+          ids = {}
      
           attributesJsonObject.each do |group, facetIds|
               gid = group[11..group.length] # prefix "attributes"
@@ -148,33 +146,31 @@ module AboutYou
               facetIds = Array(facetIds)
               ids[gid] = facetIds;
           end
-     
-      return ids;
+      return ids
       end
 
       def parseFacetIdsInVariants(jsonObject)
 
           if (jsonObject["variants"]) 
-              ids = Array(nil);
+              ids = []
               jsonObject["variants"].each do |variant|
-                  ids.push(parseAttributesJson(variant["attributes"]));
+                  ids.push(parseAttributesJson(variant["attributes"]))
               end
-              ids = AboutYou::SDK::Model::FacetGroupSet.mergeFacetIds(ids);
-
-              return ids;
+              ids = AboutYou::SDK::Model::FacetGroupSet.mergeFacetIds(ids)
+              return ids
           elsif (jsonObject["default_variant"]) 
-              ids = parseAttributesJson(jsonObject["default_variant"]["attributes"]);
+              ids = parseAttributesJson(jsonObject["default_variant"]["attributes"])
 
-              return ids;
+              return ids
           end
 
-          return nil;
+          nil
       end
 
       def parseFacetIdsInBrand(jsonObject)
       
-          if (!jsonObject["brand_id"]) 
-              return nil;
+          unless jsonObject["brand_id"] 
+              return nil
           end
   
           Hash['0' => jsonObject["brand_id"]];
@@ -186,7 +182,6 @@ module AboutYou
           if (self.facetIds.empty?) 
               raise 'ShopApi\Exception\RuntimeException! To use this method, you must add the field ProductFields::ATTRIBUTES_MERGED to the "product search" or "products by ids"'
           end
-  
           self.facetGroups = AboutYou::SDK::Model::FacetGroupSet.new(self.facetIds);
       end
   
@@ -195,11 +190,10 @@ module AboutYou
        ###
       def facetGroupSet()
       
-          if (!self.facetGroups)
+          unless @facetGroups
               generateFacetGroupSet
           end
-  
-          self.facetGroups;
+          @facetGroups
       end
   
        ###
@@ -458,7 +452,6 @@ module AboutYou
        # @return \Collins\ShopApi\Model\Facet
        ###
       def brand()
-      
           self.facetGroupSet().facet(AboutYou::SDK::Constants::FACET_BRAND, self.brandId);
       end
   

data/lib/aboutyou-sdk/Model/ProductSearchResult/SaleCounts.rb

@@ -36,7 +36,7 @@ module AboutYou
               saleCounts = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"]);
               saleCounts.parseTerms(jsonObject["terms"]);
 
-              return self;
+              saleCounts
           end
 
            ###

data/lib/aboutyou-sdk/Model/ProductsResult.rb

@@ -42,7 +42,7 @@ module AboutYou
          ###
          # @return integer[] array of product ids
          ###
-        def getProductsNotFound()
+        def productsNotFound()
           
             return self.idsNotFound;
         end

data/lib/aboutyou-sdk/Model/Variant.rb

@@ -139,15 +139,14 @@ module AboutYou
 
           def parseFacetIds(jsonObject)
           
-              ids = Array(nil)
+              ids = {}
               if !(jsonObject["attributes"].empty?) 
                   jsonObject["attributes"].each do |group, aIds|
                       gid = group[11..group.length] # rm prefix "attributs_"
-                      ids.push(Hash[Integer(gid) => aIds]);
+                      ids[Integer(gid)] = aIds
                   end
               end
-
-              return ids;
+              return ids
           end
           
                 

data/lib/aboutyou-sdk/Query.rb

@@ -191,7 +191,7 @@ module AboutYou
        #   - Instance of AboutYou::SDK::Query
        ###      
       def requireCategoryTree(fetchForced = false)
-        if fetchForced || !self.factory.categoryManager.isEmpty
+        unless fetchForced || self.factory.categoryManager.isEmpty
             return self
         end
 

data/tests/Sinatra-test/Main.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
 
 get "/" do
-  erb :'testDocExample'
+  erb :'docExampleProducts'
 end

data/tests/testVariantsByIds.rb

@@ -1,6 +1,6 @@
 require 'sinatra'
 require 'pry_debug'
-require 'aboutyou-sdk'
+require_relative '../lib/aboutyou-sdk.rb'
 
 class AY
   attr_accessor :result
@@ -21,12 +21,14 @@ class AY
   end
 end
 
-shop = AY.new(281, 'e6068c4ca020262613d06122663cb300')
+shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', "session_id", AboutYou::SDK::CacheProvider::Redis.new(Redis.new))
 shop.result = ""
 
 variantResult = shop.fetchVariantsByIds([7832543])
 variantResult.variants.each do |key, variant|
-  shop.result = shop.result + String(variant.id) + '<img src="' + variant.image.url + '">' + '</br>'
+  variant.facetIds.each do |fId|
+    shop.result = shop.result + String(fId)
+  end
 end
 get "/" do
   return shop.result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aboutyou-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Ferenc Beutel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use the Ruby SDK to build apps for the ABOUT YOU platform.
 email: ferenc1993beutel@gmx.de
 executables: []