aboutyou-sdk 0.0.24 → 0.0.25

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

@@ -1,125 +0,0 @@
-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 = Hash.new
-          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[product.id] = 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/FacetCounts.rb

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

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

@@ -1,71 +0,0 @@
-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 :productCountInSale
-        # count of prodocuts not in sale
-        attr_accessor :productCountNotInSale
-        # count of total products
-        attr_accessor :productCountTotal
-        # count of products without facet
-        attr_accessor :productCountWithoutAnyFacet
-        # count of products with other facets
-        attr_accessor :productCountWithOtherFacet
-
-        ###
-        # the Constructor for the sale counts class
-        #
-        # * *Args*    :
-        #   - +productCountTotal+ -> the total productcount
-        #   - +productCountWithOtherFacet+ -> the productcount without any facets
-        #   - +productCountWithoutAnyFacet+ -> the productcount with other facets
-        #   
-        # * *Returns* :
-        #   - Instance of AboutYou::SDK::Model::SaleCounts
-        ###
-        def initialize(productCountTotal, productCountWithOtherFacet, productCountWithoutAnyFacet)
-          self.productCountTotal           = productCountTotal
-          self.productCountWithOtherFacet  = productCountWithOtherFacet
-          self.productCountWithoutAnyFacet = productCountWithoutAnyFacet
-        end
-          
-        ###
-        # This method is used for creating an instance of this class by a jsonObject.
-        #
-        # * *Args*    :
-        #   - +jsonObject+ -> the jsonObject received from the api
-        #   
-        # * *Returns* :
-        #   - Instance of AboutYou::SDK::Model::SaleCounts
-        ###
-        def self.createFromJson(jsonObject)
-          saleCounts = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"])
-          saleCounts.parseTerms(jsonObject["terms"])
-
-          saleCounts
-        end
-
-        ###
-        # This method is used for parsing the terms of the jsonObject
-        #
-        # * *Args*    :
-        #   - +jsonTerms+ -> the terms of the jsonObject received from the api
-        ###
-        def parseTerms(jsonTerms)
-          jsonTerms.each do |term|
-            term["term"] == 0 ?
-              self.productCountNotInSale = term["count"] :
-              self.productCountInSale = term["count"]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-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 :productCountTotal
-        # count of products without facet
-        attr_accessor :productCountWithOtherFacet
-        # count of products with other facets
-        attr_accessor :productCountWithoutAnyFacet
-
-        ###
-        # the Constructor for the terms count class
-        #
-        # * *Args*    :
-        #   - +productCountTotal+ -> the total productcount
-        #   - +productCountWithOtherFacet+ -> the productcount without any facets
-        #   - +productCountWithoutAnyFacet+ -> the productcount with other facets
-        #   
-        # * *Returns* :
-        #   - Instance of AboutYou::SDK::Model::TermsCount
-        ###
-        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

@@ -1,47 +0,0 @@
-module AboutYou
-  module SDK
-    module Model
-      class ProductsEansResult
-
-          # @var string[] #
-          attr_accessor :eansNotFound
-          attr_accessor :pageHash
-          attr_accessor :errors
-          attr_accessor :products
-
-           ###
-           # @param \stdClass $jsonObject
-           # @param ModelFactoryInterface $factory
-           #
-           # @return static
-           ###
-          def self.createFromJson(jsonObject, factory)
-
-              productsEansResult = self.new
-              productsEansResult.products = Array(nil)
-              productsEansResult.eansNotFound = Array(nil)
-              productsEansResult.errors = Array(nil)
-
-              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

@@ -1,52 +0,0 @@
-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 productsNotFound()
-          
-            return self.idsNotFound;
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-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

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

