aboutyou-sdk 0.0.24 → 0.0.25

data/lib/{aboutyou-sdk/Model/CategoryManager/DefaultCategoryManager.rb → AboutYou/Model/CategoryManager/default_category_manager.rb}

@@ -15,84 +15,86 @@ module AboutYou
           # the read-in categories from the category manager
           attr_accessor :categories
           # the parent child ids for the categories
-          attr_accessor :parentChildIds
+          attr_accessor :parent_child_ids
           # the cache client
           attr_accessor :cache
           # the cache key for the app
-          attr_accessor :cacheKey
+          attr_accessor :cache_key
           # instance of AY
-          attr_accessor :shopApi
+          attr_accessor :shop_api
 
           ###
           # the Constructor for the AY class
           #
           # * *Args*    :
           #   - +cache+ -> The cache client set on the AY class
-          #   - +appId+ -> The App-Id of the App
-          #   - +shopApi+ -> an Instance of AY
+          #   - +app_id+ -> The App-Id of the App
+          #   - +shop_api+ -> 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'
-              self.loadCachedCategories
+          def initialize(cache = nil, app_id = '', shop_api)
+            self.categories = {}
+            self.shop_api = shop_api
+            self.cache    = cache
+            self.cache_key = 'AY:SDK:' + String(app_id) + ':categories'
+            load_cached_categories
           end
 
           ###
           # Gets the cached Categories for this app
-          # 
+          #
           # * *Returns* :
           #   - True/False determining whether the loading was sucessfull or not
           ###
-          def loadCachedCategories
-            parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
+          def load_cached_categories
+            parse_json(
+              cache.get(cache_key),
+              shop_api.model_factory_instance
+            ) if cache && cache.exists(cache_key)
           end
 
           ###
-          # this method caches a given jsonObject
-          # 
+          # this method caches a given json_object
+          #
           # * *Args*    :
-          #   - +jsonObject+ -> the jsonObject received from the api
+          #   - +json_object+ -> the jsonObject received from the api
           #
           # * *Returns* :
           #   - True/False determining whether the setting was sucessfull or not
           ###
-          def cacheCategories(jsonObject)
-            self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
+          def cache_categories(json_object)
+            cache.set(cache_key, json_object, DEFAULT_CACHE_DURATION)
           end
 
           ###
           # This method clears the cache
-          # 
+          #
           # * *Returns* :
           #   - True/False determining whether the clearing was sucessfull or not
           ###
-          def clearCache
-            self.cache.delete(self.cacheKey)
+          def clear_cache
+            cache.delete(cache_key)
           end
 
           ###
-          # this method parses a json object received from the api and 
+          # this method parses a json object received from the api and
           # creates models from it
           #
           # * *Args*    :
-          #   - +jsonObject+ -> the jsonObject received from the api
+          #   - +json_object+ -> 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)
-            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
+          def parse_json(json_object, factory)
+            return if !json_object && categories.empty?
+            cache_categories(json_object) if cache
+            self.parent_child_ids = json_object['parent_child']
+            json_object['ids'].each do |id, json_category|
+              categories[id] = factory.create_category(json_category)
             end
           end
 
@@ -103,26 +105,26 @@ module AboutYou
           # * *Returns* :
           #   - a boolean which determines whether this Category Manager has read-in categories or not
           ###
-          def isEmpty
-            self.categories.empty?
+          def empty?
+            categories.empty?
           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)
