aboutyou-sdk 0.0.7 → 0.0.8

data/lib/aboutyou-sdk/Client.rb

@@ -2,124 +2,99 @@ 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;
+      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'
+
+      attr_accessor :appId
+      attr_accessor :appPassword
+      attr_accessor :apiEndPoint
+      attr_accessor :pageId
+
+      def initialize(appId, appPassword, apiEndPoint = 'stage', logger = nil)
+
+        self.appId = appId
+        self.appPassword = appPassword
+      end
+
+
+       ###
+       # @param appId        the app id for client authentication
+       # @param appPassword  the app password/token for client authentication.
+       ###
+      def appCredentials=(appId, appPassword)
+
+        self.appId= appId
+        self.appPassword= appPassword
+      end
+
+
+       ###
+       # @param apiEndPoint the endpoint can be the string 'stage' or 'live',
+       #                    then the default endpoints will be used or
+       #                    an absolute url
+       ###
+      def apiEndpoint=(apiEndPoint)
+
+        case
+          when apiEndPoint=='stage'
+            self.apiEndPoint = API_END_POINT_STAGE
+          when apiEndPoint=='sandbox'
+            self.apiEndPoint = API_END_POINT_SANDBOX
+          when apiEndPoint=='live'
+            self.apiEndPoint = API_END_POINT_LIVE
+        else
+          self.apiEndPoint = apiEndPoint
         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 }
