aboutyou-sdk 0.0.24 → 0.0.25

data/lib/AboutYou/Model/product_search_result.rb

@@ -0,0 +1,114 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a product search result model
+      #
+      ###
+      class ProductSearchResult
+        attr_accessor :products
+        attr_accessor :page_hash
+        attr_accessor :product_count
+        attr_accessor :sale_counts
+        attr_accessor :price_ranges
+        attr_accessor :facets
+        attr_accessor :categories
+        attr_accessor :raw_facets
+
+        def initialize
+          self.products = {}
+        end
+
+        ###
+        # @param \stdClass $json_object
+        # @param ModelFactoryInterface $factory
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object, factory)
+          product_search_result = new
+
+          product_search_result.page_hash     = json_object['page_hash']
+          product_search_result.product_count = json_object['product_count']
+          product_search_result.raw_facets    = json_object['facets']
+
+          json_object['products'].each do |json_product|
+            product = factory.create_product(json_product)
+            product_search_result.products[product.id] = product
+          end
+
+          product_search_result.parse_facets(json_object['facets'], factory)
+          # free memory
+          json_object['categories'] = nil
+          json_object['prices'] = nil
+          json_object['sale'] = nil
+
+          product_search_result.facets = factory.create_facets_counts(
+            json_object
+          )
+
+          product_search_result
+        end
+
+        def parse_facets(json_object, factory)
+          self.categories = factory.create_categories_facets(
+            json_object['categories']
+          ) if json_object['categories']
+
+          self.price_ranges = factory.create_price_ranges(
+            json_object['prices']
+          ) if json_object['prices']
+
+          self.sale_counts = factory.create_sale_facet(
+            json_object['sale']
+          ) if json_object['sale']
+        end
+
+        ###
+        # Returns the min price in euro cent or null, if the price range was not requested/selected
+        #
+        # * @return integer|null
+        ###
+        def min_price
+          return nil if price_ranges.empty?
+
+          price_ranges.each do |price_range|
+            next if price_range.product_count == 0
+            return price_range.min
+          end
+
+          price_ranges[0].min
+        end
+
+        ###
+        # Returns the max price in euro cent, if the price range was not requested/selected
+        #
+        # @return integer|null
+        ###
+        def max_price
+          return nil if price_ranges.empty?
+
+          price_ranges.reverse_each do |price_range|
+            next if price_range.product_count == 0
+            return price_range.max
+          end
+
+          price_ranges[-1].max
+        end
+
+        ###
+        # @return Category[]
+        ###
+        def category_tree
+          top_level_categories = []
+          categories.each do |category|
+            top_level_categories.push(category) if category.parent.nil?
+          end
+
+          top_level_categories
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/products_ean_result.rb

@@ -0,0 +1,43 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # this class represents a products ean result model
+      #
+      ###
+      class ProductsEansResult
+        attr_accessor :eans_not_found
+        attr_accessor :page_hash
+        attr_accessor :errors
+        attr_accessor :products
+
+        ###
+        # @param \stdClass $json_object
+        # @param ModelFactoryInterface $factory
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object, factory)
+          products_ean_result = new
+          products_ean_result.products = []
+          products_ean_result.eans_not_found = []
+          products_ean_result.errors = []
+
+          products_ean_result.page_hash = json_object['page_hash'] ? json_object['page_hash'] : nil
+
+          json_object['eans'].each do |json_product|
+            if json_product['error_code']
+              products_ean_result.errors.push(json_product)
+              products_ean_result.eans_not_found.push(json_product['ean'])
+              next
+            end
+            products_ean_result.products.push(factory.create_product(json_product))
+          end if json_object['eans']
+
+          products_ean_result
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/products_result.rb

@@ -0,0 +1,56 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a products result model
+      #
+      ###
+      class ProductsResult
+        include AbstractModel
+
+        attr_accessor :ids_not_found
+        attr_accessor :page_hash
+        attr_accessor :errors
+        attr_accessor :products
+
+        ###
+        # @param \stdClass $json_object
+        # @param ModelFactoryInterface $factory
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object, factory)
+          products_result = new
+
+          products_result.page_hash = json_object['page_hash'] ? json_object['page_hash'] : nil
+          products_result.errors = []
+          products_result.ids_not_found = []
+          products_result.products = {}
+
+          if json_object['ids']
+            json_object['ids'].each do |key, json_product|
+              if json_product['error_code']
+                products_result.ids_not_found.push(key)
+                products_result.errors.push(json_product)
+                next
+              end
+              products_result.products[Integer(key)] = factory.create_product(
+                json_product
+              )
+            end
+          end
+
+          products_result
+        end
+
+        ###
+        # @return integer[] array of product ids
+        ###
+        def products_not_found
+          ids_not_found
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/result_error.rb

@@ -0,0 +1,28 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents an result error model
+      #
+      ###
+      module ResultError
+        attr_accessor :error_ident
+        attr_accessor :error_code
+        attr_accessor :error_message
+
+        def initialize(json_object)
+          parse_error_result(json_object)
+
+          self
+        end
+
+        def parse_error_result(json_object)
+          self.error_ident   = json_object.key?('error_ident') ? String(json_object['error_ident']) : nil
+          self.error_code    = json_object.key?('error_code') ? Integer(json_object['error_code']) : 0
+          self.error_message = json_object.key?('error_message') ? json_object['error_message'] : nil
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/variant.rb

