aboutyou-sdk 0.0.24 → 0.0.25

data/lib/aboutyou-sdk/QueryBuilder.rb

@@ -1,499 +0,0 @@
-module AboutYou
-  module SDK
-    ###
-    # the QueryBuilder is a module supporting the query with mroe complex logic
-    # concerning the building of the queries for the api-call
-    #
-    # Author:: Collins GmbH & Co KG
-    ###
-    module QueryBuilder
-
-       ###
-       # builds the autocompletion-query
-       #
-       # * *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)
-
-        unless searchword.is_a? String
-          raise 'InvalidArgumentException! searchword must be a string'
-        end
-
-        # downcase is a workaround of ticket SAPI-532
-        options = {'searchword' => searchword.downcase}
-
-        if limit != nil
-          if !(limit.is_a? Integer) && !limit[/\d/] 
-            raise 'InvalidArgumentException! limit must be an integer'
-          end
-          options['limit'] = Integer(limit)
-        end
-
-        unless types.empty? 
-          options['types'] = types
-        end
-
-        self.query.push({'autocompletion' => options})
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchBasket(sessionId)
-
-        checkSessionId(sessionId)
-
-        self.query.push({'basket' => {'session_id' => sessionId}})
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   - +items+ -> an Array containing all of the items which should be added
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def addItemsToBasket(sessionId, items)
-
-        checkSessionId(sessionId)
-        
-        orderLines = []
-
-        items.each do |item|
-          orderLine = {
-            'id' => item.id,
-            'variant_id' => item.variantId
-          }
-
-          if item.additionalData
-            orderLine['additional_data'] = item.additionalData
-          end
-
-          orderLines.push(orderLine)
-        end
-
-        self.query.push({'basket' => {
-          'session_id' => sessionId,
-          'order_lines' => orderLines
-        }})
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   - +itemSets+ -> an instance of AboutYou::SDK::Model::BasketSet
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def addItemSetsToBasket(sessionId, itemSets)
-
-        checkSessionId(sessionId)
-
-        orderLines = []
-
-        itemSets.each do |itemSet|
-          orderLine = {
-            'id' => itemSet.id,
-            'set_items' => []
-          }
-
-          if itemSet.additionalData
-            orderLine['additional_data'] = itemSet.additionalData
-          end
-
-          itemSet.items.each do |item|
-            entry = {'variant_id' => item.variantId}
-            if item.additionalData
-              entry['additional_data'] = item.additionalData
-            end
-            orderLine['set_items'].push(entry)
-          end
-
-          orderLines.push(orderLine)
-        end
-
-        self.query.push({'basket' => {
-          'session_id' => sessionId,
-          'order_lines' => orderLines
-        }})
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   - +productVariantId+ -> ID of product variant
-       #   - +basketItemId+ -> ID of single item or set in the basket
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def addToBasket(sessionId, productVariantId, basketItemId)
-
-        checkSessionId(sessionId)
-
-        self.query.push({'basket' => {
-          'session_id' => sessionId,
-          'order_lines' => [{
-            'id' => basketItemId,
-            'variant_id' => Integer(productVariantId)
-          }]
-        }})
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   - +itemIds+ -> array of basket item ids to delete, this can be sets or single items
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def removeFromBasket(sessionId, itemIds)
-
-        checkSessionId(sessionId)
-
-        orderLines = []
-
-        itemIds.each do |id|
-          orderLines.push({'delete' => id})
-        end
-
-        self.query.push({
-          'basket' => {
-            'session_id' => sessionId,
-            'order_lines' => orderLines
-          }
-        })
-        self
-      end
-
-       ###
-       # builds the basket-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> a String containing the session id of an user
-       #   - +basket+ -> an instance of AboutYou::SDK::Model::Basket
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def updateBasket(sessionId, basket)
-
-        checkSessionId(sessionId)
-
-        basketQuery = {'session_id'  => sessionId}
-
-        orderLines = basket.orderLinesArray
-        unless orderLines.empty?
-          basketQuery['order_lines'] = orderLines
-        end
-
-        self.query.push({'basket' => basketQuery})
-        self
-      end
-
-       ###
-       # builds the category-query
-       #
-       # * *Args*    :
-       #   - +ids+ -> either a single category ID as integer or an array of IDs
-       #   
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchCategoriesByIds(ids = nil)
-       
-        if ids == nil
-          self.query.push('category' => nil)
-        else 
-          # we allow to pass a single ID instead of an array
-          ids = Array(ids)
-
-          ids.each do |id|
-            id = Integer(id)
-            if id < 1
-              raise 'InvalidArgumentException! A single category ID must be greater than 0'
-            end
-          end
-
-          ids = ids.map{|id| Integer(id)}
-
-          self.query.push({
-            'category' => {
-              'ids' => ids}
-          })
-        end
-        self
-      end
-
-       ###
-       # builds the category_tree-query
-       #
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchCategoryTree
-
-        self.query.push({'category_tree' => {"version"=>"2"}})
-        self
-      end
-
-       ###
-       # builds the products-query
-       #
-       # * *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 = [])
-        # we allow to pass a single ID instead of an array
-
-        ids = Array(ids).map{|id| Integer(id)}
-
-        self.query.push({'products' => {
-          'ids' => ids,
-          'fields' => AboutYou::SDK::Criteria::ProductFields.filterFields(fields)
-          }
-        })
-        self
-      end
-
-       ###
-       # builds the live_variant-query
-       #
-       # * *Args*    :
-       #   - +ids+ -> Either a single id or an Array of ids which should be fetched
-       #      
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchLiveVariantByIds(ids) 
-        # we allow to pass a single ID instead of an array
-        ids = Array(ids)
-
-        ids = ids.map{|id| Integer(id)}
-
-        self.query.push({'live_variant' => {'ids' => ids}})
-        self
-      end
-
-       ###
-       # builds the products_eans-query
-       #
-       # * *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 = [])
-        
-        self.query.push({
-          'products_eans' => {
-            'eans'   => eans,
-            'fields' => AboutYou::SDK::Criteria::ProductFields.filterFields(fields),
-            'version' => '2'
-          }
-        })
-        self
-      end
-
-       ###
-       # builds the get_order-query
-       #
-       # * *Args*    :
-       #   - +orderId+ -> id of the order which should be fetched
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchOrder(orderId)
-
-        self.query.push({'get_order' => {'order_id' => orderId}})
-        self
-      end
-
-       ###
-       # builds the initiate_order-query
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> A String containing the sessionId of the User
-       #   - +successUrl+ -> callback URL if the order was OK
-       #   - +cancelUrl+ -> callback URL if the order was canceled [optional]
-       #   - +errorUrl+ -> callback URL if the order had any exceptions [optional]
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def initiateOrder(sessionId, successUrl, cancelUrl, errorUrl)
-
-        checkSessionId(sessionId)
-
-        args = {
-          'session_id' => sessionId,
-          'success_url' => successUrl
-        }
-        if cancelUrl
-          args['cancel_url'] = cancelUrl
-        end
-        if errorUrl
-          args['error_url'] = errorUrl
-        end
-        self.query.push({'initiate_order' => args})
-        self
-      end
-
-       ###
-       # builds the product_search-query
-       #
-       # * *Args*    :
-       #   - +criteria+ -> Hash containing one or multiple search terms
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchProductSearch(criteria)
-
-        checkSessionId(criteria.sessionId)
-        
-        self.query.push({'product_search' => criteria.toArray})
-        self
-      end
-
-       ###
-       # builds the facets-query
-       #
-       # * *Args*    :
-       #   - +groupIds+ -> Array of group ids [optional]
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchFacets(groupIds = [])
-
-        if groupIds
-          groupids = groupIds.map{|groupId| Integer(groupId)}
-        end
-
-        self.query.push({'facets' => {'group_ids' => groupids}})
-        self
-      end
-
-       ###
-       # builds the facet-query
-       #
-       # * *Args*    :
-       #   - +params+ -> Hash containing 2 keys: "id", "group_id"
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchFacet(params)
-
-        if params.empty? 
-          raise 'InvalidArgumentException! no params given'
-        end
-
-        self.query.push({'facet' => params})
-        self
-      end
-
-       ###
-       # builds the facet_types-query
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchFacetTypes
-
-        self.query.push({'facet_types' => nil})
-        self
-      end
-
-       ###
-       # builds the suggest-query
-       #
-       # * *Args*    :
-       #   - +searchword+ -> the searchs tring to search for
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchSuggest(searchword)
-
-        self.query.push({'suggest' => {'searchword' => searchword}})
-        self
-      end
-
-       ###
-       # builds the child_apps-query
-       #     
-       # * *Returns* :
-       #   - Instance of AboutYou::SDK::Query
-       ###
-      def fetchChildApps
-
-        self.query.push({'child_apps' => nil})
-        self
-      end
-
-       ###
-       # turns all queries built in here into a json string
-       #     
-       # * *Returns* :
-       #   - Json string containing all queries built in here
-       ###
-      def queryString
-
-        self.query.to_json
-      end
-
-       ###
-       # checks whether the session id is valid or not
-       #
-       # * *Args*    :
-       #   - +sessionId+ -> the session id of a user
-       ###
-      def checkSessionId(sessionId)
-
-        unless sessionId.is_a? String 
-          raise 'InvalidArgumentException! The session id must be a string'
-        end
-        unless sessionId.length > 4 
-          raise 'InvalidArgumentException! The session id must have at least 5 characters'
-        end
-      end
-    end
-  end
-end