aboutyou-sdk 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDdiN2JjYmMwYTVkOGY2MTUwYmQ0MzdlZGNjODRiMDdkNTlmNDA0ZA==
+    OWI2YjA3YmNlNTE2ZTE4YzQ4YWM0NGZkMTYyYTQ5ZjM4MjZiNDQxOQ==
   data.tar.gz: !binary |-
-    NGI0M2JmOTg4MjI2ODk0YzA2NGNmOGE1ODJhNmMwM2ZiOTAzNDBiZg==
+    ODZhYjdhYWZlOWFkOGY3MzdhMDg0NjhjMmM1ZWJiODM4NzZkNDIyNQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTVmODJjYjM2YTI0NTg1ODk3OWU3NWU4ODc2ZjI5ZjIxZGZhY2E4N2M4ZmFk
-    MzkwNmQ4ZjY3NTFhOTNkYTJiNzJhZDExNjkxNzgxOTE4NDkxODM4MmMxOTVm
-    YmRhZDczYjE1ZTQ4ODc4MTE1ZWVlYWM4NWMwNTYwNTlhNzVhNDQ=
+    ODBmNGUxMGUzMzk3MmJjODk5NjhmZDllZDJjYTc1YmMzNGZlMjZhYWE1ZDBk
+    NjdkMmVmZmRjNmJhODJjODNhMDhmZmIwMDRmMDJlZGJlODE1MDU2ODA5ODdj
+    ZTgwMTA5MTVjNDdmNzc1YWViYmNhNjlhOWZkMWY2Y2NlY2VlZDI=
   data.tar.gz: !binary |-
-    YjI3Zjk2MGVkNTQxMzRlYzJjZWY0NjVkYmRmYzQyYzM2ODJlZTQ4MDg0MWJh
-    NGU1NWRlNDk4NmZkYTdmNjE2Nzk0MmQyNDAxYmViYTFlMjU0MDdmMTY1M2U3
-    MmYxMTM3ZWVmMTIwNmRiMTA5YTE0MzAzNjRlOGM5MGVlMDRmYWM=
+    YWY3NzA5ZTgwZTRjZDQ1NzdiYTdlOTUwMmRiYjVmNjgzZGJhYWQ0ZWFlZDUw
+    YWQ1NzhkNDYxZTVlYmYwZDFmMmZiNWNjMmM1YTgzZGFhYzY1NzMzNGUyZDE1
+    MzM1NDRjYWI2MTgwYzljYjczMWJjNjYyM2JkYmE5NjY5NzY5OGY=

data/lib/aboutyou-sdk/Criteria/ProductSearchCriteria.rb

@@ -75,7 +75,7 @@ module AboutYou
         #   - an instance of AboutYou::SDK::Criteria::ProductSearchCriteria
         ###
         def filterBy(key, value)
-          filter[key] = value
+          @filter[key] = value
           return self
         end
 
@@ -164,7 +164,6 @@ module AboutYou
             end
             attributes = merged
           end
-          
           self.filterBy(FILTER_ATTRIBUTES, attributes)
         end
 
@@ -458,7 +457,7 @@ module AboutYou
             params['result'] = self.result
           end
           unless @filter.empty?
-            params['filter'] = self.filter
+            params['filter'] = @filter
           end
 
           params

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

@@ -2,169 +2,212 @@ module AboutYou
   module SDK
     module Model
       module CategoryManager
+        ###
+        # This class is responsible for handling all the logic when working with
+        # categories
+        #
+        # author:: Collins GmbH & Co KG
+        ###
         class DefaultCategoryManager