+          def category_tree(active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            subcategories(0, active_only)
           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
           #
@@ -138,7 +140,7 @@ module AboutYou
           # 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
@@ -146,26 +148,30 @@ module AboutYou
           # * *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
+          def categories(
+              ids = nil,
+              active_only = 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
-              end
+              next unless category(id)
+              category = category(id)
+              next unless
+                active_only == AboutYou::SDK::Model::Category::ALL ||
+                category.is_active
+              categories[id] = category
             end
+
             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
@@ -173,14 +179,14 @@ module AboutYou
           # * *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)
+          def subcategories(id, active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+            return [] unless parent_child_ids && parent_child_ids.key?(String(id))
+            categories(parent_child_ids[String(id)], active_only)
           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
@@ -188,11 +194,15 @@ module AboutYou
           # * *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
+          def first_category_by_name(
+              name,
+              active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY
+            )
+            categories.each do |category|
+              return category if
+                category.name == name &&
+                (active_only == AboutYou::SDK::Model::Category::ACTIVE_ONLY ||
+                category.is_active)
             end
 
             nil
@@ -200,7 +210,7 @@ module AboutYou
 
           ###
           # 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
@@ -208,17 +218,22 @@ module AboutYou
           # * *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
+          def categories_by_name(
+              name,
+              active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY
+            )
+            result_categories = []
+            categories.each do |category|
+              result_categories.push(category) if
+              category.name == name &&
+              (active_only == AboutYou::SDK::Model::Category::ALL ||
+              category.is_active)
             end
-            resultCategories
+
+            result_categories
           end
         end
       end
     end
   end
-end
+end

data/lib/{aboutyou-sdk/Model/FacetManager/DefaultFacetManager.rb → AboutYou/Model/FacetManager/default_facet_manager.rb}

@@ -10,88 +10,90 @@ module AboutYou
         ###
         class DefaultFacetManager
           # the duration for the cached values to live
-          DEFAULT_CACHE_DURATION = 7200;
+          DEFAULT_CACHE_DURATION = 7200
 
           # 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
+          attr_accessor :cache_key
           # an Instance of AY
-          attr_accessor :shopApi
+          attr_accessor :shop_api
 
           ###
           # 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
+          #   - +app_id+ -> The App-Id of the App
+          #   - +shop_api+ -> 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'
+          def initialize(cache = nil, app_id = '', shop_api)
+            self.cache     = cache
+            self.facets    = {}
+            self.shop_api  = shop_api
+            self.cache_key = 'AY:SDK:' + String(app_id) + ':facets'
 
-            self.loadCachedFacets
+            load_cached_facets
           end
 
           ###
           # Gets the cached Categories for this app
-          # 
+          #
           # * *Returns* :
           #   - True/False determining whether the loading was sucessfull or not
           ###
-          def loadCachedFacets
-            parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
+          def load_cached_facets
+            parse_json(
+              cache.get(cache_key),
+              shop_api.model_factory_instance
+            ) if cache && cache.exists(cache_key)
           end
-          
+
           ###
-          # this method caches a given jsonObject
-          # 
+          # this method caches a given json_object
+          #
           # * *Args*    :
-          #   - +jsonObject+ -> the jsonObject received from the api
+          #   - +json_object+ -> the jsonObject received from the api
           #
           # * *Returns* :
           #   - True/False determining whether the setting was sucessfull or not
           ###
-          def cacheFacets(jsonObject)
-            self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
+          def cache_facets(json_object)
+            cache.set(cache_key, json_object, DEFAULT_CACHE_DURATION)
           end
-          
+
           ###
           # This method clears the cache
-          # 
+          #
           # * *Returns* :
           #   - True/False determining whether the clearing was sucessfull or not
           ###
-          def clearCache
-            self.cache.delete(self.cacheKey)
+          def clear_cache
+            cache.delete(cache_key)
           end
-          
+
           ###
-          # this method parses a json object received from the api and 
+          # this method parses a json object received from the api and
           # creates models from it
           #
           # * *Args*    :
-          #   - +jsonObject+ -> the jsonObject received from the api
+          #   - +json_object+ -> 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
+          def parse_json(json_object, factory, query = nil)
+            return unless facets.empty? && json_object
+            cache_facets(json_object) if cache
+            self.facets = factory.create_facets_list(json_object, query)
           end
-          
+
           ###
           # this method checks whether this facet manager has read-in
           # facets or not
@@ -99,40 +101,46 @@ module AboutYou
           # * *Returns* :
           #   - a boolean which determines whether this facet Manager has read-in facets or not
           ###
-          def isEmpty
-            self.facets.empty?
+          def empty?
+            facets.empty?
           end
 
           ###
-          # This method is used for getting a facet model by a given groupId and facetId
-          # 
+          # This method is used for getting a facet model by a given group_id and facetId
+          #
           # * *Args*    :
-          #   - +groupId+ -> the group id for which a facet model should be returned
+          #   - +group_id+ -> 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
+          #   - either an instance of AboutYou::SDK::Model::Facet or nil if +group_id+ or +id+ is not found
+          ###
+          def facet(group_id, id)
+            look_up_key = AboutYou::SDK::Model::Facet.new(
+              0,
+              '',
+              [],
+              0,
+              ''
+            ).unique_key(group_id, id)
+            facets[look_up_key] ? facets[look_up_key] : 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
+          #   - +group_ids+ -> 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) }
+          def facets_by_group_ids(group_ids = [])
+            group_ids = group_ids.map { |gId| Integer(gId) }
+            facets.select { |_key, facet| group_ids.include?(facet.group_id) }
           end
         end
       end
     end
   end
-end
+end