aboutyou-sdk 0.0.24 → 0.0.25

data/lib/AboutYou/Model/categories_result.rb

@@ -0,0 +1,24 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class is used as a model for a categories result
+      #
+      ###
+      class CategoriesResult
+        attr_accessor :categories
+        attr_accessor :categories_not_found
+        attr_accessor :ids
+
+        def initialize(category_manager, ids)
+          self.ids = ids
+          self.categories = category_manager.categories(
+            ids,
+            AboutYou::SDK::Model::Category::ALL
+          )
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/category.rb

@@ -0,0 +1,102 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a category model
+      #
+      ###
+      class Category
+        ALL = false
+        ACTIVE_ONLY = true
+
+        # @var integer */
+        attr_accessor :id
+        # @var string */
+        attr_accessor :name
+        # @var boolean */
+        attr_accessor :is_active
+        # @var integer */
+        attr_accessor :position
+        # @var Category */
+        attr_accessor :parent_id
+        # @var Category[] */
+        attr_accessor :all_subcategories
+        # @var Category[] */
+        attr_accessor :active_subcategories
+        # @var integer */
+        attr_accessor :product_count
+        attr_accessor :category_manager
+
+        def initialize
+          self.all_subcategories = []
+          self.active_subcategories = []
+        end
+
+        ###
+        # @param object        $json_object  json as object tree
+        # @param ModelFactoryInterface $factory
+        # @param Category|null $parent
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object, cat_manager)
+          category = new
+
+          category.parent_id        = json_object['parent']
+          category.id               = json_object['id']
+          category.name             = json_object['name']
+          category.is_active        = json_object['active']
+          category.position         = json_object['position']
+          category.category_manager = cat_manager
+
+          category
+        end
+
+        ###
+        # @return boolean
+        ###
+        def path_active?
+          is_active && (parent.nil? || parent.path_active?)
+        end
+
+        ###
+        # @return Category|null
+        ###
+        def parent
+          return nil unless parent_id
+
+          category_manager.category(parent_id)
+        end
+
+        ###
+        # @param bool $activeOnly
+        #
+        # @return Category[]
+        ###
+        def subcategories(active_only = ACTIVE_ONLY)
+          subcategories = category_manager.subcategories(id, active_only)
+          return subcategories if active_only == ALL
+
+          result = {}
+
+          subcategories.each do |key, subcat|
+            result[key] = subcat if subcat.is_active
+          end
+
+          result
+        end
+
+        ###
+        # @return Category[]
+        ###
+        def breadcrumb
+          breadcrumb = parent ? parent.breadcrumb : []
+          breadcrumb.push(self)
+
+          breadcrumb
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/category_tree.rb

@@ -0,0 +1,37 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a category tree model
+      #
+      ###
+      class CategoryTree
+        # @var CategoryManagerInterface */
+        attr_accessor :category_manager
+
+        def initialize(cat_manager)
+          self.category_manager = cat_manager
+        end
+
+        ###
+        # @param bool $activeOnly if true, then only active categories will returned, otherwise all categories
+        #
+        # @return array|Category[]
+        ###
+        def categories(act_only = AboutYou::SDK::Model::Category::ACTIVE_ONLY)
+          category_manager.category_tree(act_only)
+        end
+
+        ###
+        # Count active root all categories
+        #
+        # {@inheritdoc}
+        ###
+        def count
+          categories(true).count
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/facet.rb