-        
-            DEFAULT_CACHE_DURATION = 7200;
-
-            # @var Category[] */
-            @categories;
-            attr_accessor :categories
-
-            # @var integer[] */
-            @parentChildIds;
-            attr_accessor :parentChildIds
-
-            # @var Cache */
-            @cache;
-            attr_accessor :cache
-
-            @cacheKey;
-            attr_accessor :cacheKey
-
-             ###
-             # @param string $appId  This must set, when you use more then one instances with different apps
-             # @param CacheProvider $cache
-             ###
-            def initialize(cache = nil, appId = '')
-            
-                self.cache    = cache;
-                self.cacheKey = 'AY:SDK:' + String(appId) + ':categories';
-
-                self.loadCachedCategories();
+          # the duration for the cached values to live
+          DEFAULT_CACHE_DURATION = 7200
+
+          # the read-in categories from the category manager
+          attr_accessor :categories
+          # the parent child ids for the categories
+          attr_accessor :parentChildIds
+          # the cache client
+          attr_accessor :cache
+          # the cache key for the app
+          attr_accessor :cacheKey
+
+          ###
+          # the Constructor for the AY class
+          #
+          # * *Args*    :
+          #   - +cache+ -> The cache client set on the AY class
+          #   - +appId+ -> The App-Id of the App
+          #
+          # * *Returns* :
+          #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
+          ###
+          def initialize(cache = nil, appId = '')
+              self.cache    = cache
+              self.cacheKey = 'AY:SDK:' + String(appId) + ':categories'
+              self.loadCachedCategories
+          end
+
+          ###
+          # Gets the cached Categories for this app
+          ###
+          def loadCachedCategories
+            if self.cache
+              self.categories = self.cache.get(self.cacheKey) ? self.cache.get(self.cacheKey) : nil
             end
