aboutyou-sdk 0.0.24 → 0.0.25

data/lib/AboutYou/Model/image.rb

@@ -0,0 +1,102 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class is a represenatation of an Image model
+      #
+      ###
+      class Image
+        MIN_WIDTH  = 50
+        MIN_HEIGHT = 50
+        MAX_WIDTH  = 1400
+        MAX_HEIGHT = 2000
+
+        class << self
+        attr_accessor :base_url
+        end
+        # @var null|string[] */
+        attr_accessor :additional_items
+        # @var null|string */
+        attr_accessor :angle
+        # @var null|string */
+        attr_accessor :background
+        # @var null|string[] */
+        attr_accessor :color
+        # @var null|string */
+        attr_accessor :ext
+        # @var null|string */
+        attr_accessor :gender
+        # @var string */
+        attr_accessor :hash
+        # @var ImageSize */
+        attr_accessor :image_size
+        # @var integer */
+        attr_accessor :file_size
+        # @var null|string */
+        attr_accessor :focus
+        # @var string */
+        attr_accessor :mime_type
+        # @var null|\stdClass */
+        attr_accessor :model_data
+        # @var null|integer */
+        attr_accessor :next_detail_level
+        # @var null|string */
+        attr_accessor :preparation
+        # @var null|array */
+        attr_accessor :tags
+        # @var null|string */
+        attr_accessor :type
+        # @var string */
+        attr_accessor :view
+
+        ###
+        # @param \stdClass $json_object
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object)
+          image = new
+
+          image.additional_items  = json_object['additional_items'] ? json_object['additional_items'] : nil
+          image.angle             = json_object['angle'] ? json_object['angle'] : nil
+          image.background        = json_object['background'] ? json_object['background'] : nil
+          image.color             = json_object['color'] ? json_object['color'] : nil
+          image.ext               = json_object['ext'] ? json_object['ext'] : nil
+          image.file_size         = json_object['size'] ? json_object['size'] : 0
+          image.focus             = json_object['focus'] ? json_object['focus'] : nil
+          image.gender            = json_object['gender'] ? json_object['gender'] : nil
+          image.hash              = json_object['hash'] ? json_object['hash'] : nil
+          image.mime_type         = json_object['mime'] ? json_object['mime'] : nil
+          image.model_data        = json_object['model_data'] ? json_object['model_data'] : nil
+          image.next_detail_level = json_object['next_detail_level'] ? json_object['next_detail_level'] : nil
+          image.preparation       = json_object['preparation'] ? json_object['preparation'] : nil
+          image.tags              = json_object['tags'] ? json_object['tags'] : nil
+          image.type              = json_object['type'] ? json_object['type'] : nil
+          image.view              = json_object['view'] ? json_object['view'] : nil
+
+          image.image_size = ImageSize.new(
+            Integer(json_object['image']['width']),
+            Integer(json_object['image']['height'])
+          )
+
+          image
+        end
+
+        ###
+        # @param int $width
+        # @param int $height
+        #
+        # @return string returns the relative url
+        ###
+        def url(width = 200, height = 200)
+          width = [[width, MAX_WIDTH].min, MIN_WIDTH].max
+          height = [[height, MAX_HEIGHT].min, MIN_HEIGHT].max
+
+          self.class.base_url + '/' + hash + '?width=' + String(width) +
+            '&height=' + String(height)
+        end
+      end
+    end
+  end
+end

data/lib/{aboutyou-sdk/Model/ImageSize.rb → AboutYou/Model/image_size.rb}

@@ -1,21 +1,25 @@
 module AboutYou
   module SDK
     module Model
+      ###
+      #
+      # This class represents the image size of an image
+      #
+      ###
       class ImageSize
         # @var integer */
-        @width;
         attr_accessor :width
 
         # @var integer */
-        @height;
         attr_accessor :height
 
         def initialize(width, height)
+          self.width = width
+          self.height = height
 
