aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/product_search_result.rb

@@ -2,29 +2,47 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a product search result model
-      #
       ###
       class ProductSearchResult
+        # Array of instances of AboutYou::SDK::Model::Product
         attr_accessor :products
+        # String page hash
         attr_accessor :page_hash
+        # Integer count of products
         attr_accessor :product_count
+        # Integer count of products in sale
         attr_accessor :sale_counts
+        # Array containing instances of AboutYou::SDK::Model::PriceRange
         attr_accessor :price_ranges
+        # Array containing instances of AboutYou::SDK::Model::Facet
         attr_accessor :facets
+        # Array containing instances of AboutYou::SDK::Model::Category
         attr_accessor :categories
+        # raw facets
         attr_accessor :raw_facets
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::ProductSearchResult class
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::ProductSearchResult
+        ###
         def initialize
           self.products = {}
+
+          self
         end
 
         ###
-        # @param \stdClass $json_object
-        # @param ModelFactoryInterface $factory
+        # 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
         #
-        # @return static
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::ProductSearchResult
         ###
         def self.create_from_json(json_object, factory)
           product_search_result = new
@@ -51,6 +69,13 @@ module AboutYou
           product_search_result
         end
 
+        ###
+        # This method is used for parsing the facets of the search result
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the json_object received from the api
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        ###
         def parse_facets(json_object, factory)
           self.categories = factory.create_categories_facets(
             json_object['categories']
@@ -66,9 +91,10 @@ module AboutYou
         end
 
         ###
-        # Returns the min price in euro cent or null, if the price range was not requested/selected
+        # Getter for the min price
         #
-        # * @return integer|null
+        # * *Returns*    :
+        #   - nil / Integer
         ###
         def min_price
           return nil if price_ranges.empty?
@@ -82,9 +108,10 @@ module AboutYou
         end
 
         ###
-        # Returns the max price in euro cent, if the price range was not requested/selected
+        # Getter for the max price
         #
-        # @return integer|null
+        # * *Returns*    :
+        #   - nil / Integer
         ###
         def max_price
           return nil if price_ranges.empty?
@@ -98,7 +125,10 @@ module AboutYou
         end
 
         ###
-        # @return Category[]
+        # Getter for the category tree
+        #
+        # * *Returns*    :
+        #   - [] / Array containing instances of AboutYou::SDK::Model::Category
         ###
         def category_tree
           top_level_categories = []

data/lib/AboutYou/Model/{products_ean_result.rb → products_eans_result.rb}

@@ -2,21 +2,27 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # this class represents a products ean result model
-      #
       ###
       class ProductsEansResult
+        # Array of not found eans
         attr_accessor :eans_not_found
+        # String page hash
         attr_accessor :page_hash
+        # Array of errors
         attr_accessor :errors
+        # Array of instances of AboutYou::SDK::Model::Product
         attr_accessor :products
 
         ###
-        # @param \stdClass $json_object
-        # @param ModelFactoryInterface $factory
+        # 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
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::ProductsEansResult
         ###
         def self.create_from_json(json_object, factory)
           products_ean_result = new

data/lib/AboutYou/Model/products_result.rb

@@ -2,23 +2,29 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a products result model
-      #
       ###
       class ProductsResult
         include AbstractModel
 
-        attr_accessor :ids_not_found
+        # Array of not found product ids
+        attr_accessor :productsNotFound
+        # String page hash
         attr_accessor :page_hash
+        # Array of errors
         attr_accessor :errors
+        # Array of instances of AboutYou::SDK::Model::Product
         attr_accessor :products
 
         ###
-        # @param \stdClass $json_object
-        # @param ModelFactoryInterface $factory
+        # 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
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::ProductsResult
         ###
         def self.create_from_json(json_object, factory)
           products_result = new
@@ -31,7 +37,7 @@ module AboutYou
           if json_object['ids']
             json_object['ids'].each do |key, json_product|
               if json_product['error_code']
-                products_result.ids_not_found.push(key)
+                products_result.productsNotFound.push(key)
                 products_result.errors.push(json_product)
                 next
               end
@@ -43,13 +49,6 @@ module AboutYou
 
           products_result
         end
-
-        ###
-        # @return integer[] array of product ids
-        ###
-        def products_not_found
-          ids_not_found
-        end
       end
     end
   end

data/lib/AboutYou/Model/result_error.rb

@@ -2,21 +2,37 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents an result error model
-      #
       ###
       module ResultError
+        # error ident
         attr_accessor :error_ident
+        # error code
         attr_accessor :error_code
+        # error message
         attr_accessor :error_message
 
+        ###
+        # Constructor for the AboutYou::SDK::Model::ResultError class
+        #
+        # * *Args* :
+        #   - +json_object+ -> the json_object received from the api
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::ResultError
+        ###
         def initialize(json_object)
           parse_error_result(json_object)
 
           self
         end
 
+        ###
+        # This method parses the error result
+        #
+        # * *Args* :
+        #   - +json_object+ -> the json_object received from the api
+        ###
         def parse_error_result(json_object)
           self.error_ident   = json_object.key?('error_ident') ? String(json_object['error_ident']) : nil
           self.error_code    = json_object.key?('error_code') ? Integer(json_object['error_code']) : 0

data/lib/AboutYou/Model/variant.rb

@@ -2,42 +2,68 @@ module AboutYou
   module SDK
     module Model
       ###
-      #
       # This class represents a variant model
-      #
       ###
       class Variant
         include AbstractModel
-
+        # instance of AboutYou::SDK::Factory::DefaultModelFactory
         attr_accessor :factory
+        # instance of AboutYou::SDK::Model::Product
         attr_accessor :product
+        # Integer id
         attr_accessor :id
+        # Array of AboutYou::SDK::Model::Image
         attr_accessor :images
+        # instance of AboutYou::SDK::Model::Image
         attr_accessor :selected_image
+        # Integer about number id
         attr_accessor :about_number
+        # Array of AboutYou::SDK::Model::FacetGroup
         attr_accessor :facet_groups
+        # String ean
         attr_accessor :ean
+        # Boolean is variant default for product or not
         attr_accessor :is_default
+        # Integer price
         attr_accessor :price
+        # Integer old price
         attr_accessor :old_price
+        # Integer retail price
         attr_accessor :retail_price
+        # additional information
         attr_accessor :additional_info
+        # integer quantity
         attr_accessor :quantity
+        # Array of Integer facet_ids
         attr_accessor :facet_ids
+        # Integer first active data
         attr_accessor :first_active_date
+        # integer first Sale data
         attr_accessor :first_sale_date
+        # Integer creation date
         attr_accessor :created_date
+        # Integer update Date
         attr_accessor :updated_date
+        # String color
         attr_accessor :color
+        # Integer length
         attr_accessor :length
+        # string season_code
         attr_accessor :season_code
 
         ###
-        # @param \stdClass $json_object
-        # @param ModelFactoryInterface $factory
-        # @param Product $product
+        # 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
+        #   - +product+ -> Product of this variant
+        #
+        # * *Fails* :
+        #   - if json_object has no id 
         #
-        # @return static
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Variant
         ###
         def self.create_from_json(json_object, factory, product)
           fail 'MalformedJsonException' unless json_object['id']
@@ -73,6 +99,15 @@ module AboutYou
           variant
         end
 
+        ###
+        # This method is used for parsing images
+        #
+        # * *Args*    :
+        #   - +image_json+ -> the image json_object received from the api
+        #
+        # * *Returns* :
+        #   - [] / Array of instances of AboutYou::SDK::Model::Image
+        ###
         def parse_images(image_json)
           image_array = []
           image_json.each do |image|
@@ -83,11 +118,13 @@ module AboutYou
         end
 
         ###
-        # Get image by given hash.
+        # This method searches for an image by a certain hash
         #
-        # @param string $hash The image hash.
+        # * *Args*    :
+        #   - +hash+ -> the hash used for searching
         #
-        # @return Image
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::Image
         ###
         def image_by_hash(hash)
           images.each do |image|
@@ -98,13 +135,13 @@ module AboutYou
         end
 
         ###
-        # Select a specific image.
+        # You can select an image with this method by a certain hash
         #
-        # @param string $hash The image hash or null for default image.
+        # * *Args*    :
+        #   - +hash+ -> the hash used for selecting [optional]
         #
-        # @return void
-        #
-        # @depracted
+        # * *Returns* :
+        #   - Boolean determining whether the selection was successful or not
         ###
         def select_image(hash = nil)
           if hash
@@ -117,9 +154,10 @@ module AboutYou
         end
 
         ###
-        # Get selected or default image.
+        # Getter for selected / default image
         #
-        # @return Image
+        # * *Returns* :
+        #   - nil / AboutYou::SDK::Model::Image
         ###
         def image
           if selected_image
@@ -131,6 +169,15 @@ module AboutYou
           nil
         end
 
+        ###
+        # This method parses the facet ids of a certain json_object
+        #
+        # * *Args*    :
+        #   - +json_object+ -> The json_object received from the api
+        #
+        # * *Returns* :
+        #   - {} / Hash containing pairs of group_id => attribute_ids
+        ###
         def parse_facet_ids(json_object)
           ids = {}
 
@@ -142,33 +189,47 @@ module AboutYou
           ids
         end
 
+        ###
+        # This method generated a facet group set for a certain json_object
+        #
+        # * *Args*    :
+        #   - +json_object+ -> The json_object received from the api
+        ###
         def generate_facet_group_set(json_object)
           ids = parse_facet_ids(json_object)
           self.facet_groups = AboutYou::SDK::Model::FacetGroupSet.new(ids)
         end
 
         ###
-        # @param integer $group_id
+        # This method searches by a certain facet group id
+        #
+        # * *Args*    :
+        #   - +group_id+ -> The group_id used for searching
         #
-        # @return FacetGroup|null
+        # * *Returns* :
+        #   - nil / instance of AboutYou::SDK::Model::FacetGroup
         ###
         def facet_group(group_id)
           facet_groups.group(group_id)
         end
 
         ###
-        # @return FacetGroup|null
+        # Getter for the size facet group
+        #
+        # * *Returns* :
+        #   - instance of AboutYou::SDK::Model::FacetGroup
         ###
         def size
-          ###
           # @todo: Instance level caching
-          ###
           group_id = size_group_id
           facet_group(group_id) unless group_id.empty?
         end
 
         ###
-        # @return integer|null
+        # This method is used for getting the size group id
+        #
+        # * *Returns* :
+        #   - nil / group_id
         ###
         def size_group_id
           keys = {}
@@ -192,10 +253,10 @@ module AboutYou
         end
 
         ###
-        # Returns the quantity per pack for this variant.
-        # By default, this returns 1. But some items can have a bigger number.
+        # Getter for the quantity per pack
         #
-        # @return int quantity per pack
+        # * *Returns* :
+        #   - Integer quantity
         ###
         def quantity_per_pack
           facet_group = facet_group(