aboutyou-sdk 0.0.1

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

@@ -0,0 +1,125 @@
+module AboutYou
+  module SDK
+    module Model
+      class ProductSearchResult
+
+          attr_accessor :products
+          attr_accessor :pageHash
+          attr_accessor :productCount
+          attr_accessor :saleCounts
+          attr_accessor :priceRanges
+          attr_accessor :facets
+          attr_accessor :categories
+          attr_accessor :rawFacets
+
+        
+          def initialize
+
+              self.products = Array(nil)
+          end
+
+           ###
+           # @param \stdClass $jsonObject
+           # @param ModelFactoryInterface $factory
+           #
+           # @return static
+           ###
+          def self.createFromJson(jsonObject, factory)
+              productSearchResult = self.new
+              jsonObj = jsonObject
+
+              productSearchResult.pageHash = jsonObj["pageHash"];
+              productSearchResult.productCount = jsonObj["product_count"];
+              productSearchResult.rawFacets = jsonObj["facets"];
+
+              jsonObj["products"].each do |jsonProduct|
+                  product = factory.createProduct(jsonProduct)
+                  productSearchResult.products.push(product)
+              end
+              productSearchResult.parseFacets(jsonObj["facets"], factory);
+              #free memory
+              jsonObj["categories"] = nil
+              jsonObj["prices"] = nil
+              jsonObj["sale"] = nil
+              productSearchResult.facets= factory.createFacetsCounts(jsonObject)
+
+              return productSearchResult;
+          end
+
+
+          def parseFacets(jsonObject, factory)
+              if (jsonObject["categories"])
+                  self.categories = factory.createCategoriesFacets(jsonObject["categories"])
+              end
+              if (jsonObject["prices"]) 
+                  self.priceRanges = factory.createPriceRanges(jsonObject["prices"]);
+              end
+              if (jsonObject["sale"]) 
+                  self.saleCounts = factory.createSaleFacet(jsonObject["sale"]);
+              end
+          end
+
+
+           ###
+           # Returns the min price in euro cent or null, if the price range was not requested/selected
+           #
+           # * @return integer|null
+           ###
+          def minPrice()
+
+              if (self.priceRanges.empty?)
+                return nil;
+              end
+
+              self.priceRanges.each do |priceRange|
+                  if (priceRange.productCount === 0) 
+                      next;
+                  end
+
+                  return priceRange.min;
+              end
+
+              return self.priceRanges[0].min
+          end
+
+           ###
+           # Returns the max price in euro cent, if the price range was not requested/selected
+           #
+           # @return integer|null
+           ###
+          def maxPrice()
+
+              if (self.priceRanges.empty?)
+                return nil;
+              end
+
+              maxPrice = 0;
+              self.priceRanges.reverse_each do |priceRange|
+                  if (priceRange.productCount == 0) 
+                      next;
+                  end
+
+                  return priceRange.max();
+              end
+
+              return self.priceRanges[-1].max;
+          end
+
+           ###
+           # @return Category[]
+           ###
+          def categoryTree()
+
+              topLevelCategories = Array(nil);
+              self.categories.each do |category|
+                  if (category.parent() == nil) 
+                      topLevelCategories.push(category);
+                  end
+              end
+
+              return topLevelCategories;
+          end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/ProductSearchResult/FacetCount.rb

@@ -0,0 +1,26 @@
+module AboutYou
+  module SDK
+    module Model
+      class FacetCount
+
+        # @var Facet */
+        @facet;
+        attr_accessor :facet
+
+        # @var integer */
+        @count;
+        attr_accessor :count
+
+         ###
+         # @param Facet   $facet
+         # @param integer $count
+         ###
+        def initialize(facet, count)
+
+            self.facet = facet;
+            self.count = count;
+        end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/ProductSearchResult/FacetCounts.rb

@@ -0,0 +1,38 @@
+module AboutYou
+  module SDK
+    module Model
+      class FacetCounts 
+
+        attr_accessor :groupId
+        attr_accessor :facetCountList
+        attr_accessor :productCountTotal
+        attr_accessor :productCountWithoutAnyFacet
+        attr_accessor :productCountWithOtherFacet
+        
+        
+        def initialize(productCountTotal, productCountWithOtherFacet, productCountWithoutAnyFacet)
+        
+            self.productCountTotal           = productCountTotal;
+            self.productCountWithOtherFacet  = productCountWithOtherFacet;
+            self.productCountWithoutAnyFacet = productCountWithoutAnyFacet;
+        end
+
+         ###
+         # @param integer      $groupId
+         # @param \stdClass    $jsonObject
+         # @param FacetCount[] $facetCounts
+         #
+         # @return FacetCounts
+         ###
+        def self.createFromJson(groupId, jsonObject, facetCountList)
+
+            facetCounts = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"])
+            facetCounts.groupId = groupId;
+            facetCounts.facetCountList = facetCountList;
+
+            return facetCounts;
+        end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/ProductSearchResult/PriceRange.rb

@@ -0,0 +1,49 @@
+module AboutYou
+  module SDK
+    module Model
+      class PriceRange
+
+        attr_accessor :productCount
+        attr_accessor :from
+        attr_accessor :to
+        attr_accessor :min
+        attr_accessor :max
+        attr_accessor :mean
+        attr_accessor :sum
+
+
+         ###
+         # Expected json format
+         # {
+         # "count": 25138,
+         # "from": 0,
+         # "min": 399,
+         # "max": 19999,
+         # "to": 20000,
+         # "total_count": 25138,
+         # "total": 133930606,
+         # "mean": 5327.8147028403
+         # }
+         #
+         # @param \stdClass $jsonObject
+         #
+         # @return static
+         ###
+        def self.createFromJson(jsonObject)
+
+            priceRange = self.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"]
+
+            return priceRange;
+        end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/ProductSearchResult/SaleCounts.rb