@@ -0,0 +1,214 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a variant model
+      #
+      ###
+      class Variant
+        include AbstractModel
+
+        attr_accessor :factory
+        attr_accessor :product
+        attr_accessor :id
+        attr_accessor :images
+        attr_accessor :selected_image
+        attr_accessor :about_number
+        attr_accessor :facet_groups
+        attr_accessor :ean
+        attr_accessor :is_default
+        attr_accessor :price
+        attr_accessor :old_price
+        attr_accessor :retail_price
+        attr_accessor :additional_info
+        attr_accessor :quantity
+        attr_accessor :facet_ids
+        attr_accessor :first_active_date
+        attr_accessor :first_sale_date
+        attr_accessor :created_date
+        attr_accessor :updated_date
+        attr_accessor :color
+        attr_accessor :length
+        attr_accessor :season_code
+
+        ###
+        # @param \stdClass $json_object
+        # @param ModelFactoryInterface $factory
+        # @param Product $product
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object, factory, product)
+          fail 'MalformedJsonException' unless json_object['id']
+
+          variant                   = new
+          variant.factory           = factory
+          variant.product           = product
+
+          variant.images            = variant.parse_images(json_object['images'])
+          # free memory
+          json_object['images']     = nil
+
+          variant.id                = json_object['id']
+          variant.about_number      = (json_object['about_number']) ? json_object['about_number'] : nil
+          variant.ean               = (json_object['ean']) ? json_object['ean'] : nil
+          variant.is_default        = (json_object['default']) ? json_object['default'] : nil
+          variant.price             = (json_object['price']) ? json_object['price'] : nil
+          variant.old_price         = (json_object['old_price']) ? json_object['old_price'] : nil
+          variant.retail_price      = (json_object['retail_price']) ? json_object['retail_price'] : nil
+          variant.additional_info   = (json_object['additional_info']) ? json_object['additional_info'] : nil
+          variant.quantity          = (json_object['quantity']) ? json_object['quantity'] : 0
+          variant.first_active_date = (json_object['first_active_date']) ? json_object['first_active_date'] : nil
+          variant.first_sale_date   = (json_object['first_sale_date']) ? json_object['first_sale_date'] : nil
+          variant.created_date      = (json_object['created_date']) ? json_object['created_date'] : nil
+          variant.updated_date      = (json_object['updated_date']) ? json_object['updated_date'] : nil
+
+          variant.facet_ids         = variant.parse_facet_ids(json_object)
+          variant.facet_groups      = variant.generate_facet_group_set(json_object)
+          variant.color             = variant.facet_group(AboutYou::SDK::Constants::FACET_COLOR)
+          variant.length            = variant.facet_group(AboutYou::SDK::Constants::FACET_LENGTH)
+          variant.season_code       = variant.facet_group(AboutYou::SDK::Constants::FACET_SEASON_CODE)
+
+          variant
+        end
+
+        def parse_images(image_json)
+          image_array = []
+          image_json.each do |image|
+            image_array.push(factory.create_image(image))
+          end if image_json
+
+          image_array
+        end
+
+        ###
+        # Get image by given hash.
+        #
+        # @param string $hash The image hash.
+        #
+        # @return Image
+        ###
+        def image_by_hash(hash)
+          images.each do |image|
+            return image if image.hash == hash
+          end
+
+          nil
+        end
+
+        ###
+        # Select a specific image.
+        #
+        # @param string $hash The image hash or null for default image.
+        #
+        # @return void
+        #
+        # @depracted
+        ###
+        def select_image(hash = nil)
+          if hash
+            self.selected_image = image_by_hash(hash)
+            true
+          else
+            self.selected_image = nil
+            false
+          end
+        end
+
+        ###
+        # Get selected or default image.
+        #
+        # @return Image
+        ###
+        def image
+          if selected_image
+            return selected_image
+          elsif images[0]
+            return images[0]
+          end
+
+          nil
+        end
+
+        def parse_facet_ids(json_object)
+          ids = {}
+
+          json_object['attributes'].each do |group, attribute_ids|
+            group_id = group[11..group.length] # rm prefix 'attributs_'
+            ids[Integer(group_id)] = attribute_ids
+          end unless json_object['attributes'].empty?
+
+          ids
+        end
+
+        def generate_facet_group_set(json_object)
+          ids = parse_facet_ids(json_object)
+          self.facet_groups = AboutYou::SDK::Model::FacetGroupSet.new(ids)
+        end
+
+        ###
+        # @param integer $group_id
+        #
+        # @return FacetGroup|null
+        ###
+        def facet_group(group_id)
+          facet_groups.group(group_id)
+        end
+
+        ###
+        # @return FacetGroup|null
+        ###
+        def size
+          ###
+          # @todo: Instance level caching
+          ###
+          group_id = size_group_id
+          facet_group(group_id) unless group_id.empty?
+        end
+
+        ###
+        # @return integer|null
+        ###
+        def size_group_id
+          keys = {}
+          groups = facet_groups.groups
+          size_run = facet_group(AboutYou::SDK::Constants::FACET_SIZE_RUN)
+
+          groups.each do |group|
+            keys[group.name] = group.group_id
+          end if groups.is_a?(Array)
+
+          size_run.facets.each do |facet|
+            group_name = facet.value
+            return keys[group_name] if keys.key?(group_name)
+          end unless size_run.empty?
+
+          return keys['size'] if keys.key?('size')
+
+          return keys['size_run'] if keys.key?('size_run')
+
+          nil
+        end
+
+        ###
+        # Returns the quantity per pack for this variant.
+        # By default, this returns 1. But some items can have a bigger number.
+        #
+        # @return int quantity per pack
+        ###
+        def quantity_per_pack
+          facet_group = facet_group(
+            AboutYou::SDK::Constants::FACET_QUANTITY_PER_PACK
+          )
+          return 1 unless facet_group
+
+          facets = facet_group.facets
+          return 1 unless facets
+
+          facets[0].value
+        end
+      end
+    end
+  end
+end