+      end
+
+
+       ###
+       # Builds a JSON string representing the request data via Guzzle.
+       # Executes the API request.
+       #
+       # @param body the queries as json string
+       ###
+      def request(body)
+
+        if self.pageId
+          request = { 
+            :body=>body,
+            :basic_auth => {
+              :username => self.appId,
+              :password => self.appPassword
+            },
+            :headers => {
+              'Content-Type' => 'application/json',
+              'Accept-Encoding' => 'gzip,deflate',
+              'X-Page-ID'=> self.pageId
             }
-            else
-              request = { 
+          }
+        else
+            request = { 
               :body=>body,
-              :basic_auth => { :username => @appId , :password => @appPassword},
-              :headers => { 'Content-Type' => 'application/json',
-                            'Accept-Encoding' => 'gzip,deflate'  }
+              :basic_auth => {
+                :username => self.appId,
+                :password => self.appPassword
+              },
+              :headers => {
+                'Content-Type' => 'application/json',
+                'Accept-Encoding' => 'gzip,deflate'
+              }
             }
-            end
+        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  
+        response = HTTParty.post("https://shop-api.aboutyou.de/api", request)
+        
+        unless response.code >= 200 && response.code < 300 || response.code == 304
+            raise String(response.code)
+            unless response.is_a? Array
+              raise 'result is not array'
             end
-
-            return JSON.parse(response.body)
         end
+
+        JSON.parse(response.body)
+      end
     end
   end
 end

data/lib/aboutyou-sdk/Constants.rb

@@ -6,43 +6,43 @@
 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;
+        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';
+        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';
+        TYPE_PRODUCTS = 'products'
+        TYPE_CATEGORIES = 'categories'
 
-        API_ENVIRONMENT_STAGE   = 'stage';
-        API_ENVIRONMENT_SANDBOX = 'sandbox';
-        API_ENVIRONMENT_LIVE    = 'live';
+        API_ENVIRONMENT_STAGE   = 'stage'
+        API_ENVIRONMENT_SANDBOX = 'sandbox'
+        API_ENVIRONMENT_LIVE    = 'live'
     end
   end
 end

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

@@ -243,7 +243,7 @@ module AboutYou
               self.result['limit'] = limit
 
               offset = [offset, 0].max;
-              self.result['offset']
+              self.result['offset'] = offset
 
               return self;
           end

data/lib/aboutyou-sdk/Query.rb

@@ -1,261 +1,262 @@
-  require_relative 'QueryBuilder.rb'
+require_relative 'QueryBuilder.rb'
+
 module AboutYou
   module SDK
     class Query
       include AboutYou::SDK::QueryBuilder
       
-        QUERY_TREE   = 'category_tree';
-        QUERY_FACETS = 'facets';
-
-        attr_accessor :client
-        attr_accessor :query
-        attr_accessor :mapping
-        attr_accessor :factory
-        attr_accessor :ghostQuery
-        attr_accessor :allQuery
-        
+      QUERY_TREE   = 'category_tree'
+      QUERY_FACETS = 'facets'
 
-         ###
-         # @param ShopApiClient $client
-         # @param ModelFactoryInterface $factory
-         # @param EventDispatcher $eventDispatcher
-         ###
-        def initialize(client, factory)
-            self.client = client
-            self.query=Array(nil)
-            self.ghostQuery = Array(nil)
-            self.allQuery = Array(nil)
-            self.factory=factory
-            self.mapping = Hash[
-            'autocompletion' => 'createAutocomplete',
-            'basket'         => 'createBasket',
-            'category'       => 'createCategoriesResult',
-            'category_tree'  => 'createCategoryTree',
-            'facets'         => 'createFacetsList',
-            'facet'          => 'createFacetList',
-            'facet_types'    => 'createFacetTypes',
-            'products'       => 'createProductsResult',
-            'products_eans'  => 'createProductsEansResult',
-            'product_search' => 'createProductSearchResult',
-            'suggest'        => 'createSuggest',
-            'get_order'      => 'createOrder',
-            'initiate_order' => 'initiateOrder',
-            'child_apps'     => 'createChildApps',
-            'live_variant'   => 'createVariantsResult'
-            ]
-        end
-        
-         ###
-         # @param string $searchword The prefix search word to search for.
-         # @param int    $limit      Maximum number of results.
-         # @param array  $types      Array of types to search for (Constants::TYPE_...).
-         #
-         # @return $this
-         #
-         # @throws \InvalidArgumentException
-         ###
-        def fetchAutocomplete(searchword,limit = nil,types = nil)
-          
-          super(searchword, limit, types);
+      attr_accessor :client
+      attr_accessor :query
+      attr_accessor :mapping
+      attr_accessor :factory
+      attr_accessor :ghostQuery
+      attr_accessor :allQuery
 
-          self.requireCategoryTree;
-          self.requireFacets;
 
-          return self
-        end
+      def initialize(client, factory)
+        self.client = client
+        self.query= []
+        self.ghostQuery = []
+        self.allQuery = []
+        self.factory=factory
+        self.mapping = {
+          'autocompletion' => 'createAutocomplete',
+          'basket'         => 'createBasket',
+          'category'       => 'createCategoriesResult',
+          'category_tree'  => 'createCategoryTree',
+          'facets'         => 'createFacetsList',
+          'facet'          => 'createFacetList',
+          'facet_types'    => 'createFacetTypes',
+          'products'       => 'createProductsResult',
+          'products_eans'  => 'createProductsEansResult',
+          'product_search' => 'createProductSearchResult',
+          'suggest'        => 'createSuggest',
+          'get_order'      => 'createOrder',
+          'initiate_order' => 'initiateOrder',
+          'child_apps'     => 'createChildApps',
+          'live_variant'   => 'createVariantsResult'
+        }
+      end
 
-         ###
-         # @param string $sessionId Free to choose ID of the current website visitor.
-         #
-         # @return $this
-         ###
-        def fetchBasket(sessionId)
-       
-          super(sessionId);
+       ###
+       # @param string $searchword The prefix search word to search for.
+       # @param int    $limit      Maximum number of results.
+       # @param array  $types      Array of types to search for (Constants::TYPE_...).
+       #
+       # @return $this
+       #
+       # @throws \InvalidArgumentException
+       ###
+      def fetchAutocomplete(searchword, limit = nil, types = nil)
 
-          self.requireCategoryTree;
-          self.requireFacets;
+        super(searchword, limit, types)
 
-          return self
-        end
+        self.requireCategoryTree
+        self.requireFacets
 
-         ###
-         # @param string[]|int[] $ids
-         # @param array $fields
-         #
-         # @return $this
-         ###
-        def fetchProductsByIds(ids,fields = Array(nil))
-          super(ids, fields);
-          if (AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields)) 
-              self.requireCategoryTree();
-          end
-          if (AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields)) 
-              self.requireFacets();
-          end
+        return self
+      end
 
-          return self;
-        end
+       ###
+       # @param string $sessionId Free to choose ID of the current website visitor.
+       #
+       # @return $this
+       ###
+      def fetchBasket(sessionId)
 
-         ###
-         # @param string[] $eans
-         # @param array $fields
-         #
-         # @return $this
-         ###
-        def fetchProductsByEans(eans,fields = Array(nil))
-          super(eans, fields);
-
-          if (AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields)) 
-              self.requireCategoryTree();
-          end
-          if (AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields)) 
-              self.requireFacets();
-          end
+        super(sessionId)
 
