aboutyou-sdk 0.0.1

data/lib/aboutyou-sdk/Client.rb

@@ -0,0 +1,125 @@
+module AboutYou
+  module SDK
+    class Client
+
+        API_END_POINT_STAGE   = 'http://shop-api.staging.aboutyou.de/api';
+        API_END_POINT_SANDBOX = 'http://shop-api.sandbox.aboutyou.de/api';
+        API_END_POINT_LIVE    = 'https://shop-api.aboutyou.de/api';
+
+         ###
+         # @param string $appId
+         # @param string $appPassword
+         # @param string $apiEndPoint
+         # @param LoggerInterface $logger
+         ###
+        def initialize(appId, appPassword, apiEndPoint = 'stage', logger = nil)
+
+            self.setAppCredentials(appId, appPassword);
+            self.setApiEndpoint(apiEndPoint);
+        end
+
+         ###
+         # @param string $appId        the app id for client authentication
+         # @param string $appPassword  the app password/token for client authentication.
+         ###
+        def setAppCredentials(appId, appPassword)
+
+            @appId = appId;
+            @appPassword = appPassword;
+        end
+
+         ###
+         # @return string
+         ###
+        def getApiEndPoint()
+
+            @apiEndPoint;
+        end
+
+         ###
+         # @param string $apiEndPoint the endpoint can be the string 'stage' or 'live',
+         #                            then the default endpoints will be used or
+         #                            an absolute url
+         ###
+        def setApiEndpoint(apiEndPoint)
+
+          case
+            when apiEndPoint=='stage'
+              @apiEndPoint = API_END_POINT_STAGE;
+            when apiEndPoint=='sandbox'
+              @apiEndPoint = API_END_POINT_SANDBOX;
+            when apiEndPoint=='live'
+              @apiEndPoint = API_END_POINT_LIVE;
+          else
+              @apiEndPoint = apiEndPoint;
+          end
+        end
+
+
+         ###
+         # @return string
+         ###
+        def getPageId()
+
+            @pageId;
+        end
+
+         ###
+         # @param string $pageId
+         ###
+        def setPageId(pageId)
+
+            @pageId = pageId;
+        end
+
+
+         ###
+         # Builds a JSON string representing the request data via Guzzle.
+         # Executes the API request.
+         #
+         # @param string $body the queries as json string
+         #
+         # @return \Guzzle\Http\Message\Response response object
+         #
+         # @throws ApiErrorException will be thrown if response was invalid
+         ###
+        def request(body)
+
+            if (@pageId)
+              request = { 
+              :body=>body,
+              :basic_auth => { :username => @appId , :password => @appPassword},
+              :headers => { 'Content-Type' => 'application/json',
+                            'Accept-Encoding' => 'gzip,deflate',
+                            'X-Page-ID'=> @pageId }
+            }
+            else
+              request = { 
+              :body=>body,
+              :basic_auth => { :username => @appId , :password => @appPassword},
+              :headers => { 'Content-Type' => 'application/json',
+                            'Accept-Encoding' => 'gzip,deflate'  }
+            }
+            end
+
+            response = HTTParty.post("https://shop-api.aboutyou.de/api",request)
+            begin 
+                if (!((response.code >= 200 && response.code < 300) || response.code == 304))
+                    raise response.code().to_s
+                end
+                begin 
+                    if (response.is_a? Array) 
+                        raise 'result is not array'
+                    end
+                rescue 
+                    raise
+                end
+            rescue
+                raise  
+            end
+
+            return JSON.parse(response.body)
+        end
+    end
+  end
+end

data/lib/aboutyou-sdk/Constants.rb

