aboutyou-sdk 0.0.24 → 0.0.25

data/lib/{aboutyou-sdk/Model/ProductSearchResult/FacetCount.rb → AboutYou/Model/ProductSearchResult/facet_count.rb}

@@ -1,7 +1,6 @@
 module AboutYou
   module SDK
     module Model
-      
       ###
       # This class represents a FacetCount model.
       #
@@ -19,7 +18,7 @@ module AboutYou
         # * *Args*    :
         #   - +facet+ -> a facet
         #   - +count+ -> the count of the facet
-        #   
+        #
         # * *Returns* :
         #   - Instance of AboutYou::SDK::Model::FacetCount
         ###
@@ -30,4 +29,4 @@ module AboutYou
       end
     end
   end
-end
+end

data/lib/AboutYou/Model/ProductSearchResult/facet_counts.rb

@@ -0,0 +1,67 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # This class represents a FacetCounts model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
+      class FacetCounts
+        # The group_id of the facetcounts
+        attr_accessor :group_id
+        # an array of facetcount objects
+        attr_accessor :facet_count_list
+        # the cont of the products
+        attr_accessor :product_count_total
+        # the count of the products without facets
+        attr_accessor :product_count_without_any_facet
+        # the count of the procuts with other facets
+        attr_accessor :product_count_with_other_facet
+
+        ###
+        # the Constructor for the facetcounts class
+        #
+        # * *Args*    :
+        #   - +product_count_total+ -> the total productcount
+        #   - +product_count_with_other_facet+ -> the productcount without any facets
+        #   - +product_count_without_any_facet+ -> the productcount with other facets
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::FacetCounts
+        ###
+        def initialize(
+            product_count_total,
+            product_count_with_other_facet,
+            product_count_without_any_facet
+          )
+          self.product_count_total             = product_count_total
+          self.product_count_with_other_facet  = product_count_with_other_facet
+          self.product_count_without_any_facet = product_count_without_any_facet
+        end
+
+        ###
+        # This method is used for creating an instance of this class by a json_object.
+        #
+        # * *Args*    :
+        #   - +group_id+ -> the groupId of the facetcounts
+        #   - +json_object+ -> the jsonObject received from the api
+        #   - +facet_count_list+ -> a list of facetcount objects
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::FacetCounts
+        ###
+        def self.create_from_json(group_id, json_object, facet_count_list)
+          facet_counts = new(
+            json_object['total'],
+            json_object['other'],
+            json_object['missing']
+          )
+          facet_counts.group_id = group_id
+          facet_counts.facet_count_list = facet_count_list
+
+          facet_counts
+        end
+      end
+    end
+  end
+end

data/lib/{aboutyou-sdk/Model/ProductSearchResult/PriceRange.rb → AboutYou/Model/ProductSearchResult/price_range.rb}

@@ -8,7 +8,7 @@ module AboutYou
       ###
       class PriceRange
         # the product count
-        attr_accessor :productCount
+        attr_accessor :product_count
         # startpoint of the price range
         attr_accessor :from
         # end of the price range
@@ -17,35 +17,34 @@ module AboutYou
         attr_accessor :min
         # max value of the price range
         attr_accessor :max
-        # 
+        #
         attr_accessor :mean
-        # 
+        #
         attr_accessor :sum
 
-
         ###
-        # This method is used for creating an instance of this class by a jsonObject.
+        # This method is used for creating an instance of this class by a json_object.
         #
         # * *Args*    :
-        #   - +jsonObject+ -> the jsonObject received from the api
-        #   
+        #   - +json_object+ -> the jsonObject received from the api
+        #
         # * *Returns* :
         #   - Instance of AboutYou::SDK::Model::PriceRange
         ###
-        def self.createFromJson(jsonObject)
-          priceRange = self.new
+        def self.create_from_json(json_object)
+          price_range = new
 
-          priceRange.productCount = jsonObject["count"]
-          priceRange.from = jsonObject["from"]
-          priceRange.to = jsonObject["to"]
-          priceRange.min = jsonObject["min"]
-          priceRange.max = jsonObject["max"]
-          priceRange.mean = jsonObject["mean"]
-          priceRange.sum = jsonObject["total"]
+          price_range.product_count = json_object['count']
+          price_range.from = json_object['from']
+          price_range.to = json_object['to']
+          price_range.min = json_object['min']
+          price_range.max = json_object['max']
+          price_range.mean = json_object['mean']
+          price_range.sum = json_object['total']
 
-          priceRange
+          price_range
         end
       end
     end
   end
-end
+end

