aboutyou-sdk 0.0.24 → 0.0.25

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

@@ -0,0 +1,57 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # This class is an abstract model of a basket item
+      #
+      # author:: Collins GmbH & Co KG
+      ###
+      module AbstractBasketItem
+        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
+        ###
+        attr_accessor :additional_data
+        attr_accessor :is_changed
+
+        ###
+        # @return string|null
+        ###
+        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.
+        #
+        # @param array $additional_data additional data for this variant
+        #
+        # @throws \InvalidArgumentException
+        ###
+        def addition_data=(additional_data)
+          check_additional_data(additional_data)
+          self.is_changed = true
+
+          self.additional_data = additional_data
+        end
+
+        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
+            additional data' if
+            IMAGE_URL_REQUIRED && !additional_data.key?('image_url')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # BasketItem is a class used for adding a variant item into the basket
+      #
+      # 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
+        ###
+        attr_accessor :id
+
+        ###
+        # Constructor.
+        #
+        # @param string $id
+        # @param integer $variant_id
+        # @param array $additional_data
+        ###
+        def initialize(id, variant_id, additional_data = nil, app_id = nil)
+          check_id(id)
+          self.id = id
+          super(variant_id, additional_data, app_id)
+        end
+
+        ###
+        # @param object $json_object The basket data.
+        # @param Product[] $products
+        #
+        # @return BasketItem
+        #
+        # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+        ###
+        def create_from_json(json_object, products)
+          item = new(
+              json_object['id'],
+              json_object['variant_id'],
+              if json_object.key?('additional_data')
+                [json_object['additional_data']]
+              else
+                nil
+              end,
+              json_object.key?('app_id') ? json_object['app_id'] : nil
+          )
+
+          item.parse_error_result(json_object)
+          item.json_object = json_object
+
+          unless json_object['product_id'].empty?
+            if products.key?(json_object['product_id'])
+              item.product = products[json_object['product_id']]
+            else
+              fail 'UnexpectedResultException! Product with ID ' +
+                String(json_object['product_id']) +
+                ' expected but wasnt received with the basket'
+            end
+          end
+
+          item
+        end
+
+        ###
+        # @param mixed $id
+        # @throws \InvalidArgumentException
+        ###
+        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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # BasketSet is a class used for adding a set of variant items into the basket
+      #
+      # If you want to add a set of variant items into a basket, you need to create an instance
+      # of a BasketSet. The BasketSet contains BasketSetItems.
+      #
+      # 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
+
+        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
+        ###
+        attr_accessor :id
+        attr_accessor :items
+        attr_accessor :errors
+        attr_accessor :total_price
+        attr_accessor :total_net
+        attr_accessor :total_vat
+        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.
+        #
+        # @param string $id ID of the basket item set.
+        # @param array $additional_data additional data for this item set
+        ###
+        def initialize(id, additional_data = nil)
+          check_id(id)
+          check_additional_data(additional_data, true)
+          self.id = id
+          self.additional_data = additional_data
+        end
+
+        ###
+        # @param \stdClass $json_object
+        # @param ModelFactoryInterface $factory
+        # @param Product[] $products
+        #
+        # @return BasketSet
+        ###
+        def create_from_json(json_object, factory, products)
+          set = new(
+            json_object['id'],
+            if json_object.key?('additional_data')
+              [json_object['additional_data']]
+            else
+              nil
+            end
+            )
+
+          set.parse_error_result(json_object)
+
+          json_object['set_items'].each do |index, json_term|
+            item = factory.create_basket_set_item(json_term, products)
+            if item.errors?
+              set.errors[index] = item
+            else
+              set.items[index] = item
+            end
+          end
+          if json_object.key?('total_price')
+            set.totalPrice = json_object['total_price']
+          end
+          if json_object.key?('total_net')
+            set.totalPrice = json_object['total_net']
+          end
+          if json_object.key?('total_vat')
+            set.totalPrice = json_object['total_vat']
+          end
+
+          set
+        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']
+        #  );
+        #
+        # @param $itemId
+        # @param $subItems
+        # @param array $additional_data
+        #
+        # @return BasketSet
+        ###
+        def create(item_id, sub_items, additional_data = nil)
+          set = new(item_id, additional_data)
+
+          sub_items.each do |item_data|
+            set.add_item(
+              AboutYou::SDK::Model::BasketSetItem.new(
+                item_data[0],
+                item_data[1] ? item_data[1] : nil
+              )
+            )
+          end
+
+          set
+        end
+
+        ###
+        # @param BasketSetItem $item
+        ###
+        def add_item(item)
+          if items.count == 0
+            self.item_app_id = item.app_id
+          elsif item_app_id != item.app_id
+            fail '\InvalidArgumentException! you can not set different app ids
+              for items in an item-set.'
+          end
+
+          items.push(item)
+        end
+
+        ###
+        # @return boolean
+        ###
+        def errors?
+          error_code || errors.count > 0
+        end
+
+        def unique_key
+          key = ':'
+          unless additional_data
+            additional_data.sort!
+            key = key + ':' + additional_data.to_json
+          end
+
+          items = []
+          self.items.each do |item|
+            items.push(item.unique_key)
+          end
+          key += items.to_json
+
+          key
+        end
+
+        ###
+        # @param mixed $id
+        # @throws \InvalidArgumentException
+        ###
+        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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module AboutYou
+  module SDK
+    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
+
+        ERROR_CODE_PRODUCT_NOT_INCLUDED = 1001
+
+        ###
+        # @param object $json_object The basket data.
+        # @param Product[] $products
+        #
+        # @return BasketVariantItem
+        #
+        # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+        ###
+        def create_from_json(json_object, products)
+          item = new(
+            json_object['variant_id'],
+            if json_object.key?('additional_data')
+              [json_object['additional_data']]
+            else
+              nil
+            end,
+            json_object.key?('app_id') ? json_object['app_id'] : nil
+          )
+
+          item.parse_error_result(json_object)
+          item.json_object = json_object
+
+          unless json_object['product_id'].nil?
+            if products.key?(json_object['product_id'])
+              item.product = products[json_object['product_id']]
+            else
+              item.errorCode    = ERROR_CODE_PRODUCT_NOT_INCLUDED
+              item.errorMessage = 'Product with ID ' +
+                json_object['product_id'] + ' expected but wasnt received
+                with the basket'
+            end
+          end
+
+          item
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+module AboutYou
+  module SDK
+    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
+        attr_accessor :json_object
+        attr_accessor :product
+        attr_accessor :variant
+        attr_accessor :variant_id
+        attr_accessor :app_id
+
+        ###
+        # Constructor.
+        #
+        # @param integer $variant_id
+        # @param array $additional_data
+        ###
+        def initialize(variant_id, additional_data = nil, app_id = nil)
+          check_variant_id(variant_id)
+          check_addition_data(additional_data)
+          self.variant_od = variant_id
+          self.additional_data = additional_data
+
+          return unless app_id
+
+          check_app_id(app_id)
+          self.app_id = app_id
+        end
+
+        ###
+        # @return boolean
+        ###
+        def errors?
+          error_code > 0
+        end
+
+        ###
+        # Get the total price.
+        #
+        # @return integer
+        ###
+        def total_price
+          json_object['total_price']
+        end
+
+        ###
+        # Get the tax.
+        #
+        # @return integer
+        ###
+        def tax
+          json_object['tax']
+        end
+
+        ###
+        # Get the value added tax.
+        #
+        # @return integer
+        ###
+        def total_vat
+          json_object['total_vat']
+        end
+
+        ###
+        # @return integer
+        ###
+        def total_net
+          json_object['total_net']
+        end
+
+        ###
+        # Get the variant old price in euro cents.
+        #
+        # @return integer
+        ###
+        def old_price
+          variant.old_price
+        end
+
+        ###
+        # Get the product variant.
+        #
+        # @return Variant
+        ###
+        def variant
+          self.variant = product.variant_by_id(variant_id) unless
+          @variant && product
+
+          @variant
+        end
+
+        ###
+        # @return string
+        ###
+        def unique_key
+          key = variant_id
+          if additionalData
+            additionalData.sort!
+            key += ':' + additionalData.to_json
+          end
+
+          key
+        end
+
+        def check_variant_id(variant_id)
+          fail '\InvalidArgumentException! the variant id must be
+            an integer' unless variant_id.is_a?(Integer)
+        end
+
+        def check_app_id(app_id)
+          fail '\InvalidArgumentException! the app id must be
+            an integer' unless app_id.is_a?(Integer)
+        end
+      end
+    end
+  end
+end