aboutyou-sdk 0.0.24 → 0.0.25

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

@@ -1,102 +0,0 @@
-module AboutYou
-  module SDK
-    module Model
-      class VariantsResult
-      
-          # @var Variant[] */
-          attr_accessor :variants
-          # @var array */
-          attr_accessor :errors
-          
-           ###
-           # 
-           # @param \stdClass $jsonObject
-           # @param \Collins\ShopApi\Model\ModelFactoryInterface $factory
-           # @param \Collins\ShopApi\Model\ProductSearchResult $productSearchResult
-           # 
-           # @return static
-           ###
-          def self.create(variants, errors = Array(nil), productSearchResult)
-    
-              variantsResult = self.new   
-              variantsResult.variants = Hash.new
-              variantsResult.errors = errors;
-
-              if (productSearchResult == false || variants.count == 0) 
-                  # no variant was found
-                  return variantsResult;
-              end
-
-              # get products from product-search
-              products = productSearchResult.products();
-              variants.each do |variantId, productId|
-                  if !(products[productId])
-                      # product was not delivered                
-                      variantsResult.errors.push(variantId)
-                      next
-                  end
-
-                  product = products[productId];
-                  variant = product.variantById(variantId);
-
-                  if (variant.is_a? AboutYou::SDK::Model::Variant) 
-                      variantsResult.variants[variantId] = variant;                
-                  end
-              end    
-
-              return variantsResult;
-          end
-
-           ###
-           # @return bool
-           ###
-          def hasVariantsFound()
-          
-              self.variants.count > 0;
-          end
-
-           ###
-           # @return bool
-           ###
-          def hasVariantsNotFound()
-          
-              self.errors.count > 0;
-          end
-
-           ###
-           # @return Variant[]
-           ###
-          def variantsFound()
-          
-              self.variants;
-          end
-          
-
-           ###
-           # @param int $id
-           #
-           #
-           # @return Variant|null
-           ###
-          def variantById(id)
-          
-              result = nil;
-
-              if (self.variants[id]) 
-                  result = self.variants[id];
-              end
-
-              return result;
-          end
-
-           ###
-           # @return int[]
-           ###
-          def variantsNotFound()
-          
-              self.errors;
-          end
-      end
-    end
-  end
-end

data/lib/aboutyou-sdk/Query.rb