data/lib/AboutYou/Model/ProductSearchResult/sale_counts.rb

@@ -0,0 +1,79 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # This class represents a Sale Counts model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
+      class SaleCounts
+        # count of products in sale
+        attr_accessor :product_count_in_sale
+        # count of prodocuts not in sale
+        attr_accessor :product_count_not_in_sale
+        # count of total products
+        attr_accessor :product_count_total
+        # count of products without facet
+        attr_accessor :product_count_without_any_facet
+        # count of products with other facets
+        attr_accessor :product_count_with_other_facet
+
+        ###
+        # the Constructor for the sale counts class
+        #
+        # * *Args*    :
+        #   - +product_count_total+ -> the total productcount
+        #   - +product_count_with_other_facet+ -> the productcount without any facets
+        #   - +product_count_without_any_facet+ -> the productcount with other facets
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::SaleCounts
+        ###
+        def initialize(product_count_total,
+            product_count_with_other_facet,
+            product_count_without_any_facet
+          )
+          self.product_count_total             = product_count_total
+          self.product_count_with_other_facet  = product_count_with_other_facet
+          self.product_count_without_any_facet = product_count_without_any_facet
+        end
+
+        ###
+        # This method is used for creating an instance of this class by a json_object.
+        #
+        # * *Args*    :
+        #   - +json_object+ -> the jsonObject received from the api
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::SaleCounts
+        ###
+        def self.create_from_json(json_object)
+          sale_counts = new(
+            json_object['total'],
+            json_object['other'],
+            json_object['missing']
+          )
+          sale_counts.parse_terms(json_object['terms'])
+
+          sale_counts
+        end
+
+        ###
+        # This method is used for parsing the terms of the json_object
+        #
+        # * *Args*    :
+        #   - +jsonTerms+ -> the terms of the json_object received from the api
+        ###
+        def parse_terms(json_terms)
+          json_terms.each do |term|
+            if term['term'] == 0
+              self.product_count_not_in_sale = term['count']
+            else
+              self.product_count_in_sale     = term['count']
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/ProductSearchResult/terms_count.rb

@@ -0,0 +1,40 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      # This class represents a Terms Count model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
+      class TermsCounts
+        # count of total products
+        attr_accessor :product_count_total
+        # count of products without facet
+        attr_accessor :product_count_with_other_facet
+        # count of products with other facets
+        attr_accessor :product_count_without_any_facet
+
+        ###
+        # the Constructor for the terms count class
+        #
+        # * *Args*    :
+        #   - +product_count_total+ -> the total productcount
+        #   - +product_count_with_other_facet+ -> the productcount without any facets
+        #   - +product_count_without_any_facet+ -> the productcount with other facets
+        #
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::TermsCount
+        ###
+        def initialize(
+            product_count_total,
+            product_count_with_other_facet,
+            product_count_without_any_facet
+          )
+          self.productCountTotal           = product_count_total
+          self.product_count_with_other_facet  = product_count_with_other_facet
+          self.product_count_without_any_facet = product_count_without_any_facet
+        end
+      end
+    end
+  end
+end

data/lib/{aboutyou-sdk/Model/AbstractModel.rb → AboutYou/Model/abstract_model.rb}

@@ -1,14 +1,13 @@
 module AboutYou
   module SDK
     module Model
-      
       ###
-      # This Module is abstract and represents a model which has a shopApi attribute
+      # This Module is abstract and represents a model which has a shop_api attribute
       #
       # author:: Collins GmbH & Co KG
       ###
       module AbstractModel
-        attr_accessor :shopApi
+        attr_accessor :shop_api
       end
     end
   end

data/lib/{aboutyou-sdk/Model/App.rb → AboutYou/Model/app.rb}

@@ -10,38 +10,38 @@ module AboutYou
         # the id of the app
         attr_accessor :id
         # the logo url of the app
-        attr_accessor :logoUrl
+        attr_accessor :logo_url
         # the name of the app
         attr_accessor :name
         # the url of the app
         attr_accessor :url
         # the privacy statement url
-        attr_accessor :privacyStatementUrl
+        attr_accessor :privacy_statement_url
         # the tearms of service url
-        attr_accessor :tosUrl
+        attr_accessor :tos_url
 
         ###
-        # This method is used for creating an instance of this class by a jsonObject.
+        # This method is used for creating an instance of this class by a json_object.
         #
         # * *Args*    :
-        #   - +json+ -> the jsonObject received from the api
-        #   
+        #   - +json+ -> the json_object received from the api
+        #
         # * *Returns* :
         #   - Instance of AboutYou::SDK::Model::App
         ###
