aboutyou-sdk 0.0.9 → 0.0.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjEwNWU3MTUxOGVmMWM4OGU1NmI3N2EzODUxZDQxNDc4MTYwMDg1ZA==
+    MDdiN2JjYmMwYTVkOGY2MTUwYmQ0MzdlZGNjODRiMDdkNTlmNDA0ZA==
   data.tar.gz: !binary |-
-    ZjJhZTViOGQzOTNmNGQzN2RmNjY2YjE5ZjMyNWJlNWZmZjczNjQ4Yg==
+    NGI0M2JmOTg4MjI2ODk0YzA2NGNmOGE1ODJhNmMwM2ZiOTAzNDBiZg==
 SHA512:
   metadata.gz: !binary |-
-    N2IyNDAyNTE1OGY2MjY3YmRkZjQ4ZjY5ZWY0NWY3OTBjNmY5YjRhYzAxYmRl
-    YmI1YWNhOTE1YzllNDAwMGQ1MjIyNTIyMjdhMTJhMmQ5ZWE3Y2IyZThiNzlh
-    ZmZmZDhiZjg0ZWE4MGFiZGJjZThlZjQ1YjlmNzYwZTJmYjYxMzY=
+    ZTVmODJjYjM2YTI0NTg1ODk3OWU3NWU4ODc2ZjI5ZjIxZGZhY2E4N2M4ZmFk
+    MzkwNmQ4ZjY3NTFhOTNkYTJiNzJhZDExNjkxNzgxOTE4NDkxODM4MmMxOTVm
+    YmRhZDczYjE1ZTQ4ODc4MTE1ZWVlYWM4NWMwNTYwNTlhNzVhNDQ=
   data.tar.gz: !binary |-
-    NjExZDYwM2U1YTdiZWNmY2EyZDdiYmEwYjAwZDJiZjkzOWE1NmRlZDA1Y2Nm
-    NTVlYjRmMzhjMmZmNjBjNDU1ZDQ3MjE0OTBjMzVkOTIzNThjNmEyNThkMmU3
-    NjIwYjk1MDg0NTQ3N2NiNDgzNWFlYzhiM2I0NjFhZTE0MWFiNDI=
+    YjI3Zjk2MGVkNTQxMzRlYzJjZWY0NjVkYmRmYzQyYzM2ODJlZTQ4MDg0MWJh
+    NGU1NWRlNDk4NmZkYTdmNjE2Nzk0MmQyNDAxYmViYTFlMjU0MDdmMTY1M2U3
+    MmYxMTM3ZWVmMTIwNmRiMTA5YTE0MzAzNjRlOGM5MGVlMDRmYWM=

data/lib/aboutyou-sdk.rb

@@ -2,44 +2,57 @@ require 'httparty'
 require 'json'
 require 'require_all'
 
-require_rel "aboutyou-sdk"
-
- ###
- # Provides access to the Collins Frontend Platform.
- # All the public methods cover a single API query.
- #
- # author:: Collins GmbH & Co KG
- ###
+require_rel 'aboutyou-sdk'
+
+###
+# Provides access to the Collins Frontend Platform.
+# All the public methods cover a single API query.
+#
+# author:: Collins GmbH & Co KG
+###
 class AY
+  
+  # url for staging
   IMAGE_URL_STAGE   = 'http://mndb.staging.aboutyou.de/mmdb/file'
+  # url for the sandbox
   IMAGE_URL_SANDBOX = 'http://mndb.sandbox.aboutyou.de/mmdb/file'
+  # url for live
   IMAGE_URL_LIVE    = 'http://cdn.aboutyou.de/file'
 
+  # the client which performs the api calls
   attr_accessor :aboutYouClient
+  # the app id of the app which should be represented by an instance of AY
   attr_accessor :appId
+  # the authentifaction token from dev-center for the app id
   attr_accessor :appPassword
+  # the endpoint used for api calls
   attr_accessor :apiEndPoint
