aboutyou-sdk 0.0.27 → 0.0.28

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2Q0MGRiOTIwZTM2OGQwYWM5MzA5NmIzYzhhNGRhY2IyZGU1MGQyZg==
+    YjFiOTBiOTIxNjQxMTM1ZDdkMzQ4NTU5YzA3MDU5YmRiMGY2MGUzZg==
   data.tar.gz: !binary |-
-    M2Y0ZmYwMDEwOTcxNDYwMWYwNmViZGFmMGVhZGEyZTY0YzRlNWU3Zg==
+    YmM2MjIwOTg0ZGY0MjViYmYxNDY4NmNhYzM0MWYwY2MzMjU1MjM0Ng==
 SHA512:
   metadata.gz: !binary |-
-    NTYyMTY0YmRkODQ5NmNlNTYwZDRlNjIxOThlMTM2MGE1M2VhNmY5YTE4NDQw
-    NzRlNDA3ZjY2NjE1YjMxZGVjZDU4YTVmMmQ5NDdjYTUyNTFhNDMzOTU3Y2Rh
-    MDcyNWVlOTFkNzFjZGIwMDc3NzAzZDI2MTA3MDM2YTFlODNlOGM=
+    NzY1MDBiM2NkZWRmM2IzNzE0NTBkZTlkYzI2YjdlMGZhYjg1ZWFiODM3MjYw
+    ODc2MDg3M2I1NTdkYzFiY2Q1MmU3NzdiNzI1NDE5NDJjZmE2OThmMjVkOThi
+    OGZhODViMWEzM2I2YzU2ODdmMzQyZTZiOTZlMTEzYjQ3ZDBjOTY=
   data.tar.gz: !binary |-
-    N2RmYzYzNmUwMDA3NDM2ZDU1ZWQzY2ZjNTMwYmUxNDYwZTFiMjFkNDE1N2Vk
-    Zjg0ZGMzOTc0NzQ0NjgxODY4OTg5NDgwYTQ0Y2FlOWIxMmVmOGQwMDRkNjU2
-    NTU5MzIyMjAwMDA3NDk1ZDViZDZkMjZmNjE1OTYyMzI5ZDBlZWE=
+    ZGM2MDFjNjAzZTU5MmI1ZDc2NzFlYTA4ZjFlMDliZTAxYmU2NzQ1ODZmNTdi
+    NGRjODIwOGJjMjVjMDZhN2Y2ZmZlNzA2ZjkyMGE2NDRjNzRkMzUwOGE4MTI3
+    MDMyYTM2MDI0MTEyMGQ3NTg2ZDdlYWQ0NjBhODkwY2EyN2NlZGU=

data/lib/AboutYou/Factory/default_model_factory.rb

@@ -543,6 +543,19 @@ module AboutYou
           AboutYou::SDK::Model::App.create_from_json(json_object)
         end
 
+        ###
+        # creates an spell correction result
+        #
+        # * *Args*    :
+        #   - +json_array+ -> the api response in an array
+        #
+        # * *Returns* :
+        #   - an Array containing String
+        ###
+        def create_spell_correction(json_array, _query)
+          json_array
+        end
+
         ###
         # this methods initiates the category manager
         #

data/lib/AboutYou/query.rb

@@ -60,7 +60,8 @@ module AboutYou
           'get_order'      => 'create_order',
           'initiate_order' => 'initiate_order',
           'child_apps'     => 'create_child_apps',
-          'live_variant'   => 'create_variants_result'
+          'live_variant'   => 'create_variants_result',
+          'did_you_mean'   => 'create_spell_correction'
         }
       end
 

data/lib/AboutYou/query_builder.rb

@@ -490,6 +490,34 @@ module AboutYou
 
         self
       end
