aboutyou-sdk 0.0.29 → 0.0.30

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWJkYTExNDNlM2QxNjIzZjdjNzdmYWRhYWI1YjBlZjc5ODFjZGMwYQ==
+    NGQwY2IxMmM2YzExZDQzYzBjZmJkNzI4ZjIwM2ZmMWZlZjMwODQyOQ==
   data.tar.gz: !binary |-
-    OGYwNWE3ZTVmNWQ5NDY2ZDczNTkwMzgxY2ViOGJlYjI1MzUxMDk1NQ==
+    MDIxYjY3ODZkMGRiYjE2OGZkZjgyMmVlMGIxNTFiMTRjMDk3MDQyYw==
 SHA512:
   metadata.gz: !binary |-
-    MmI2OGI0MWE5NTMyNzIyMmRkMDMyNTg5ZTIzODI1YjQ4MTJkNzU3NTFhMzMz
-    MDRiMzliNDdhYWQ1NGU5M2Q0NmNjYzlmZTFmMzgxZmI5NTc0N2Y5ODQzODgx
-    M2JjMjMwMWQyZjg5NTg0MjFmNDExNDc0YTFhNzVmZjM0M2E1MDg=
+    MWRiZmU3NjhlMzljODkzODYxMTc2ZWQ5ZDJlOTE4YjM0OTQxYjFhMzg2MTVk
+    ODM0NzI2MTA4ZGRiMmQzYTliZGZjYzNkMDcyNDhmY2ViYWU4ZjkyNDQ3NTRh
+    ODZiZDM3MmEwZDVkOThmMjg5NDZhYzhmMWI5YmFjYzFlM2FmMWU=
   data.tar.gz: !binary |-
-    NzgyM2ExY2Q5NmRjMDNmYTY0ZWM0MzY4NDdhNDkyMmY3NzZhZmY4NTQ0YTcx
-    YzE1MmJkZWYxMjBiODAxNzA2ZDA2ODE3N2NiYTdjYTNlMjBlN2MxYjUxNjZl
-    MWQwZjY2MzIxZjM1MWRmMWNiYjk4NzczMGFhYWEyMDA2Njk2YzI=
+    ZWFiM2ZlNjVjNjA5OTYzOGU2MjUzZTE4MDA5YzA3YjQ3OGU5MTJhYTI1ZDIw
+    YzUxYTMwMzZmNDM0NmQ2ODg0Njk3NmQyY2UwNmYxNTRkODc5Nzk0MDEwOTY5
+    NGVhYWY5MTQyNGMxOGE3Mzc0YWE5NzIxNzljNDhhM2ZmODYyY2Q=

data/lib/AboutYou/CacheProvider/dalli.rb

@@ -1,5 +1,8 @@
 module AboutYou
   module SDK
+    ###
+    # The CacheProvider namespace
+    ###
     module CacheProvider
       ###
       # This class is used as an interface for cache operations.

data/lib/AboutYou/Criteria/product_fields.rb

@@ -1,5 +1,8 @@
 module AboutYou
   module SDK
+    ###
+    # The Criteria namespace
+    ###
     module Criteria
       ###
       # This class is used for the selection of certain product fields

data/lib/AboutYou/Criteria/product_search_criteria.rb

@@ -29,18 +29,11 @@ module AboutYou
         SORT_MOST_VIEWED = 'most_viewed'
         # Sort-argument passed to api for price
         SORT_PRICE = 'price'
-
         # api-call-name for sorting ascending
         SORT_ASC  = 'asc'
         # api-call-name for sorting descending
         SORT_DESC = 'desc'
 
-        # api-call name for requiring all facets
-        FACETS_ALL = '_all'
-
-        # api-call-value for requiring unlimited facets
-        FACETS_UNLIMITED = -1
-
         # api-call-name for filtering the sale
         FILTER_SALE          = 'sale'
         # api-call-name for filtering the categories
@@ -310,6 +303,9 @@ module AboutYou
         #   - +group_id+ -> group id which facets you want to receive
         #   - +limit+ -> limits the received facets
         #
+        # * *Fails* :
+        #   - if group_id is not convertable in an Integer
+        #
         # * *Returns* :
         #   - an instance of AboutYou::SDK::Criteria::ProductSearchCriteria
         ###
@@ -318,7 +314,7 @@ module AboutYou
 
           fail "InvalidArgumentException! Group id must be an integer or a
           string containing digits" unless
-          group_id.is_a?(Fixnum) && Integer(group_id)
+          group_id.is_a?(Fixnum) || Integer(group_id)
 
           result['facets'] = {} unless result['facets']
 
