aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/brand.rb

@@ -3,17 +3,21 @@ module AboutYou
     module Model
       ###
       # This Class represents a brand model
-      #
-      # author:: Collins GmbH & Co KG
       ###
       class Brand
+        # the id of the brand
         attr_accessor :id
+        # the name of the brand
         attr_accessor :name
 
         ###
-        # @param object $json_object
+        # This method is used for creating an instance of this class by a json_object.
         #
-        # @return Basket
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Brand
         ###
         def self.create_from_json(json_object)
           brand = new

data/lib/AboutYou/Model/categories_result.rb

@@ -2,15 +2,26 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class is used as a model for a categories result
-      #
       ###
       class CategoriesResult
+        # Array containing instances of AboutYou::SDK::Model::Category
         attr_accessor :categories
+        # Array containing the categories which are not found
         attr_accessor :categories_not_found
+        # the ids of the categories in this result
         attr_accessor :ids
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::CategoriesResult class
+        #
+        # * *Args*    :
+        #   - +category_manager+ -> instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
+        #   - +ids+ -> the ids of the categories in this result
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::CategoriesResult
+        ###
         def initialize(category_manager, ids)
           self.ids = ids
           self.categories = category_manager.categories(

data/lib/AboutYou/Model/category.rb

@@ -2,43 +2,55 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a category model
-      #
       ###
       class Category
+        # all categories
         ALL = false
+        # only active categories
         ACTIVE_ONLY = true
 
-        # @var integer */
+        # id of the category
         attr_accessor :id
-        # @var string */
+        # name of the category
         attr_accessor :name
-        # @var boolean */
+        # boolean determining whether the category is active
         attr_accessor :is_active
-        # @var integer */
+        # position of the category
         attr_accessor :position
-        # @var Category */
+        # id of the parent category
         attr_accessor :parent_id
-        # @var Category[] */
+        # Array containing all subcategories
         attr_accessor :all_subcategories
-        # @var Category[] */
+        # Array containing all active subcategories
         attr_accessor :active_subcategories
-        # @var integer */
+        # count of products in category
         attr_accessor :product_count
+        # instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
         attr_accessor :category_manager
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::Category class
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::Category
+        ###
         def initialize
           self.all_subcategories = []
           self.active_subcategories = []
+
+          self
         end
 
         ###
-        # @param object        $json_object  json as object tree
-        # @param ModelFactoryInterface $factory
-        # @param Category|null $parent
+        # 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
+        #   - +cat_manager+ -> instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
         #
-        # @return static
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Category
         ###
         def self.create_from_json(json_object, cat_manager)
           category = new
@@ -54,14 +66,21 @@ module AboutYou
         end
 
         ###
-        # @return boolean
+        # This method checks if the complete category path up to this category is
+        # active
+        #
+        # * *Returns* :
+        #   - Boolean determining whether the complete path up to this category is active or not
         ###
         def path_active?
           is_active && (parent.nil? || parent.path_active?)
         end
 
         ###
-        # @return Category|null
+        # This method returns the parent category
+        #
+        # * *Returns* :
+        #   - Either instance of AboutYou::SDK::Model::Category or nil if no parent category is set
         ###
         def parent
           return nil unless parent_id
@@ -70,9 +89,13 @@ module AboutYou
         end
 
         ###
-        # @param bool $activeOnly
+        # This method is used for getting all subcategories
         #
-        # @return Category[]
+        # * *Args*    :
+        #   - +active_only+ -> boolean controlling whether the result should only contain active categories or not
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of category_id => instance of AboutYou::SDK::Model::Category
         ###
         def subcategories(active_only = ACTIVE_ONLY)
           subcategories = category_manager.subcategories(id, active_only)
@@ -88,7 +111,10 @@ module AboutYou
         end
 
         ###
-        # @return Category[]
+        # This method is used for getting the breadcrumb up to this category
+        #
+        # * *Returns* :
+        #   - Array containing instances of AboutYou::SDK::Model::Category
         ###
         def breadcrumb
           breadcrumb = parent ? parent.breadcrumb : []

data/lib/AboutYou/Model/category_tree.rb

@@ -2,31 +2,45 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a category tree model
-      #
       ###
       class CategoryTree
-        # @var CategoryManagerInterface */
+        # instance of AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager
         attr_accessor :category_manager
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::CategoryTree class
+        #
+        # * *Args* :
+        #   - +cat_manager+ -> The category manager
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::CategoryTree
+        ###
         def initialize(cat_manager)
           self.category_manager = cat_manager
+
+          self
         end
 
         ###
-        # @param bool $activeOnly if true, then only active categories will returned, otherwise all categories
+        # This method is used for getting the root categories of the tree
+        #
+        # * *Args* :
+        #   - +act_only+ -> boolean controlling whether the result should only contain active categories or not
         #
-        # @return array|Category[]
+        # * *Returns* :
+        #   - a Hash containing pairs of category_id => instance of AboutYou::SDK::Model::Category
         ###
         def categories(act_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
           category_manager.category_tree(act_only)
         end
 
         ###
-        # Count active root all categories
+        # This method counts all active root categories
         #
-        # {@inheritdoc}
+        # * *Returns* :
+        #   - Integer count of active root categories
         ###
         def count
           categories(true).count

data/lib/AboutYou/Model/facet.rb

@@ -2,9 +2,7 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a Facet model
-      #
       ###
       class Facet
         # Group Id for Brands
@@ -53,28 +51,39 @@ module AboutYou
         FACET_QUANTITY_PER_PACK = 263
         # Group Id for Season Code
         FACET_SEASON_CODE = 289
-        
+        # api-call name for requiring all facets
+        FACETS_ALL = '_all'
+        # api-call-value for requiring unlimited facets
+        FACETS_UNLIMITED = -1
+
+        # json_object with which this instance was created
         attr_accessor :json_object
-        # @var integer */
+        # id of the facet
         attr_accessor :id
-        # @var string */
+        # name of the facet
         attr_accessor :name
-        # @var string */
+        # value of the facet
         attr_accessor :value
-        # @var integer */
+        # id of the group of the facet
         attr_accessor :group_id
-        # @var string */
+        # name of the group of the facet
         attr_accessor :group_name
-        # @var array */
+        # options of the facet
         attr_accessor :options
 
         ###
-        # @param integer $id
-        # @param string  $name
-        # @param string  $value
-        # @param integer $group_id
-        # @param string  $group_name
-        # @param array   $options
+        # Constructor for the AboutYou::SDK::Model::Facet class
+        #
+        # * *Args* :
+        #   - +id+ -> the id of the facet
+        #   - +name+ -> the name of the facet
+        #   - +value+ -> the value of the facet
+        #   - +group_id+ -> id of the group of the facet
+        #   - +group_name+ -> name of the group of the facet
+        #   - +options+ -> options of the facet
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::Facet
         ###
         def initialize(id, name, value, group_id, group_name, options = nil)
           self.id         = id
@@ -83,12 +92,18 @@ module AboutYou
           self.group_id   = group_id
           self.group_name = group_name
           self.options    = options
+
+          self
         end
 
         ###
-        # @param $json_object
+        # 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
         #
-        # @return static
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Facet
         ###
         def self.create_from_json(json_object)
           new(
@@ -102,9 +117,14 @@ module AboutYou
         end
 
         ###
-        # a facet is unique with the combination about id and group id
+        # This method is used for creating a unique key for a facet
+        #
+        # * *Args* :
+        #   - +group_id+ -> id of the group of a facet
+        #   - +facet_id+ -> id of a facet
         #
-        # @return string
+        # * *Returns* :
+        #   - a String containing a unique key for a facet
         ###
         def unique_key(group_id = nil, facet_id = nil)
           return String(group_id) + ':' + String(facet_id) unless
@@ -115,11 +135,13 @@ module AboutYou
         end
 
         ###
-        # Get option value.
+        # Getter for options
         #
-        # @param string $key The option key.
+        # * *Args* :
+        #   - +key+ -> The key for which options should be returned
         #
-        # @return mixed
+        # * *Returns* :
+        #   - either null if no options are set or a String containing an option
         ###
         def option(key)
           return unless options

data/lib/AboutYou/Model/facet_group.rb

@@ -2,38 +2,51 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a facet group model
-      #
       ###
       class FacetGroup
-        # @var Facet[] */
+        # Array of instances of AboutYou::SDK::Model::Facet
         attr_accessor :facets
-        # @var integer */
+        # id of this facet group
         attr_accessor :id
-        # @var string */
+        # name of the facet group
         attr_accessor :name
+        # id of the group of this facet group
         attr_accessor :group_id
 
         ###
-        # @param integer $id
-        # @param string  $name
+        # Constructor for the AboutYou::SDK::Model::FacetGroup class
+        #
+        # * *Args* :
+        #   - +id+ -> the id of the facet group
+        #   - +name+ -> the name of the facet group
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::FacetGroup
         ###
         def initialize(id, name)
           self.id = id
           self.name = name
           self.facets = {}
+
+          self
         end
 
         ###
-        # @param Facet $facet
+        # this method adds a facet to the facet group
+        #
+        # * *Args* :
+        #   - +facet+ -> instance of AboutYou::SDK::Model::Facet which should be added
         ###
         def add_facet(facet)
           facets[facet.id] = facet
         end
 
         ###
-        # @param Facet[] $facet
+        # this method adds facets to the facet group
+        #
+        # * *Args* :
+        #   - +facets+ -> Array containing instances of AboutYou::SDK::Model::Facet which should be added
         ###
         def add_facets(facets)
           facets.each do |facet|
@@ -42,28 +55,33 @@ module AboutYou
         end
 
         ###
-        # Returns all facet names separated with the given parameter
-        # eg. for size with to size facets "36" and "37" -> "36/37"
-        #
-        # @param string $separator
+        # this method is used for getting all of the facet names of this facet group
         #
-        # @return string
+        # * *Args* :
+        #   - +separator+ -> String controlling how the facet names should be seperated
+        #   
+        # * *Returns* :
+        #   - Array of Strings
         ###
         def facet_names(separator = '/')
           names = []
           facets.each do |facet|
             names.push(facet.name)
           end
-
           names.join(separator)
+
+          names
         end
 
         ###
-        # facet groups are equal, if the ids and all child ids are equal
+        # This method is used for checking whether a given facet group is equal
+        # to this facet group
         #
-        # @param FacetGroup $facet_group
-        #
-        # @return boolean
+        # * *Args* :
+        #   - +facet_group+ -> instance of AboutYou::SDK::Model::FacetGroup used for checking
+        #   
+        # * *Returns* :
+        #   -Boolean determining whether the facet groups are equal
         ###
         def equal?(facet_group)
           return false unless id == facet_group.id
@@ -72,9 +90,10 @@ module AboutYou
         end
 
         ###
-        # @see equal?
+        # This method is used for creating a unique key for this facet group
         #
-        # @return string
+        # * *Returns* :
+        #   - a String containing a unique key for this facet group
         ###
         def unique_key
           facet_ids = facets.keys
@@ -83,10 +102,25 @@ module AboutYou
           String(id) + ':' + String(facet_ids.join(','))
         end
 
+        ###
+        # Gett for the ids
+        #
+        # * *Returns* :
+        #   - Hash containing a pair of facet_group_id => Array of facet_ids
+        ###
         def ids
           { id => facets.keys }
         end
 
+        ###
+        # This method checks if this facet group contains a facet
+        #
+        # * *Args* :
+        #   - +facet+ -> instance of AboutYou::SDK::Model::Facet
+        #
+        # * *Returns* :
+        #   - Boolean determining whether this facet group contains the facet or not
+        ###
         def contains(facet)
           facets.key?(facet.id)
         end