@@ -0,0 +1,48 @@
+ ###
+ # Contains often used properties related to the App development.
+ #
+ # @author Antevorte GmbH
+ ###
+module AboutYou
+  module SDK
+    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;
+
+        SORT_RELEVANCE = 'relevance';
+        SORT_UPDATED = 'updated_date';
+        SORT_CREATED = 'created_date';
+        SORT_MOST_VIEWED = 'most_viewed';
+        SORT_PRICE = 'price';
+
+        TYPE_PRODUCTS = 'products';
+        TYPE_CATEGORIES = 'categories';
+
+        API_ENVIRONMENT_STAGE   = 'stage';
+        API_ENVIRONMENT_SANDBOX = 'sandbox';
+        API_ENVIRONMENT_LIVE    = 'live';
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module AboutYou
+  module SDK
+    module Criteria
+      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"
+
+        def self.filterFields(fields)
+          fields = fields.uniq
+
+          # this simplifies parsing on (pre)fetching facets
+          if (
+            fields.include? ATTRIBUTES_MERGED && (
+              fields.include?(BRAND)  ||
+              fields.include?(VARIANTS) ||
+              fields.include?(DEFAULT_VARIANT)
+            )
+          )
+            fields.push(ATTRIBUTES_MERGED)
+          end
+
+          return fields;
+        end
+        
+        def self.requiresFacets(fields)
+          requiredFacetFields = [BRAND,VARIANTS,DEFAULT_VARIANT,ATTRIBUTES_MERGED] & fields
+          return (requiredFacetFields.count > 0);
+        end
+
+        def self.requiresCategories(fields)
+
+          return fields.include?(CATEGORIES)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,436 @@
+module AboutYou
+  module SDK
+    module Criteria
+      class ProductSearchCriteria
+          SORT_TYPE_RELEVANCE   = 'relevance';
+          SORT_TYPE_UPDATED     = 'updated_date';
+          SORT_TYPE_CREATED     = 'created_date';
+          SORT_TYPE_MOST_VIEWED = 'most_viewed';
+          SORT_TYPE_PRICE       = 'price';
+
+          SORT_ASC  = 'asc';
+          SORT_DESC = 'desc';
+
+          FACETS_ALL = '_all';
+          FACETS_UNLIMITED = -1;
+
+          FILTER_SALE          = 'sale';
+          FILTER_CATEGORY_IDS  = 'categories';
+          FILTER_PRICE         = 'prices';
+          FILTER_SEARCHWORD    = 'searchword';
+          FILTER_ATTRIBUTES    = 'facets';
+
+          attr_accessor :filter
+          attr_accessor :result
+          attr_accessor :sessionId
+
+           ###
+           # @param string $sessionId
+           ###
+          def initialize(sessionId)
+
+              self.filter    = Hash.new
+              self.sessionId = sessionId
+              self.result    = Hash.new
+          end
+
+
+           ###
+           # @param string $key
+           # @param string $value
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterBy(key, value)
+
+              self.filter[key] = value
+              return self
+          end
+
+           ###
+           # @param string $key
+           #
+           # @return null|mixed
+           ###
+          def getFilter(key)
+              if(self.filter[key])
+                return self.filter[key]
+              end
+
+              return nil
+          end
+
+           ###
+           # @param boolean|null $sale
+           #    true => only sale products
+           #    false => no sale products
+           #    null => both (default)
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterBySale(sale = true)
+
+            if !(sale.is_a?(TrueClass) || sale.is_a?(FalseClass)) 
+                  sale = nil;
+              end
+
+              return self.filterBy(FILTER_SALE, sale);
+          end
+
+           ###
+           # @return boolean|null
+           ###
+          def saleFilter()
+
+              return self.filter(FILTER_SALE);
+          end
+
+           ###
+           # @param string $searchword
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterBySearchword(searchword)
+
+              return self.filterBy(FILTER_SEARCHWORD, searchword);
+          end
+
+           ###
+           # @return string|null
+           ###
+          def searchwordFilter()
+
+              return self.filter(FILTER_SEARCHWORD);
+          end
+
+           ###
+           # @param integer[] $categoryIds  array of integer
+           # @param boolean $append         if true the category ids will added to current filter
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterByCategoryIds(categoryIds, append = false)
+
+            if (append && self.filter[FILTER_CATEGORY_IDS])
+              categoryIds = self.filter[FILTER_CATEGORY_IDS] + categoryIds
+            end
+              categoryIds = categoryIds.uniq
+
+              return self.filterBy(FILTER_CATEGORY_IDS, categoryIds);
+          end
+
+           ###
+           # @return integer[]|null
+           ###
+          def categoryFilter()
+
+              return self.filter(FILTER_CATEGORY_IDS)
+          end
+
+           ###
+           # @param array $attributes  array of array with group id and attribute ids
+           #   for example [0 => [264]]: search for products with the brand "TOM TAILER"
+           # @param boolean $append, if true the category ids will added to current filter
+           #
+           # @return ProductSearchFilter
+           ###
+          def filterByFacetIds(attributes, append = false)
+          
+            if (append && self.filter[FILTER_ATTRIBUTES])
+                  merged = self.filter[FILTER_ATTRIBUTES];
+                  attributes.each do |groupId, facetIds|
+                    if (merged.key?(groupId)) 
+                      merged[groupId] = (merged[groupId] + facetIds).uniq;
+                    else
+                      merged[groupId] = facetIds;
+                    end 
+                  end
+                  
+                  attributes = merged;
+            end
+              return self.filterBy(FILTER_ATTRIBUTES, attributes);
+          end
+
+           ###
+           # @return array|null
+           # @see filterByFacetIds()
+           ###
+          def facetFilter()
+
+              return self.filter(FILTER_ATTRIBUTES);
+          end
+
+           ###
+           # @param FacetGroup $facetGroup
+           # @param boolean $append, if true the category ids will added to current filter
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterByFacetGroup(facetGroup, append = false)
+
+              return self.filterByFacetIds(facetGroup.ids(), append);
+          end
+
+           ###
+           # @param FacetGroupSet $facetGroupSet
+           # @param boolean $append, if true the category ids will added to current filter
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterByFacetGroupSet(facetGroupSet, append = false)
+
+              return self.filterByFacetIds(facetGroupSet.ids(), append);
+          end
+
+           ###
+           # @param integer $from  must be 1 or greater
+           # @param integer $to    must be 1 or greater
+           #
+           # @return ProductSearchCriteria
+           ###
+          def filterByPriceRange(from = 0, to = 0)
+
+            from = Integer(from)
+              to = Integer(to)
+
+              price = Hash.new;
+              if (from > 0) 
+                  price["from"] = from
+              end
+              if (to > 0) 
+                  price["to"] = to
+              end
+
+              return self.filterBy(FILTER_PRICE, price);
+          end
+
+           ###
+           # Returns an associative array with could contains "to" and/or "from", eg.
+           # ["from" => 100, "to" => 10000] or ["to" => 20000]
+           #
+           # @return array|null
+           ###
+          def priceRangeFilter()
+
+              return self.filter(FILTER_PRICE);
+          end
+
+           ###
+           # @param string $type
+           # @param string $direction
+           #
+           # @return $this
+           ###
+          def sortBy(type, direction = SORT_ASC)
+
+              self.result['sort'] = Hash[
+                  'by'        => type,
+                  'direction' => direction,
+              ]
+
+              return self;
+          end
+
+           ###
+           # @param integer $limit
+           # @param integer $offset
+           #
+           # @return $this
+           ##
+          def setLimit(limit, offset = 0)
+
+              limit = [[limit, 200].min, 0].max
+              self.result['limit'] = limit
+
+              offset = [offset, 0].max;
+              self.result['offset']
+
+              return self;
+          end
+
+           ###
+           # @param bool $enable
+           #
+           # @return $this
+           ###
+          def selectSales(enable = true)
+
+              if (enable) 
+                  self.result['sale'] = true
+              else 
+                  self.result['sale'] = nil
+              end
+
+              return self;
+          end
+
+           ###
+           # @param bool $enable
+           #
+           # @return $this
+           ###
+          def selectPriceRanges(enable = true)
+
+              if (enable) 
+                  self.result['price'] = true
+              else 
+                  self.result['price'] = nil
+              end
+
+              return self;
+          end
+
+           ###
+           # @param integer|string $groupId
+           # @param integer $limit
+           #
+           # @return $this
+           #
+           # @throws \InvalidArgumentException
+           ###
+          def selectFacetsByGroupId(groupId, limit)
+
+              self.checkFacetLimit(limit);
+              if (!(groupId.is_a? Fixnum) && (Integer(groupId)).nil?)
+                  raise InvalidArgumentException();
+              end
+
+              if (!self.result['facets']) 
+                  self.result['facets'] = Hash.new
+              end
+
+              if !(self.result['facets'][groupId]) 
+                  self.result['facets'][String(groupId)] = Hash['limit' => limit];
+              end
+              return self;
+          end
+
+           ###
+           # @param FacetGetGroupInterface $group
+           # @param integer $limit
+           #
+           # @return $this
+           ###
+          def selectFacetsByFacetGroup(group, limit)
+
+              return self.selectFacetsByGroupId(group.getGroupId(), limit);
+          end
+
+           ###
+           # @param integer $limit
+           #
+           # @return $this
+           ###
+          def selectAllFacets(limit)
+
+              self.checkFacetLimit(limit);
+              self.result['facets'] = Hash[self::FACETS_ALL => Hash['limit' => limit]];
+
+              return self;
+          end
+
+          def checkFacetLimit(limit)
+
+              if !((limit.is_a? Fixnum) || (limit.is_a? Integer)) 
+                  raise  InvalidArgumentException('limit must be an integer');
+              end
+              if (limit < -1) 
+                  raise InvalidArgumentException('limit must be positive or -1 for unlimited facets');
+              end
+          end
+
+           ###
+           # @param bool $enable
+           #
+           # @return $this
+           ###
+          def selectCategories(enable = true)
+
+              if (enable) 
+                  self.result['categories'] = true;
+              else 
+                  self.result['categories'] = nil;
+              end
+
+              return self;
+          end
+
+           ###
+           # @param integer|Product[] $ids
+           #
+           # @return $this
+           ###
+          def boostProducts(ids)
+
+              ids = ids.map{
+                |val|
+                if val.instance_of? Product
+                  return val.getId()
+                end 
+                return Integer(val)
+                }
+              ids = ids.uniq;
+              self.result['boosts'] = ids;
+
+              return self;
+          end
+
+           ###
+           # @param string[] $fields
+           #
+           # @return $this
+           ###
+          def selectProductFields(fields)
+
+            self.result['fields'] = AboutYou::SDK::Criteria::ProductFields.filterFields(fields);
+
+              return self;
+          end
+
+           ###
+           # @param string $sessionId
+           #
+           # @return $this
+           #
+          def setSessionId(sessionId)
+
+              self.sessionId = sessionId;
+
+              return self;
+          end
+          
+          def requiresCategories()
+
+            productCategories = (self.result.has_key?('fields') && AboutYou::SDK::Criteria::ProductFields.requiresCategories(self.result['fields']))
+            categoryFacets = (self.result.has_key?('categories') && self.result['categories'])
+
+            return (productCategories || categoryFacets)
+          end
+
+          def requiresFacets()
+            
+            productFacets = (self.result.key?('fields') && AboutYou::SDK::Criteria::ProductFields.requiresFacets(self.result['fields']))
+            facetFacets = (self.result.key?('facets') && !self.result['facets'].empty?)
+            return (productFacets || facetFacets)
+          end
+
+           ###
+           # @return array
+           ###
+          def toArray()
+
+            params = Hash['session_id' => self.sessionId]
+
+            if !(self.result.empty?) 
+                params['result'] = self.result;
+            end
+            if (self.filter) 
+                params['filter'] = self.filter;
+            end
+
+            return params;
+          end
+      end
+    end
+  end
+end