-          return self;
+        self.requireCategoryTree
+        self.requireFacets
+
+        return self
+      end
+
+       ###
+       # @param string[]|int[] $ids
+       # @param array $fields
+       #
+       # @return $this
+       ###
+      def fetchProductsByIds(ids,fields = [])
+        
+        super(ids, fields)
+        
+        if AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields) 
+            self.requireCategoryTree
+        end
+        if AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields) 
+            self.requireFacets
         end
 
-         ###
-         # @param ProductSearchCriteria $criteria
-         #
-         # @return $this
-         ###
-        def fetchProductSearch(criteria)
+        return self
+      end
 
-          super(criteria);
-          if (criteria.requiresCategories()) 
-              self.requireCategoryTree();
-          end
-          if (criteria.requiresFacets()) 
-              self.requireFacets();
-          end
+       ###
+       # @param string[] $eans
+       # @param array $fields
+       #
+       # @return $this
+       ###
+      def fetchProductsByEans(eans,fields = [])
+        
+        super(eans, fields)
 
-          return self
+        if AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields)
+            self.requireCategoryTree
+        end
+        if AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields)
+            self.requireFacets
         end
 
-        def requireCategoryTree(fetchForced = false)
-          if !(fetchForced || self.factory.categoryManager().isEmpty())
-              return self
-          end
+        return self
+      end
 
-          self.ghostQuery.push(Hash[QUERY_TREE => Hash[
-              'category_tree' => Hash['version' => '2']]])
+       ###
+       # @param ProductSearchCriteria $criteria
+       #
+       # @return $this
+       ###
+      def fetchProductSearch(criteria)
 
-           return self
+        super(criteria)
+        
+        if criteria.requiresCategories
+            self.requireCategoryTree
+        end
+        if criteria.requiresFacets
+            self.requireFacets
         end
 
-        def requireFacets(fetchForced = false)
-          if !(fetchForced || self.factory.facetManager.isEmpty) 
-              return self;
-          end
-          self.ghostQuery.push(Hash[QUERY_FACETS => Hash[
-              'facets' => Hash.new]])
+        return self
+      end
 
-          return self;
-        end
+      def requireCategoryTree(fetchForced = false)
         
-         ###
-         # @return string
-         ###
-        def queryString()
-            result = Array(nil)
-            self.ghostQuery.each do |ghostQuery|
-              (ghostQuery.is_a? Hash) ? result.push(ghostQuery[ghostQuery.keys[0]]) : nil 
-            end
-            self.allQuery = result + self.query
-            return (result + self.query).to_json
+        unless fetchForced || self.factory.categoryManager.isEmpty
+            return self
         end
 
+        self.ghostQuery.push({QUERY_TREE => {
+            'category_tree' => {
+              'version' => '2'
+        }}})
 
-         ###
-         # request the queries and returns an array of the results
-         #
-         # @return array
-         ###
-        def execute()
-          
-            if (self.query.empty? && self.ghostQuery.empty?) 
-                return Array(nil);
-            end
-            queryString = queryString()
-            result = self.client.request(queryString);
-            parseResult(result, self.query.count > 1)
+         return self
+      end
+
+      def requireFacets(fetchForced = false)
+        unless fetchForced || self.factory.facetManager.isEmpty
+            return self
         end
+        self.ghostQuery.push({QUERY_FACETS => {
+            'facets' => {}
+        }})
 
-         ###
-         # request the current query and returns the first result
-         #
-         # @return mixed
-         ###
-        def executeSingle()
+        return self
+      end
 
-            result = execute();
-            result[-1]
+       ###
+       # @return string
+       ###
+      def queryString
+        result = []
+        self.ghostQuery.each do |ghostQuery|
+          (ghostQuery.is_a? Hash) ? result.push(ghostQuery[ghostQuery.keys[0]]) : nil 
         end
-        
-        def checkResponse(jsonResponse)
-        
-            if (jsonResponse == false || !(jsonResponse.is_a? Array) || jsonResponse.count != self.allQuery.count)
-            
-                raise 'UnexpectedResultException!'
-            end
+        self.allQuery = result + self.query
+        return (result + self.query).to_json
+      end
 