-        def self.createFromJson(json)
-          app = self.new
+        def self.create_from_json(json)
+          app = 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"]
+          app.id                    = json['id']
+          app.logo_url              = json['logo_url']
+          app.name                  = json['name']
+          app.url                   = json['url']
+          app.privacy_statement_url = json['privacy_statement_url']
+          app.tos_url               = json['tos_url']
 
           app
         end
       end
     end
   end
-end
+end

data/lib/{aboutyou-sdk/Model/Autocomplete.rb → AboutYou/Model/autocomplete.rb}

@@ -19,9 +19,9 @@ module AboutYou
         # the Constructor for the autocomplete class
         #
         # * *Args*    :
-        #   - +productCountTotal+ -> the total productcount
-        #   - +productCountWithOtherFacet+ -> the productcount without any facets
-        #   
+        #   - +product_count_total+ -> the total productcount
+        #   - +product_count_with_other_facet+ -> the productcount without any facets
+        #
         # * *Returns* :
         #   - Instance of AboutYou::SDK::Model::AutoComplete
         ###
@@ -34,38 +34,36 @@ module AboutYou
         # This method lets you build an autocomplete model by a json response from the api
         #
         # * *Args*    :
-        #   - +jsonObject+ -> the json response from the api
+        #   - +json_object+ -> the json response from the api
         #   - +factory+ -> the model factory responsible for building the models
-        #   
+        #
         # * *Returns* :
         #   - Instance of AboutYou::SDK::Model::AutoComplete
         ###
-        def self.createFromJson(jsonObject, factory)
-          self.new(parseCategories(jsonObject, factory), parseProducts(jsonObject, factory))
+        def self.create_from_json(json_object, factory)
+          new(
+            parse_categories(json_object, factory),
+            parse_products(json_object, factory)
+          )
         end
 
         ###
         # This method parses the json object and builds category models from it
         #
         # * *Args*    :
-        #   - +jsonObject+ -> the json response from the api
+        #   - +json_object+ -> the json response from the api
         #   - +factory+ -> the model factory responsible for building the models
-        #   
+        #
         # * *Returns* :
         #   - Array containing instances of AboutYou::SDK::Model::Category
         ###
-        def self.parseCategories(jsonObject, factory)
-          unless jsonObject.key?('categories') 
-            return NOT_REQUESTED
-          end
-
-          if jsonObject["categories"] == nil 
-              return []
-          end
+        def self.parse_categories(json_object, factory)
+          return NOT_REQUESTED unless json_object.key?('categories')
+          return [] if json_object['categories'].nil?
 
           categories = []
-          jsonObject["categories"].each do |category|
-            categories.push(factory.createCategory(category))
+          json_object['categories'].each do |category|
+            categories.push(factory.create_category(category))
           end
 
           categories
@@ -75,24 +73,19 @@ module AboutYou
         # This method parses the json object and builds product models from it
         #
         # * *Args*    :
-        #   - +jsonObject+ -> the json response from the api
+        #   - +json_object+ -> the json response from the api
         #   - +factory+ -> the model factory responsible for building the models
-        #   
+        #
         # * *Returns* :
         #   - Array containing instances of AboutYou::SDK::Model::Product
         ###
-        def self.parseProducts(jsonObject, factory)
-          unless jsonObject.key?('products')
-            return NOT_REQUESTED
-          end
-
-          if jsonObject["products"] == nil
-              return []
-          end
+        def self.parse_products(json_object, factory)
+          return NOT_REQUESTED unless json_object.key?('products')
+          return [] if json_object['products'].nil?
 
           products = []
-          jsonObject["products"].each do |product|
-            products.push(factory.createProduct(product))
+          json_object['products'].each do |product|
+            products.push(factory.create_product(product))
           end
 
           products
@@ -100,4 +93,4 @@ module AboutYou
       end
     end
   end
-end
+end

data/lib/AboutYou/Model/basket.rb

