aboutyou-sdk 0.0.22 → 0.0.23

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWI0ZDkyZTNmMTZiMjg0NzQ4ZTA2ZDMzMDM2ZGFjMTVjMDE5ZjVkMA==
+    OTE1YWM2YjQ2NmIwYTM4Y2Q3OTcxOWVkZGQzNDQwZDVlZjkxMzhlYg==
   data.tar.gz: !binary |-
-    MTRmMDE3YmUzMmY3ZDIyNDZlNzkwOWUzZWVkNDk4YmE5MDkyMjUxNg==
+    M2NmOTMwYTdmNzEyZTc2MjQyNmY5ZDQ4MGU3YjQyNDEwYWJkYjU2OQ==
 SHA512:
   metadata.gz: !binary |-
-    NDE1MzliMjk0OWRlMDllNmI1MzUxNTEyMjM3MjE0OTkyMjgzOTU3ZmI5ZjVk
-    ODllYzAyNjNkMGQ1YzFmZjI5NzE5MTAxZTExN2I1MDM2MDVkYWRmOGYwZTdj
-    OTEzOTBmODcwOTY5ZTA1NTE2N2QzNjE3ZGQxMjI3MjdkMDFiYmI=
+    OGYzMTc2MTU2YjU5YzY2MjE5ZWFiMDc5ZTkxZjY3MDhjZThjZTA3MWZjMjJl
+    NDlmNmEyZWEwNGU4MTNiYzk2OGQ5ZTBkMjYyODQ5ZWFkNzAxMGM5ZGQ5M2Nj
+    N2YxYjQwZmY0YmJkYmJiZWE0NzVjODU3ZDhjMmZlZDRiYmE0YWM=
   data.tar.gz: !binary |-
-    ZWI3ZDNlNGNiMTA5NjkwNTNhZjNkOGVjYjZhMTA0NWVlNzY3ZjlkYWM2MWMy
-    ZDI0N2FmNWZlZmEwZDA3ZmU2ZTYzOTYwNmI3MTRhY2Y2MTBhMGI4MjEwOWQ5
-    YzI4YTQ5NDk2MzNjODI3NTg4ZGUwNDcyN2Y4YmIyNTU2OGExMjY=
+    NDdkYzJlN2UxN2YwYWE2NDNjMjc0NTA0ZjAzYTQyODFhZWQ2ODRkNTQ0ZGFl
+    YjRkODY3YTEzMjBmZWE3YWM1M2IzMGRhNTg1YmZlNGY5OGFhZDdjNWFjMGU3
+    YjYyYTZmN2M1YWQxM2MxMTZjODUzZDRjMjQwNGVjYjNmMDYyM2Q=

data/lib/aboutyou-sdk.rb

@@ -1,9 +1,6 @@
 require 'httparty'
 require 'json'
 require 'require_all'
-require 'dalli'
-require 'redis'
-
 
 require_rel 'aboutyou-sdk'
 

data/lib/aboutyou-sdk/CacheProvider/Dalli.rb

@@ -1,24 +1,82 @@
 module AboutYou
   module SDK
     module CacheProvider
+      
+      ###
+      # This class is used as an interface for cache operations.
+      # It is used when caching with Dalli.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class Dalli
+        require 'dalli'
+        
+        # an instance of the cache client.
         attr_accessor :client
+        
+        ###
+        # the Constructor for the Dalli class
+        #
+        # * *Args*    :
+        #   - +client+ -> an instance of Dalli::Client
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::CacheProvider::Dalli
+        ###
         def initialize(client)
           self.client = client
         end
         
+        ###
+        # This method is used for setting new cache entries with Dalli.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   - +value+ -> The value of the cache entry
+        #   - +duration+ -> the duration of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the setting was successfull of not
+        ###
         def set(key, value, duration)
           self.client.set(key, value, duration)
         end
         
+        ###
+        # This method is used for getting cache entries with Dalli.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - Either the value for the given key or nil if the key was not found
+        ###
         def get(key)
           self.client.get(key)
         end
         
+        ###
+        # This method is used for deleting cache entries with Dalli.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the deletion was successfull or not
+        ###
         def delete(key)
           self.client.delete(key)
         end
         