-            self.width = width;
-            self.height = height;
+          self
         end
       end
     end
   end
-end
+end

data/lib/AboutYou/Model/initiate_order.rb

@@ -0,0 +1,53 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents an initiate order model
+      #
+      ###
+      class InitiateOrder
+        attr_accessor :url
+        attr_accessor :user_token
+        attr_accessor :app_token
+        attr_accessor :error_code
+        attr_accessor :error_message
+
+        ###
+        # @param string $url
+        # @param string $user_token
+        # @param string $app_token
+        ###
+        def initialize(url, user_token, app_token)
+          self.url        = url
+          self.user_token = user_token
+          self.app_token  = app_token
+
+          self
+        end
+
+        ###
+        # @param \stdClass $json
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object)
+          order = new(
+              json_object['url'],
+              json_object['user_token'],
+              json_object['app_token']
+          )
+
+          order.parse_error_result(json_object)
+
+          order
+        end
+
+        def parse_error_result(json_object)
+          self.error_code       = json_object.key?('error_code') ? 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/order.rb

@@ -0,0 +1,22 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents an order model
+      #
+      ###
+      class Order
+        attr_accessor :id
+        attr_accessor :basket
+
+        def initialize(id, basket)
+          self.id     = id
+          self.basket = basket
+
+          self
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/product.rb

