aboutyou-sdk 0.0.24 → 0.0.25

data/lib/aboutyou-sdk/Client.rb

@@ -1,134 +0,0 @@
-module AboutYou
-  module SDK
-    ###
-    # This Class manages the API-Calls
-    # 
-    # Author:: Collins GmbH & Co KG
-    ###
-    class Client
-
-      # url for staging-api-requests
-      API_END_POINT_STAGE   = 'http://shop-api.staging.aboutyou.de/api'
-      # url for sandbox-api-requests
-      API_END_POINT_SANDBOX = 'http://shop-api.sandbox.aboutyou.de/api'
-      # url for live-api-requests
-      API_END_POINT_LIVE    = 'https://shop-api.aboutyou.de/api'
-
-      # the app id of the app which should be represented by an instance of AY
-      attr_accessor :appId
-      # the authentifaction token from dev-center for the app id
-      attr_accessor :appPassword
-      # the url used for api calls
-      attr_accessor :apiEndPoint
-      # the page id of the current page visited by an user
-      attr_accessor :pageId
-
-      
-      ###
-      # the Constructor for the Client class
-      #
-      # * *Args*    :
-      #   - +appId+ -> The App-Id of the App
-      #   - +appPassword+ -> The Auth-Token of the App
-      #   - +apiEndPoint+ -> Can be either live or staging
-      #   - +logger+ -> Logger-Template
-      #   
-      # * *Returns* :
-      #   - Instance of AboutYou::SDK::Client
-      ###
-      def initialize(appId, appPassword, apiEndPoint = 'stage', logger = nil)
-
-        self.appId = appId
-        self.appPassword = appPassword
-      end
-
-
-       ###
-       # Setter for app-credentials
-       #
-       # * *Args*    :
-       #   - +appId+ -> The App-Id of the App
-       #   - +appPassword+ -> The Auth-Token of the App
-       ###
-      def appCredentials=(appId, appPassword)
-
-        self.appId= appId
-        self.appPassword= appPassword
-      end
-
-
-       ###
-       # Setter for the api endpoint
-       #
-       # * *Args*    :
-       #   - +apiEndPoint+ -> Can be either live or staging
-       ###
-      def apiEndpoint=(apiEndPoint)
-
-        case
-          when apiEndPoint=='stage'
-            self.apiEndPoint = API_END_POINT_STAGE
-          when apiEndPoint=='sandbox'
-            self.apiEndPoint = API_END_POINT_SANDBOX
-          when apiEndPoint=='live'
-            self.apiEndPoint = API_END_POINT_LIVE
-        else
-          self.apiEndPoint = apiEndPoint
-        end
-      end
-
-
-       ###
-       # Builds a JSON string representing the request-data
-       # Executes the API request
-       # builds a JSON string representing the response-data
-       # 
-       # * *Args*    :
-       #   - +body+ -> the body of the api-call, containing all request data
-       #
-       # * *Returns* :
-       #   - Json-String containing the response-body
-       ###
-      def request(body)
-
-        if self.pageId
-          request = { 
-            :body=>body,
-            :basic_auth => {
-              :username => self.appId,
-              :password => self.appPassword
-            },
-            :headers => {
-              'Content-Type' => 'application/json',
-              'Accept-Encoding' => 'gzip,deflate',
-              'X-Page-ID'=> self.pageId
-            }
-          }
-        else
-            request = { 
-              :body=>body,
-              :basic_auth => {
-                :username => self.appId,
-                :password => self.appPassword
-              },
-              :headers => {
-                'Content-Type' => 'application/json',
-                'Accept-Encoding' => 'gzip,deflate'
-              }
-            }
-        end
-
-        response = HTTParty.post("https://shop-api.aboutyou.de/api", request)
-        
-        unless response.code >= 200 && response.code < 300 || response.code == 304
-            raise String(response.code)
-            unless response.is_a? Array
-              raise 'result is not array'
-            end
-        end
-
-        JSON.parse(response.body)
-      end
-    end
-  end
-end

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

@@ -1,268 +0,0 @@
-module AboutYou
-  module SDK
-    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
-        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

@@ -1,76 +0,0 @@
-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