@@ -0,0 +1,235 @@
+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 :unique_variant_count
+        attr_accessor :products
+        attr_accessor :total_price
+        attr_accessor :total_net
+        attr_accessor :total_vat
+        attr_accessor :total_amount
+        attr_accessor :deleted_items
+        attr_accessor :updated_items
+
+        ###
+        # @param object $json_object
+        # @param ModelFactoryInterface $factory
+        #
+        # @return Basket
+        ###
+        def self.create_from_json(json_object, factory)
+          basket = new
+          basket.errors = {}
+          basket.deleted_items = {}
+          basket.updated_items = {}
+          basket.total_price  = json_object['total_price']
+          basket.total_net    = json_object['total_net']
+          basket.total_vat    = json_object['total_vat']
+          basket.parse_items(json_object, factory)
+          basket.total_amount = items.count
+
+          basket
+        end
+
+        ###
+        # @return boolean
+        ###
+        def errors?
+          errors.count > 0
+        end
+
+        ###
+        # @param $itemId
+        #
+        # @return BasketItem|BasketSet|null
+        ###
+        def item(item_id)
+          return items[item_id] if items.key?(item_id)
+        end
+
+        def collected_items
+          items = self.items
+          items_merged = {}
+          items.each do |item|
+            key = item.unique_key
+            if items_merged.key?(key)
+              amount = items_merged[key]['amount'] + 1
+              items_merged[key] = {
+                'item' => item,
+                'price' => item.total_price * amount,
+                'amount' => amount
+              }
+            else
+              items_merged[key] = {
+                'item' => item,
+                'price' => item.total_price,
+                'amount' => 1
+              }
+            end
+          end
+
+          items_merged
+        end
+
+        ###
+        # build order line for update query
+        # @return array
+        ###
+        def order_lines_array
+          order_lines = []
+
+          deleted_items.uniq.each do |itemId|
+            order_lines.push('delete' => itemId)
+          end
+
+          updatedItems.each do |item|
+            order_lines.push(item)
+          end
+
+          order_lines
+        end
+
+        def parse_items(json_object, factory)
+          products = {}
+
+          json_object['products'].each do |key, json_product|
+            products[key] = factory.create_product(json_product)
+          end if json_object['products']
+
+          self.products = products
+          vids = []
+
+          json_object['order_lines'].each do |key, json_item|
+            if json_item['set_items']
+              item = factory.create_basket_set(json_item, products)
+            else
+              vids.push(json_item['variantId'])
+              item = factory.create_basket_item(json_item, products)
+            end
+
+            if item.errors?
+              errors[key] = item
+            else
+              items[item.id] = item
+            end
+          end if json_object['order_lines']
+
+          vids = vids.uniq
+          self.uniqueVariantCount = vids.count
+        end
+
+        ###
+        # @param string $itemId
+        #
+        # @return $this
+        ###
+        def delete_item(item_id)
+          deleted_items[item_id] = item_id
+
+          self
+        end
+
+        ###
+        # @param string[] $itemIds
+        #
+        # @return $this
+        ###
+        def delete_items(item_ids)
+          item_ids.each do |item_id|
+            deleted_items[item_id] = item_id
+          end
+
+          self
+        end
+
+        ###
+        # @return $this
+        ###
+        def delete_all_items
+          items = self.items
+
+          return self unless items.empty?
+          ids = []
+          items.each do |item|
+            ids.push = item.id
+          end
+          delete_items(ids)
+
+          self
+        end
+
+        ###
+        # @param BasketItem $basketItem
+        #
+        # @return $this
+        ###
+        def update_item(basket_item)
+          item = {
+            'id' => basket_item.id,
+            'variant_id' => basket_item.variant_id,
+            'app_id' => basket_item.app_id
+          }
+          add_data = basket_item.additional_data
+          if add_data
+            check_additional_data(add_data)
+            item['additional_data'] = add_data
+          end
+          updated_items[basket_item.id] = item
+
+          self
+        end
+
+        ###
+        # @param BasketSet $basketSet
+        #
+        # @return $this
+        ###
+        def update_item_set(basket_set)
+          items = basket_set.items
+
+          fail 'InvalidArgumentException! BasketSet
+            needs at least one item' if items.empty?
+
+          item_set = []
+          items.each do |sub_item|
+            item = {
+              'variant_id' => sub_item.variant_id,
+              'app_id' => sub_item.app_id
+            }
+            add_data = sub_item.additional_data
+            if add_data
+              check_additional_data(add_data)
+              item['additional_data'] = add_data
+            end
+            item_set.push = item
+          end
+
+          updated_items[basket_set.id] = {
+            'id' => basket_set.id,
+            'additional_data' => basket_set.additional_data,
+            'set_items' => item_set
+          }
+
+          self
+        end
+
+        def check_additional_data(add_data = nil, _img_url_required = false)
+          fail 'InvalidArgumentException! description is required
+            in additional data' if add_data && !add_data.key?('description')
+          fail 'InvalidArgumentException! internal_infos must be an array' if
+          add_data.key?('internal_infos') &&
+          !add_data['internal_infos'].is_a?(Array)
+        end
+      end
+    end
+  end
+end