@@ -0,0 +1,58 @@
+module AboutYou
+  module SDK
+    module Model
+      class SaleCounts
+
+          # @var integer */
+          @productCountInSale;
+          attr_accessor :productCountInSale
+
+          # @var integer */
+          @productCountNotInSale;
+          attr_accessor :productCountNotInSale
+        
+          @productCountTotal
+          attr_accessor :productCountTotal
+
+          @productCountWithoutAnyFacet
+          attr_accessor :productCountWithoutAnyFacet
+
+          @productCountWithOtherFacet
+          attr_accessor :productCountWithOtherFacet
+
+          def initialize(productCountTotal, productCountWithOtherFacet, productCountWithoutAnyFacet)
+
+              self.productCountTotal           = productCountTotal;
+              self.productCountWithOtherFacet  = productCountWithOtherFacet;
+              self.productCountWithoutAnyFacet = productCountWithoutAnyFacet;
+          end
+          
+           ###
+           # @param \stdClass $jsonObject
+           #
+           # @return static
+           ###
+          def self.createFromJson(jsonObject)
+              saleCounts = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"]);
+              saleCounts.parseTerms(jsonObject["terms"]);
+
+              return self;
+          end
+
+           ###
+           # {@inheritdoc}
+           ###
+          def parseTerms(jsonTerms)
+
+              jsonTerms.each do |term|
+                  if (term["term"] == "0")
+                      self.productCountNotInSale = term["count"];
+                  else
+                      self.productCountInSale = term["count"];
+                  end
+              end
+          end
+      end
+    end
+  end
+end

data/lib/aboutyou-sdk/Model/ProductSearchResult/TermsCount.rb

@@ -0,0 +1,27 @@
+module AboutYou
+  module SDK
+    module Model
+      class TermsCounts
+
+          # @var integer */
+          @productCountTotal;
+          attr_accessor :productCountTotal
+
+          # @var integer */
+          @productCountWithOtherFacet;
+          attr_accessor :productCountWithOtherFacet
+
+          # @var integer */
+          @productCountWithoutAnyFacet;
+          attr_accessor :productCountWithoutAnyFacet
+
+          def initialize(productCountTotal, productCountWithOtherFacet, productCountWithoutAnyFacet)
+
+              self.productCountTotal           = productCountTotal;
+              self.productCountWithOtherFacet  = productCountWithOtherFacet;
+              self.productCountWithoutAnyFacet = productCountWithoutAnyFacet;
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module AboutYou
+  module SDK
+    module Model
+      class ProductsEansResult
+
+          # @var string[] #
+          attr_accessor :eansNotFound
+          attr_accessor :pageHash
+          attr_accessor :errors
+
+           ###
+           # @param \stdClass $jsonObject
+           # @param ModelFactoryInterface $factory
+           #
+           # @return static
+           ###
+          def self.createFromJson(jsonObject, factory)
+
+              productsEansResult = self.new
+
+              if jsonObject["pageHash"]
+                productsEansResult.pageHash = jsonObject["pageHash"]
+              else
+                productsEansResult.pageHash = nil
+              end
+
+              if (jsonObject["eans"]) 
+                  jsonObject["eans"].each do |jsonProduct| 
+                      if (jsonProduct["error_code"]) 
+                          productsEansResult.errors.push(jsonProduct)
+                          productsEansResult.eansNotFound = productsEansResult.eansNotFound + jsonProduct["ean"]
+                          next;
+                      end
+                      productsEansResult.products.push = factory.createProduct(jsonProduct);
+                  end
+              end
+
+              return productsEansResult;
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module AboutYou
+  module SDK
+    module Model
+      class ProductsResult
+        include AbstractModel
+
+        attr_accessor :idsNotFound
+        attr_accessor :pageHash
+        attr_accessor :errors
+        attr_accessor :products
+
+
+         ### 
+         # @param \stdClass $jsonObject
+         # @param ModelFactoryInterface $factory
+         #
+         # @return static
+         ###
+        def self.createFromJson(jsonObject, factory)
+  
+            productsResult = self.new
+
+              productsResult.pageHash = (jsonObject["pageHash"]) ? jsonObject["pageHash"] : nil;
+              productsResult.errors=Array(nil)
+              productsResult.idsNotFound=Array(nil)
+              productsResult.products = Hash.new
+
+              if (jsonObject["ids"])
+                  jsonObject["ids"].each do |key, jsonProduct|
+                      if (jsonProduct["error_code"]) 
+                          productsResult.idsNotFound.push(key)
+                          productsResult.errors.push(jsonProduct);
+                          next
+                      end
+                      productsResult.products[Integer(key)] = factory.createProduct(jsonProduct);
+                  end
+              end
+
+              return productsResult;
+        end
+
+         ###
+         # @return integer[] array of product ids
+         ###
+        def getProductsNotFound()
+          
+            return self.idsNotFound;
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module AboutYou
+  module SDK
+    module Model
+      module ResultError
+      
+          attr_accessor :errorIdent
+          attr_accessor :errorCode
+          attr_accessor :errorMessage
+        
+          def initialize(jsonObject)
+          
+              self.parseErrorResult(jsonObject);
+          end
+
+          def parseErrorResult(jsonObject)
+          
+              self.errorIdent   = (jsonObject.key?("error_ident")) ? String(jsonObject["error_ident"]) : nil;
+              self.errorCode    = (jsonObject.key?("error_code")) ? Integer(jsonObject["error_code"]) : 0;
+              self.errorMessage = (jsonObject.key?("error_message")) ? jsonObject["error_message"] : nil;
+          end
+      end
+    end
+  end
+end