aboutyou-sdk 0.0.13 → 0.0.14

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDQzMDNhYThmZmVhMjk4MTQzZDMxZDBhMWE1MWQzZWYxY2EwYjgzYQ==
+    ZDBmNjhmNzliNGI3N2JjOTk4MDgxODc0NDBjNTYwZjI5N2RlNGIzZA==
   data.tar.gz: !binary |-
-    MjJiMWEyZTg1ZTFkY2NhMjg4ZjY0NWY5M2Q0OWM1NGM1YjAyZmM0Yg==
+    YWZkODI5NmM1ODhhMDFiOWJkNTBmODI3ZjczYTIzYjRjZDJiMzc2OQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmU3ZDljM2UwYmE0ODgzZjNkZTk3MGRmOTFhNWEyYmVmMGVmYzAwMDQ2ZmYz
-    ZjZkZmFlZjE1MTk0MTk3ZmU2NWZhMmEzOGY0ZmY3OTA0NmRmN2U4ZGZhMDY3
-    ZWY3OWM5MjY4ODA1ZDU3YjA3ODg3NTk4NDNiOTk5Y2RiYmI0ZWM=
+    MDJhYjY1MGRhYjc3ZjEyOWM4YTNiZDlhMGY0YjZiOGM0Y2UxNWM5YjI1ZTQx
+    NzY4Y2JiMzljMDBlYzliNTVhYjY4ODNmN2ExYjQyMTlmMDBhY2M3NmUzYzBj
+    ZDg4YzdlOGZhNzA5Yjg0ZGZmZjdmOGE2YzQyNDc1MWM0MTE3NjI=
   data.tar.gz: !binary |-
-    NGI0OWFkYTFiOGM4ZDM0MzhiODMxOGRhMzQ5NjIxMzdiMDdmZjQ4NmFkNDE2
-    MmZhMDU4YmYxZmVkMmE4ODI2ZGQwMzgxZGYxYjJjYmI3MjI3OWUzYjAzN2Nk
-    ZDdiYzQzN2E5ZDk5ZThlYjdjYWExYjMyZTA0ZGI5Y2JlMzFlYTY=
+    NDAxMWRlNjQyNDdkZWU4ZjU1M2I1OTQ3ZjExMTViNmEwMjFlYzA3NzcyZjg0
+    MDI2OTg2MmMzMmQzMTRkMmI1Y2U3NmY5ZTQxNjEyZGU5YTUzZjRjYzNiZTJi
+    NTAyMmYyNDUwMGZmMWE0NWM1N2E4ZTE2NDk2YTA4YmM0MTdlYzM=

data/lib/aboutyou-sdk.rb

@@ -1,6 +1,9 @@
 require 'httparty'
 require 'json'
 require 'require_all'
+require 'dalli'
+require 'redis'
+
 
 require_rel 'aboutyou-sdk'
 
@@ -60,11 +63,17 @@ class AY
       appPassword,
       sessionId = 'SESSION_ID',
       cache = nil,
-      cacheServer= 'localhost:11211',
+      cacheServer= nil,
       apiEndPoint = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE,
       resultFactory = nil,
       logger = nil
-  )
+    )
+    
+    if cacheServer == nil
+      cacheServer = 'localhost:11211' if cache == 'memcache'
+      cacheServer = {:host => "localhost", :port => 6379} if cache == 'redis'
+    end
+    
     self.sessionId   = sessionId
     self.appId       = appId
     self.appPassword = appPassword
@@ -74,21 +83,26 @@ class AY
       apiEndPoint, 
       logger
     )
+        
+    self.cache = Dalli::Client.new(cacheServer, {:value_max_bytes => 5242880}) if cache == 'memcache' 
+    self.cache = Redis.new(cacheServer) if cache == 'redis'
 
+    if resultFactory
+      self.modelFactoryInstance = resultFactory
+    else
+      initDefaultFactory(self.cache)
+    end
+    
     if apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE
       self.baseImageUrl = (IMAGE_URL_STAGE)
       self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE         
     elsif apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
       self.baseImageUrl = (IMAGE_URL_SANDBOX)
       self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
-    else
+    elsif apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE
       self.baseImageUrl = (IMAGE_URL_LIVE)
+      self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE
     end
-    if cache == 'memcache'
-      require 'dalli'
-      self.cache = Dalli::Client.new(cacheServer, {:value_max_bytes => 5242880})
-    end
-    resultFactory ? self.modelFactoryInstance = resultFactory : initDefaultFactory(self.cache)
   end
 
   ###
