aboutyou-sdk 0.0.1

data/lib/aboutyou-sdk/Model/Basket/BasketItem.rb

@@ -0,0 +1,100 @@
+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 variantId.
+        # It can contain $additionalData that will be transmitted to the merchant untouched.
+        #
+        # Example usage:
+        # $variantId = $variant->getId(); // $variant is instance of \Collins\ShopApi\Model\Variant
+        # $basketItem = new BasketItem('my-personal-identifier', $variantId);
+        # $basketItem->setAdditionalData('jeans with engraving "for you"', ['engraving_text' => 'for you']);
+        # $shopApi->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 $variantId
+            # @param array $additionalData
+            ###
+           def initialize(id, variantId, additionalData = nil, appId = nil)
+
+               self.checkId(id);
+               self.id = id;
+               super(variantId, additionalData, appId);
+           end
+
+            ###
+            # @param object $jsonObject The basket data.
+            # @param Product[] $products
+            #
+            # @return BasketItem
+            #
+            # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+            ###
+           def self.createFromJson(jsonObject, products)
+
+               item = self.new(
+                   jsonObject["id"], 
+                   jsonObject["variant_id"], 
+                   (jsonObject.key?("additional_data")) ? Array(jsonObject["additional_data"]) : nil,
+                   (jsonObject.key?("app_id")) ? jsonObject["app_id"] : nil
+               )
+
+               item.parseErrorResult(jsonObject);
+
+               item.jsonObject = jsonObject;
+
+               if !(jsonObject["product_id"].empty?)
+                   if (products.key?(jsonObject["product_id"]))
+                       item.product=(products[jsonObject["product_id"]]);
+                   else
+                       raise '\Collins\ShopApi\Exception\UnexpectedResultException! Product with ID '+String(jsonObject["product_id"])+' expected but wasnt received with the basket'
+                   end
+               end
+
+               jsonObject["id"] = nil
+               jsonObject["variant_id"] = nil
+               jsonObject["additional_data"] = nil
+               jsonObject["product_id"] = nil
+
+               return item;
+           end
+
+
+            ###
+            # @param mixed $id
+            # @throws \InvalidArgumentException
+            ###
+           def self.checkId(id) 
+
+               if (!(id.is_a? String) || id.length < 2)
+                   raise '\InvalidArgumentException! ID of the BasketSetItem must be a String that must contain minimum two characters'            
+               end
+           end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/Basket/BasketSet.rb

@@ -0,0 +1,192 @@
+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)
+       # $shopApi->updateBasket(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 :totalPrice;
+          attr_accessor :totalNet
+          attr_accessor :totalVat
+          attr_accessor :itemAppId
+
+
+           ###
+           # 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 $additionalData that contains the URL to the image.
+           #
+           # @param string $id ID of the basket item set.
+           # @param array $additionalData additional data for this item set
+           ###
+          def initialize(id, additionalData = nil)
+          
+              self.checkId(id);
+              self.checkAdditionData(additionalData, true);
+              self.id = id;
+              self.additionalData = additionalData;
+          end
+
+           ###
+           # @param \stdClass $jsonObject
+           # @param ModelFactoryInterface $factory
+           # @param Product[] $products
+           #
+           # @return BasketSet
+           ###
+          def self.createFromJson(jsonObject, factory, products)
+          
+              set = self.new(jsonObject["id"], (jsonObject.key?("additional_data") ? Array(jsonObject["additional_data"]) : nil));
+
+              set.parseErrorResult(jsonObject);
+
+              jsonObject["set_items"].each do |index, jsonItem|
+                  item = factory.createBasketSetItem(jsonItem, products);
+                  if (item.hasErrors) 
+                      set.errors[index] = item;
+                  else
+                      set.items[index] = item;
+                  end
+              end
+
+              set.totalPrice = (jsonObject.key?("total_price") ? jsonObject["total_price"] : nil)
+              set.totalNet = (jsonObject.key?("total_net") ? jsonObject["total_net"] : nil)
+              set.totalVat = (jsonObject.key?("total_vat") ? jsonObject["total_vat"] : nil)
+
+              return 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 $additionalData
+           #
+           # @return BasketSet
+           ###
+          def self.create(itemId, subItems, additionalData = nil)
+          
+              set = self.new(itemId, additionalData);
+              subItems.each do |itemData|
+                  set.addItem(AboutYou::SDK::Model::BasketSetItem.new(itemData[0], (itemData[1]) ? itemData[1] : nil));
+              end
+
+              return set;
+          end
+
+           ###
+           # @param BasketSetItem $item
+           ###
+          def addItem(item)
+          
+              if (self.items.count == 0) 
+                  self.itemAppId= item.appId();
+              elsif (self.itemAppId != item.appId) 
+                  raise '\InvalidArgumentException! you can not set different app ids for items in an item-set.'
+              end
+
+              self.items.push(item);
+          end
+
+          
+           ###
+           # @return boolean
+           ###
+          def hasErrors()
+          
+              return self.errorCode || self.errors.count > 0;
+          end
+
+
+          def uniqueKey()
+          
+              key = ':';
+              additionalData = self.additionalData;
+              if !(additionalData)
+                  additionalData.sort!
+                  key = key + ':' + additionalData.to_json
+              end
+
+              items = Array(nil);
+              self.items.each do |item|
+                  items.push(item.uniqueKey);
+              end
+              key = key + items.to_json;
+
+              return key;
+          end
+
+           ###
+           # @param mixed $id
+           # @throws \InvalidArgumentException
+           ###
+          def checkId(id) 
+          
+              if (!(id.is_a? String) || id.length < 2)
+                  raise '\InvalidArgumentException! ID of the BasketSetItem must be a String that must contain minimum two characters'          
+              end
+          end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/Basket/BasketSetItem.rb

