aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/facet_group_set.rb

@@ -2,26 +2,28 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a facet group set model
-      #
       ###
       class FacetGroupSet
-        # @var array */
+        # Array of ids of the facet groups in this set
         attr_accessor :ids
-        # @var FacetGroup[] */
+        # Array of instances of AboutYou::SDK::Model::FacetGroups
         attr_accessor :groups
-        # @var Facet[] */
+        # Array of instances of AboutYou::SDK::Model::Facet
         attr_accessor :facets
-        # @var FacetManagerInterface */
         class << self
+          # instance of AboutYou::SDK::Model::Facet_Manager::DefaultFacetManager
           attr_accessor :facet_manager
         end
 
         ###
-        # @param array $ids two dimensional array of group ids and array ids
+        # Constructor for the AboutYou::SDK::Model::FacetGroupSet class
         #
-        # @throws \InvalidArgumentException
+        # * *Args* :
+        #   - +ids+ -> the ids of the facet groups of this set
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::FacetGroupSet
         ###
         def initialize(ids)
           self.facets = {}
@@ -30,17 +32,27 @@ module AboutYou
             fail '\InvalidArgumentException! ids must be an associative array
               of [$groupId => [$facetId,...],..]' unless facet_ids.is_a?(Array)
           end
-
           self.ids = ids
+
+          self
         end
 
         ###
-        # @return boolean
+        # This method checks whether this set is empty
+        #
+        # * *Returns* :
+        #   - Boolean determining whether this set is empty or not
         ###
         def empty?
           ids.empty?
         end
 
+        ###
+        # This method is used for generating facet groups for this set
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of group_id => instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def gen_lazy_groups
           groups = {}
           ids.each do |group_id, facet_ids|
@@ -61,11 +73,23 @@ module AboutYou
           groups
         end
 
+        ###
+        # Getter for the facet groups of this set
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of group_id => instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def lazy_groups
           return @groups unless @groups.empty?
           gen_lazy_groups
         end
 
+        ###
+        # This method fetches the facets of this set
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of group_id => instance of AboutYou::SDK::Model::FacetGroup
+        ###
         def fetch
           return unless facets && facets.empty?
 
@@ -87,7 +111,10 @@ module AboutYou
         end
 
         ###
-        # @return FacetGroup[]
+        # Getter for the facet groups of this set
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of group_id => instance of AboutYou::SDK::Model::FacetGroup
         ###
         def groups
           fetch if @groups.empty?
@@ -96,33 +123,55 @@ module AboutYou
         end
 
         ###
-        # @param $group_id
+        # this method is used for getting a group of this set by a group id
         #
-        # @return FacetGroup|null
+        # * *Returns* :
+        #   - +group_id+ -> the group id for which the facet group should be returned
+        #
+        # * *Returns* :
+        #   - Either nil if not found or instance of AboutYou::SDK::Model::FacetGroup
         ###
         def group(group_id)
           return groups[group_id] if groups[group_id]
         end
 
         ###
-        # @param $group_id
+        # this method is used for checking whether a group is in this set or not
+        #
+        # * *Returns* :
+        #   - +group_id+ -> the group id used for searching
         #
-        # @return bool
+        # * *Returns* :
+        #   - Boolean determining whether this set includes the group_id or not
         ###
         def group?(group_id)
           !ids[group_id].empty?
         end
 
         ###
-        # @param string $key
+        # This method gets a facet by key
         #
-        # @return Facet|null
+        # * *Returns* :
+        #   - +key+ -> the facet key used for searching
+        #
+        # * *Returns* :
+        #   - Either nil if not found or instance of AboutYou::SDK::Model::Facet
         ###
         def facet_by_key(key)
           fetch
           facets[key] ? facets[key] : nil
         end
 
+        ###
+        # This method gets a facet by given facet if and facet group id
+        #
+        # * *Returns* :
+        #   - +facet_group_id+ -> the facet group id used for searching
+        #   - +facet_id+ -> the facet id used for searching
+        #
+        # * *Returns* :
+        #   - Either nil if not found or instance of AboutYou::SDK::Model::Facet
+        ###
         def facet(facet_group_id, facet_id)
           fetch if facets.empty?
 
@@ -131,10 +180,10 @@ module AboutYou
         end
 
         ###
-        # set are equal, if all groups are equal
-        # which means, that all included facet ids per group must be the same
+        # This method is used for creating a unique key for this facet group set
         #
-        # @return string
+        # * *Returns* :
+        #   - a String containing a unique key for this facet group set
         ###
         def unique_key
           ids.sort!
@@ -144,9 +193,13 @@ module AboutYou
         end
 
         ###
-        # @param FacetUniqueKeyInterface $facetCompable
+        # This method checks whether this set contains a facet or facet group set
         #
-        # @return boolean
+        # * *Args* :
+        #   - +facet_compable+ -> Facet compable
+        #
+        # * *Returns* :
+        #   - Either nil if wrong input or Boolean determining whether the compable is found or not
         ###
         def contains(facet_compable)
           return contains_facet_group_set(facet_compable) if
@@ -158,6 +211,15 @@ module AboutYou
           false
         end
 
+        ###
+        # This method checks whether a facet is in this set or not
+        #
+        # * *Args* :
+        #   - +facet+ -> Facet compable
+        #
+        # * *Returns* :
+        #   - Boolean determining whether this set includes the facet or not
+        ###
         def contains_facet_get_group_interface(facet)
           lazy_groups = self.lazy_groups
           id = facet.group_id
@@ -169,6 +231,15 @@ module AboutYou
           false
         end
 
