aboutyou-sdk 0.0.22 → 0.0.23

data/lib/aboutyou-sdk/Model/CategoryManager/DefaultCategoryManager.rb

@@ -44,13 +44,22 @@ module AboutYou
 
           ###
           # Gets the cached Categories for this app
+          # 
+          # * *Returns* :
+          #   - True/False determining whether the loading was sucessfull or not
           ###
           def loadCachedCategories
             parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
           end
 
           ###
-          # This method caches the currently read-in categories
+          # this method caches a given jsonObject
+          # 
+          # * *Args*    :
+          #   - +jsonObject+ -> the jsonObject received from the api
+          #
+          # * *Returns* :
+          #   - True/False determining whether the setting was sucessfull or not
           ###
           def cacheCategories(jsonObject)
             self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
@@ -58,6 +67,9 @@ module AboutYou
 
           ###
           # This method clears the cache
+          # 
+          # * *Returns* :
+          #   - True/False determining whether the clearing was sucessfull or not
           ###
           def clearCache
             self.cache.delete(self.cacheKey)

data/lib/aboutyou-sdk/Model/FacetManager/DefaultFacetManager.rb

@@ -42,14 +42,23 @@ module AboutYou
           end
 
           ###
-          # Gets the cached Facets for this app
+          # Gets the cached Categories for this app
+          # 
+          # * *Returns* :
+          #   - True/False determining whether the loading was sucessfull or not
           ###
           def loadCachedFacets
             parseJson(self.cache.get(self.cacheKey), self.shopApi.modelFactoryInstance) if self.cache && self.cache.exists(self.cacheKey)
           end
           
           ###
-          # This method caches the currently read-in Facets
+          # this method caches a given jsonObject
+          # 
+          # * *Args*    :
+          #   - +jsonObject+ -> the jsonObject received from the api
+          #
+          # * *Returns* :
+          #   - True/False determining whether the setting was sucessfull or not
           ###
           def cacheFacets(jsonObject)
             self.cache.set(self.cacheKey, jsonObject, DEFAULT_CACHE_DURATION)
@@ -57,6 +66,9 @@ module AboutYou
           
           ###
           # This method clears the cache
+          # 
+          # * *Returns* :
+          #   - True/False determining whether the clearing was sucessfull or not
           ###
           def clearCache
             self.cache.delete(self.cacheKey)

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

@@ -1,24 +1,31 @@
 module AboutYou
   module SDK
     module Model
+      
+      ###
+      # This class represents a FacetCount model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class FacetCount
-
-        # @var Facet */
-        @facet;
+        # The Facet
         attr_accessor :facet
-
-        # @var integer */
-        @count;
+        # The count of the facet
         attr_accessor :count
 
-         ###
-         # @param Facet   $facet
-         # @param integer $count
-         ###
+        ###
+        # the Constructor for the facetcount class
+        #
+        # * *Args*    :
+        #   - +facet+ -> a facet
+        #   - +count+ -> the count of the facet
+        #   
+        # * *Returns* :
+        #   - Instance of AboutYou::SDK::Model::FacetCount
+        ###
         def initialize(facet, count)
-
-            self.facet = facet;
-            self.count = count;
+          self.facet = facet
+          self.count = count
         end
       end
     end

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

@@ -1,36 +1,57 @@
 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;
+          self.productCountTotal           = productCountTotal
+          self.productCountWithOtherFacet  = productCountWithOtherFacet
+          self.productCountWithoutAnyFacet = productCountWithoutAnyFacet
         end
 
-         ###
-         # @param integer      $groupId
-         # @param \stdClass    $jsonObject
-         # @param FacetCount[] $facetCounts
-         #
-         # @return FacetCounts
-         ###
+        ###
+        # 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 = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"])
-            facetCounts.groupId = groupId;
-            facetCounts.facetCountList = facetCountList;
-
-            return facetCounts;
+          facetCounts
         end
       end
     end

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

@@ -1,47 +1,49 @@
 module AboutYou
   module SDK
     module Model
+      ###
+      # This class represents a Price Range model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class PriceRange
-
+        # the product count
         attr_accessor :productCount
+        # startpoint of the price range
         attr_accessor :from
+        # end of the price range
         attr_accessor :to
+        # min value of the price range
         attr_accessor :min
+        # max value of the price range
         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
-         ###
+        ###
+        # 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::PriceRange
+        ###
         def self.createFromJson(jsonObject)
+          priceRange = self.new
 
-            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"]
+          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;
+          priceRange
         end
       end
     end

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

@@ -1,57 +1,70 @@
 module AboutYou
   module SDK
     module Model
+      ###
+      # This class represents a Sale Counts model.
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class SaleCounts
 
-          # @var integer */
-          @productCountInSale;
-          attr_accessor :productCountInSale
+        # 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
 
-          # @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
+        ###
+        # 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
           
-           ###
-           # @param \stdClass $jsonObject
-           #
-           # @return static
-           ###
-          def self.createFromJson(jsonObject)
-              saleCounts = self.new(jsonObject["total"], jsonObject["other"], jsonObject["missing"]);
-              saleCounts.parseTerms(jsonObject["terms"]);
-
-              saleCounts
-          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"])
 
-           ###
-           # {@inheritdoc}
-           ###
-          def parseTerms(jsonTerms)
+          saleCounts
+        end
 
-              jsonTerms.each do |term|
-                  if (term["term"] == "0")
-                      self.productCountNotInSale = term["count"];
-                  else
-                      self.productCountInSale = term["count"];
-                  end
-              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

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

@@ -1,26 +1,35 @@
 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
 
-          # @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
+        ###
+        # 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

data/lib/aboutyou-sdk/Query.rb

@@ -250,6 +250,7 @@ module AboutYou
         if self.query.empty? && self.ghostQuery.empty? 
           return []
         end
+        binding.pry
         parseResult(self.client.request(queryString), self.query.count > 1)
       end