aboutyou-sdk 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDM2NDY3ZmIyNzA3NDQxMzJiMjUyMWQ0MjU1ZTNiYjVmNDc0NDY0OQ==
+    OTM0MmUzNTAxZDAzY2NiMmVhNzg4YjY1MmYzYjBhZmMzNjg3ODFlNw==
   data.tar.gz: !binary |-
-    NGQ4Mzk1Zjk3ODJmMTU1NGJmYjViOGYxMWU4ZTVlYjNlZGU2ZDk4NQ==
+    ZTg2NzY5NzQ3YWQzM2Q4ZDI5MTRkOGJkOGYyZmFkYTdhMWZkMzU1NQ==
 SHA512:
   metadata.gz: !binary |-
-    YjQ0ZDU5NzRmZTFkZDMzYjBhNWI0MGVlMGQxZGI0NzViZmUwOGQ5YzliM2Uy
-    OTU2NzJhNTBmMTNmYWRiMmU3MDk1YTEzNjg3MTQzNzM2NjkyYjQxNTc2Njg2
-    NDQ1YTlhNWE2NjdiMTMxYmRiMTA1YjQyZjE2NTdmZTIwMTU0MzY=
+    ZDM1NTc0ZjFmZmVlYjI0YWY0YTI1MTk2MGYyNTkwMGNiOWZmNDI1NjA0MzUx
+    ZWQzMGNlNjVlMzI0YjY3MTZkYTIyMmI2NjlmOGZiMzVmZjY3ZTk3NmU1YTM5
+    ZTk2NmM1MTM5NmRkOTkzYzk5ZWI4YzhkOGYwNzNmMGEzNzczNGQ=
   data.tar.gz: !binary |-
-    OGU1ODc0NGMzNjhhODJiMzkyYmJhMDVmNGI4OGI2ZDRhMDFmNTU2YjVlMTNh
-    NjI0MDc5ZTgyZjQxZjJmNTk3NmZiNjY4MmZiYmU4MDg1YmQ3ZDZiM2EzMDMz
-    Zjg3ZDg3NTZlZGUyNTVjNjM4ZWQ4MmViM2ViZTMzM2NkMDUzMWE=
+    ZmE2MTI3OThmMjRlODhhMTNlNGQ1M2ExOTJmYzFhOTNjNjU0YWMzNWZmMDI4
+    OWEyODkyNWIyNzMwZTU2NjA2M2MwZDRmYTA4Y2MxOGNjY2JlYzM1ZjAyNjJl
+    ZWVhYWUyMWQ0ZGMxODIxYmU5ZmM5MmQyMzVkMGQxMGYyZjM5YmI=

data/lib/aboutyou-sdk.rb

@@ -6,539 +6,493 @@ require_rel "aboutyou-sdk"
 
  ###
  # Provides access to the Collins Frontend Platform.
- # This class is abstract because it's not meant to be instanciated.
  # All the public methods cover a single API query.
  #
  # @author Collins GmbH & Co KG
  ###
 class AY
