aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/product.rb

@@ -2,41 +2,76 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents an product model
-      #
       ###
       class Product
         include AbstractModel
-
+        # product id
         attr_accessor :id
+        # instance of AboutYou::SDK::Factory::DefaultModelFactory
         attr_accessor :factory
+        # product name
         attr_accessor :name
+        # product in sale or not
         attr_accessor :is_sale
+        # product active or not
         attr_accessor :is_active
+        # short description
         attr_accessor :description_short
+        # long description
         attr_accessor :description_long
+        # product min price
         attr_accessor :min_price
+        # product max price
         attr_accessor :max_price
+        # product max savings price
         attr_accessor :max_savings_price
+        # product max savings
         attr_accessor :max_savings
+        # product max savings percentage
         attr_accessor :max_savings_percentage
+        # product brand id
         attr_accessor :brand_id
+        # product merchant id
         attr_accessor :merchant_id
+        # category id paths of this product
         attr_accessor :category_id_paths
+        # facet ids of this product
         attr_accessor :facet_ids
+        # product default image
         attr_accessor :default_image
+        # product default variant
         attr_accessor :default_variant
+        # product selected variant
         attr_accessor :selected_variant
+        # variants of product
         attr_accessor :variants
+        # inactive styles of product
         attr_accessor :inactive_variants
+        # styles of product
         attr_accessor :styles
+        # facet groups of product
         attr_accessor :facet_groups
+        # root categories for product
         attr_accessor :root_categories
+        # active root categories for the product
         attr_accessor :active_root_categories
+        # leaf categories for product
         attr_accessor :leaf_categories
+        # active leaf categories of the product
         attr_accessor :active_leaf_categories
 
+        ###
+        # This method is used for creating an instance of this class by a json_object.
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #   - +app_id+ -> app id of the product
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Product
+        ###
         def self.create_from_json(json_object, factory, app_id)
           product = new
 
@@ -75,6 +110,18 @@ module AboutYou
           product
         end
 
+        ###
+        # This method is used for parsing the variants of the product
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #   - +product+ -> self
+        #   - +attribute_name+ -> attribute name for parsing [optional]
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of variant_id => instance of AboutYou::SDK::Model::Variant
+        ###
         def parse_variants(json_object, factory, product, attribute_name = 'variants')
           variants = {}
 
@@ -90,6 +137,16 @@ module AboutYou
           variants
         end
 
+        ###
+        # This method is used for parsing the styles of the product
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Product
+        ###
         def parse_styles(json_object, factory)
           styles = []
 
@@ -100,6 +157,15 @@ module AboutYou
           styles
         end
 
+        ###
+        # This method is used for parsing the category id paths for this product
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - Array of Strings
+        ###
         def parse_category_id_paths(json_object)
           paths = []
 
@@ -113,20 +179,47 @@ module AboutYou
           paths
         end
 
+        ###
+        # This method is used for parsing the facet ids of this product
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - a Hash containing pairs of facet_ids => AboutYou::SDK::Model::Facet
+        ###
         def parse_facet_ids(json_object)
           ids = parse_facet_ids_in_attributes_merged(json_object)
           ids = parse_facet_ids_in_variants(json_object) if ids.nil?
           ids = parse_facet_ids_in_brand(json_object) if ids.nil?
 
-          !ids.nil? ? ids : []
+          !ids.nil? ? ids : {}
         end
 
+        ###
+        # This method is used for parsing the facet ids in merged attributes
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - nil / a Hash containing pairs of facet_ids => AboutYou::SDK::Model::Facet
+        ###
         def parse_facet_ids_in_attributes_merged(json_object)
           return nil unless json_object['attributes_merged']
 
           parse_attributes_json(json_object['attributes_merged'])
         end
 
+        ###
+        # This method is used for parsing an attribues json object
+        #
+        # * *Args*    :
+        #   - +attributes_json_object+ -> the attributes_json_object received from the api
+        #
+        # * *Returns* :
+        #   - nil / a Hash containing pairs of facet_ids => AboutYou::SDK::Model::Facet
+        ###
         def parse_attributes_json(attributes_json_object)
           ids = {}
 
@@ -141,6 +234,15 @@ module AboutYou
           ids
         end
 
+        ###
+        # This method is used for parsing the facet ids in the variants of this product
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - Array containing facet ids
+        ###
         def parse_facet_ids_in_variants(json_object)
           if json_object['variants']
             ids = []
@@ -159,12 +261,27 @@ module AboutYou
           nil
         end
 
+        ###
+        # This method is used for parsing the facet ids brands
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - nil / a Hash containing pairs of facet_ids => AboutYou::SDK::Model::Facet
+        ###
         def parse_facet_ids_in_brand(json_object)
           return nil unless json_object['brand_id']
 
           { '0' => [json_object['brand_id']] }
         end
 
+        ###
+        # This method generates a facet group set for self.facet_ids
+        #
+        # * *Fails*    :
+        #   - if self.facet_ids is empty
+        ###
         def generate_facet_group_set
           fail 'RuntimeException! To use this method, you must add the field
             ProductFields::ATTRIBUTES_MERGED to the "product search" or
@@ -173,18 +290,39 @@ module AboutYou
           self.facet_groups = AboutYou::SDK::Model::FacetGroupSet.new(facet_ids)
         end
 
+        ###
+        # Getter for the facet group set
+        #
+        # * *Returns* :
+        #   - instance of AboutYou::SDK::Model::FacetGroupSet
+        ###
         def facet_group_set
           generate_facet_group_set unless @facet_groups
 
           @facet_groups
         end
 