@@ -0,0 +1,86 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a Facet model
+      #
+      ###
+      class Facet
+        attr_accessor :json_object
+        # @var integer */
+        attr_accessor :id
+        # @var string */
+        attr_accessor :name
+        # @var string */
+        attr_accessor :value
+        # @var integer */
+        attr_accessor :group_id
+        # @var string */
+        attr_accessor :group_name
+        # @var array */
+        attr_accessor :options
+
+        ###
+        # @param integer $id
+        # @param string  $name
+        # @param string  $value
+        # @param integer $group_id
+        # @param string  $group_name
+        # @param array   $options
+        ###
+        def initialize(id, name, value, group_id, group_name, options = nil)
+          self.id         = id
+          self.name       = name
+          self.value      = value
+          self.group_id   = group_id
+          self.group_name = group_name
+          self.options    = options
+        end
+
+        ###
+        # @param $json_object
+        #
+        # @return static
+        ###
+        def self.create_from_json(json_object)
+          new(
+              json_object['facet_id'],
+              json_object['name'],
+              json_object['value'] ? json_object['value'] : nil,
+              json_object['id'],
+              json_object['group_name'],
+              json_object['options'] ? json_object['options'] : nil
+          )
+        end
+
+        ###
+        # a facet is unique with the combination about id and group id
+        #
+        # @return string
+        ###
+        def unique_key(group_id = nil, facet_id = nil)
+          return String(group_id) + ':' + String(facet_id) unless
+          group_id.nil? && facet_id.nil?
+
+          String(self.group_id) + ':' + String(id) unless
+          self.group_id.nil? && self.facet_id.nil?
+        end
+
+        ###
+        # Get option value.
+        #
+        # @param string $key The option key.
+        #
+        # @return mixed
+        ###
+        def option(key)
+          return unless options
+          options.each do |option|
+            return option['value'] if option['key'] == key
+          end
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/facet_group.rb

@@ -0,0 +1,96 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a facet group model
+      #
+      ###
+      class FacetGroup
+        # @var Facet[] */
+        attr_accessor :facets
+        # @var integer */
+        attr_accessor :id
+        # @var string */
+        attr_accessor :name
+        attr_accessor :group_id
+
+        ###
+        # @param integer $id
+        # @param string  $name
+        ###
+        def initialize(id, name)
+          self.id = id
+          self.name = name
+          self.facets = {}
+        end
+
+        ###
+        # @param Facet $facet
+        ###
+        def add_facet(facet)
+          facets[facet.id] = facet
+        end
+
+        ###
+        # @param Facet[] $facet
+        ###
+        def add_facets(facets)
+          facets.each do |facet|
+            add_facet(facet)
+          end
+        end
+
+        ###
+        # Returns all facet names separated with the given parameter
+        # eg. for size with to size facets "36" and "37" -> "36/37"
+        #
+        # @param string $separator
+        #
+        # @return string
+        ###
+        def facet_names(separator = '/')
+          names = []
+          facets.each do |facet|
+            names.push(facet.name)
+          end
+
+          names.join(separator)
+        end
+
+        ###
+        # facet groups are equal, if the ids and all child ids are equal
+        #
+        # @param FacetGroup $facet_group
+        #
+        # @return boolean
+        ###
+        def equal?(facet_group)
+          return false unless id == facet_group.id
+
+          unique_key == facet_group.unique_key
+        end
+
+        ###
+        # @see equal?
+        #
+        # @return string
+        ###
+        def unique_key
+          facet_ids = facets.keys
+          facet_ids.sort!
+
+          String(id) + ':' + String(facet_ids.join(','))
+        end
+
+        def ids
+          { id => facets.keys }
+        end
+
+        def contains(facet)
+          facets.key?(facet.id)
+        end
+      end
+    end
+  end
+end

data/lib/AboutYou/Model/facet_group_set.rb