+      
+      ###
+      # builds the spell_correction
+      #
+      # * *Args*    :
+      #   - +searchword+ -> the search string to search for
+      #   - +category_ids+ -> the cat ids to filter for
+      #
+      # * *Returns* :
+      #   - Instance of AboutYou::SDK::Query
+      ###
+      def fetch_spell_correction(searchword, category_ids = nil)
+        fail 'InvalidArgumentException! searchword must be a string' unless
+        searchword.is_a?(String)
+
+        options = {
+            'searchword' => searchword
+        }
+        options['filter'] = {
+            'categories' => category_ids
+        } unless category_ids.empty?
+
+        query.push(
+            'did_you_mean' => options
+        )
+
+        self
+      end
 
       ###
       # builds the child_apps-query

data/lib/aboutyou-sdk.rb

@@ -117,7 +117,7 @@ class AY
   def add_item_to_basket(session_id, variant_id, amount = 1)
     basket = AboutYou::SDK::Model::Basket.new
 
-    unless variant_id.is_a?(Long)
+    unless variant_id.is_a?(Integer)
       if variant_id.is_a?(String) && variant_id[/\d/]
         variant_id = Integer(variant_id)
       else
@@ -222,6 +222,34 @@ class AY
   )
     query.fetch_autocomplete(searchword, limit, types).execute_single
   end
+  
+  ###
+  # Returns the result of an spell correction API request.
+  # spell correction searches for products by a given searchword.
+  # You might filter by category ids aswell.
+  #
+  # * *Args*    :
+  #   - +searchword+ -> The prefix search word to search for
+  #   - +category_ids+ -> The category ids used as a filter [optional]
+  #
+  # * *Returns* :
+  #   - Array of Strings
+  ###
+  def fetch_spell_correction(searchword, category_ids = nil)
+    unless category_ids.nil?
+      # we allow to pass a single ID instead of an array
+      category_ids = Array(category_ids)
+
+      category_ids.each do |cat_id|
+        fail 'InvalidArgumentException! A single category ID must be an integer
+          or a numeric string' unless cat_id.is_a?(Integer) || cat_id[/\d/]
+        fail '\InvalidArgumentException! A single category ID must be greater
+          than 0' if cat_id < 1
+      end
+    end
+
+    query.fetch_spell_correction(searchword, category_ids).execute_single
+  end
 
   ###
   # Fetch the basket of the given session_id.

data/tests/Sinatra-test/Main.rb

@@ -50,4 +50,7 @@ get "/blogTest" do
 end
 get "/filterByFacetIds" do
   erb :docExampleFilterByFacetIds
+end
+get "/docExampleSpellCorrection" do
+  erb :testDocExampleSpellCorrection
 end

data/tests/testAutocomplete.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 class AY
   attr_accessor :result

data/tests/testCatFilter.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 class AY
   attr_accessor :result

data/tests/testCatTree.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 class AY
   attr_accessor :result

data/tests/testCategoryCaching.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 get "/doCache" do
   shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', AboutYou::SDK::CacheProvider::Dalli.new(Dalli::Client.new))

data/tests/testDalliCache.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 get "/doCache" do
   shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', AboutYou::SDK::CacheProvider::Dalli.new(Dalli::Client.new))

data/tests/testFacetTypes.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb'
+require_relative '../lib/aboutyou-sdk.rb'
 
 class AY
   attr_accessor :result

data/tests/testFacets.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testFetchFacet.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testJavaScript.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testProdCatLongestPath.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testProductSearchResult.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testProductsByEans.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testProductsByIds.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testRedisCache.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative'../lib/ay.rb'
+require_relative'../lib/aboutyou-sdk.rb'
 
 get "/doCache" do
   shop = AY.new(281, 'e6068c4ca020262613d06122663cb300', 'sessionId', AboutYou::SDK::CacheProvider::Redis.new(Redis.new))

data/tests/testSuggest.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

data/tests/testVariantsByIds.rb

@@ -1,5 +1,5 @@
 require 'sinatra'
-require_relative '../lib/ay.rb' 
+require_relative '../lib/aboutyou-sdk.rb' 
 
 class AY
   attr_accessor :result

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aboutyou-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Ferenc Beutel