aboutyou-sdk 0.0.1

data/lib/aboutyou-sdk/QueryBuilder.rb

@@ -0,0 +1,440 @@
+require 'json'
+
+module AboutYou
+  module SDK
+    module QueryBuilder
+
+      ###
+      # @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)
+
+         if (!(searchword.is_a? String))
+             raise 'InvalidArgumentException! searchword must be a string'
+         end
+
+         # strtolower is a workaround of ticket SAPI-532
+         options = Hash[
+             '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
+
+         if (!types.empty?) 
+             options['types'] = types;
+         end
+
+         self.query.push(Hash['autocompletion' => options])
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId Free to choose ID of the current website visitor.
+      #
+      # @return $this
+      ###
+     def fetchBasket(sessionId)
+
+         checkSessionId(sessionId);
+
+         self.query.push(Hash['basket' => Hash['session_id' => sessionId]])
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId        Free to choose ID of the current website visitor.
+      # @param int    $productVariantId ID of product variant.
+      # @param int    $amount           Amount of items to add.
+      #
+      #@return $this
+      ###
+     def addItemsToBasket(sessionId, items)
+
+         checkSessionId(sessionId);
+
+         orderLines = Array();
+
+         items.each do ||item|
+             orderLine = Hash['id' => item.getId(),'variant_id' => item.getVariantId()]
+
+             if(item.getAdditionalData()) 
+                 orderLine['additional_data'] = item.getAdditionalData();
+             end
+
+             orderLines.push(orderLine)
+         end
+
+         self.query.push( Hash['basket' => Hash['session_id' => sessionId,'order_lines' => orderLines]])
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId        Free to choose ID of the current website visitor.
+      # @param Model\BasketItemSet[]    $itemSets
+      # @param int    $amount           Amount of items to add.
+      #
+      # @return $this
+      ###
+     def addItemSetsToBasket(sessionId, itemSets)
+
+         checkSessionId(sessionId);
+
+         orderLines = Array();
+
+         itemSets.each do |itemSet|
+             orderLine = Hash[
+                 'id' => itemSet.getId(),
+                 'set_items' => Array()
+             ]
+
+             if(itemSet.getAdditionalData()) 
+                 orderLine['additional_data'] = itemSet.getAdditionalData();
+             end
+
+
+             itemSet.getItems().each do |item|
+                 entry = Hash['variant_id' => item.getVariantId()]
+
+                 if(item.getAdditionalData()) 
+                     entry['additional_data'] = item.getAdditionalData();
+                 end
+
+                 orderLine['set_items'].push(entry)
+             end
+
+             orderLines.push(orderLine)
+         end
+
+         self.query.push(Hash['basket' => Hash['session_id' => sessionId,'order_lines' => orderLines]])
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId        Free to choose ID of the current website visitor.
+      # @param int    $productVariantId ID of product variant.
+      # @param string $basketItemId  ID of single item or set in the basket
+      #
+      # @return $this
+      ###
+     def addToBasket(sessionId, productVariantId, basketItemId)
+
+         checkSessionId(sessionId);
+
+         self.query.push(Hash['basket' => Hash[
+                 'session_id' => sessionId,
+                 'order_lines' => Array(
+                     Hash[
+                         'id' => basketItemId,
+                         'variant_id' => Integer(productVariantId)
+                     ]
+                 )
+             ]
+           ]
+         )
+
+         return self;
+     end
+
+      ###
+      # @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 $this
+      ###
+     def removeFromBasket(sessionId, itemIds)
+
+         checkSessionId(sessionId);
+
+         orderLines = Array();
+
+         itemIds.each do |id|
+             orderLines.push(Hash['delete' => id])
+         end
+
+         self.query.push(Hash[
+             'basket' => Hash[
+                 'session_id' => sessionId,
+                 'order_lines' => orderLines
+               ]
+           ]
+         )
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId
+      # @param Basket $basket
+      #
+      # @return $this
+      ###
+     def updateBasket(sessionId, basket)
+
+         checkSessionId(sessionId);
+
+         basketQuery = Hash['session_id'  => sessionId]
+
+         orderLines = basket.getOrderLinesArray();
+         if (!orderLines.empty?) 
+             basketQuery['order_lines'] = orderLines;
+         end
+
+         self.query.push(Hash['basket' => basketQuery])
+
+         return self;
+     end
+
+      ###
+      # @param int[]|string[] $ids either a single category ID as integer or an array of IDs
+      #
+      # @return $this
+      ###
+     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 = id.to_i
+                 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(Hash[
+                 'category' => Hash[
+                     'ids' => ids
+                   ]
+                 ]
+             )
+         end
+         return self
+     end
+
+      ###
+      # @param int $maxDepth -1 <= $maxDepth <= 10,
+      #
+      # @return $this
+      ###
+     def fetchCategoryTree()
+
+         self.query.push(Hash['category_tree' => {"version"=>"2"}])
+
+         return self
+     end
+
+      ###
+      # @param string[]|int[] $ids
+      # @param array $fields
+      #
+      # @return $this
+      ###
+     def fetchProductsByIds(ids,fields = Array(nil))
+         # we allow to pass a single ID instead of an array
+
+         ids = Array(ids)
+         ids = ids.map{|id| Integer(id)}
+
+         self.query.push(Hash['products' => Hash['ids' => ids,'fields' => AboutYou::SDK::Criteria::ProductFields::filterFields(fields)]])
+
+         return self;
+     end
+
+      ###
+      # @param string[]|int[] $ids
+      #
+      # @return $this
+      ###
+     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(Hash['live_variant' => Hash['ids'    => ids]])
+
+         return self;
+     end
+
+      ###
+      # @param string[] $eans
+      # @param array $fields
+      #
+      # @return $this
+      ###
+     def fetchProductsByEans(eans,fields = Array())
+         self.query.push(Hash[
+             'products_eans' => Hash[
+                 'eans'   => eans,
+                 'fields' => ProductFields::filterFields(fields),
+                 'version' => '2'
+             ]
+           ]
+         )
+
+         return self;
+     end
+
+      ###
+      # @param string|int $orderId
+      #
+      # @return $this
+      ###
+     def fetchOrder(orderId)
+
+         self.query.push(Hash['get_order' => Hash['order_id' =>orderId]])
+
+         return self;
+     end
+
+      ###
+      # @param string $sessionId
+      # @param string $successUrl
+      # @param string $cancelUrl
+      # @param string $errorUrl
+      #
+      # @return $this
+      ###
+     def initiateOrder(sessionId, successUrl, cancelUrl, errorUrl)
+
+         checkSessionId(sessionId);
+
+         args = Hash['session_id' => sessionId,'success_url' => successUrl]
+         if (cancelUrl)
+           args['cancel_url'] = cancelUrl;
+         end
+         if (errorUrl)
+           args['error_url'] = errorUrl;
+         end
+         self.query.push(Hash['initiate_order' => args])
+
+         return self;
+     end
+
+      ###
+      # @param ProductSearchCriteria $criteria
+      #
+      # @return $this
+      ###
+     def fetchProductSearch(criteria)
+
+         checkSessionId(criteria.sessionId());
+         self.query.push(Hash['product_search' =>criteria.toArray])
+
+         return self;
+     end
+
+      ###
+      # @param array $groupIds
+      #
+      # @return $this
+      #
+      # @throws \InvalidArgumentException
+      ###
+     def fetchFacets(groupIds = Array())
+
+         groupIds = groupIds.map{|groupId| Integer(groupId)}
+
+         self.query.push(Hash['facets' => Hash['group_ids' => groupIds]])
+
+         return self;
+     end
+
+      ###
+      # @param array $params
+      #
+      # @return $this
+      #
+      # @throws \InvalidArgumentException
+      ###
+     def fetchFacet(params)
+
+         if (params.empty) 
+             raise 'InvalidArgumentException! no params given'
+         end
+
+         self.query.push(Hash['facet' => params])
+
+         return self
+     end
+
+      ###
+      # @return $this
+      ###
+     def fetchFacetTypes()
+
+         self.query.push(Hash['facet_types' => nil]);
+
+         return self;
+     end
+
+      ###
+      # @param string $searchword The search string to search for.
+      #
+      # @return $this
+      ###
+     def fetchSuggest(searchword)
+
+         self.query.push(Hash['suggest' => Hash['searchword' => searchword]])
+
+         return self
+     end
+
+      ###
+      # @return $this
+      ###
+     def fetchChildApps()
+
+         self.query.push(Hash['child_apps' => nil])
+
+         return self;
+     end
+
+      ###
+      # @return string
+      ###
+     def queryString()
+
+         return self.query.to_json
+     end
+
+      ###
+      # @param $sessionId
+      #
+      # @throws \InvalidArgumentException
+      ###
+     def checkSessionId(sessionId)
+
+         if (!(sessionId.is_a? String)) 
+             raise 'InvalidArgumentException! The session id must be a string'
+         end
+         if !(sessionId.length > 4) 
+             raise 'InvalidArgumentException! The session id must have at least 5 characters'
+         end
+     end
+    end
+  end
+end

data/tests/Sinatra-test/Main.rb

@@ -0,0 +1,5 @@
+require 'sinatra'
+
+get "/" do
+  erb :'partial_view', :locals => {:foo => "bar"}
+end

data/tests/testApiClient.rb

@@ -0,0 +1,35 @@
+require 'httparty'
+
+query = HTTParty.post("https://shop-api.aboutyou.de/api",
+{ 
+  :body=>
+  '[{
+    "products": {
+        "ids": [
+            144388,
+            144389
+        ],
+        "fields": [
+            "id",
+            "name",
+            "active",
+            "brand_id",
+            "description_long",
+            "description_short",
+            "default_variant",
+            "variants",
+            "min_price",
+            "max_price",
+            "sale",
+            "default_image",
+            "attributes_merged",
+            "categories"
+        ]
+    }
+}]',
+  :basic_auth => { :username => 281 , :password => 'e6068c4ca020262613d06122663cb300'},
+  :headers => { 'Content-Type' => 'application/json',
+                'Accept-Encoding' => 'gzip,deflate'  }
+})
+
+puts query