aboutyou-sdk 0.0.1

data/lib/aboutyou-sdk/Model/AbstractModel.rb

@@ -0,0 +1,26 @@
+module AboutYou
+  module SDK
+    module Model
+      module AbstractModel
+        # @var ShopApi #
+        @shopApi
+
+         ###
+         # @param ShopApi $shopApi
+         ###
+        def shopApi=(shopApi)
+        
+            @shopApi = shopApi;
+        end
+
+         ###
+         # @return ShopApi
+         ###
+        def shopApi()
+        
+            @shopApi;
+        end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/App.rb

@@ -0,0 +1,35 @@
+module AboutYou
+  module SDK
+    module Model     
+      class App
+      
+          attr_accessor :id
+          attr_accessor :logoUrl
+          attr_accessor :name
+          attr_accessor :url
+          attr_accessor :privacyStatementUrl
+          attr_accessor :tosUrl
+          
+        
+           ###
+           # @param \stdClass $json
+           #
+           # @return static
+           ###
+          def self.createFromJson(json)
+          
+              app = self.new
+
+              app.id                  = json["id"];
+              app.logoUrl             = json["logo_url"]
+              app.name                = json["name"]
+              app.url                 = json["url"]
+              app.privacyStatementUrl = json["privacy_statement_url"]
+              app.tosUrl              = json["tos_url"]
+
+              return app;
+          end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/Autocomplete.rb