+        ###
+        # This method is used for getting a category
+        #
+        # * *Args*    :
+        #   - +active+ -> Boolean determining whether the category has to be active or not
+        #
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Category
+        ###
         def category(active = false)
-          return nil unless category_id_paths
+          return unless category_id_paths
 
           leaf_categories(active)[leaf_categories(active).keys[0]]
         end
 
+        ###
+        # Getter for the deepest category
+        #
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Category
+        ###
         def category_with_longest_active_path
           return nil unless category_id_paths
 
@@ -196,10 +334,25 @@ module AboutYou
           nil
         end
 
+        ###
+        # Getter for the leaf categories
+        #
+        # * *Args*    :
+        #   - +active_only+ -> Boolean controlling whether only active categories should be returned or not
+        #
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Category
+        ###
         def leaf_categories(active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
           factory.category_manager.categories(leaf_category_ids, active_only)
         end
 
+        ###
+        # Getter for the root category ids
+        #
+        # * *Returns* :
+        #   - Array containing category_ids
+        ###
         def root_category_ids
           root_category = []
           category_id_paths.each do |category_id_path|
@@ -209,6 +362,12 @@ module AboutYou
           root_category.uniq
         end
 
+        ###
+        # Getter for the leaf category ids
+        #
+        # * *Returns* :
+        #   - Array containing category_ids
+        ###
         def leaf_category_ids
           leaf_categories = []
           category_id_paths.each do |category_id_path|
@@ -218,18 +377,54 @@ module AboutYou
           leaf_categories.uniq
         end
 
+        ###
+        # Getter for the categories
+        #
+        # * *Args*    :
+        #   - +active_only+ -> Boolean controlling whether only active categories should be returned or not
+        #
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Category
+        ###
         def categories(active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
           root_categories(active_only)
         end
 
+        ###
+        # Getter for the root categories
+        #
+        # * *Args*    :
+        #   - +active_only+ -> Boolean controlling whether only active categories should be returned or not
+        #
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Category
+        ###
         def root_categories(active_only = Category::ACTIVE_ONLY)
           factory.category_manager.categories(root_category_ids, active_only)
         end
 
+        ###
+        # Getter for facets for a certain group id
+        #
+        # * *Args*    :
+        #   - +group_id+ -> group_id used for searching
+        #
+        # * *Returns* :
+        #   - [] / instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def group_facets(group_id)
           facet_group_set.group(group_id) ? group.facets : []
         end
 
+        ###
+        # Getter for all facetGroups for a certain group id
+        #
+        # * *Args*    :
+        #   - +group_id+ -> group_id used for searching
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of unique_group_key => group_id
+        ###
         def facet_groups(group_id)
           all_groups = {}
 
@@ -242,6 +437,15 @@ module AboutYou
           all_groups
         end
 
+        ###
+        # Getter for the selectable facet groups
+        #
+        # * *Args*    :
+        #   - +selected_facet_group_set+ -> selected instance of AboutYou::SDK::Model::FacetGroupSet
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of unique_group_key => instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def selectable_facet_groups(selected_facet_group_set)
           all_groups = {}
           selected_group_ids = selected_facet_group_set.group_ids
@@ -279,6 +483,15 @@ module AboutYou
           all_groups
         end
 
+        ###
+        # Getter for the excluded groups
+        #
+        # * *Args*    :
+        #   - +selected_facet_group_set+ -> selected instance of AboutYou::SDK::Model::FacetGroupSet
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of unique_group_key => instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def excluded_facet_groups(selected_facet_group_set)
           all_groups = {}
 
@@ -307,6 +520,12 @@ module AboutYou
           all_groups
         end
 
+        ###
+        # Getter for the brand
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Facet
+        ###
         def brand
           facet_group_set.facet(
             AboutYou::SDK::Model::Facet::FACET_BRAND,
@@ -314,10 +533,28 @@ module AboutYou
           )
         end
 
+        ###
+        # This method returns a variant by a certain variant_id
+        #
+        # * *Args*    :
+        #   - +variant_id+ -> variant id used for searching
+        #
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Variant
+        ###
         def variant_by_id(variant_id)
           variants[variant_id] ? variants[variant_id] : nil
         end
 
+        ###
+        # This method searches for variants by a certain ean
+        #
+        # * *Args*    :
+        #   - +ean+ -> ean used for searching
+        #
+        # * *Returns* :
+        #   - [] / Array containing instances of AboutYou::SDK::Model::Variant
+        ###
         def variants_by_ean(ean)
           variants = []
 
@@ -328,6 +565,15 @@ module AboutYou
           variants
         end
 
+        ###
+        # This method searches for a variant by a certain facet group set
+        #
+        # * *Args*    :
+        #   - +facet_group_set+ -> facet_group_set used for searching
+        #
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Variant
+        ###
         def variant_by_facet(facet_group_set)
           key = facet_group_set.unique_key
           variants.each do |variant|
@@ -337,6 +583,16 @@ module AboutYou
           nil
         end
 
+        ###
+        # This method searches for variants by a certain facet_id and group_id
+        #
+        # * *Args*    :
+        #   - +facet_id+ -> facet_id used for searching
+        #   - +group_id+ -> group_id used for searching
+        #
+        # * *Returns* :
+        #   - [] / Array containing instances of AboutYou::SDK::Model::Variant
+        ###
         def variants_by_facet_id(facet_id, group_id)
           variants = []