- 
-            jsonResponse.each_with_index do |responseObject, index|
-                currentQuery = self.allQuery[index];
-                responseKey  = jsonResponse[index].keys[0];
-                queryKey     = currentQuery.keys[0];
-                if (responseKey != queryKey) 
-                    raise 'UnexpectedResultException!
-                        result ' + String(queryKey) + ' expected, but ' + String(responseKey) + ' given on position ' + String(index) +
-                        ' - query: ' + currentQuery.to_json
-                end
-                
-                if !(self.mapping.has_key?(responseKey)) 
-                    raise 'UnexpectedResultException! internal error, ' + String(responseKey) + ' is unknown result'
-                end
-            end
+
+       ###
+       # request the queries and returns an array of the results
+       #
+       # @return array
+       ###
+      def execute
+
+        if self.query.empty? && self.ghostQuery.empty? 
+          return []
+        end
+        parseResult(self.client.request(queryString), self.query.count > 1)
+      end
+
+       ###
+       # request the current query and returns the first result
+       #
+       # @return mixed
+       ###
+      def executeSingle
+
+        execute[-1]
+      end
+
+      def checkResponse(jsonResponse)
+
+        if jsonResponse == false || !(jsonResponse.is_a? Array) || jsonResponse.count != self.allQuery.count
+          raise 'UnexpectedResultException!'
+        end
+
+        (0..jsonResponse.count-1).each do |index|
+          currentQuery = self.allQuery[index]
+          responseKey  = jsonResponse[index].keys[0]
+          queryKey     = currentQuery.keys[0]
+
+          if responseKey != queryKey
+            raise 'UnexpectedResultException! result ' + String(queryKey) + ' expected,
+              but ' + String(responseKey) + ' given on position ' + String(index) +
+              ' - query: ' + currentQuery.to_json
+          end
+
+          unless self.mapping.key? responseKey
+            raise 'UnexpectedResultException! internal error, ' + String(responseKey) + ' is unknown result'
+          end
         end
+      end
+
+      def parseResult(jsonResponse, isMultiRequest=true)
+
+        self.checkResponse(jsonResponse)
+        results = []
+        queryIds = []
         
-        def parseResult(jsonResponse, isMultiRequest=true)
-         
-            self.checkResponse(jsonResponse)
-            results = Array(nil)
-            queryIds = Array(nil)
-            self.allQuery.each do |query|
-              queryIds.push(query.keys[0])
+        self.allQuery.each do |query|
+          queryIds.push(query.keys[0])
+        end
+
+        jsonResponse.each_with_index do |responseObject, index|
+          currentQuery   = self.allQuery[index]
+          resultKey      = responseObject.keys[0]
+          jsonObject     = responseObject[resultKey]
+          queryKey       = currentQuery.keys[0]
+          factory        = self.factory
+          
+          if (jsonObject.is_a? Hash) && jsonObject['error_code']
+            result = factory.preHandleError(jsonObject, resultKey, isMultiRequest)
+            if result != false
+              results.push({resultKey=> result})
+              next
             end
+          end
             
-            jsonResponse.each_with_index do |responseObject, index|
-                currentQuery   = self.allQuery[index]
-                resultKey      = responseObject.keys[0]
-                jsonObject     = responseObject[resultKey]
-                queryKey       = currentQuery.keys[0]
-                factory        = self.factory
-                if !(queryKey == "facet_types" || queryKey == "suggest" || queryKey == "facet")
-                  if (jsonObject['error_code'])
-                    result = factory.preHandleError(jsonObject, resultKey, isMultiRequest);
-                    if (result != false) 
-                        results.push(Hash[resultKey=> result])
-                        next
-                    end
-                  end
-                end
-                query   = currentQuery[queryKey];
-                queryId = queryIds[index];
-                if (queryId == QUERY_FACETS)
-                  factory.updateFacetManager(jsonObject, query);
-                elsif (queryId == QUERY_TREE) 
-                  factory.initializeCategoryManager(jsonObject);
-                else 
-                  method  = self.mapping[resultKey];
-                  result = factory.send(method, jsonObject, query)
-                  results.push(result)
-                end
-            end
+          query   = currentQuery[queryKey]
+          queryId = queryIds[index]
+          if queryId == QUERY_FACETS
+            factory.updateFacetManager(jsonObject, query)
+          elsif queryId == QUERY_TREE
+            factory.initializeCategoryManager(jsonObject)
+          else 
+            method = self.mapping[resultKey]
+            result = factory.send(method, jsonObject, query)
+            results.push(result)
+          end
+        end
 
-            return results;
+        return results
         end
     end
   end