-    IMAGE_URL_STAGE   = 'http://mndb.staging.aboutyou.de/mmdb/file'
-    IMAGE_URL_SANDBOX = 'http://mndb.sandbox.aboutyou.de/mmdb/file'
-    IMAGE_URL_LIVE    = 'http://cdn.aboutyou.de/file'
-    
-    attr_accessor :aboutYouClient
-    attr_accessor :appId
-    attr_accessor :appPassword
-    attr_accessor :apiEndPoint
-    attr_accessor :environment
-    attr_accessor :logger
-    attr_accessor :modelFactoryInstance
-    attr_accessor :baseImageUrl
-    attr_accessor :sessionId
-    
-        
-     ###
-     # @param string $appId
-     # @param string $appPassword
-     # @param string $apiEndPoint Constants::API_ENVIRONMENT_LIVE for live environment, Constants::API_ENVIRONMENT_STAGE for staging
-     # @param ResultFactoryInterface $resultFactory if null it will use the DefaultModelFactory with the DefaultFacetManager
-     # @param LoggerInterface $logger
-     # @param \Aboutyou\Common\Cache\CacheMultiGet|\Doctrine\Common\Cache\CacheMultiGet $facetManagerCache
-     ###
-    def initialize(appId,appPassword,sessionId = 'SESSION_ID', apiEndPoint = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE, resultFactory = nil, logger = nil,facetManagerCache = nil)
-      aboutYouClient = AboutYou::SDK::Client.new(appId, appPassword, apiEndPoint, logger)
-        
-        if (apiEndPoint === AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE) 
-            self.setBaseImageUrl(IMAGE_URL_STAGE)
-            self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE         
-          elsif (apiEndPoint === AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX) 
-            self.setBaseImageUrl(IMAGE_URL_SANDBOX)
-            self.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
-        else 
-            self.setBaseImageUrl(IMAGE_URL_LIVE)
-        end
-        
-        self.sessionId   = sessionId
-        self.appId       = appId
-        self.appPassword = appPassword
-        self.aboutYouClient = aboutYouClient
-        self.apiEndPoint = apiEndPoint
+  IMAGE_URL_STAGE   = 'http://mndb.staging.aboutyou.de/mmdb/file'
+  IMAGE_URL_SANDBOX = 'http://mndb.sandbox.aboutyou.de/mmdb/file'
+  IMAGE_URL_LIVE    = 'http://cdn.aboutyou.de/file'
+
+  attr_accessor :aboutYouClient
+  attr_accessor :appId
+  attr_accessor :appPassword
+  attr_accessor :apiEndPoint
+  attr_accessor :environment
+  attr_accessor :logger
+  attr_accessor :modelFactoryInstance
+  attr_accessor :baseImageUrl
+  attr_accessor :sessionId
+
+   ###
+   # @param apiEndPoint=>live    = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE
+   # @param apiEndPoint=>staging = AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE
+   # @param resultFactory if null it will use the DefaultModelFactory with the DefaultFacetManager
+   ###
+  def initialize(appId,appPassword,sessionId = 'SESSION_ID', apiEndPoint = AboutYou::SDK::Constants::API_ENVIRONMENT_LIVE, resultFactory = nil, logger = nil,facetManagerCache = nil)
+    
+    self.sessionId   = sessionId
+    self.appId       = appId
+    self.appPassword = appPassword
+    self.aboutYouClient = AboutYou::SDK::Client.new(appId, appPassword, apiEndPoint, logger)
+
+    if apiEndPoint == AboutYou::SDK::Constants::API_ENVIRONMENT_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.environment = AboutYou::SDK::Constants::API_ENVIRONMENT_SANDBOX
+    else 
+      self.baseImageUrl=(IMAGE_URL_LIVE)
     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.
-     #
-     # It is highly recommend to use the basket update method, to manage your items.
-     #
-     # @param string $sessionId
-     # @param integer $variantId
-     # @param integer $amount
-     #
-     # @return Basket
-     #
-     # @throws \InvalidArgumentException
-     ##
-    def addItemToBasket(sessionId, variantId, amount = 1)
-    
-        if (!variantId.is_a? Long) 
-
-            if (variantId.is_a String && variantId[/\d/]) 
-                variantId = Integer(variantId);
-            else 
-                raise 'the variant id must be an integer or string with digits'
-            end
-        end
-
-        basket = AboutYou::SDK::Model::Basket.new()
-
-        amount.times do
-          item =  AboutYou::SDK::Model::Basket::BasketItem.new(generateBasketItemId(), variantId)
-            basket.updateItem(item)
-        end
-
-        updateBasket(sessionId, basket);
+  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.
+   #
+   # It is highly recommend to use the basket update method, to manage your items.
+   #
+   # @param string $sessionId
+   # @param integer $variantId
+   # @param integer $amount
+   #
+   # @return Basket
+   #
+   # @throws \InvalidArgumentException
+   ##
+  def addItemToBasket(sessionId, variantId, amount = 1)
+
+    basket = AboutYou::SDK::Model::Basket.new
+
+    unless variantId.is_a? Long
+      if variantId.is_a? String && variantId[/\d/]
+        variantId = Integer(variantId)
+      else 
+        raise 'the variant id must be an integer or string with digits'
+      end
     end
 
-    
-    def generateBasketItemId()
-    
-      'i_' + SecureRandom.uuid
 
+    amount.times do
+      basket.updateItem(AboutYou::SDK::Model::Basket::BasketItem.new(generateBasketItemId, variantId))
     end
 