@@ -0,0 +1,353 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents an product model
+      #
+      ###
+      class Product
+        include AbstractModel
+
+        attr_accessor :id
+        attr_accessor :factory
+        attr_accessor :name
+        attr_accessor :is_sale
+        attr_accessor :is_active
+        attr_accessor :description_short
+        attr_accessor :description_long
+        attr_accessor :min_price
+        attr_accessor :max_price
+        attr_accessor :max_savings_price
+        attr_accessor :max_savings
+        attr_accessor :max_savings_percentage
+        attr_accessor :brand_id
+        attr_accessor :merchant_id
+        attr_accessor :category_id_paths
+        attr_accessor :facet_ids
+        attr_accessor :default_image
+        attr_accessor :default_variant
+        attr_accessor :selected_variant
+        attr_accessor :variants
+        attr_accessor :inactive_variants
+        attr_accessor :styles
+        attr_accessor :facet_groups
+        attr_accessor :root_categories
+        attr_accessor :active_root_categories
+        attr_accessor :leaf_categories
+        attr_accessor :active_leaf_categories
+
+        def self.create_from_json(json_object, factory, app_id)
+          product = new
+
+          # these are required fields
+          fail 'MalformedJsonException!' unless json_object['id'] || json_object['name']
+
+          product.factory = factory
+
+          product.id                     = json_object['id']
+          product.name                   = json_object['name']
+
+          product.is_sale                = json_object['sale'] ? json_object['sale'] : false
+          product.description_short      = json_object['description_short'] ? json_object['description_short'] : ''
+          product.description_long       = json_object['description_long'] ? json_object['description_long'] : ''
+          product.is_active              = json_object['active'] ? json_object['active'] : true
+          product.brand_id               = json_object['brand_id'] ? json_object['brand_id'] : nil
+          product.merchant_id            = json_object['merchant_id'] ? json_object['merchant_id'] : nil
+
+          product.min_price              = json_object['min_price'] ? json_object['min_price'] : nil
+          product.max_price              = json_object['max_price'] ? json_object['max_price'] : nil
+          product.max_savings_price      = json_object['max_savings'] ? json_object['max_savings'] : nil
+          product.max_savings_percentage = json_object['max_savings_percentage'] ? json_object['max_savings_percentage'] : nil
+
+          product.default_image          = json_object['default_image'] ? factory.create_image(json_object['default_image']) : nil
+          product.default_variant        = json_object['default_variant'] ? factory.create_variant(json_object['default_variant'], self) : nil
+
+          product.variants               = product.parse_variants(json_object, factory, product)
+          product.inactive_variants      = product.parse_variants(json_object, factory, product, 'inactive_variants')
+          product.styles                 = product.parse_styles(json_object, factory)
+
+          key                            = 'categories.' + String(app_id)
+          product.category_id_paths      = json_object[key] ? json_object[key] : []
+
+          product.facet_ids              = product.parse_facet_ids(json_object)
+
+          product
+        end
+
+        def parse_variants(json_object, factory, product, attribute_name = 'variants')
+          variants = {}
+
+          json_object[attribute_name].each do |json_variant|
+            variants[json_variant['id']] = factory.create_variant(
+              json_variant,
+              product
+            )
+          end if
+          json_object.key?(attribute_name) &&
+          !json_object[attribute_name].empty?
+
+          variants
+        end
+
+        def parse_styles(json_object, factory)
+          styles = []
+
+          json_object['styles'].each do |style|
+            styles.push(factory.create_product(style))
+          end if json_object.key?('styles') && !json_object['styles'].empty?
+
+          styles
+        end
+
+        def parse_category_id_paths(json_object)
+          paths = []
+
+          json_object.each do |name, category_paths|
+            if name.index('categories') == 0
+              paths = category_paths
+              break
+            end
+          end
+
+          paths
+        end
+
+        def parse_facet_ids(json_object)
+          ids = parse_facet_ids_in_attributes_merged(json_object)
+          ids = parse_facet_ids_in_variants(json_object) if ids.nil?
+          ids = parse_facet_ids_in_brand(json_object) if ids.nil?
+
+          !ids.nil? ? ids : []
+        end
+
+        def parse_facet_ids_in_attributes_merged(json_object)
+          return nil unless json_object['attributes_merged']
+
+          parse_attributes_json(json_object['attributes_merged'])
+        end
+
+        def parse_attributes_json(attributes_json_object)
+          ids = {}
+
+          attributes_json_object.each do |group, facet_ids|
+            gid = group[11..group.length] # rm prefix 'attributes'
+
+            # TODO: Remove Workaround for Ticket ???
+            facet_ids = Array(facet_ids)
+            ids[gid] = facet_ids
+          end
+
+          ids
+        end
+
+        def parse_facet_ids_in_variants(json_object)
+          if json_object['variants']
+            ids = []
+            json_object['variants'].each do |variant|
+              ids.push(parse_attributes_json(variant['attributes']))
+            end
+            ids = AboutYou::SDK::Model::FacetGroupSet.merge_facet_ids(ids)
+            return ids
+          elsif json_object['default_variant']
+            ids = parse_attributes_json(
+              json_object['default_variant']['attributes']
+            )
+            return ids
+          end
+
+          nil
+        end
+
+        def parse_facet_ids_in_brand(json_object)
+          return nil unless json_object['brand_id']
+
+          { '0' => [json_object['brand_id']] }
+        end
+
+        def generate_facet_group_set
+          fail 'RuntimeException! To use this method, you must add the field
+            ProductFields::ATTRIBUTES_MERGED to the "product search" or
+            "products by ids"' if facet_ids.empty?
+
+          self.facet_groups = AboutYou::SDK::Model::FacetGroupSet.new(facet_ids)
+        end
+
+        def facet_group_set
+          generate_facet_group_set unless @facet_groups
+
+          @facet_groups
+        end
+
+        def category(active = false)
+          return nil unless category_id_paths
+
+          leaf_categories(active)[leaf_categories(active).keys[0]]
+        end
+
+        def category_with_longest_active_path
+          return nil unless category_id_paths
+
+          category_id_paths.sort! { |x, y| y.count <=> x.count }.each do |path|
+            return factory.category_manager.category(path[-1]) if
+            factory.category_manager.category(path[-1]).path_active?
+          end
+
+          nil
+        end
+
+        def leaf_categories(active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+          factory.category_manager.categories(leaf_category_ids, active_only)
+        end
+
+        def root_category_ids
+          root_category = []
+          category_id_paths.each do |category_id_path|
+            root_category.push(category_id_path[0])
+          end
+
+          root_category.uniq
+        end
+
+        def leaf_category_ids
+          leaf_categories = []
+          category_id_paths.each do |category_id_path|
+            leaf_categories.push(category_id_path[-1])
+          end
+
+          leaf_categories.uniq
+        end
+
+        def categories(active_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+          root_categories(active_only)
+        end
+
+        def root_categories(active_only = Category::ACTIVE_ONLY)
+          factory.category_manager.categories(root_category_ids, active_only)
+        end
+
+        def group_facets(group_id)
+          facet_group_set.group(group_id) ? group.facets : []
+        end
+
+        def facet_groups(group_id)
+          all_groups = {}
+
+          variants.each do |variant|
+            variant.facet_group_set.groups.each do |group|
+              all_groups[group.unique_key] = group if group.id == group_id
+            end
+          end
+
+          all_groups
+        end
+
+        def selectable_facet_groups(selected_facet_group_set)
+          all_groups = {}
+          selected_group_ids = selected_facet_group_set.group_ids
+
+          variants.each do |variant|
+            next if facet_group_set.contains(selected_facet_group_set)
+
+            facet_group_set = variant.facet_group_set
+            ids = facet_group_set.group_ids
+
+            ids.each do |group_id|
+              next if selected_group_ids.include?(group_id)
+
+              group = facet_group_set.group(group_id)
+              fail 'RuntimeException! group for id ' + group_id +
+                ' not found' if group.nil?
+
+              all_groups[group_id][group.unique_key] = group
+            end
+          end
+
+          selected_group_ids.each do |group_id|
+            ids = selected_facet_group_set.ids
+            ids[group_id] = nil
+            my_facet_group_set = AboutYou::SDK::Model::FacetGroupSet.new(ids)
+            variants.each do |variant|
+              facet_group_set = variant.facet_group_set
+              if facet_group_set.contains(my_facet_group_set)
+                group = facet_group_set.group(group_id)
+                all_groups[group_id][group.unique_key] = group
+              end
+            end
+          end
+
+          all_groups
+        end
+
+        def excluded_facet_groups(selected_facet_group_set)
+          all_groups = {}
+
+          variants.each do |variant|
+            next unless facet_group_set.contains(selected_facet_group_set)
+
+            facet_group_set = variant.facet_group_set
+            facet_group_set.group_ids.each do |group_id|
+              next if selected_facet_group_set.group_ids.include?(group_id)
+              group = facet_group_set.group(group_id)
+              fail 'RuntimeException! group for id ' + String(group_id) +
+                ' not found' if group.nil?
+              facets = group.facets
+              next unless facets
+
+              unless all_groups[group_id]
+                all_groups[group_id] = AboutYou::SDK::Model::FacetGroup.new(
+                  group.id,
+                  group.name
+                )
+                all_groups[group_id].add_facets(facets)
+              end
+            end
+          end
+
+          all_groups
+        end
+
+        def brand
+          facet_group_set.facet(
+            AboutYou::SDK::Constants::FACET_BRAND,
+            brand_id
+          )
+        end
+
+        def variant_by_id(variant_id)
+          variants[variant_id] ? variants[variant_id] : nil
+        end
+
+        def variants_by_ean(ean)
+          variants = []
+
+          variants.each do |_key, variant|
+            variants.push(variant) if variant.ean == ean
+          end
+
+          variants
+        end
+
+        def variant_by_facet(facet_group_set)
+          key = facet_group_set.unique_key
+          variants.each do |variant|
+            return variant if variant.facet_group_set.unique_key == key
+          end
+
+          nil
+        end
+
+        def variants_by_facet_id(facet_id, group_id)
+          variants = []
+
+          facet = AboutYou::SDK::Facet.new(facet_id, '', '', group_id, '')
+          self.variants.each do |variant|
+            variants.push(variant) if variant.facet_group_set.contains(facet)
+          end
+
+          variants
+        end
+      end
+    end
+  end
+end