+        ###
+        # This method is used for checking whether a cache entry exists or not with Dalli.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the key exists in the cache or not
+        ###
         def exists(key)
           self.client.get(key) != nil
         end

data/lib/aboutyou-sdk/CacheProvider/Redis.rb

@@ -1,26 +1,84 @@
 module AboutYou
   module SDK
     module CacheProvider
+      
+      ###
+      # This class is used as an interface for cache operations.
+      # It is used when caching with Redis.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class Redis
+        require 'redis'
+        
+        # an instance of the cache client.
         attr_accessor :client
+        
+        ###
+        # the Constructor for the Redis class
+        #
+        # * *Args*    :
+        #   - +client+ -> an instance of Redis
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::CacheProvider::Redis
+        ###
         def initialize(client)
           self.client = client
         end
         
+        ###
+        # This method is used for setting new cache entries with Redis.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   - +value+ -> The value of the cache entry
+        #   - +duration+ -> the duration of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the setting was successfull of not
+        ###
         def set(key, value, duration)
           value = value.to_json unless value.is_a?(String)
           self.client.set(key, value)
           self.client.expire(key, duration)
         end
         
+        ###
+        # This method is used for getting cache entries with Redis.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - Either the value for the given key or nil if the key was not found
+        ###
         def get(key)
           JSON.parse(self.client.get(key))
         end
         
+        ###
+        # This method is used for deleting cache entries with Redis.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the deletion was successfull or not
+        ###
         def delete(key)
           self.client.del(key)
         end
         
+        ###
+        # This method is used for checking whether a cache entry exists or not with Redis.
+        #
+        # * *Args*    :
+        #   - +key+ -> The key of the cache entry
+        #   
+        # * *Returns* :
+        #   - True/False determining whether the key exists in the cache or not
+        ###
         def exists(key)
           self.client.exists(key)
         end

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

@@ -1,25 +1,14 @@
 module AboutYou
   module SDK
     module Model
+      
+      ###
+      # This Module is abstract and represents a model which has a shopApi attribute
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       module AbstractModel
-        # @var ShopApi #
-        @shopApi
-
-         ###
-         # @param ShopApi $shopApi
-         ###
-        def shopApi=(shopApi)
-        
-            @shopApi = shopApi;
-        end
-
-         ###
-         # @return ShopApi
-         ###
-        def shopApi()
-        
-            @shopApi;
-        end
+        attr_accessor :shopApi
       end
     end
   end

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

@@ -1,34 +1,46 @@
 module AboutYou
   module SDK
-    module Model     
+    module Model
+      ###
+      # This Class represents an app model
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class App
-      
-          attr_accessor :id
-          attr_accessor :logoUrl
-          attr_accessor :name
-          attr_accessor :url
-          attr_accessor :privacyStatementUrl
-          attr_accessor :tosUrl
-          
-        
-           ###
-           # @param \stdClass $json
-           #
-           # @return static
-           ###
-          def self.createFromJson(json)
-          
-              app = self.new
+        # the id of the app
+        attr_accessor :id
+        # the logo url of the app
+        attr_accessor :logoUrl
+        # the name of the app
+        attr_accessor :name
+        # the url of the app
+        attr_accessor :url
+        # the privacy statement url
+        attr_accessor :privacyStatementUrl
+        # the tearms of service url
+        attr_accessor :tosUrl
 
-              app.id                  = json["id"];
-              app.logoUrl             = json["logo_url"]
-              app.name                = json["name"]
-              app.url                 = json["url"]
-              app.privacyStatementUrl = json["privacy_statement_url"]
-              app.tosUrl              = json["tos_url"]
+        ###
+        # This method is used for creating an instance of this class by a jsonObject.
+        #
+        # * *Args*    :
+        #   - +json+ -> the jsonObject received from the api
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::App
+        ###
+        def self.createFromJson(json)
+          app = self.new
 
-              return app;
-          end
+          app.id                  = json["id"]
+          app.logoUrl             = json["logo_url"]
+          app.name                = json["name"]
+          app.url                 = json["url"]
+          app.privacyStatementUrl = json["privacy_statement_url"]
+          app.tosUrl              = json["tos_url"]
+
+          app
+        end
       end
     end
   end

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