@@ -356,6 +352,10 @@ module AboutYou
         # * *Args*    :
         #   - +limit+ -> limit which should be checked
         #
+        # * *Fails* :
+        #   - if limit is not an integer
+        #   - if limit is smaller then -1
+        #
         # * *Returns* :
         #   - nil if there is no error
         ###

data/lib/AboutYou/Factory/default_model_factory.rb

@@ -1,5 +1,8 @@
 module AboutYou
   module SDK
+    ###
+    # The Factory namespace
+    ###
     module Factory
       ###
       # This class creates model objects from a given api response
@@ -22,7 +25,7 @@ module AboutYou
         # * *Args*    :
         #   - +shop_api+ -> the client which should perform the api calls
         #   - +category_manager+ -> the category manager responsible for managing the categories
-        #   - +:facet_manager+ -> the facet manager responsible for managing the facets
+        #   - +facet_manager+ -> the facet manager responsible for managing the facets
         #
         # * *Returns* :
         #   - an instance of AboutYou::SDK::Factory::DefaultModelFactory
@@ -31,6 +34,13 @@ module AboutYou
           self.shop_api = shop_api
         end
 
+        ###
+        # this method initializes the managers
+        #
+        # * *Args*    :
+        #   - +facet_manager+ -> the facet manager responsible for managing the facets
+        #   - +category_manager+ -> the category manager responsible for managing the categories
+        ###
         def initialize_managers(facet_manager, category_manager)
           self.category_manager = category_manager
           self.facet_manager = facet_manager
@@ -657,9 +667,12 @@ module AboutYou
         #   - +json+ -> the api response in json format
         #   - +resultKey+ -> the result key received from the api
         #   - +isMultiRequest+ -> determines whether the api-request was multiquery or not
+        #
+        # * *Fails* :
+        #   - if the result_key is not basket and the json response does not contain order_lines
         ###
         def pre_handle_error(json, result_key, is_multi_request)
-          return false if result_key == 'basket' && json['order_lines']
+          return if result_key == 'basket' && json['order_lines']
 
           fail 'ResultError!' + json + is_multi_request
         end

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

@@ -7,34 +7,29 @@ module AboutYou
       # author:: Collins GmbH & Co KG
       ###
       module AbstractBasketItem
+        # determines if the image url is required
         IMAGE_URL_REQUIRED = false
-        ###
-        # Additional data are transmitted to the merchant untouched.
-        # If set (array not empty), a key "description" must exist. This description
-        # must be a string that describes the variant. If you want to pass a different image URL,
-        # you can add a key "image_url" to the $additional_data that contains the URL to the image.
-        #
-        # @var array $additional_data additional data for this variant
-        ###
+
+        # Additional data
         attr_accessor :additional_data
+        # determines whether a basket item is changed or not
         attr_accessor :is_changed
 
         ###
-        # @return string|null
+        # gets the description of the basket item
+        #
+        # * *Returns* :
+        #   - a String of null if no description is set
         ###
         def description
           additional_data['description'] if additional_data
         end
 
         ###
-        # Additional data are transmitted to the merchant untouched.
-        # If set (array not empty), a key "description" must exist. This description
-        # must be a string that describes the variant. If you want to pass a different image URL,
-        # you can add a key "image_url" to the $additional_data that contains the URL to the image.
+        # sets additional data for the basket item
         #
-        # @param array $additional_data additional data for this variant
-        #
-        # @throws \InvalidArgumentException
+        # * *Args*    :
+        #   - +additional_data+ -> the desired data to set
         ###
         def addition_data=(additional_data)
           check_additional_data(additional_data)
@@ -43,11 +38,21 @@ module AboutYou
           self.additional_data = additional_data
         end
 
+        ###
+        # checks if certain additional_data is valid to set for a basket item or not
+        #
+        # * *Args*    :
+        #   - +additional_data+ -> the desired data to check
+        #
+        # * *Fails* :
+        #   - if additional_data doesnt have a description
+        #   - if additional_data doesnt have an image url and it would be required
+        ###
         def check_additional_data(additional_data = nil)
-          return false if additional_data || IMAGE_URL_REQUIRED
-          fail '\InvalidArgumentException! description is required
-            in additional data' if additional_data.key?('description')
-          fail '\InvalidArgumentException! image_url is required in
+          return unless additional_data || IMAGE_URL_REQUIRED
+          fail 'InvalidArgumentException! description is required
+            in additional data' unless additional_data.key?('description')
+          fail 'InvalidArgumentException! image_url is required in
             additional data' if
             IMAGE_URL_REQUIRED && !additional_data.key?('image_url')
         end

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