+  # the environment which should be used by the app
   attr_accessor :environment
+  # a logger template
   attr_accessor :logger
+  # the model factory builds model objects based on the api response
   attr_accessor :modelFactoryInstance
+  # the url for getting images
   attr_accessor :baseImageUrl
+  # the session id from a user using this app
   attr_accessor :sessionId
 
-   ###
-   # the Constructor for the AY class
-   #
-   # * *Args*    :
-   #   - +appId+ -> The App-Id of the App
-   #   - +appPassword+ -> The Auth-Token of the App
-   #   - +sessionId+ -> A String containing the sessionId of the User
-   #   - +apiEndPoint+ -> Can be either live or staging
-   #   - +resultFactory+ -> If nil it will use the DefaultModelFactory with the DefaultFacetManager
-   #   - +logger+ -> Logger-Template
-   #   - +facetManagerCache+ -> The prefered Caching-Strategy
-   #   
-   # * *Returns* :
-   #   - Instance of AY
-   ###
+  ###
+  # the Constructor for the AY class
+  #
+  # * *Args*    :
+  #   - +appId+ -> The App-Id of the App
+  #   - +appPassword+ -> The Auth-Token of the App
+  #   - +sessionId+ -> A String containing the sessionId of the User
+  #   - +apiEndPoint+ -> Can be either live or staging
+  #   - +resultFactory+ -> If nil it will use the DefaultModelFactory with the DefaultFacetManager
+  #   - +logger+ -> Logger-Template
+  #   - +facetManagerCache+ -> The prefered Caching-Strategy
+  #   
+  # * *Returns* :
+  #   - Instance of AY
+  ###
   def initialize(
       appId,
       appPassword,
@@ -53,34 +66,40 @@ class AY
     self.sessionId   = sessionId
     self.appId       = appId
     self.appPassword = appPassword
-    self.aboutYouClient = AboutYou::SDK::Client.new(appId, appPassword, apiEndPoint, logger)
+    self.aboutYouClient = AboutYou::SDK::Client.new(
+      appId, 
+      appPassword, 
+      apiEndPoint, 
+      logger
+    )
     resultFactory ? self.modelFactoryInstance = resultFactory : initDefaultFactory(facetManagerCache)
 
     if apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE
-      self.baseImageUrl=(IMAGE_URL_STAGE)
+      self.baseImageUrl = (IMAGE_URL_STAGE)
       self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE         
     elsif apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
-      self.baseImageUrl=(IMAGE_URL_SANDBOX)
+      self.baseImageUrl = (IMAGE_URL_SANDBOX)
       self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
-    else 
-      self.baseImageUrl=(IMAGE_URL_LIVE)
+    else
+      self.baseImageUrl = (IMAGE_URL_LIVE)
     end
   end
 
-
-   ###
-   # Adds a single item into the basket.
-   # You can specify an amount. Please mind, that an amount > 1 will result in #amount basket positions.
-   # So if you read out the basket again later, it's your job to merge the positions again.
-   # 
-   # * *Args*    :
-   #   - +sessionId+ -> A String containing the sessionId of the User
-   #   - +variantId+ -> The Id of the Variant which should be added to the basket
-   #   - +amount+ -> The Amount of the Item which should be added to the basket
-   #   
-   # * *Returns* :
-   #   - Instance of AboutYou::SDK::Model::Basket
-   ###
+  ###
+  # Adds a single item into the basket.
+  # You can specify an amount. Please mind, that an amount > 1 will result
+  # in #amount basket positions.
+  # So if you read out the basket again later, it's your job to
+  # merge the positions again.
+  #
+  # * *Args*    :
+  #   - +sessionId+ -> A String containing the sessionId of the User
+  #   - +variantId+ -> Id of the Variant which should be added to the basket
+  #   - +amount+ -> The Amount of the Item which should be added to the basket
+  #
+  # * *Returns* :
+  #   - Instance of AboutYou::SDK::Model::Basket
+  ###
   def addItemToBasket(sessionId, variantId, amount = 1)
 
     basket = AboutYou::SDK::Model::Basket.new
@@ -471,7 +490,7 @@ class AY
 
    ###
    # Returns the URL to the Collins JavaScript file for helper functions
-   # to add product variants into the basket of Mary & Paul or auto-resizing
+   # to add product variants into the basket of AboutYou or auto-resizing
    # the Iframe. This URL may be changed in future, so please use this method instead
    # of hardcoding the URL into your HTML template.
    #  
@@ -520,9 +539,7 @@ class AY
    # Setter-Method for the api endpoint
    #  
    # * *Args*    :
-   #   - +apiEndPoint+ -> the endpoint can be the string 'stage' or 'live',
-   #                            then the default endpoints will be used or
-   #                            an absolute url
+   #   - +apiEndPoint+ -> the endpoint can be the string 'stage' or 'live', then the default endpoints will be used or an absolute url
    ###
   def apiEndpoint=(apiEndPoint)
 

data/lib/aboutyou-sdk/Client.rb

@@ -7,13 +7,20 @@ module AboutYou
     ###
     class Client
 
+      # url for staging-api-requests
       API_END_POINT_STAGE   = 'http://shop-api.staging.aboutyou.de/api'
+      # url for sandbox-api-requests
       API_END_POINT_SANDBOX = 'http://shop-api.sandbox.aboutyou.de/api'
+      # url for live-api-requests
       API_END_POINT_LIVE    = 'https://shop-api.aboutyou.de/api'
 
+      # the app id of the app which should be represented by an instance of AY
       attr_accessor :appId
+      # the authentifaction token from dev-center for the app id
       attr_accessor :appPassword
+      # the url used for api calls
       attr_accessor :apiEndPoint
+      # the page id of the current page visited by an user
       attr_accessor :pageId
 
       

data/lib/aboutyou-sdk/Constants.rb

@@ -6,43 +6,78 @@ module AboutYou
     # Author:: Collins GmbH & Co KG
     ###
     module Constants
-        SDK_VERSION = 0.1
-        FACET_BRAND = 0
-        FACET_COLOR = 1
-        FACET_SIZE = 2
-        FACET_GENDERAGE = 3
-        FACET_CUPSIZE = 4
-        FACET_LENGTH = 5
-        FACET_DIMENSION3 = 6
-        FACET_SIZE_CODE = 206
-        FACET_SIZE_RUN = 172
-        FACET_CLOTHING_UNISEX_INT = 173
-        FACET_CLOTHING_UNISEX_INCH = 174
-        FACET_SHOES_UNISEX_EUR = 194
-        FACET_CLOTHING_WOMEN_DE = 175
-        FACET_CLOTHING_UNISEX_ONESIZE = 204
-        FACET_SHOES_UNISEX_ADIDAS_EUR = 195
-        FACET_CLOTHING_WOMEN_BELTS_CM = 181
-        FACET_CLOTHING_WOMEN_INCH = 180
-        FACET_CLOTHING_MEN_BELTS_CM = 190
-        FACET_CLOTHING_MEN_INCH = 189
-        FACET_CLOTHING_MEN_DE = 187
-        FACET_CONDITION = 234
-        FACET_QUANTITY_PER_PACK = 263
-        FACET_SEASON_CODE = 289
+      
+      # Version of the SDK
+      SDK_VERSION = 0.1
+      # Group Id for Brands
+      FACET_BRAND = 0
+      # Group Id for Color
+      FACET_COLOR = 1
+      # Group Id for Size
+      FACET_SIZE = 2
+      # Group Id for Gender/Age
+      FACET_GENDERAGE = 3
+      # Group Id for Cupsize
+      FACET_CUPSIZE = 4
+      # Group Id for Length
+      FACET_LENGTH = 5
+      # Group Id for Dimensions
+      FACET_DIMENSION3 = 6
+      # Group Id for Size-Codes
+      FACET_SIZE_CODE = 206
+      # Group Id for Size_Run
+      FACET_SIZE_RUN = 172
+      # Group Id for Clothing_Unisex_Int
+      FACET_CLOTHING_UNISEX_INT = 173
+      # Group Id for Clothing_Unisex_Inch
+      FACET_CLOTHING_UNISEX_INCH = 174
+      # Group Id for Clothing_Unisex_Eur
+      FACET_SHOES_UNISEX_EUR = 194
+      # Group Id for Clothing_Women_DE
+      FACET_CLOTHING_WOMEN_DE = 175
+      # Group Id for Clothing_Unisex_Onesize
+      FACET_CLOTHING_UNISEX_ONESIZE = 204
+      # Group Id for Shoes_Unisex_Adidas_Eur
+      FACET_SHOES_UNISEX_ADIDAS_EUR = 195
+      # Group Id for Clothing_Women_Belts_Cm
+      FACET_CLOTHING_WOMEN_BELTS_CM = 181
+      # Group Id for Clothing_Women_Inch
+      FACET_CLOTHING_WOMEN_INCH = 180
+      # Group Id for Clothing_Men_Belts_Cm
+      FACET_CLOTHING_MEN_BELTS_CM = 190
+      # Group Id for Clothing_Men_Inch
+      FACET_CLOTHING_MEN_INCH = 189
+      # Group Id for Clothing_Men_De
+      FACET_CLOTHING_MEN_DE = 187
+      # Group Id for Condition
+      FACET_CONDITION = 234
+      # Group Id for Quantity_Per_Pack
+      FACET_QUANTITY_PER_PACK = 263
+      # Group Id for Season Code
+      FACET_SEASON_CODE = 289
+      
+      # Sort-argument passed to api for relevance
+      SORT_RELEVANCE = 'relevance'
+      # Sort-argument passed to api for last updated
+      SORT_UPDATED = 'updated_date'
+      # Sort-argument passed to api for creation date
+      SORT_CREATED = 'created_date'
+      # Sort-argument passed to api for most viewed
+      SORT_MOST_VIEWED = 'most_viewed'
+      # Sort-argument passed to api for price
+      SORT_PRICE = 'price'
 
-        SORT_RELEVANCE = 'relevance'
-        SORT_UPDATED = 'updated_date'
-        SORT_CREATED = 'created_date'
-        SORT_MOST_VIEWED = 'most_viewed'
-        SORT_PRICE = 'price'
+      # argument for api when requiring products
+      TYPE_PRODUCTS = 'products'
+      # argument for api when requiring categories
+      TYPE_CATEGORIES = 'categories'
 
-        TYPE_PRODUCTS = 'products'
-        TYPE_CATEGORIES = 'categories'
-
-        API_ENVIRONMENT_STAGE   = 'stage'
-        API_ENVIRONMENT_SANDBOX = 'sandbox'
-        API_ENVIRONMENT_LIVE    = 'live'
+      # environment-named for api-staging
+      API_ENVIRONMENT_STAGE   = 'stage'
+      # environment-named for api-sandbox
+      API_ENVIRONMENT_SANDBOX = 'sandbox'
+      # environment-named for api-live
+      API_ENVIRONMENT_LIVE    = 'live'
     end
   end
 end

data/lib/aboutyou-sdk/Criteria/ProductFields.rb

@@ -1,54 +1,101 @@
 module AboutYou
   module SDK
     module Criteria
+      ###
+      # This class is used for the selection of certain product fields
+      # which should be fetched in addition when making an api call
+      #
+      # author:: Collins GmbH & Co KG
+      ###
       class ProductFields
-         ###
-         # id and name is set per default
-         ###
-        IS_ACTIVE              = "active"
-        BRAND                  = "brand_id"
-        DESCRIPTION_LONG       = "description_long"
-        DESCRIPTION_SHORT      = "description_short"
-        DEFAULT_VARIANT        = "default_variant"
-        VARIANTS               = "variants"
-        MIN_PRICE              = "min_price"
-        MAX_PRICE              = "max_price"
-        IS_SALE                = "sale"
-        DEFAULT_IMAGE          = "default_image"
-        ATTRIBUTES_MERGED      = "attributes_merged"
-        CATEGORIES             = "categories"
-        INACTIVE_VARIANTS      = "inactive_variants"
-        MAX_SAVINGS            = "max_savings"
-        MAX_SAVINGS_PERCENTAGE = "max_savings_percentage"
-        tags                   = "tags"
+        # id and name is set per default
+        
+        #product field "is_active"
+        IS_ACTIVE              = 'active'
+        #product field "brand_id"
+        BRAND                  = 'brand_id'
+        #product field "description_long"
+        DESCRIPTION_LONG       = 'description_long'
+        #product field "description_short"
+        DESCRIPTION_SHORT      = 'description_short'
+        #product field "default_variant"
+        DEFAULT_VARIANT        = 'default_variant'
+        #product field "variants"
+        VARIANTS               = 'variants'
+        #product field "min_price"
+        MIN_PRICE              = 'min_price'
+        #product field "max_price"
+        MAX_PRICE              = 'max_price'
+        #product field "sale"
+        IS_SALE                = 'sale'
+        #product field "default_image"
+        DEFAULT_IMAGE          = 'default_image'
+        #product field "attributes_merged"
+        ATTRIBUTES_MERGED      = 'attributes_merged'
+        #product field "categories"
+        CATEGORIES             = 'categories'
+        #product field "inactive_variants"
+        INACTIVE_VARIANTS      = 'inactive_variants'
+        #product field "max_savings"
+        MAX_SAVINGS            = 'max_savings'
+        #product field "max_savings_percentage"
+        MAX_SAVINGS_PERCENTAGE = 'max_savings_percentage'
+        #product field "tags"
+        TAGS                   = 'tags'
 
+        ###
+        # filters a given set of fields
+        #
+        # * *Args*    :
+        #   - +fields+ -> an Array of product fields which should be filtered
+        #
+        # * *Returns* :
+        #   - a filtered Array of product fields
+        ###
         def self.filterFields(fields)
           fields = fields.uniq
 
           # this simplifies parsing on (pre)fetching facets
-          if (
-            fields.include? ATTRIBUTES_MERGED && (
+          if (fields.include? ATTRIBUTES_MERGED) && (
               fields.include?(BRAND)  ||
               fields.include?(VARIANTS) ||
               fields.include?(DEFAULT_VARIANT)
             )
-          )
             fields.push(ATTRIBUTES_MERGED)
           end
-
-          return fields;
+          fields
         end
-        
+
+        ###
+        # determines whether the api call has to require Facets or not
+        #
+        # * *Args*    :
+        #   - +fields+ -> an Array of product fields which should be filtered
+        #
+        # * *Returns* :
+        #   - a boolean which is true when ap call has to require facets
+        ###
         def self.requiresFacets(fields)
-          requiredFacetFields = [BRAND,VARIANTS,DEFAULT_VARIANT,ATTRIBUTES_MERGED] & fields
-          return (requiredFacetFields.count > 0);
+          ([BRAND,
+            VARIANTS,
+            DEFAULT_VARIANT,
+            ATTRIBUTES_MERGED
+           ] & fields).count > 0
         end
 
+        ###
+        # determines whether the api call has to require Categories or not
+        #
+        # * *Args*    :
+        #   - +fields+ -> an Array of product fields which should be filtered
+        #
+        # * *Returns* :
+        #   - a boolean which is true when ap call has to require categories
+        ###
         def self.requiresCategories(fields)
-
-          return fields.include?(CATEGORIES)
+          fields.include?(CATEGORIES)
         end
       end
     end
   end
-end
+end