-
-            def loadCachedCategories()
-            
-                if (self.cache) 
-                    self.categories = self.cache.fetch(self.cacheKey) ? self.cache.fetch(self.cacheKey): nil;
-                end
-            end
-
-            def cacheCategories()
-            
-                if (self.cache) 
-                    self.cache.save(self.cacheKey, self.categories,DEFAULT_CACHE_DURATION);
-                end
-            end
-
-            def clearCache()
-            
-                if (self.cache) 
-                    self.cache.delete(self.cacheKey);
-                end
-            end
-
-             ###
-             # @param \stdObject $jsonObject
-             # @param ModelFactoryInterface $factory
-             #
-             # @return $this
-             ###
-            def parseJson(jsonObject, factory)
-                self.categories = Hash.new
-                self.parentChildIds = jsonObject["parent_child"]
-
-                jsonObject["ids"].each do |id, jsonCategory|
-                    @categories[id] = factory.createCategory(jsonCategory);
-                end
-                self.cacheCategories();
-
-                return self
-            end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def isEmpty()
-            
-                return (@categories == nil);
-            end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def categoryTree(activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
-            
-                return self.subcategories(0, activeOnly);
+          end
+
+          ###
+          # This method caches the currently read-in categories
+          ###
+          def cacheCategories
+            if self.cache
+              binding.pry
+              self.cache.set(self.cacheKey, self.categories, DEFAULT_CACHE_DURATION)
             end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def category(id)
-                if !(self.categories[String(id)])
-                    return nil;
-                end
-
-                return self.categories[String(id)];
+          end
+
+          ###
+          # This method clears the cache
+          ###
+          def clearCache
+            if self.cache
+              self.cache.delete(self.cacheKey)
             end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def categories(ids=nil, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
-              if (ids == nil)
-                  return @categories
-                end
-                if !(@categories) 
-                    return Hash.new;
-                end
-                categories = Hash.new
-                ids.each do |id|
-                    if (@categories[id])
-                        category = @categories[id];
-                        if (activeOnly == AboutYou::SDK::Model::Category::ALL || category.isActive)
-                            categories[id] = category;
-                        end
-                    end
-                end
-                return categories;
+          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::DefaultCategoryManager
+          ###
+          def parseJson(jsonObject, factory)
+            self.categories = {}
+            self.parentChildIds = jsonObject["parent_child"]
+
+            jsonObject["ids"].each do |id, jsonCategory|
+                self.categories[id] = factory.createCategory(jsonCategory)
             end
-            
-            def allCategories()
-            
-                return self.categories;
-            end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def subcategories(id, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
-                if !(self.parentChildIds.key?(String(id)))
-                    return Array(nil);
+            self.cacheCategories()
+            self
+          end
+
+          ###
+          # this method checks whether this category manager has read-in
+          # categories or not
+          #
+          # * *Returns* :
+          #   - a boolean which determines whether this catManager has read-in categories or not
+          ###
+          def isEmpty
+            self.categories == nil
+          end
+
+          ###
+          # This method returns the root categories for the read-in categories
+          # 
+          # * *Args*    :
+          #   - +activeOnly+ -> determines whether the result should contain only active categories or not
+          #
+          # * *Returns* :
+          #   - a Hash containing pairs of Category_Id => instance of AboutYou::SDK::Model::Category
+          ###
+          def categoryTree(activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+              self.subcategories(0, activeOnly)
+          end
+
+          ###
+          # This method is used for getting a category model by a given id
+          # 
+          # * *Args*    :
+          #   - +id+ -> the id for which a category model should be returned
+          #
+          # * *Returns* :
+          #   - either an instance of AboutYou::SDK::Model::Category or nil if +id+ is not found
+          ###
+          def category(id)
+            return nil unless @categories[String(id)]
+            @categories[String(id)]
+          end
+
+          ###
+          # This method is used for getting either all categories when +id+
+          # is nil or a Hash of all Category Models found for an Array of
+          # Category Ids
+          # 
+          # * *Args*    :
+          #   - +ids+ -> an Array of category Ids
+          #   - +activeOnly+ -> determines whether the result should contain only active categories or not
+          #
+          # * *Returns* :
+          #   - a Hash containing pairs of Category_ID => an Instance of AboutYou::SDK::Model::Category
+          ###
+          def categories(ids=nil, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            return @categories if ids == nil
+            return {} unless @categories
+
+            categories = {}
+
+            ids.each do |id|
+              if category(id)
+                category = category(id)
+                if activeOnly == AboutYou::SDK::Model::Category::ALL || category.isActive
+                  categories[id] = category
                 end
-
-                ids = self.parentChildIds[String(id)];
-                return self.categories(ids, activeOnly);
+              end
             end
-
-             ###
-             # {@inheritdoc}
-             ###
-            def firstCategoryByName(name, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
-            
-                self.categories.each do |category|
-                    if (category.name == name && (activeOnly == AboutYou::SDK::Model::Category::ACTIVE_ONLY || category.isActive))
-                        return category;
-                    end
-                end
-
-                return nil;
+            categories
+          end
+
+          ###
+          # This method gets the subcategories for a given category id
+          # 
+          # * *Args*    :
+          #   - +id+ -> an Array of category Ids
+          #   - +activeOnly+ -> determines whether the result should contain only active categories or not
+          #
+          # * *Returns* :
+          #   - a Hash containing pairs of Category_ID => an Instance of AboutYou::SDK::Model::Category
+          ###
+          def subcategories(id, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            return Array(nil) unless self.parentChildIds.key?(String(id))
+            self.categories(self.parentChildIds[String(id)], activeOnly)
+          end
+
+          ###
+          # This method gets the first category which has a certain name
+          # 
+          # * *Args*    :
+          #   - +name+ -> the name which should be found
+          #   - +activeOnly+ -> determines whether the result should contain only active categories or not
+          #
+          # * *Returns* :
+          #   - either an instance of AboutYou::SDK::Model::Category or nil if +name+ not found
+          ###
+          def firstCategoryByName(name, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            self.categories.each do |category|
+              if category.name == name && (activeOnly == AboutYou::SDK::Model::Category::ACTIVE_ONLY || category.isActive)
+                return category
+              end
             end
 
-             ###
-             # {@inheritdoc}
-             ###
-            def categoriesByName(name, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
-                
-                resultCategories = Array(nil)
-                self.categories.each do |category|
-                    if(category.name == name && (activeOnly == AboutYou::SDK::Model::Category::ALL || category.isActive))
-                        resultCategories.push(category)
-                    end
-                end
-                return resultCategories;
+            nil
+          end
+
+          ###
+          # This method gets the subcategories for a given category id
+          # 
+          # * *Args*    :
+          #   - +id+ -> an Array of category Ids
+          #   - +activeOnly+ -> determines whether the result should contain only active categories or not
+          #
+          # * *Returns* :
+          #   - a Hash containing pairs of Category_ID => an Instance of AboutYou::SDK::Model::Category
+          ###
+          def categoriesByName(name, activeOnly = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            resultCategories = []
+            self.categories.each do |category|
+              if category.name == name && (activeOnly == AboutYou::SDK::Model::Category::ALL || category.isActive)
+                resultCategories.push(category)
+              end
             end
+            resultCategories
+          end
         end
       end
     end

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

@@ -66,28 +66,27 @@ module AboutYou
               end
           end
 
-          def fetch()
+          def fetch
           
-              if !(self.facets.empty?) 
-                return;
+              unless self.facets 
+                return
               end
               self.ids.each do |idPair|
 
                   idPair.each do |groupId, facetIds|
-                      facet = self.class.facetManager.facet(groupId, facetIds);
+                      facet = self.class.facetManager.facet(groupId, facetIds[0])
 
-                      if !(facet)
-                          # TODO: error handling
+                      unless facet
+                        # TODO: error handling
                           next
                       end
 
-                      if (self.groups[groupId]) 
-                          group = self.groups[groupId];
+                      if @groups[groupId]
+                          group = @groups[groupId]
                       else
-                          group = AboutYou::SDK::Model::FacetGroup.new(groupId, facet.groupName());
-                          self.groups[groupId] = group;
+                          group = AboutYou::SDK::Model::FacetGroup.new(groupId, facet.groupName)
+                          @groups[groupId] = group
                       end
-
                       group.addFacet(facet);
                       self.facets[facet.uniqueKey] = facet;
                   end
@@ -97,13 +96,12 @@ module AboutYou
            ###
            # @return FacetGroup[]
            ###
-          def groups()
-          
-              if (@groups.empty?)
-                  self.fetch();
+          def groups
+              if @groups.empty?
+                  self.fetch
               end
-
-              return(@groups);
+              
+              @groups
           end
 
            ###
@@ -113,8 +111,8 @@ module AboutYou
            ###
           def group(groupId)
             
-              groups = self.groups();
-              if (groups["groupId"]) 
+              groups = self.groups
+              if (groups[groupId]) 
                   return groups[groupId];
               end
 

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

@@ -69,7 +69,6 @@ module AboutYou
             def facet(groupId, id)
             
                 lookupKey = AboutYou::SDK::Model::Facet.new(0, "", [], 0, "").uniqueKey(groupId, id);
-
                 return (self.facets[lookupKey]) ? self.facets[lookupKey] : nil;
             end
         end

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

@@ -27,6 +27,7 @@ module AboutYou
           attr_accessor :color
           attr_accessor :length
           attr_accessor :seasonCode
+          attr_accessor :jsonObject
         
            ###
            # @param \stdClass $jsonObject
@@ -43,8 +44,9 @@ module AboutYou
             end
 
             variant = self.new
-            variant.factory    = factory;
-            variant.product    = product;
+            variant.factory    = factory
+            variant.product    = product
+            variant.jsonObject = jsonObject
             
             
             variant.parseImages(jsonObj["images"])
@@ -141,7 +143,7 @@ module AboutYou
               if !(jsonObject["attributes"].empty?) 
                   jsonObject["attributes"].each do |group, aIds|
                       gid = group[11..group.length] # rm prefix "attributs_"
-                      ids.push(Hash[gid => aIds]);
+                      ids.push(Hash[Integer(gid) => aIds]);
                   end
               end
 
@@ -172,9 +174,8 @@ module AboutYou
            #
            # @return FacetGroup|null
            ###
-          def facetGroup(groupId, jsonObject)
-
-            return self.facetGroupSet(jsonObject).group(groupId);
+           def facetGroup(groupId, jsonObject=self.jsonObject)
+            return self.facetGroupSet(jsonObject).group(groupId)
           end
 
            ###

data/lib/aboutyou-sdk/Query.rb

@@ -323,7 +323,6 @@ module AboutYou
           jsonObject     = responseObject[resultKey]
           queryKey       = currentQuery.keys[0]
           factory        = self.factory
-          
           if (jsonObject.is_a? Hash) && jsonObject['error_code']
             result = factory.preHandleError(jsonObject, resultKey, isMultiRequest)
             if result != false
@@ -331,7 +330,6 @@ module AboutYou
               next
             end
           end
-            
           query   = currentQuery[queryKey]
           queryId = queryIds[index]
           if queryId == QUERY_FACETS

data/lib/aboutyou-sdk.rb

@@ -37,6 +37,8 @@ class AY
   attr_accessor :baseImageUrl
   # the session id from a user using this app
   attr_accessor :sessionId
+  # the CacheServer
+  attr_accessor :cache
 
   ###
   # the Constructor for the AY class
@@ -48,7 +50,7 @@ class AY
   #   - +apiEndPoint+ -> Can be either live or staging
   #   - +resultFactory+ -> If nil it will use the DefaultModelFactory with the DefaultFacetManager
   #   - +logger+ -> Logger-Template
-  #   - +facetManagerCache+ -> The prefered Caching-Strategy
+  #   - +cache+ -> The prefered Caching-Strategy
   #   
   # * *Returns* :
   #   - Instance of AY
@@ -57,12 +59,11 @@ class AY
       appId,
       appPassword,
       sessionId = 'SESSION_ID',
+      cache = nil,
       apiEndPoint = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE,
       resultFactory = nil,
-      logger = nil,
-      facetManagerCache = nil
+      logger = nil
   )
-    
     self.sessionId   = sessionId
     self.appId       = appId
     self.appPassword = appPassword
@@ -72,7 +73,6 @@ class AY
       apiEndPoint, 
       logger
     )
-    resultFactory ? self.modelFactoryInstance = resultFactory : initDefaultFactory(facetManagerCache)
 
     if apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE
       self.baseImageUrl = (IMAGE_URL_STAGE)
@@ -83,6 +83,11 @@ class AY
     else
       self.baseImageUrl = (IMAGE_URL_LIVE)
     end
+    if cache == 'memcache'
+      require 'dalli'
+      self.cache = Dalli::Client.new('localhost:11211')
+    end
+    resultFactory ? self.modelFactoryInstance = resultFactory : initDefaultFactory(self.cache)
   end
 
   ###
@@ -371,6 +376,8 @@ class AY
   def fetchFacets(groupIds=[])
 
     query.fetchFacets(groupIds).executeSingle
+    
+    self.modelFactoryInstance.facetManager.facets
   end
 
 
@@ -574,7 +581,6 @@ class AY
    #   - +cache+ -> an Instance of the used cache [optional]
    ###
   def initDefaultFactory(cache = nil)
-
     resultFactory = AboutYou::SDK::Factory::DefaultModelFactory.new(self,
           AboutYou::SDK::Model::FacetManager::DefaultFacetManager.new,
           AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager.new(cache, self.appId)

data/tests/Sinatra-test/Main.rb

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

data/tests/testCatTree.rb

@@ -1,5 +1,4 @@
 require 'sinatra'
-require 'pry_debug'
 require 'aboutyou-sdk'
 
 class AY

data/tests/testDalli.rb

@@ -0,0 +1,15 @@
+require 'sinatra'
+require "pry_debug"
+require_relative'../lib/aboutyou-sdk.rb'
+
+shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', 'memcache')
+
+shop.fetchProductsByIds(
+  [661132, 660971, 661367, 661361],
+  [AboutYou::SDK::Criteria::ProductFields::CATEGORIES,
+    AboutYou::SDK::Criteria::ProductFields::VARIANTS]
+)
+get "/" do
+  binding.pry
+  return shop.cache.get('AY:SDK:281:categories')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aboutyou-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Ferenc Beutel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -104,6 +104,7 @@ files:
 - tests/testAutocomplete.rb
 - tests/testCatFilter.rb
 - tests/testCatTree.rb
+- tests/testDalli.rb
 - tests/testFacetTypes.rb
 - tests/testFacets.rb
 - tests/testFetchFacet.rb