@@ -7,50 +7,45 @@ module AboutYou
       # If you want to add a variant into a basket, you need to create an instance
       # of a BasketItem. The BasketItem represents a variant by it's variant_id.
       # It can contain $additional_data that will be transmitted to the merchant untouched.
-      #
-      # Example usage:
-      # $variant_id = $variant->getId(); // $variant is instance of \Collins\ShopApi\Model\Variant
-      # $basketItem = new BasketItem('my-personal-identifier', $variant_id);
-      # $basketItem->setAdditionalData('jeans with engraving 'for you'', ['engraving_text' => 'for you']);
-      # $shop_api->addItemToBasket(session_id(), $basketItem);
-      #
-      # @see \Collins\ShopApi\Model\Variant
-      # @see \Collins\ShopApi\Model\Basket
-      # @see \Collins\ShopApi
       ###
       class BasketItem
         include AboutYou::SDK::Model::ResultError
         include AboutYou::SDK::Model::AbstractBasketItem
         include AboutYou::SDK::Model::BasketVariantItem
 
-        ###
-        # The ID of this basket item. You can choose this ID by yourself to identify
-        # your item later.
-        #
-        # @var string $id ID of this basket item
-        ###
+        # The ID of this basket item. You can choose this ID by yourself to identify your item later.
         attr_accessor :id
 
         ###
-        # Constructor.
+        # Constructor for the AboutYou::SDK::Model::BasketItem class
         #
-        # @param string $id
-        # @param integer $variant_id
-        # @param array $additional_data
+        # * *Args*    :
+        #   - +id+ -> the basket item id
+        #   - +variant_id+ -> the id of the variant
+        #   - +additional_data+ -> additional data of the basket item [optional]
+        #   - +app_id+ -> the app id [optional]
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketItem
         ###
         def initialize(id, variant_id, additional_data = nil, app_id = nil)
           check_id(id)
           self.id = id
           super(variant_id, additional_data, app_id)
+
+          self
         end
 
         ###
-        # @param object $json_object The basket data.
-        # @param Product[] $products
+        # This method is used for creating a basket item with a given api json
+        # response. It is best practice to use this method.
         #
-        # @return BasketItem
+        # * *Args*    :
+        #   - +json_object+ -> the api response key
+        #   - +products+ -> array of products
         #