@@ -0,0 +1,92 @@
+module AboutYou
+  module SDK
+    module Model
+      class Autocomplete
+    
+        NOT_REQUESTED = nil;
+
+         ###
+         # @var Product[]
+         ###
+        attr_accessor :products
+
+         ###
+         # @var Category[]
+         ###
+        attr_accessor :categories
+
+        def initialize(categories = nil, products = nil)
+        
+            self.categories = categories;
+            self.products   = products;
+        end
+
+         ###
+         # @param \stdClass $jsonObject The autocomplete data.
+         # @param ModelFactoryInterface $factory
+         # 
+         # @return static
+         ###
+        def self.createFromJson(jsonObject, factory)
+        
+            autocomplete = self.new(parseCategories(jsonObject, factory), parseProducts(jsonObject, factory))
+
+            return autocomplete;
+        end
+
+         ###
+         # parse autocompleted categories.
+         #
+         #
+         # @param \stdClass $jsonObject
+         # @param ModelFactoryInterface $factory
+         #
+         # @return Category[]|null
+         ###
+        def self.parseCategories(jsonObject, factory)
+        
+            if !(jsonObject.key?('categories')) 
+                return NOT_REQUESTED;
+            end
+
+            if (jsonObject["categories"] == nil) 
+                return Array(nil);
+            end
+
+            categories = Array(nil)
+            jsonObject["categories"].each do |category|
+                categories.push(factory.createCategory(category))
+            end
+
+            return categories;
+        end
+
+         ###
+         # parse autocompleted products.
+         #
+         # @param \stdClass $jsonObject
+         # @param ModelFactoryInterface $factory
+         #
+         # @return Products[]
+         ###
+        def self.parseProducts(jsonObject, factory)
+        
+            if !(jsonObject.key?('products'))
+                return NOT_REQUESTED;
+            end
+
+            if (jsonObject["products"] == nil) 
+                return Array(nil);
+            end
+
+            products = Array(nil);
+            jsonObject["products"].each do |product|
+                products.push(factory.createProduct(product))
+            end
+
+            return products;
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,262 @@
+module AboutYou
+  module SDK
+    module Model
+      class Basket
+
+          attr_accessor :items
+          attr_accessor :errors
+          attr_accessor :uniqueVariantCount
+          attr_accessor :products
+          attr_accessor :totalPrice
+          attr_accessor :totalNet
+          attr_accessor :totalVat
+          attr_accessor :totalAmount
+          attr_accessor :deletedItems
+          attr_accessor :updatesItems
+          
+        
+           ###
+           # @param object $jsonObject
+           # @param ModelFactoryInterface $factory
+           #
+           # @return Basket
+           ###
+          def self.createFromJson(jsonObject, factory)
+
+              basket = self.new
+              basket.errors = Hash.new
+              basket.deletedItems = Hash.new
+              basket.updatedItems = Hash.new
+              basket.totalPrice  = jsonObject["total_price"];
+              basket.totalNet    = jsonObject["total_net"];
+              basket.totalVat    = jsonObject["total_vat"]
+              basket.parseItems(jsonObject, factory);
+              basket.totalAmount = self.items.count
+
+              return basket;
+          end
+
+           ###
+           # @return boolean
+           ###
+          def hasErrors()
+
+              return self.errors.count > 0;
+          end
+
+           ###
+           # @param $itemId
+           #
+           # @return BasketItem|BasketSet|null
+           ###
+          def item(itemId)
+
+              if (self.items.key?(itemId))
+                  return self.items[itemId]
+              else
+                  return nil
+              end
+          end
+          
+          def collectedItems()
+
+              items = self.items;
+              itemsMerged = Hash.new
+              items.each do |item|
+                  key = item.uniqueKey();
+                  if (itemsMerged.key?(key)) 
+                      amount = itemsMerged[key]['amount'] + 1;
+                      itemsMerged[key] = Hash[
+                          'item' => item,
+                          'price' => (item.totalPrice() * amount),
+                          'amount' => amount
+                        ]
+                  else 
+                      itemsMerged[key] = Hash[
+                          'item' => item,
+                          'price' => item.totalPrice(),
+                          'amount' => 1
+                      ]
+                  end
+              end
+
+              return itemsMerged
+          end
+
+           ###
+           # build order line for update query
+           # @return array
+           ###
+          def orderLinesArray()
+
+              orderLines = Array(nil)
+
+              (self.deletedItems.uniq).each do |itemId| 
+                orderLines.push(Hash['delete' =>itemId])
+              end
+
+              self.updatedItems.each do |item|
+                orderLines.push(item)
+              end 
+
+              return orderLines
+          end
+
+          def parseItems(jsonObject, factory)
+
+              products = Hash.new
+              if (jsonObject["products"])
+                jsonObject["products"].each do |key, jsonProduct|
+                      products[key] = factory.createProduct(jsonProduct);
+                end
+              end
+
+              self.products = products;
+
+              vids = Array(nil)
+              if (jsonObject["order_lines"]) 
+                  jsonObject["order_lines"].each do |key, jsonItem|
+                      if (jsonItem["set_items"]) 
+                          item = factory.createBasketSet(jsonItem, products);
+                      else
+                          vids.push(jsonItem["variantId"])
+                          item = factory.createBasketItem(jsonItem, products);
+                      end
+
+                      if (item.hasErrors) 
+                          self.errors[key] = item;
+                      else 
+                          self.items[item.id] = item;
+                      end
+                  end
+              end
+
+              vids = vids.uniq
+              self.uniqueVariantCount = vids.count;
+          end
+
+           ###
+           # Methods to manipulate basket
+           #
+           # this api is unstable method names and signatures may be changed in the future
+           ###
+
+
+           ###
+           # @param string $itemId
+           #
+           # @return $this
+           ###
+          def deleteItem(itemId)
+
+              self.deletedItems[itemId] = itemId;
+              return self
+          end
+
+           ###
+           # @param string[] $itemIds
+           #
+           # @return $this
+           ###
+          def deleteItems(itemIds)
+              
+              itemIds.each do |itemId|
+                self.deletedItems[itemId] = itemId
+              end
+              return self
+          end
+
+           ###
+           # @return $this
+           ###
+          def deleteAllItems()
+
+              items = self.items
+
+              if !(items.empty?)
+                  ids = Array(nil);
+
+                  items.each do |item|                
+                      ids.push = item.id
+                  end
+
+                  self.deleteItems(ids)
+              end
+              
+              return self;
+          end
+
+           ###
+           # @param BasketItem $basketItem
+           #
+           # @return $this
+           ###
+          def updateItem(basketItem)
+
+              item = Hash[
+                  'id' => basketItem.id,
+                  'variant_id' => basketItem.variantId(),
+                  'app_id' => basketItem.appId()
+              ]
+              additionalData = basketItem.additionalData();
+              if (additionalData)
+                  self.checkAdditionData(additionalData);
+                  item['additional_data'] = additionalData;
+              end
+
+              self.updatedItems[basketItem.id] = item;
+
+              return self
+          end
+
+           ###
+           # @param BasketSet $basketSet
+           #
+           # @return $this
+           ###
+          def updateItemSet(basketSet)
+
+              items = basketSet.items;
+
+              if (items.empty?) 
+                  raise 'InvalidArgumentException! BasketSet needs at least one item'            
+              end
+
+              itemSet = Array(nil);
+              items.each do |subItem|
+                  item = Hash[
+                      'variant_id' => subItem.variantId(),
+                      'app_id' => subItem.appId()
+                  ]
+                  additionalData = subItem.additionalData();
+                  if (additionalData) 
+                      checkAdditionData(additionalData);
+                      item['additional_data'] = additionalData;
+                  end
+                  itemSet.push = item;
+              end
+
+              self.updatedItems[basketSet.id] = Hash[
+                  'id' => basketSet.id,
+                  'additional_data' => basketSet.additionalData,
+                  'set_items' => itemSet
+              ]
+
+              return self;
+          end
+
+          
+          def checkAdditionData(additionalData = nil, imageUrlRequired = false)
+
+              if (additionalData && !additionalData.key?('description')) 
+                  raise 'InvalidArgumentException! description is required in additional data'
+              end
+
+              if (additionalData.key?('internal_infos') && !(additionalData['internal_infos'].is_a? Array)) 
+                  raise 'InvalidArgumentException! internal_infos must be an array'
+              end
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module AboutYou
+  module SDK
+    module Model
+      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 $additionalData that contains the URL to the image.
+           #
+           # @var array $additionalData additional data for this variant
+           ###
+          attr_accessor :additionalData;
+          attr_accessor :isChanged
+
+           ###
+           # @return string|null
+           ###
+          def description()
+          
+              return (self.additionalData) ?
+                  self.additionalData['description'] :
+                  nil
+          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 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.
+           #
+           # @return array|null additional data
+           ###
+          def additionalData()
+          
+              return (self.additionalData) ?
+                  self.additionalData :
+                  nil
+          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 $additionalData that contains the URL to the image.
+           #
+           # @param array $additionalData additional data for this variant
+           #
+           # @throws \InvalidArgumentException
+           ###
+          def additionData=(additionalData)
+          
+              self.checkAdditionData(additionalData);
+              self.isChanged = true;
+
+              self.additionalData = additionalData;
+          end
+
+          def self.checkAdditionData(additionalData = nil)
+          
+              if (additionalData || IMAGE_URL_REQUIRED) 
+                  if (additionalData.key?('description')) 
+                      raise '\InvalidArgumentException! description is required in additional data'
+                  end
+                  if (IMAGE_URL_REQUIRED && !(additionalData.key?('image_url')))
+                      raise '\InvalidArgumentException! image_url is required in additional data'
+                  end
+              end
+          end
+      end
+    end
+  end
+end