@@ -1,255 +0,0 @@
-module AboutYou
-  module SDK
-    module Model
-      
-      class Variant 
-        include AbstractModel
-        
-          attr_accessor :factory
-          attr_accessor :product
-          attr_accessor :id
-          attr_accessor :images
-          attr_accessor :selectedImage
-          attr_accessor :aboutNumber
-          attr_accessor :facetGroups
-          attr_accessor :ean
-          attr_accessor :isDefault
-          attr_accessor :price
-          attr_accessor :oldPrice
-          attr_accessor :retailPrice
-          attr_accessor :additionalInfo
-          attr_accessor :quantity
-          attr_accessor :facetIds
-          attr_accessor :firstActiveDate
-          attr_accessor :firstSaleDate
-          attr_accessor :createdDate
-          attr_accessor :updatedDate
-          attr_accessor :color
-          attr_accessor :length
-          attr_accessor :seasonCode
-          attr_accessor :jsonObject
-        
-           ###
-           # @param \stdClass $jsonObject
-           # @param ModelFactoryInterface $factory
-           # @param Product $product
-           #
-           # @return static
-           ###
-          def self.createFromJson(jsonObject, factory, product)
-          
-            jsonObj = jsonObject
-            if (!jsonObj["id"]) 
-              raise 'MalformedJsonException'
-            end
-
-            variant = self.new
-            variant.factory    = factory
-            variant.product    = product
-            variant.jsonObject = jsonObject
-            
-            
-            variant.parseImages(jsonObj["images"])
-            #free memory
-            jsonObj["images"] = nil
-            
-            variant.id         = jsonObj["id"]       
-            
-            variant.aboutNumber = (jsonObj["about_number"]) ? jsonObj["about_number"] : nil
-            variant.ean = (jsonObj["ean"]) ? jsonObj["ean"] : nil
-            variant.isDefault = (jsonObj["default"]) ? jsonObj["default"] : nil
-            variant.price = (jsonObj["price"]) ? jsonObj["price"] : nil
-            variant.oldPrice = (jsonObj["old_price"]) ? jsonObj["old_price"] : nil
-            variant.retailPrice = (jsonObj["retail_price"]) ? jsonObj["retail_price"] : nil
-            variant.additionalInfo = (jsonObj["additional_info"]) ? jsonObj["additional_info"] : nil
-            variant.quantity = (jsonObj["quantity"]) ? jsonObj["quantity"] : 0
-            variant.firstActiveDate = (jsonObj["first_active_date"]) ? jsonObj["first_active_date"] : nil
-            variant.firstSaleDate = (jsonObj["first_sale_date"]) ? jsonObj["first_sale_date"] : nil
-            variant.createdDate = (jsonObj["created_date"]) ? jsonObj["created_date"] : nil
-            variant.updatedDate = (jsonObj["updated_date"]) ? jsonObj["updated_date"] : nil
-
-            variant.facetIds = variant.parseFacetIds(jsonObj)
-            variant.color = variant.facetGroup(AboutYou::SDK::Constants::FACET_COLOR, jsonObject)
-            variant.length = variant.facetGroup(AboutYou::SDK::Constants::FACET_LENGTH, jsonObject)
-            variant.seasonCode = variant.facetGroup(AboutYou::SDK::Constants::FACET_SEASON_CODE,jsonObject)
-
-
-            return variant
-          end     
-
-          
-          def parseImages(imageObject)
-            if (!self.images)
-              self.images = Array(nil);
-                if(imageObject)
-                  imageObject.each do |image| 
-                      self.images.push(self.factory.createImage(image))
-                  end  
-                end
-            end
-          end
-          
-           ###
-           # Get image by given hash.
-           #
-           # @param string $hash The image hash.
-           #
-           # @return Image
-           ###
-          def imageByHash(hash)
-          
-              self.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 selectImage(hash=nil)
-              if (hash) 
-                  self.selectedImage = imageByHash(hash);
-              else
-                  self.selectedImage = nil;
-              end
-          end
-
-           ###
-           # Get selected or default image.
-           #
-           # @return Image
-           ###
-          def image
-          
-              if (self.selectedImage) 
-                  return self.selectedImage;
-              elsif (self.images[0])
-                  return self.images[0];
-              end
-              return nil;
-          end
-
-
-          def parseFacetIds(jsonObject)
-          
-              ids = {}
-              if !(jsonObject["attributes"].empty?) 
-                  jsonObject["attributes"].each do |group, aIds|
-                      gid = group[11..group.length] # rm prefix "attributs_"
-                      ids[Integer(gid)] = aIds
-                  end
-              end
-              return ids
-          end
-          
-                
-          def generateFacetGroupSet(jsonObject)
-
-              ids = self.parseFacetIds(jsonObject)
-              self.facetGroups= AboutYou::SDK::Model::FacetGroupSet.new(ids)
-          end
-
-
-           ###
-           # @return FacetGroupSet
-           ###
-          def facetGroupSet(jsonObject)
-          
-            if !(self.facetGroups)
-                  self.generateFacetGroupSet(jsonObject);
-              end
-              return self.facetGroups;
-          end
-
-           ###
-           # @param integer $groupId
-           #
-           # @return FacetGroup|null
-           ###
-           def facetGroup(groupId, jsonObject=self.jsonObject)
-            return self.facetGroupSet(jsonObject).group(groupId)
-          end
-
-           ###
-           # @return FacetGroup|null
-           ###
-          def size()
-          
-               ###
-               # @todo: Instance level caching
-               ###
-              groupId = self.sizeGroupId();
-
-              if !(groupId.empty?)
-                  return self.facetGroup(groupId);
-              end
-          end
-
-           ###
-           # @return integer|null
-           ###
-          def sizeGroupId()
-          
-              keys = Hash.new
-
-              groups = self.facetGroupSet().groups();
-
-              if (groups.is_a? Array)
-                  groups.each do |group|
-                      keys[group.name] = group.groupId();
-                  end
-              end
-
-              sizeRun = self.facetGroup(AboutYou::SDK::Constants::FACET_SIZE_RUN);
-
-              if !(sizeRun.empty?)
-                  sizeRun.facets.each do |facet|
-                      groupName = facet.value();
-                      if (keys.key?(groupName))
-                          return keys[groupName];
-                      end
-                  end
-              end
-              if (keys.key?('size'))
-                  return keys['size'];
-              end
-              if (keys.key?('size_run')) 
-                  return keys['size_run'];
-              end
-
-              return 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 quantityPerPack()
-          
-              facetGroup = self.facetGroup(AboutYou::SDK::Constants::FACET_QUANTITY_PER_PACK);
-
-              if !(facetGroup)
-                  return 1;
-              end
-
-              facets = facetGroup.facets();
-
-              if !(facets)
-                  return 1;
-              end
-              
-              return facets[0].value();
-          end
-      end
-    end
-  end
-end