@@ -0,0 +1,209 @@
+module AboutYou
+  module SDK
+    module Model
+      ###
+      #
+      # This class represents a facet group set model
+      #
+      ###
+      class FacetGroupSet
+        # @var array */
+        attr_accessor :ids
+        # @var FacetGroup[] */
+        attr_accessor :groups
+        # @var Facet[] */
+        attr_accessor :facets
+        # @var FacetManagerInterface */
+        class << self
+          attr_accessor :facet_manager
+        end
+
+        ###
+        # @param array $ids two dimensional array of group ids and array ids
+        #
+        # @throws \InvalidArgumentException
+        ###
+        def initialize(ids)
+          self.facets = {}
+          self.groups = {}
+          ids.each do |_key, facet_ids|
+            fail '\InvalidArgumentException! ids must be an associative array
+              of [$groupId => [$facetId,...],..]' unless facet_ids.is_a?(Array)
+          end
+
+          self.ids = ids
+        end
+
+        ###
+        # @return boolean
+        ###
+        def empty?
+          ids.empty?
+        end
+
+        def gen_lazy_groups
+          groups = {}
+          ids.each do |group_id, facet_ids|
+            group = AboutYou::SDK::Model::FacetGroup.new(group_id, nil)
+            facet_ids.each do |facet_id|
+              facet = AboutYou::SDK::Model::Facet.new(
+                facet_id,
+                nil,
+                nil,
+                group_id,
+                nil
+              )
+              group.add_facet(facet)
+            end
+            groups[group_id] = group
+          end
+
+          groups
+        end
+
+        def lazy_groups
+          return @groups unless @groups.empty?
+          gen_lazy_groups
+        end
+
+        def fetch
+          return unless facets && facets.empty?
+
+          ids.each do |group_id, facet_ids|
+            facet = self.class.facet_manager.facet(group_id, facet_ids[0])
+            next unless facet
+            if @groups[group_id]
+              group = @groups[group_id]
+            else
+              group = AboutYou::SDK::Model::FacetGroup.new(
+                group_id,
+                facet.group_name
+              )
+              @groups[group_id] = group
+            end
+            group.add_facet(facet)
+            facets[facet.unique_key] = facet
+          end
+        end
+
+        ###
+        # @return FacetGroup[]
+        ###
+        def groups
+          fetch if @groups.empty?
+
+          @groups
+        end
+
+        ###
+        # @param $group_id
+        #
+        # @return FacetGroup|null
+        ###
+        def group(group_id)
+          return groups[group_id] if groups[group_id]
+        end
+
+        ###
+        # @param $group_id
+        #
+        # @return bool
+        ###
+        def group?(group_id)
+          !ids[group_id].empty?
+        end
+
+        ###
+        # @param string $key
+        #
+        # @return Facet|null
+        ###
+        def facet_by_key(key)
+          fetch
+          facets[key] ? facets[key] : nil
+        end
+
+        def facet(facet_group_id, facet_id)
+          fetch if facets.empty?
+
+          return facets[String(facet_group_id) + ':' + String(facet_id)] if
+          facets[String(facet_group_id) + ':' + String(facet_id)]
+        end
+
+        ###
+        # set are equal, if all groups are equal
+        # which means, that all included facet ids per group must be the same
+        #
+        # @return string
+        ###
+        def unique_key
+          ids.sort!
+          ids.map { |sub_ids| sub_ids.sort! }
+
+          ids.to_json
+        end
+
+        ###
+        # @param FacetUniqueKeyInterface $facetCompable
+        #
+        # @return boolean
+        ###
+        def contains(facet_compable)
+          return contains_facet_group_set(facet_compable) if
+          facet_compable.is_a?(self.class)
+
+          return contains_facet_get_group_interface(facet_compable) if
+          facet_compable.is_a? AboutYou::SDK::Model::FacetGetGroupInterface
+
+          false
+        end
+
+        def contains_facet_get_group_interface(facet)
+          lazy_groups = self.lazy_groups
+          id = facet.group_id
+
+          if lazy_groups.key?(id)
+            return lazy_groups[id].unique_key == facet.unique_key
+          end
+
+          false
+        end
+
+        def contains_facet_group_set(facet_group_set)
+          return true if unique_key == facet_group_set.unique_key
+
+          lazy_groups.each do |id, group|
+            return false if
+            lazy_groups['id'] || lazy_groups[id].unique_key != group.unique_key
+          end
+
+          true
+        end
+
+        def self.merge_facet_ids(facet_ids_array)
+          ids = {}
+
+          facet_ids_array.each do |facet_ids_hash|
+            facet_ids_hash.each do |group_id, facet_ids|
+              if ids[Integer(group_id)]
+                ids[Integer(group_id)] = ids[Integer(group_id)] +
+                  facet_ids.uniq
+              else
+                ids[Integer(group_id)] = facet_ids
+              end
+            end
+          end
+
+          ids
+        end
+
+        ###
+        # @return array
+        ###
+        def group_ids
+          ids.keys
+        end
+      end
+    end
+  end
+end