-    
-     ###
-     # Remove basket item.
-     #
-     # @param string $sessionId     Free to choose ID of the current website visitor.
-     # @param string[] $itemIds     array of basket item ids to delete, this can be sets or single items
-     #
-     # @return \Collins\ShopApi\Model\Basket
-     ###
-    def removeItemsFromBasket(sessionId, itemIds)
-    
-        basket = AboutYou::SDK::Model::Basket.new()
-        basket.deleteItems(itemIds)
-
-        updateBasket(sessionId, basket)
+    updateBasket(sessionId, basket)
+  end
+
+
+  def generateBasketItemId
+
+    'i_' + SecureRandom.uuid
+  end
+
+
+   ###
+   # Remove basket item.
+   #
+   # @param string $sessionId     Free to choose ID of the current website visitor.
+   # @param string[] $itemIds     array of basket item ids to delete, this can be sets or single items
+   #
+   # @return \Collins\ShopApi\Model\Basket
+   ###
+  def removeItemsFromBasket(sessionId, itemIds)
+
+    basket = AboutYou::SDK::Model::Basket.new
+    basket.deleteItems(itemIds)
+
+    updateBasket(sessionId, basket)
+  end
+
+
+   ###
+   # @param string $sessionId
+   # @param Basket $basket
+   #
+   # @return \Collins\ShopApi\Model\Basket
+   ###
+  def updateBasket(sessionId, basket)
+
+    query.updateBasket(sessionId, basket).executeSingle
+  end
+
+
+   ###
+   # @param string $sessionId the session id
+   # @param string $successUrl callback URL if the order was OK
+   # @param string $cancelUrl callback URL if the order was canceled [optional]
+   # @param string $errorUrl callback URL if the order had any exceptions [optional]
+   #
+   # @return \Collins\ShopApi\Model\InitiateOrder
+   ###
+  def initiateOrder(sessionId,successUrl,cancelUrl = nil,errorUrl = nil)
+
+    query.initiateOrder(sessionId, successUrl, cancelUrl, errorUrl).executeSingle
+  end
+
+
+   ###
+   # Returns the result of an auto completion API request.
+   # Auto completion searches for products and categories by
+   # a given prefix ($searchword).
+   #
+   # @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 \Collins\ShopApi\Model\Autocomplete
+   ###
+   def fetchAutocomplete(searchword, limit = 50, types = [AboutYou::SDK::Constants::TYPE_PRODUCTS, AboutYou::SDK::Constants::TYPE_CATEGORIES])
+
+    query.fetchAutocomplete(searchword, limit, types).executeSingle
+  end
+
+
+   ###
+   # Fetch the basket of the given sessionId.
+   #
+   # @param string $sessionId Free to choose ID of the current website visitor.
+   #
+   # @return \Collins\ShopApi\Model\Basket
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchBasket(sessionId)
+
+    query.fetchBasket(sessionId).executeSingle
+  end
+
+
+   ###
+   # Returns the result of a category search API request.
+   # By passing one or several category ids it will return
+   # a result of the categories data.
+   #
+   # @param mixed $ids either a single category ID as integer or an array of IDs
+   #
+   # @return \Collins\ShopApi\Model\CategoriesResult
+   ###
+  def fetchCategoriesByIds(ids = nil)
+    # we allow to pass a single ID instead of an array
+
+    if ids
+      ids = Array(ids)
     end
 
-    
-     ###
-     # @param string $sessionId
-     # @param Basket $basket
-     #
-     # @return \Collins\ShopApi\Model\Basket
-     ###
-    def updateBasket(sessionId, basket)
-    
-        query = query().updateBasket(sessionId, basket)
-    
-        query.executeSingle()
+    categoryManager = self.categoryManager
+    return AboutYou::SDK::Model::CategoriesResult.new(categoryManager, ids)
+  end
+
+
+   ###
+   # @param int $maxDepth  -1 <= $maxDepth <= 10
+   #
+   # @return CategoryTree
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchCategoryTree
+
+    AboutYou::SDK::Model::CategoryTree.new(self.categoryManager)
+  end
+  
+
+   ###
+   # The Categories will be fetch automatically, if required by any other fetch method
+   #
+   # For Example
+   # $productsResult = $api->fetchProductsByIds([12345], ['categories']);
+   #  will fetch the categories with the same request.
+   # $rootCategories = $api->getCategoryManager()->getCategoryTree();
+   #  will give you all categories for your Menu without an other request
+   #
+   # @param bool $fetchIfEmpty
+   #
+   # @return CategoryManagerInterface
+   ###
+  def categoryManager(fetchIfEmpty = true)
+
+    categoryManager = self.modelFactory.categoryManager
+
+    if fetchIfEmpty && categoryManager.isEmpty
+      query.requireCategoryTree.executeSingle
     end
 