@@ -1,350 +0,0 @@
-require_relative 'QueryBuilder.rb'
-
-module AboutYou
-  module SDK
-     ###
-     # The Query class coordinates the building, executing and parsing of one or multiple API-calls
-     #
-     # Author:: Collins GmbH & Co KG
-     ###
-    class Query
-      # QueryBuilder is a helper class containing most of the logix behind
-      # building the api-request
-      include AboutYou::SDK::QueryBuilder
-      
-      # used for checking whether a query contains a category-request or not
-      QUERY_TREE   = 'category_tree'
-      # used for checking whether a query contains a facets-request or not
-      QUERY_FACETS = 'facets'
-
-      # The Api-Client which performs the Api-Calls
-      attr_accessor :client
-      # the query built by the app itself
-      attr_accessor :query
-      # a Hash containing the mapping for
-      # api_call_name => method_name_in_model_factory
-      attr_accessor :mapping
-      # the model factory which builds the models from the api-response
-      attr_accessor :factory
-      # a helper-query used for fetching categories and/or facets if needed
-      attr_accessor :ghostQuery
-      # the actual query send to the api containing query and ghost-query
-      attr_accessor :allQuery
-
-
-       ###
-       # the Constructor for the Query class
-       #
-       # * *Args*    :
-       #   - +client+ -> an instance of AboutYou::SDK::Client
-       #   - +factory+ -> an instance of AboutYou::SDK::Factory::DefaultModelFactory
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###      
-      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
-
-       ###
-       # wrapper-method for fetchAutocomplete which coordinates Category- and Facet-Manager
-       #
-       # * *Args*    :
-       #   - +searchword+ -> a String containing the word to search completitions for
-       #   - +limit+ -> Maximum number of results [optional]
-       #   - +types+ -> Array of types to search for [optional]
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchAutocomplete(searchword, limit = nil, types = nil)
-
-        super(searchword, limit, types)
-
-        self.requireCategoryTree
-        self.requireFacets
-
-        return self
-      end
-
-       ###
-       # wrapper-method for fetchBasket which coordinates Category- and Facet-Manager
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchBasket(sessionId)
-
-        super(sessionId)
-
-        self.requireCategoryTree
-        self.requireFacets
-
-        return self
-      end
-      
-      def fetchFacets(groupIds=[])
-        super(groupIds)
-      end
-
-       ###
-       # wrapper-method for fetchProductsByIds which coordinates Category- and Facet-Manager
-       #
-       # * *Args*    :
-       #   - +ids+ -> Either a single id or an Array of ids which should be fetched
-       #   - +fields+ -> Additional product fields which should be fetched for each product [optional]
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      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
-        return self
-      end
-
-       ###
-       # wrapper-method for fetchProductsByEans which coordinates Category- and Facet-Manager
-       #
-       # * *Args*    :
-       #   - +eans+ -> Either a single ean or an Array of eans which should be fetched
-       #   - +fields+ -> Additional product fields which should be fetched for each product [optional]
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchProductsByEans(eans,fields = [])
-        
-        super(eans, fields)
-
-        if AboutYou::SDK::Criteria::ProductFields.requiresCategories(fields)
-            self.requireCategoryTree
-        end
-        if AboutYou::SDK::Criteria::ProductFields.requiresFacets(fields)
-            self.requireFacets
-        end
-
-        return self
-      end
-
-       ###
-       # wrapper-method for fetchProductSearch which coordinates Category- and Facet-Manager
-       #
-       # * *Args*    :
-       #   - +criteria+ -> Hash containing one or multiple search terms
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchProductSearch(criteria)
-
-        super(criteria)
-        
-        if criteria.requiresCategories
-            self.requireCategoryTree
-        end
-        if criteria.requiresFacets
-            self.requireFacets
-        end
-
-        return self
-      end
-      
-
-       ###
-       # this method checks whether it is neccessary for the query to get the category-tree from the api
-       #
-       # * *Args*    :
-       #   - +fetchForced+ -> determines whether the requirance of the category tree is forced
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###      
-      def requireCategoryTree(fetchForced = false)
-        unless fetchForced || self.factory.categoryManager.isEmpty
-            return self
-        end
-
-        self.ghostQuery.push({QUERY_TREE => {
-            'category_tree' => {
-              'version' => '2'
-        }}})
-
-         return self
-      end
-
-      
-       ###
-       # this method checks whether it is neccessary for the query to get the facets from the api
-       #
-       # * *Args*    :
-       #   - +fetchForced+ -> determines whether the requirance of the facets is forced
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###          
-      def requireFacets(fetchForced = false)
-        unless fetchForced || self.factory.facetManager.isEmpty
-            return self
-        end
-        self.ghostQuery.push({QUERY_FACETS => {
-            'facets' => {}
-        }})
-
-        return self
-      end
-
-       ###
-       # the methods builds the complete query string which represents the body of the api call
-       #   
-       # * *Returns* :
-       #   - JSON-String containing all queries which need to be executed
-       ###    
-      def queryString
-        result = []
-        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
-      end
-
-
-       ###
-       # requests all of the queries and returns the parsed api-response
-       #   
-       # * *Returns* :
-       #   - an Array containing all of the models build with the data of the api 
-       ###    
-      def execute
-        if self.query.empty? && self.ghostQuery.empty? 
-          return []
-        end
-        parseResult(self.client.request(queryString), self.query.count > 1)
-      end
-
-       ###
-       # requests all of the queries and returns only the first parsed api-response
-       #   
-       # * *Returns* :
-       #   - the first model build with the data of the api 
-       ###
-      def executeSingle
-
-        execute[-1]
-      end
-
-      
-       ###
-       # this method checks whether the api delievered a valid json-response or not
-       # 
-       # * *Args*    :
-       #   - +jsonResponse+ -> the plain json received from the api
-       ###      
-      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
-      
-      
-       ###
-       # parses the plain json result from the api and calls the respective modelfactory methods 
-       # for building the models for the json resposne
-       # 
-       # * *Args*    :
-       #   - +jsonResponse+ -> the plain json received from the api
-       #   - +isMultiRequest+ -> boolean which determines whether the request has more then one
-       #                         query or not [optional]
-       #   
-       # * *Returns* :
-       #   - an Array containing all models build from the modelfactory 
-       ###     
-      def parseResult(jsonResponse, isMultiRequest=true)
-
-        self.checkResponse(jsonResponse)
-        results = []
-        queryIds = []
-        
-        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
-          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
-        end
-    end
-  end
-end