aboutyou-sdk 0.0.29 → 0.0.30

data/lib/AboutYou/Model/Basket/basket_set_item.rb

@@ -3,23 +3,22 @@ module AboutYou
     module Model
       ###
       # BasketSetItem is a class used for adding a variant set item into the basket
-      #
-      # @see \Collins\ShopApi\Model\Variant
-      # @see \Collins\ShopApi\Model\Basket
-      # @see \Collins\ShopApi
       ###
       class BasketSetItem
         include AboutYou::SDK::Model::BasketVariantItem
-
+        # erorr code if a product is not included
         ERROR_CODE_PRODUCT_NOT_INCLUDED = 1001
 
         ###
-        # @param object $json_object The basket data.
-        # @param Product[] $products
+        # This method is used for creating a basket set item from a given api json
+        # response. It is best practice to use this method.
         #
-        # @return BasketVariantItem
+        # * *Args*    :
+        #   - +json_object+ -> the api response key
+        #   - +products+ -> Array of products
         #
-        # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketSetItem
         ###
         def create_from_json(json_object, products)
           item = new(

data/lib/AboutYou/Model/Basket/basket_variant_item.rb

@@ -3,23 +3,29 @@ module AboutYou
     module Model
       ###
       # BasketVairantItem is a class representing a basket variant item
-      #
-      # @see \Collins\ShopApi\Model\Variant
-      # @see \Collins\ShopApi\Model\Basket
-      # @see \Collins\ShopApi
       ###
       module BasketVariantItem
+        # the json object from which this instance was created from
         attr_accessor :json_object
+        # the product of this variant item
         attr_accessor :product
+        # the variant of this variant item
         attr_accessor :variant
+        # the variant id of this variant item
         attr_accessor :variant_id
+        # the app id of this variant item
         attr_accessor :app_id
 
         ###
-        # Constructor.
+        # Constructor for the AboutYou::SDK::Model::BasketVariantItem class
         #
-        # @param integer $variant_id
-        # @param array $additional_data
+        # * *Args*    :
+        #   - +variant_id+ -> the id of the variant item
+        #   - +additional_data+ -> additional data of the variant item
+        #   - +app_id+ -> the app id for the variant item
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketVariantItem
         ###
         def initialize(variant_id, additional_data = nil, app_id = nil)
           check_variant_id(variant_id)
@@ -27,66 +33,79 @@ module AboutYou
           self.variant_od = variant_id
           self.additional_data = additional_data
 
-          return unless app_id
+          return self unless app_id
 
           check_app_id(app_id)
           self.app_id = app_id
+
+          self
         end
 
         ###
-        # @return boolean
+        # This method checks if there are errors in the variant item
+        #
+        # * *Returns* :
+        #   - Boolean determining whether there are errors or not
         ###
         def errors?
           error_code > 0
         end
 
         ###
-        # Get the total price.
+        # Getter for the total price
         #
-        # @return integer
+        # * *Returns* :
+        #   - an Integer containing the total price
         ###
         def total_price
           json_object['total_price']
         end
 
         ###
-        # Get the tax.
+        # Getter for the tax
         #
-        # @return integer
+        # * *Returns* :
+        #   - an Integer containing the tax
         ###
         def tax
           json_object['tax']
         end
 
         ###
-        # Get the value added tax.
+        # Getter for the total vat
         #
-        # @return integer
+        # * *Returns* :
+        #   - an Integer containing the total vat
         ###
         def total_vat
           json_object['total_vat']
         end
 
         ###
-        # @return integer
+        # Getter for the total net
+        #
+        # * *Returns* :
+        #   - an Integer containing the total net
         ###
         def total_net
           json_object['total_net']
         end
 
         ###
-        # Get the variant old price in euro cents.
+        # Getter for the old price of the variant
         #
-        # @return integer
+        # * *Returns* :
+        #   - an Integer containing the old price of the variant
         ###
         def old_price
           variant.old_price
         end
 
         ###
-        # Get the product variant.
+        # Getter for the variant
         #
-        # @return Variant
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::Variant
         ###
         def variant
           self.variant = product.variant_by_id(variant_id) unless
@@ -96,7 +115,10 @@ module AboutYou
         end
 
         ###
-        # @return string
+        # This method is used for creating a unique key for the basket set
+        #
+        # * *Returns* :
+        #   - a String containing a unique key for the basket set
         ###
         def unique_key
           key = variant_id
@@ -108,11 +130,23 @@ module AboutYou
           key
         end
 
+        ###
+        # This method checks if a variant id is valid
+        #
+        # * *Fails* :
+        #   - if variant_id is not an integer
+        ###
         def check_variant_id(variant_id)
           fail '\InvalidArgumentException! the variant id must be
             an integer' unless variant_id.is_a?(Integer)
         end
 
+        ###
+        # This method checks if an app id is valid
+        #
+        # * *Fails* :
+        #   - if app_id is not an integer
+        ###
         def check_app_id(app_id)
           fail '\InvalidArgumentException! the app id must be
             an integer' unless app_id.is_a?(Integer)

data/lib/AboutYou/Model/ProductSearchResult/facet_count.rb

@@ -3,8 +3,6 @@ module AboutYou
     module Model
       ###
       # This class represents a FacetCount model.
-      #
-      # author:: Collins GmbH & Co KG
       ###
       class FacetCount
         # The Facet

data/lib/AboutYou/Model/ProductSearchResult/price_range.rb

@@ -17,9 +17,9 @@ module AboutYou
         attr_accessor :min
         # max value of the price range
         attr_accessor :max
-        #
+        # mean
         attr_accessor :mean
-        #
+        # sum
         attr_accessor :sum
 
         ###

data/lib/AboutYou/Model/abstract_model.rb

@@ -1,12 +1,14 @@
 module AboutYou
   module SDK
+    ###
+    # The Model namespace
+    ###
     module Model
       ###
-      # This Module is abstract and represents a model which has a shop_api attribute
-      #
-      # author:: Collins GmbH & Co KG
+      # This Module represents a model which has a shop_api attribute
       ###
       module AbstractModel
+        # instance of AY
         attr_accessor :shop_api
       end
     end

data/lib/AboutYou/Model/app.rb

@@ -3,8 +3,6 @@ module AboutYou
     module Model
       ###
       # This Class represents an app model
-      #
-      # author:: Collins GmbH & Co KG
       ###
       class App
         # the id of the app

data/lib/AboutYou/Model/autocomplete.rb

@@ -3,8 +3,6 @@ module AboutYou
     module Model
       ###
       # This Class represents an autocomplete model
-      #
-      # author:: Collins GmbH & Co KG
       ###
       class Autocomplete
         # this constant is used for values which are not requested

data/lib/AboutYou/Model/basket.rb

@@ -3,28 +3,38 @@ module AboutYou
     module Model
       ###
       # This Class represents a basket model
-      #
-      # author:: Collins GmbH & Co KG
       ###
       class Basket
         # array of items in the basket
         attr_accessor :items
         # errors of the basket
         attr_accessor :errors
+        # Integer count of unique variants
         attr_accessor :unique_variant_count
+        # Array of products
         attr_accessor :products
+        # Integer containing the total price of the basket
         attr_accessor :total_price
+        # Integer containing the total net woth of the basket
         attr_accessor :total_net
+        # Integer containing the total vat woth of the basket
         attr_accessor :total_vat
+        # Integer containing the total amount of the basket
         attr_accessor :total_amount
+        # Array containing the deleted items in the basket
         attr_accessor :deleted_items
+        # Array containing the updated items in the basket
         attr_accessor :updated_items
 
         ###
-        # @param object $json_object
-        # @param ModelFactoryInterface $factory
+        # 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
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def self.create_from_json(json_object, factory)
           basket = new
@@ -41,21 +51,38 @@ module AboutYou
         end
 
         ###
-        # @return boolean
+        # This method checks if there are errors in the basket set
+        #
+        # * *Returns* :
+        #   - Boolean determining whether there are errors or not
         ###
         def errors?
           errors.count > 0
         end
 
         ###
-        # @param $itemId
+        # This method gets an item from the basket for a given item id
+        #
+        # * *Args*    :
+        #   - +item_id+ -> the id used for searching in the basket
         #
-        # @return BasketItem|BasketSet|null
+        # * *Returns* :
+        #   - instance of AboutYou::SDK::Model::BasketItem or null if not found
         ###
         def item(item_id)
           return items[item_id] if items.key?(item_id)
         end
 
+        ###
+        # This methods creates a Hash containing pairs of 
+        # unique_item_key => instance of AboutYou::SDK::Model::BasketItem
+        # It only contains 1 entry per unique_item_key and will increase the amount
+        # if more items are given
+        #
+        # * *Returns* :
+        #   - Hash containing pairs of 
+        #     unique_item_key => instance of AboutYou::SDK::Model::BasketItem
+        ###
         def collected_items
           items = self.items
           items_merged = {}
@@ -81,8 +108,11 @@ module AboutYou
         end
 
         ###
-        # build order line for update query
-        # @return array
+        # This method builds the order lines for the update query
+        #
+        # * *Returns* :
+        #   - Array containing either Hashes with pairs of 'delete' => item_id
+        #     or instances of AboutYou::SDK::Model::BasketItem
         ###
         def order_lines_array
           order_lines = []
@@ -98,6 +128,16 @@ module AboutYou
           order_lines
         end
 
+        ###
+        # This method is used for parsing the items in the basket
+        #
+        # * *Args* :
+        #   - +json_object+ -> the json object received from the api
+        #   - +factory+ -> Instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
+        ###
         def parse_items(json_object, factory)
           products = {}
 
@@ -125,12 +165,18 @@ module AboutYou
 
           vids = vids.uniq
           self.uniqueVariantCount = vids.count
+
+          self
         end
 
         ###
-        # @param string $itemId
+        # This method is used for deleting an item from the basket
+        #
+        # * *Args* :
+        #   - +item_id+ -> the item_id for which the item should be deleted
         #
-        # @return $this
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def delete_item(item_id)
           deleted_items[item_id] = item_id
@@ -139,9 +185,13 @@ module AboutYou
         end
 
         ###
-        # @param string[] $itemIds
+        # This method is used for deleting items from the basket
         #
-        # @return $this
+        # * *Args* :
+        #   - +item_ids+ -> Array containing item ids for which items should be deleted
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def delete_items(item_ids)
           item_ids.each do |item_id|
@@ -152,7 +202,10 @@ module AboutYou
         end
 
         ###
-        # @return $this
+        # This method is used for deleting all items from the basket
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def delete_all_items
           items = self.items
@@ -168,9 +221,13 @@ module AboutYou
         end
 
         ###
-        # @param BasketItem $basketItem
+        # This method is used for updating an item in the basket
+        #
+        # * *Args* :
+        #   - +basket_item+ -> instance of AboutYou::SDK::Model::BasketItem
         #
-        # @return $this
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def update_item(basket_item)
           item = {
@@ -189,9 +246,13 @@ module AboutYou
         end
 
         ###
-        # @param BasketSet $basketSet
+        # This method is used for updating an item set in the basket
         #
-        # @return $this
+        # * *Args* :
+        #   - +basket_item+ -> instance of AboutYou::SDK::Model::BasketSet
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::Basket
         ###
         def update_item_set(basket_set)
           items = basket_set.items
@@ -222,6 +283,17 @@ module AboutYou
           self
         end
 
+        ###
+        # checks if certain additional_data is valid to set for a basket or not
+        #
+        # * *Args*    :
+        #   - +add_data+ -> the desired data to check
+        #   - +_img_url_required+ -> unused operator
+        #
+        # * *Fails* :
+        #   - if add_data doesnt have a description
+        #   - if add_data doesnt have valid internal infos
+        ###
         def check_additional_data(add_data = nil, _img_url_required = false)
           fail 'InvalidArgumentException! description is required
             in additional data' if add_data && !add_data.key?('description')