-        # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketItem
         ###
         def create_from_json(json_object, products)
           item = new(
@@ -81,13 +76,18 @@ module AboutYou
         end
 
         ###
-        # @param mixed $id
-        # @throws \InvalidArgumentException
+        # This method checks whether an basket item id is valid or not
+        #
+        # * *Args*    :
+        #   - +id+ -> the id which should be checked
+        #
+        # * *Fails* :
+        #   - if the id is not a String and has less then 2 characters
         ###
         def check_id(id)
           fail '\InvalidArgumentException! ID of the BasketSetItem must be
             a String that must contain minimum two characters' unless
-            id.is_a?(String) || id.length < 2
+            id.is_a?(String) && id.length < 2
         end
       end
     end

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

@@ -10,77 +10,59 @@ module AboutYou
       # A set can be useful if you want to sell several variants as a single product.
       # For example, if you offer a pair of shoes and additionally different styles of shoelaces
       # the customer can choose from, you maybe want to put both - shoes and laces - together.
-      #
-      # Example usage:
-      # $lacesVariantId = $lacesVariant->getId(); // $lacesVariant is instance of \Collins\ShopApi\Model\Variant
-      # $shoesVariantID = $shoesVariant->getId(); // $lacesVariant is instance of \Collins\ShopApi\Model\Variant
-      # $basketItem1 = new BasketItem($lacesVariantId);
-      #
-      # $basketSet = new BasketItemSet('my-personal-identifier');
-      # $basketSet->addItem(new BasketSetItem($lacesVariantId));
-      # $basketSet->addItem(new BasketSetItem($shoesVariantId));
-      # $basketSet->setAdditionalData(['description' => 'Shoes with laces 'yellow star'', 'image_url' = 'http://myapp.com/shoes_yello_star.png']);
-      # $basket->updateItemSet($basketSet)
-      # $shop_api->update_basket(session_id(), $basket);
-      #
-      # You can use the static method create as an alternative to generate a basket set:
-      # $basketSet = BasketItemSet::create(
-      #     'my-personal-identifier',
-      #     [
-      #         [$lacesVariant->getId()],
-      #         [$shoesVariantID->getId()],
-      #     ]
-      # );
-      # @see create()
-      #
-      # @see     \Collins\ShopApi\Model\Basket
-      # @see     \Collins\ShopApi\Model\Basket\BasketSetItem
-      # @see     \Collins\ShopApi\Model\Variant
-      # @see     \Collins\ShopApi
       ###
       class BasketSet
         include AboutYou::SDK::Model::ResultError
         include AboutYou::SDK::Model::AbstractBasketItem
 
+        # determines if an image url is required
         IMAGE_URL_REQUIRED = true
 
-        ###
-        # The ID of this basket item. You can choose this ID by yourself to identify
-        # your item later.
-        #
-        # @var string $id ID of this basket item
-        ###
+        # The ID of this basket item. You can choose this ID by yourself to identify your item later.
         attr_accessor :id
+        # array containing instances of AboutYou::SDK::Model::BasketSetItem
         attr_accessor :items
+        # array containing errors
         attr_accessor :errors
+        # total price of the set
         attr_accessor :total_price
+        # total net worth of the set
         attr_accessor :total_net
+        # total vat worth of the set
         attr_accessor :total_vat
+        # app id of an item
         attr_accessor :item_app_id
 
         ###
-        # Additional data are transmitted to the merchant untouched.
-        # If set (array not empty), a key 'description' must exist. This description
-        # must be a string that describes the variant. If you want to pass an image URL that
-        # represents this item set,
-        # you can add a key 'image_url' to the $additional_data that contains the URL to the image.
+        # Constructor for the AboutYou::SDK::Model::BasketSet class
         #
-        # @param string $id ID of the basket item set.
-        # @param array $additional_data additional data for this item set
+        # * *Args*    :
+        #   - +id+ -> the id of the basket set
+        #   - +additional_data+ -> additional data of the basket set
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketSet
         ###
         def initialize(id, additional_data = nil)
           check_id(id)
           check_additional_data(additional_data, true)
           self.id = id
           self.additional_data = additional_data
+
+          self
         end
 
         ###
-        # @param \stdClass $json_object
-        # @param ModelFactoryInterface $factory
-        # @param Product[] $products
+        # This method is used for creating a basket set with a given api json
+        # response. It is best practice to use this method.
         #
-        # @return BasketSet
+        # * *Args*    :
+        #   - +json_object+ -> the api response key
+        #   - +factory+ -> instance of AboutYou::SDK::Factory::DefaultModelFactory
+        #   - +products+ -> Array of products
+        #
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketSet
         ###
         def create_from_json(json_object, factory, products)
           set = new(
@@ -116,21 +98,16 @@ module AboutYou
         end
 
         ###
-        # Create an basket item set from an array, for example:
-        #  BasketSet::create(
-        #      'identifier4',
-        #      [
-        #          [12312121],
-        #          [7777777, ['description' => 'engravingssens', 'internal_infos' => ['stuff']]]
-        #      ],
-        #      ['description' => 'Wunderschön und so']
-        #  );
+        # This method is used for creating a basket set from an array containing
+        # instances of AboutYou::SDK::Model::BasketSetItem
         #
-        # @param $itemId
-        # @param $subItems
-        # @param array $additional_data
+        # * *Args*    :
+        #   - +item_id+ -> the id of the set
+        #   - +sub_items+ -> Array containing instances of AboutYou::SDK::Model::BasketSetItem
+        #   - +additional_data+ -> additional data of the basket set
         #
-        # @return BasketSet
+        # * *Returns* :
+        #   - an instance of AboutYou::SDK::Model::BasketSet
         ###
         def create(item_id, sub_items, additional_data = nil)
           set = new(item_id, additional_data)
@@ -148,7 +125,13 @@ module AboutYou
         end
 
         ###
-        # @param BasketSetItem $item
+        # This method is used for adding items to a basket set
+        #
+        # * *Args*    :
+        #   - +item+ -> instance of AboutYou::SDK::Model::BasketSetItem
+        #
+        # * *Fails* :
+        #   - if the app id of the set and item diverge
         ###
         def add_item(item)
           if items.count == 0
@@ -162,12 +145,21 @@ 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?
           error_code || errors.count > 0
         end
 
+        ###
+        # 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 = ':'
           unless additional_data
@@ -185,13 +177,19 @@ module AboutYou
         end
 
         ###
-        # @param mixed $id
-        # @throws \InvalidArgumentException
+        # This method is used for determining whether a certain id is valid for
+        # the basket set or not
+        #
+        # * *Args*    :
+        #   - +id+ -> the id which should be checked
+        #
+        # * *Fails* :
+        #   - if the id is not a String and its length is smaller then 2
         ###
         def check_id(id)
           fail '\InvalidArgumentException! ID of the BasketSetItem must be a
             String that must contain minimum two characters' unless
-              id.is_a?(String) || !id.length < 2
+              id.is_a?(String) && id.length > 1
         end
       end
     end