+        ###
+        # This method checks whether a facet group set is in this set or not
+        #
+        # * *Args* :
+        #   - +facet_group_set+ -> Facet compable
+        #
+        # * *Returns* :
+        #   - Boolean determining whether this set includes the facet group set or not
+        ###
         def contains_facet_group_set(facet_group_set)
           return true if unique_key == facet_group_set.unique_key
 
@@ -180,6 +251,15 @@ module AboutYou
           true
         end
 
+        ###
+        # This method merges facet ids in an multi dimensional Array
+        #
+        # * *Args* :
+        #   - +facet_ids_array+ -> Multi-Dimensional-Array containing facet ids
+        #
+        # * *Returns* :
+        #   - Array of facet ids
+        ###
         def self.merge_facet_ids(facet_ids_array)
           ids = {}
 
@@ -198,7 +278,10 @@ module AboutYou
         end
 
         ###
-        # @return array
+        # getter for the facet group ids
+        #
+        # * *Returns* :
+        #   - Array of facet group ids
         ###
         def group_ids
           ids.keys

data/lib/AboutYou/Model/image.rb

@@ -2,58 +2,65 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class is a represenatation of an Image model
-      #
       ###
       class Image
+        # min width of an image
         MIN_WIDTH  = 50
+        # min height of an image
         MIN_HEIGHT = 50
+        # max width of an image
         MAX_WIDTH  = 1400
+        # max height of an image
         MAX_HEIGHT = 2000
 
         class << self
-        attr_accessor :base_url
+          # base image url
+          attr_accessor :base_url
         end
-        # @var null|string[] */
+        # Array of additional items
         attr_accessor :additional_items
-        # @var null|string */
+        # Integer angle of the image
         attr_accessor :angle
-        # @var null|string */
+        # String background color of image
         attr_accessor :background
-        # @var null|string[] */
+        # String color of image
         attr_accessor :color
-        # @var null|string */
+        # ext
         attr_accessor :ext
-        # @var null|string */
+        # String gender of the image
         attr_accessor :gender
-        # @var string */
+        # String hash of the image
         attr_accessor :hash
-        # @var ImageSize */
+        # instance of AboutYou::SDK::Model::ImageSize
         attr_accessor :image_size
-        # @var integer */
+        # Integer file size
         attr_accessor :file_size
-        # @var null|string */
+        # String focus of the image
         attr_accessor :focus
-        # @var string */
+        # Integer mime type of the image
         attr_accessor :mime_type
-        # @var null|\stdClass */
+        # Hash model data
         attr_accessor :model_data
-        # @var null|integer */
+        # Integer next detail level
         attr_accessor :next_detail_level
-        # @var null|string */
+        # String preparation
         attr_accessor :preparation
-        # @var null|array */
+        # Array of String tags
         attr_accessor :tags
-        # @var null|string */
+        # Integer type
         attr_accessor :type
-        # @var string */
+        # String View
         attr_accessor :view
 
         ###
-        # @param \stdClass $json_object
+        # This method is used for creating an instance of this class by a json_object.
         #
-        # @return static
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Image
         ###
         def self.create_from_json(json_object)
           image = new
@@ -84,10 +91,14 @@ module AboutYou
         end
 
         ###
-        # @param int $width
-        # @param int $height
+        # This method is used for getting the image url for image
+        #
+        # * *Args*    :
+        #   - +width+ -> Width of the image
+        #   - +height+ -> Height of the image
         #
-        # @return string returns the relative url
+        # * *Returns* :
+        #   - String url for the image
         ###
         def url(width = 200, height = 200)
           width = [[width, MAX_WIDTH].min, MIN_WIDTH].max

data/lib/AboutYou/Model/image_size.rb

@@ -2,17 +2,20 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents the image size of an image
-      #
       ###
       class ImageSize
-        # @var integer */
+        # Integer width
         attr_accessor :width
-
-        # @var integer */
+        # Integer height
         attr_accessor :height
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::ImageSize class
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::ImageSize
+        ###
         def initialize(width, height)
           self.width = width
           self.height = height

data/lib/AboutYou/Model/initiate_order.rb

@@ -2,21 +2,30 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents an initiate order model
-      #
       ###
       class InitiateOrder
+        # url of the order
         attr_accessor :url
+        # user token for the order
         attr_accessor :user_token
+        # app token of the order
         attr_accessor :app_token
+        # error code of the order
         attr_accessor :error_code
+        # error message of the order
         attr_accessor :error_message
 
         ###
-        # @param string $url
-        # @param string $user_token
-        # @param string $app_token
+        # Constructor for the AboutYou::SDK::Model::InitiateOrder class
+        #
+        # * *Args* :
+        #   - +url+ -> url of the order
+        #   - +user_token+ -> user token for the order
+        #   - +app_token+ -> app token of the order
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::InitiateOrder
         ###
         def initialize(url, user_token, app_token)
           self.url        = url
@@ -27,9 +36,13 @@ module AboutYou
         end
 
         ###
-        # @param \stdClass $json
+        # 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::InitateOrder
         ###
         def self.create_from_json(json_object)
           order = new(
@@ -43,6 +56,12 @@ module AboutYou
           order
         end
 
+        ###
+        # This method is used for parsing the error result
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        ###
         def parse_error_result(json_object)
           self.error_code       = json_object.key?('error_code') ? json_object['error_code'] : 0
           self.error_message    = json_object.key?('error_message') ? json_object['error_message'] : nil

data/lib/AboutYou/Model/order.rb

@@ -2,14 +2,24 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents an order model
-      #
       ###
       class Order
+        # id of the order
         attr_accessor :id
+        # basket of the order
         attr_accessor :basket
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::InitiateOrder class
+        #
+        # * *Args* :
+        #   - +id+ -> id of the order
+        #   - +basket+ -> basket of the order
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::Order
+        ###
         def initialize(id, basket)
           self.id     = id
           self.basket = basket