-    
-     ###
-     # @param string $sessionId the session id
-     # @param string $successUrl callback URL if the order was OK
-     # @param string $cancelUrl callback URL if the order was canceled [optional]
-     # @param string $errorUrl callback URL if the order had any exceptions [optional]
-     #
-     # @return \Collins\ShopApi\Model\InitiateOrder
-     ###
-    def initiateOrder(sessionId,successUrl,cancelUrl = nil,errorUrl = nil)
-      
-        query = query().initiateOrder(sessionId, successUrl, cancelUrl, errorUrl)
-
-        query.executeSingle()
-    end
-    
-      
-     ###
-     # Returns the result of an auto completion API request.
-     # Auto completion searches for products and categories by
-     # a given prefix ($searchword).
-     #
-     # @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 \Collins\ShopApi\Model\Autocomplete
-     ###
-     def fetchAutocomplete(searchword, limit = 50, types = [AboutYou::SDK::Constants::TYPE_PRODUCTS, AboutYou::SDK::Constants::TYPE_CATEGORIES])
-        
-      query = query().fetchAutocomplete(searchword, limit, types)
-        
-      query.executeSingle()
+    categoryManager
+  end
+
+
+   ###
+   # @param integer[] $ids
+   # @param string[] $fields
+   #
+   # @return ProductsResult
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchProductsByIds(ids , fields = [])
+    # we allow to pass a single ID instead of an array
+    ids = Array(ids)
+    result = query.fetchProductsByIds(ids, fields).executeSingle
+    productsNotFound = result.getProductsNotFound
+    
+    if !productsNotFound.empty? && self.logger
+      self.logger.warning('products not found: appid=' + self.appId + ' product ids=[' + productsNotFound.join(',') + ']')
     end
 
-    
-     ###
-     # Fetch the basket of the given sessionId.
-     #
-     # @param string $sessionId Free to choose ID of the current website visitor.
-     #
-     # @return \Collins\ShopApi\Model\Basket
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchBasket(sessionId)
-    
-        query = query().fetchBasket(sessionId)
+    result
+  end
+
+
+   ###
+   # @param integer[] $ids
+   #
+   # @return ShopApi\Model\VariantsResult
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchVariantsByIds(ids) 
+    # we allow to pass a single ID instead of an array
+
+    ids = Array(ids)
+    result = query.fetchLiveVariantByIds(ids).executeSingle
+    variantsNotFound = result.variantsNotFound
+    
+    if result.hasVariantsNotFound && self.logger
+      self.logger.warning('variants or products for variants not found: appid='+self.appId+' variant ids=['+variantsNotFound.join(',')+']')
+    end        
+
+    result
+  end
+
+
+   ###
+   # @param string[] $eans
+   # @param string[] $fields
+   #
+   # @return ProductsEansResult
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchProductsByEans(eans,fields = [])
+  # we allow to pass a single ID instead of an array
+
+  eans = Array(eans)
+    
+  query.fetchProductsByEans(eans, fields).executeSingle
+  end
+
+
+   ###
+   # @param ProductSearchCriteria $criteria
+   #
+   # @return ProductSearchResult
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchProductSearch(criteria)
+
+  query.fetchProductSearch(criteria).executeSingle
+  end
+
+
+   ###
+   # Fetch the facets of the given groupIds.
+   #
+   # @param array $groupIds The group ids.
+   #
+   # @return \Collins\ShopApi\Model\Facet[] With facet id as key.
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   #@throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchFacets(groupIds=[])
+
+    query.fetchFacets(groupIds).executeSingle
+  end
+
+
+  def fetchFacetTypes
+    
+    query.fetchFacetTypes.executeSingle
+  end
+
+
+   ###
+   # @param string|integer $orderId the order id
+   #
+   # @return \Collins\ShopApi\Model\Order the order
+   ###
+  def fetchOrder(orderId)
+
+    query.fetchOrder(orderId).executeSingle
+  end
+
+
+   ###
+   # Fetch single facets by id and group id
+   # For example:
+   # $shopApi->fetchFacet([
+   #   ["id" => 123, "group_id" => 0 ],
+   #   ["id" => 456, "group_id" => 0 ]
+   # ])
+   #
+   # @param array $params Array of (id, group_id) pairs
+   #
+   # @return \Collins\ShopApi\Model\Facet[] With facet id as key.
+   #
+   # @throws ShopApi\Exception\MalformedJsonException
+   # @throws ShopApi\Exception\UnexpectedResultException
+   ###
+  def fetchFacet(params)
+
+    query.fetchFacet(params).executeSingle
+  end
+
+
+   ###
+   # Returns the result of a suggest API request.
+   # Suggestions are words that are often searched together
+   # with the searchword you pass (e.g. "stretch" for "jeans").
+   #
+   # @param string $searchword The search string to search for.
+   #
+   # @return array
+   ###
+  def fetchSuggest(searchword)
+
+    query.fetchSuggest(searchword).executeSingle
+  end
+
+
+   ###
+   # Returns the list of child apps
+   #
+   # @return array
+   ###
+  def fetchChildApps
 