@@ -561,7 +575,7 @@ class AY
    # * *Args*    :
    #   - +baseImageUrl+ -> nil will reset to the default url, false to get relative urls, otherwise the url prefix
    ###
-  def baseImageUrl=(baseImageUrl = nil)
+  def baseImageUrl= (baseImageUrl = nil)
 
     if !baseImageUrl 
       @baseImageUrl = IMAGE_URL_LIVE
@@ -571,7 +585,7 @@ class AY
       @baseImageUrl = ''
     end
 
-    self.modelFactory.baseImageUrl=(self.baseImageUrl)
+    self.modelFactory.baseImageUrl = self.baseImageUrl
   end
   
   
@@ -582,13 +596,12 @@ 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(cache, self.appId, self),
-          AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager.new(cache, self.appId, self)
+    self.modelFactoryInstance = AboutYou::SDK::Factory::DefaultModelFactory.new(self)
+    
+    self.modelFactoryInstance.initializeManagers(
+      AboutYou::SDK::Model::FacetManager::DefaultFacetManager.new(cache, self.appId, self),
+      AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager.new(cache, self.appId, self)
     )
-    resultFactory.baseImageUrl=(self.baseImageUrl)
-
-    self.modelFactoryInstance=(resultFactory)
+    self.modelFactoryInstance.baseImageUrl=(self.baseImageUrl)
   end
-  
 end

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

@@ -27,8 +27,11 @@ module AboutYou
         # * *Returns* :
         #   - an instance of AboutYou::SDK::Factory::DefaultModelFactory
         ###
-        def initialize(shopApi = nil, facetManager, categoryManager)
+        def initialize(shopApi = nil)
           self.shopApi = shopApi
+        end
+        
+        def initializeManagers(facetManager, categoryManager)
           self.categoryManager = categoryManager
           self.facetManager = facetManager
           AboutYou::SDK::Model::FacetGroupSet.facetManager = self.facetManager

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

@@ -20,6 +20,7 @@ module AboutYou
           attr_accessor :cache
           # the cache key for the app
           attr_accessor :cacheKey
+          # instance of AY
           attr_accessor :shopApi
 
           ###
@@ -43,17 +44,18 @@ module AboutYou
           # Gets the cached Categories for this app
           ###
           def loadCachedCategories
-            if self.cache
-              parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance)
-            end
+            parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.get(self.cacheKey)
           end
 
           ###
           # This method caches the currently read-in categories
           ###
           def cacheCategories(jsonObject)
-            if self.cache
-              self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
+            self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION) if self.cache.instance_of?(Dalli::Client)
+            if self.cache.instance_of?(Redis)
+              jsonObject = jsonObject.to_json unless jsonObject.is_a? String
+              self.cache.set(self.cacheKey, jsonObject)
+              self.cache.expire(self.cacheKey, DEFAULT_CACHE_DURATION)
             end
           end
 
@@ -61,9 +63,8 @@ module AboutYou
           # This method clears the cache
           ###
           def clearCache
-            if self.cache
-              self.cache.delete(self.cacheKey)
-            end
+            self.cache.delete(self.cacheKey) if self.cache.instance_of?(Dalli::Client)
+            self.cache.del(self.cacheKey) if self.cache.instance_of?(Redis)
           end
 
           ###
@@ -78,12 +79,16 @@ module AboutYou
           #   - Instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
           ###
           def parseJson(jsonObject, factory)
-            self.categories = {}
-            if jsonObject
-              self.cacheFacets(jsonObject)
-              self.parentChildIds = jsonObject["parent_child"]
-              jsonObject["ids"].each do |id, jsonCategory|
-                  self.categories[id] = factory.createCategory(jsonCategory)
+            unless self.categories
+              self.categories = {} 
+              jsonObject = JSON.parse(jsonObject) if jsonObject.is_a? String
+            
+              if jsonObject
+                self.cacheCategories(jsonObject)
+                self.parentChildIds = jsonObject["parent_child"]
+                jsonObject["ids"].each do |id, jsonCategory|
+                    self.categories[id] = factory.createCategory(jsonCategory)
+                end
               end
             end
           end

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

@@ -27,41 +27,40 @@ module AboutYou
                 self.cache    = cache;
                 self.shopApi  = shopApi
                 self.cacheKey = 'AY:SDK:' + String(appId) + ':facets';