@@ -1,90 +1,101 @@
 module AboutYou
   module SDK
     module Model
+      ###
+      # This Class represents an autocomplete model
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class Autocomplete
-    
-        NOT_REQUESTED = nil;
+        # this constant is used for values which are not requested
+        NOT_REQUESTED = nil
 
-         ###
-         # @var Product[]
-         ###
+        # the products of the autocomplete
         attr_accessor :products
-
-         ###
-         # @var Category[]
-         ###
+        # the categories of the autocomplete
         attr_accessor :categories
 
+        ###
+        # the Constructor for the autocomplete class
+        #
+        # * *Args*    :
+        #   - +productCountTotal+ -> the total productcount
+        #   - +productCountWithOtherFacet+ -> the productcount without any facets
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::AutoComplete
+        ###
         def initialize(categories = nil, products = nil)
-        
-            self.categories = categories;
-            self.products   = products;
+          self.categories = categories
+          self.products   = products
         end
 
-         ###
-         # @param \stdClass $jsonObject The autocomplete data.
-         # @param ModelFactoryInterface $factory
-         # 
-         # @return static
-         ###
+        ###
+        # This method lets you build an autocomplete model by a json response from the api
+        #
+        # * *Args*    :
+        #   - +jsonObject+ -> the json response from the api
+        #   - +factory+ -> the model factory responsible for building the models
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::AutoComplete
+        ###
         def self.createFromJson(jsonObject, factory)
-        
-            autocomplete = self.new(parseCategories(jsonObject, factory), parseProducts(jsonObject, factory))
-
-            return autocomplete;
+          self.new(parseCategories(jsonObject, factory), parseProducts(jsonObject, factory))
         end
 
-         ###
-         # parse autocompleted categories.
-         #
-         #
-         # @param \stdClass $jsonObject
-         # @param ModelFactoryInterface $factory
-         #
-         # @return Category[]|null
-         ###
+        ###
+        # This method parses the json object and builds category models from it
+        #
+        # * *Args*    :
+        #   - +jsonObject+ -> the json response from the api
+        #   - +factory+ -> the model factory responsible for building the models
+        #   
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Category
+        ###
         def self.parseCategories(jsonObject, factory)
-        
-            if !(jsonObject.key?('categories')) 
-                return NOT_REQUESTED;
-            end
+          unless jsonObject.key?('categories') 
+            return NOT_REQUESTED
+          end
 
-            if (jsonObject["categories"] == nil) 
-                return Array(nil);
-            end
+          if jsonObject["categories"] == nil 
+              return []
+          end
 
-            categories = Array(nil)
-            jsonObject["categories"].each do |category|
-                categories.push(factory.createCategory(category))
-            end
+          categories = []
+          jsonObject["categories"].each do |category|
+            categories.push(factory.createCategory(category))
+          end
 
-            return categories;
+          categories
         end
 
-         ###
-         # parse autocompleted products.
-         #
-         # @param \stdClass $jsonObject
-         # @param ModelFactoryInterface $factory
-         #
-         # @return Products[]
-         ###
+        ###
+        # This method parses the json object and builds product models from it
+        #
+        # * *Args*    :
+        #   - +jsonObject+ -> the json response from the api
+        #   - +factory+ -> the model factory responsible for building the models
+        #   
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Product
+        ###
         def self.parseProducts(jsonObject, factory)
-        
-            if !(jsonObject.key?('products'))
-                return NOT_REQUESTED;
-            end
+          unless jsonObject.key?('products')
+            return NOT_REQUESTED
+          end
 
-            if (jsonObject["products"] == nil) 
-                return Array(nil);
-            end
+          if jsonObject["products"] == nil
+              return []
+          end
 
-            products = Array(nil);
-            jsonObject["products"].each do |product|
-                products.push(factory.createProduct(product))
-            end
+          products = []
+          jsonObject["products"].each do |product|
+            products.push(factory.createProduct(product))
+          end
 
-            return products;
+          products
         end
       end
     end