-        query.executeSingle()
-    end
-
-    
-     ###
-     # Returns the result of a category search API request.
-     # By passing one or several category ids it will return
-     # a result of the categories data.
-     #
-     # @param mixed $ids either a single category ID as integer or an array of IDs
-     #
-     # @return \Collins\ShopApi\Model\CategoriesResult
-     ###
-    def fetchCategoriesByIds(ids = nil)
-      # we allow to pass a single ID instead of an array
-
-      if (ids != nil)
-          ids = Array(ids)
-      end
+    query.fetchChildApps.executeSingle
+  end
 
-      categoryManager = self.categoryManager
-      return AboutYou::SDK::Model::CategoriesResult.new(categoryManager, ids)
-    end
-    
 
-     ###
-     # @param int $maxDepth  -1 <= $maxDepth <= 10
-     #
-     # @return CategoryTree
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchCategoryTree()
-
-      return AboutYou::SDK::Model::CategoryTree.new(self.categoryManager())
-    end
-    
-     ###
-     # The Categories will be fetch automatically, if required by any other fetch method
-     #
-     # For Example
-     # $productsResult = $api->fetchProductsByIds([12345], ['categories']);
-     #  will fetch the categories with the same request.
-     # $rootCategories = $api->getCategoryManager()->getCategoryTree();
-     #  will give you all categories for your Menu without an other request
-     #
-     # @param bool $fetchIfEmpty
-     #
-     # @return CategoryManagerInterface
-     ###
-    def categoryManager(fetchIfEmpty = true)
-    
-        categoryManager = self.modelFactory.categoryManager();
+  def query
 
-        if (fetchIfEmpty && categoryManager.isEmpty)
-            self.query().requireCategoryTree().executeSingle
-        end
+    AboutYou::SDK::Query.new(self.aboutYouClient, modelFactory)
+  end
 
-        return categoryManager;
-    end
-    
-     
-     ###
-     # @param integer[] $ids
-     # @param string[] $fields
-     #
-     # @return ProductsResult
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchProductsByIds(ids , fields = Array(nil))
-        # we allow to pass a single ID instead of an array
-        
-        ids = Array(ids)
-        query = query().fetchProductsByIds(ids, fields)
-        result = query.executeSingle()
-
-        productsNotFound = result.getProductsNotFound()
-        if (!productsNotFound.empty? && self.logger)
-            self.logger.warning('products not found: appid=' + self.appId + ' product ids=[' + productsNotFound.join(',') + ']')
-        end
-
-        return result
+  
+  def modelFactory
+
+    unless self.modelFactoryInstance
+      self.initDefaultFactory
     end
-    
 
-     ###
-     # @param integer[] $ids
-     #
-     # @return ShopApi\Model\VariantsResult
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchVariantsByIds(ids) 
-        # we allow to pass a single ID instead of an array
-        
-        ids = Array(ids)
-        query = query().fetchLiveVariantByIds(ids)
-
-        result = query.executeSingle()
-        
-        variantsNotFound = result.variantsNotFound()
-        if (result.hasVariantsNotFound() && self.logger) 
-            self.logger.warning('variants or products for variants not found: appid='+self.appId+' variant ids=['+variantsNotFound.join(',')+']')
-        end        
-
-        return result
-    end
-    
-    
-     ###
-     # @param string[] $eans
-     # @param string[] $fields
-     #
-     # @return ProductsEansResult
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchProductsByEans(eans,fields = Array())
-        # we allow to pass a single ID instead of an array
-        
-        eans = Array(eans)
-
-        query = query().fetchProductsByEans(eans, fields)
-
-        query.executeSingle()
+    self.modelFactoryInstance
+  end
+
+  
+   ###
+   # @param string|nil $sessionId
+   #
+   # @return ProductSearchCriteria
+   ###
+  def productSearchCriteria(sessionId=nil)
+    unless sessionId 
+      sessionId = self.sessionId
     end
     