@@ -0,0 +1,46 @@
+module AboutYou
+  module SDK
+    module Model
+      class BasketSetItem
+          include AboutYou::SDK::Model::BasketVariantItem 
+        
+          ERROR_CODE_PRODUCT_NOT_INCLUDED = 1001;
+
+           ###
+           # @param object $jsonObject The basket data.
+           # @param Product[] $products
+           #
+           # @return BasketVariantItem
+           #
+           # @throws \Collins\ShopApi\Exception\UnexpectedResultException
+           ###
+          def self.createFromJson(jsonObject, products)
+          
+              item = self.new(
+                  jsonObject["variant_id"], 
+                  (jsonObject.key?("additional_data") ? Array(jsonObject["additional_data"]) :nil),
+                  (jsonObject.key?("app_id") ? jsonObject["app_id"] :nil)
+              );
+
+              item.parseErrorResult(jsonObject);
+
+              item.jsonObject = jsonObject;
+
+              if (jsonObject["product_id"] != nil)
+                  if (products.key?(jsonObject["product_id"]))
+                      item.product=(products[jsonObject["product_id"]]);
+                  else
+                      item.errorCode    = ERROR_CODE_PRODUCT_NOT_INCLUDED;
+                      item.errorMessage = 'Product with ID '+jsonObject["product_id"]+' expected but wasnt received with the basket';
+                  end
+              end  
+              jsonObject["variant_id"] = nil
+              jsonObject["additional_data"] = nil
+              jsonObject["product_id"] = nil
+
+              return item;
+          end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/Basket/BasketVariantItem.rb

@@ -0,0 +1,137 @@
+module AboutYou
+  module SDK
+    module Model
+      module BasketVariantItem
+           
+          attr_accessor :jsonObject
+          attr_accessor :product 
+          attr_accessor :variant
+          attr_accessor :variantId
+          attr_accessor :appId 
+
+           ###
+           # Constructor.
+           #
+           # @param integer $variantId
+           # @param array $additionalData
+           ###
+          def initialize(variantId, additionalData = nil, appId = nil)
+          
+              self.checkVariantId(variantId);
+              self.checkAdditionData(additionalData);        
+              self.variantId = variantId;
+              self.additionalData = additionalData;
+
+              if (appId) 
+                  self.checkAppId(appId);
+                  self.appId = appId;            
+              end
+          end
+
+           ###
+           # @return boolean
+           ###
+          def hasErrors()
+          
+              return self.errorCode > 0;
+          end
+
+           ###
+           # Get the total price.
+           #
+           # @return integer
+           ###
+          def totalPrice()
+          
+              return self.jsonObject["total_price"];
+          end
+
+           ###
+           # Get the tax.
+           #
+           # @return integer
+           ###
+          def tax()
+          
+              return self.jsonObject["tax"];
+          end
+
+
+           ###
+           # Get the value added tax.
+           #
+           # @return integer
+           ###
+          def totalVat()
+          
+              return self.jsonObject["total_vat"];
+          end
+
+           ###
+           # @return integer
+           ###
+          def totalNet()
+          
+              return self.jsonObject["total_net"];
+          end
+
+
+           ###
+           # Get the variant old price in euro cents.
+           #
+           # @return integer
+           ###
+          def oldPrice()
+          
+              return self.variant.oldPrice();
+          end
+
+
+           ###
+           # Get the product variant.
+           #
+           # @return Variant
+           ###
+          def variant()
+          
+              if !(self.variant) 
+                  self.variant = (self.product) ?
+                      self.product.variantById(self.variantId) :
+                      nil
+              end        
+
+              return self.variant;
+          end
+
+
+           ###
+           # @return string
+           ###
+          def uniqueKey()
+          
+              key = self.variantId();
+              additionalData = self.additionalData
+              if(additionalData)
+                  additionalData.sort!
+                  key = key + ':' + additionalData.to_json;
+              end
+              return key;
+          end
+
+          def checkVariantId(variantId)
+          
+              if !(Integer(variantId))
+                  raise '\InvalidArgumentException! the variant id must be an integer'
+              end
+          end
+
+          def checkAppId(appId)
+          
+              if !(Integer(appId))
+                  raise '\InvalidArgumentException! the app id must be an integer'
+              end
+          end
+      end
+    end
+  end
+end