-                self.facets = Hash.new
 
-                self.loadCachedFacets();
+                self.loadCachedFacets
             end
 
-            def loadCachedFacets()
-            
-                if (self.cache) 
-                  parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance)
-                end
+            def loadCachedFacets
+              parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.get(self.cacheKey)
             end
 
             def cacheFacets(jsonObject)
-            
-                if (self.cache)
-                    self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION);
-                end
+              self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION) if self.cache.instance_of?(Dalli::Client)
+              if self.cache.instance_of?(Redis)
+                jsonObject = jsonObject.to_json unless jsonObject.is_a?(String)
+                self.cache.set(self.cacheKey, jsonObject)
+                self.cache.expire(self.cacheKey, DEFAULT_CACHE_DURATION)
+              end
             end
 
-            def clearCache()
-            
-                if (self.cache)
-                    self.cache.delete(self.cacheKey);
-                end
+            def clearCache
+              self.cache.delete(self.cacheKey) if self.cache.instance_of?(Dalli::Client)
+              self.cache.del(self.cacheKey) if self.cache.instance_of?(Redis)
             end
             
             def parseJson(jsonObject, factory, query=nil)
-              if jsonObject
-                self.cacheFacets(jsonObject)
-                self.facets = factory.createFacetsList(jsonObject, query)
+              unless self.facets
+                jsonObject = JSON.parse(jsonObject) if jsonObject.is_a?(String)
+                if jsonObject
+                  self.cacheFacets(jsonObject)
+                  self.facets = factory.createFacetsList(jsonObject, query)
+                end
               end
             end
 
-            def isEmpty()
-                return (self.facets.empty?);
+            def isEmpty
+                return (self.facets.empty?)
             end
 
              ###

data/lib/aboutyou-sdk/Query.rb

@@ -124,14 +124,12 @@ module AboutYou
       def fetchProductsByIds(ids,fields = [])
         
         super(ids, fields)
-        
         if AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields) 
             self.requireCategoryTree
         end
         if AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields) 
             self.requireFacets
         end
-
         return self
       end
 
@@ -193,8 +191,7 @@ module AboutYou
        #   - Instance of AboutYou::SDK::Query
        ###      
       def requireCategoryTree(fetchForced = false)
-        
-        unless fetchForced || self.factory.categoryManager.isEmpty
+        if fetchForced || !self.factory.categoryManager.isEmpty
             return self
         end
 

data/tests/testCategoryCaching.rb

@@ -4,11 +4,7 @@ require_relative'../lib/aboutyou-sdk.rb'
 
 get "/doCache" do
 shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', 'memcache')
-shop.fetchProductsByIds(
-  [661132, 660971, 661367, 661361],
-  [AboutYou::SDK::Criteria::ProductFields::CATEGORIES,
-    AboutYou::SDK::Criteria::ProductFields::VARIANTS]
-)
+shop.fetchProductsByIds([661132, 660971, 661367, 661361], [AboutYou::SDK::Criteria::ProductFields::CATEGORIES])
 end
 
 get "/getCache" do

data/tests/testRedisCache.rb

@@ -0,0 +1,31 @@
+require 'sinatra'
+require "pry_debug"
+require_relative'../lib/aboutyou-sdk.rb'
+
+get "/doCache" do
+shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', 'redis')
+shop.fetchProductsByIds([661132, 660971, 661367, 661361], [AboutYou::SDK::Criteria::ProductFields::CATEGORIES])
+end
+
+get "/getCache" do
+  result = ""
+  shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', 'redis')
+  
+  shop.fetchCategoryTree.categories.each do |key, cate|
+    result = result + cate.name + '  '
+  end
+  
+  return result
+end
+
+get "/noCache" do
+  result = ""
+  shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', 'redis')
+  shop.cache.delete('AY:SDK:281:categories')
+  
+  shop.fetchCategoryTree.categories.each do |key, cate|
+    result = result + cate.name + '  '
+  end
+  
+  return result
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aboutyou-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Ferenc Beutel
@@ -128,6 +128,7 @@ files:
 - tests/testProductSearchResult.rb
 - tests/testProductsByEans.rb
 - tests/testProductsByIds.rb
+- tests/testRedisCache.rb
 - tests/testSuggest.rb
 - tests/testVariantsByIds.rb
 homepage: https://developer.aboutyou.de