-    
-     ###
-     # @param ProductSearchCriteria $criteria
-     #
-     # @return ProductSearchResult
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchProductSearch(criteria)
-      
-        query = query().fetchProductSearch(criteria)
-
-        query.executeSingle()
-    end
+    AboutYou::SDK::Criteria::ProductSearchCriteria.new(self.sessionId)
+  end
 
-    
-     ###
-     # Fetch the facets of the given groupIds.
-     #
-     # @param array $groupIds The group ids.
-     #
-     # @return \Collins\ShopApi\Model\Facet[] With facet id as key.
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     #@throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchFacets(groupIds=Array(nil))
-      
-        query = query().fetchFacets(groupIds)
-
-        query.executeSingle()
-    end
 
-    
-    def fetchFacetTypes()
-      
-        query = query().fetchFacetTypes()
-        
-        query.executeSingle()
-    end
+   ###
+   # Returns the URL to the Collins JavaScript file for helper functions
+   # to add product variants into the basket of Mary & Paul 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.
+   #
+   # @return string URL to the JavaScript file
+   ###
+  def javaScriptURL
 
-    
-     ###
-     # @param string|integer $orderId the order id
-     #
-     # @return \Collins\ShopApi\Model\Order the order
-     ###
-    def fetchOrder(orderId)
-      
-        query = query().fetchOrder(orderId)
-        
-        query.executeSingle()
-    end
-    
-    
-     ###
-     # Fetch single facets by id and group id
-     # For example:
-     # $shopApi->fetchFacet([
-     #   ["id" => 123, "group_id" => 0 ],
-     #   ["id" => 456, "group_id" => 0 ]
-     # ])
-     #
-     # @param array $params Array of (id, group_id) pairs
-     #
-     # @return \Collins\ShopApi\Model\Facet[] With facet id as key.
-     #
-     # @throws ShopApi\Exception\MalformedJsonException
-     # @throws ShopApi\Exception\UnexpectedResultException
-     ###
-    def fetchFacet(params)
-
-        query = query().fetchFacet(params)
-        
-        query.executeSingle()
+    if self.environment === AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE
+      '//devcenter-staging-www1.pub.collins.kg:81/appjs/'+String(self.appId)+'.js'
+    else 
+      '//developer.aboutyou.de/appjs/'+String(self.appId)+'.js'
     end
+  end
 
-    
-     ###
-     # Returns the result of a suggest API request.
-     # Suggestions are words that are often searched together
-     # with the searchword you pass (e.g. "stretch" for "jeans").
-     #
-     # @param string $searchword The search string to search for.
-     #
-     # @return array
-     ###
-    def fetchSuggest(searchword)
-    
-        query = query().fetchSuggest(searchword)
-        
-        query.executeSingle()
-    end
 
-    
-     ###
-     # Returns the list of child apps
-     #
-     # @return array
-     ###
-    def fetchChildApps()
-    
-        query = query().fetchChildApps()
+   ###
+   # Returns a HTML script tag that loads the Collins JavaScript fie.
+   #
+   # @return string HTML script tag
+   ###
+  def javaScriptTag
 
-        query.executeSingle()
-    end
+    '<script type="text/javascript" src="' + self.javaScriptURL + '"></script>'
+  end
 
-    
-    def query()
-      
-        AboutYou::SDK::Query.new(self.aboutYouClient, modelFactory())
-    end
 
-    def modelFactory()
-    
-        if (!self.modelFactoryInstance) 
-            self.initDefaultFactory();
-        #elsif (self.modelFactoryInstance instanceof \Closure) 
-        #    $closure = $this->modelFactoryInstance;
-        #    $closure($this);
-        end
-
-        return self.modelFactoryInstance;
-    end
-    
-     ###
-     # @param string|nil $sessionId
-     #
-     # @return ProductSearchCriteria
-     ###
-    def productSearchCriteria(sessionId=nil)
-        if !sessionId 
-            sessionId = self.sessionId
-        end
-        AboutYou::SDK::Criteria::ProductSearchCriteria.new(self.sessionId)
-    end
+   ###
+   # @param string $appId        the app id for client authentication
+   # @param string $appPassword  the app password/token for client authentication.
+   ###
+  def appCredentials=(appId, appPassword)
 
-    
-     ###
-     # Returns the URL to the Collins JavaScript file for helper functions
-     # to add product variants into the basket of Mary & Paul 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.
-     #
-     # @return string URL to the JavaScript file
-     ###
-    def javaScriptURL()
-    
-      if (self.environment === AboutYou::SDK::Constants::API_ENVIRONMENT_STAGE) 
-            '//devcenter-staging-www1.pub.collins.kg:81/appjs/'+String(self.appId)+'.js'
-         else 
-            '//developer.aboutyou.de/appjs/'+String(self.appId)+'.js'
-        end
+    self.appId       = appId
+    self.appPassword = appPassword
+    self.aboutYouClient.appId= appId
+    self.aboutYouClient.appPassword = appPassword
+  end
 
-    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 apiEndpoint=(apiEndPoint)
 
-     ###
-     # Returns a HTML script tag that loads the Collins JavaScript fie.
-     #
-     # @return string HTML script tag
-     ###
-    def javaScriptTag()
-    
-        '<script type="text/javascript" src="' + self.javaScriptURL() + '"></script>'
-    end
+    self.aboutYouClient.apiEndpoint=(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)
-    
-        self.appId       = appId
-        self.appPassword = appPassword
-        self.aboutYouClient.setAppCredentials(appId, appPassword)
-    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)
-    
-        self.aboutYouClient.setApiEndpoint(apiEndPoint)
-    end
+   ###
+   # @param null|false|string $baseImageUrl null will reset to the default url, false to get relative urls, otherwise the url prefix
+   ###
+  def baseImageUrl=(baseImageUrl = nil)
 
-    
-     ###
-     # @param string $logTemplate
-     #
-     # @see http://api.guzzlephp.org/class-Guzzle.Log.MessageFormatter.html
-     ###
-    def setLogTemplate(logTemplate)
-    
-        self.aboutYouClient.setLogTemplate(logTemplate)
+    if !baseImageUrl 
+      @baseImageUrl = IMAGE_URL_LIVE
+    elsif baseImageUrl.is_a? String
+      @baseImageUrl = baseImageUrl.gsub(/[#{'/'}]+$/,'')
+    else
+      @baseImageUrl = ''
     end
-    
-    
-     ###
-     # @param null|false|string $baseImageUrl null will reset to the default url, false to get relative urls, otherwise the url prefix
-     ###
-    def setBaseImageUrl(baseImageUrl = nil)
-    
-        if (baseImageUrl === nil) 
-            self.baseImageUrl = IMAGE_URL_LIVE
-        elsif (baseImageUrl.is_a? String)
-            self.baseImageUrl = baseImageUrl.gsub(/[#{'/'}]+$/,'')
-        else 
-            self.baseImageUrl = ''
-        end
-        
-        self.modelFactory().baseImageUrl=(self.baseImageUrl);
-    end
-    
-    def initDefaultFactory(cache = nil)
 
-        categoryManager = AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager.new(cache, self.appId);
-        facetManager    = AboutYou::SDK::Model::FacetManager::DefaultFacetManager.new();
+    self.modelFactory.baseImageUrl=(self.baseImageUrl)
+  end
 
-        resultFactory = AboutYou::SDK::Factory::DefaultModelFactory.new(self,facetManager,categoryManager)
-        resultFactory.baseImageUrl=(self.baseImageUrl);
+  def initDefaultFactory(cache = nil)
 
-        self.modelFactoryInstance=(resultFactory);
-    end
+    resultFactory = AboutYou::SDK::Factory::DefaultModelFactory.new(self,
+          AboutYou::SDK::Model::FacetManager::DefaultFacetManager.new,
+          AboutYou::SDK::Model::CategoryManager::DefaultCategoryManager.new(cache, self.appId)
+    )
+    resultFactory.baseImageUrl=(self.baseImageUrl)
+
+    self.modelFactoryInstance=(resultFactory)
+  end
+  
 end