searchkick 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9994b20546ec9b93a6fe9b34a0e329868aa3371b
-  data.tar.gz: 77ab1a591fe5e599b3d640d271aafe3f0642b47d
+  metadata.gz: 777b21bb34049337d1ee1c20fcf51eeaf94ab604
+  data.tar.gz: 9219dfb5026333d38ce0486f5dbee7d2b3d54838
 SHA512:
-  metadata.gz: 8cf24561e0d7d871311b6ec5d50f115d654ce64c77422c1e51a07d13831b3ae81327ff1505d59d1b707d6b4926fad61e094178e703ee7a454cffafaf80b77464
-  data.tar.gz: 95a15798d483c444398a88c6940e88275eceb850231e869a272ab0bbc659089ca651780eba84ab5ac95f9a24aa1a8aed3e05da88474e6b093aedd265e69c7c7a
+  metadata.gz: 9461e485b83ecf1169e9bb305c5296e9484d8bfc6b141b204b9870698cd8efe3f79a43687758c87ed390ba9bf15bcec227111a3ed3075d1aceb71bca38093b0d
+  data.tar.gz: 85c318dae06729ff723e27dcbcf19906f09418d7b90d7a00bfd7ad50f20a3e6f860faedbeb4d486809b47bf8ac687afb7c8e87b7917d5bddc0686f04fef756f5

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.4.2
+
+- Added support for directional synonyms
+- Easier AWS setup
+- Fixed `total_docs` method for ES 5+
+- Fixed exception on update errors
+
 ## 1.4.1
 
 - Added `partial_reindex` method

data/README.md

@@ -285,6 +285,35 @@ end
 
 Call `Product.reindex` after changing synonyms.
 
+For directional synonyms, use:
+
+```ruby
+synonyms: ["lightbulb => halogenlamp"]
+```
+
+### Tags and Dynamic Synonyms
+
+The above approach works well when your synonym list is static, but in practice, this is often not the case. When you analyze search conversions, you often want to add new synonyms or tags without a full reindex. You can use a library like [ActsAsTaggableOn](https://github.com/mbleigh/acts-as-taggable-on) and do:
+
+```ruby
+class Product < ActiveRecord::Base
+  acts_as_taggable
+  scope :search_import, -> { includes(:tags) }
+
+  def search_data
+    {
+      name_tagged: "#{name} #{tags.map(&:name).join(" ")}"
+    }
+  end
+end
+```
+
+Search with:
+
+```ruby
+Product.search query, fields: [:name_tagged]
+```
+
 ### WordNet
 
 Prepopulate English synonyms with the [WordNet database](https://en.wikipedia.org/wiki/WordNet).
@@ -930,6 +959,14 @@ Dog.search "airbudd", suggest: true # suggestions for all animals
 
 ## Debugging Queries
 
+To help with debugging queries, you can use:
+
+```ruby
+Product.search("soap", debug: true)
+```
+
+This prints useful info to `stdout`.
+
 See how Elasticsearch scores your queries with:
 
 ```ruby
@@ -1012,18 +1049,11 @@ gem 'faraday_middleware-aws-signers-v4'
 and add to your initializer:
 
 ```ruby
-require "faraday_middleware/aws_signers_v4"
-Searchkick.client =
-  Elasticsearch::Client.new(
-    url: ENV["ELASTICSEARCH_URL"],
-    transport_options: {request: {timeout: 10}}
-  ) do |f|
-    f.request :aws_signers_v4, {
-      credentials: Aws::Credentials.new(ENV["AWS_ACCESS_KEY_ID"], ENV["AWS_SECRET_ACCESS_KEY"]),
-      service_name: "es",
-      region: "us-east-1"
-    }
-  end
+Searchkick.aws_credentials = {
+  access_key_id: ENV["AWS_ACCESS_KEY_ID"],
+  secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
+  region: "us-east-1"
+}
 ```
 
 Then deploy and reindex:

data/lib/searchkick.rb

@@ -31,6 +31,7 @@ module Searchkick
   class << self
     attr_accessor :search_method_name, :wordnet_path, :timeout, :models
     attr_writer :client, :env, :search_timeout
+    attr_reader :aws_credentials
   end
   self.search_method_name = :search
   self.wordnet_path = "/var/lib/wn_s.pl"
@@ -46,6 +47,11 @@ module Searchkick
         transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}}
       ) do |f|
         f.use Searchkick::Middleware
+        f.request :aws_signers_v4, {
+          credentials: Aws::Credentials.new(aws_credentials[:access_key_id], aws_credentials[:secret_access_key]),
+          service_name: "es",
+          region: aws_credentials[:region] || "us-east-1"
+        } if aws_credentials
       end
     end
   end
@@ -93,6 +99,12 @@ module Searchkick
     end
   end
 
+  def self.aws_credentials=(creds)
+    require "faraday_middleware/aws_signers_v4"
+    @aws_credentials = creds
+    @client = nil # reset client
+  end
+
   # private
   def self.queue_items(items)
     queued_items.concat(items)
@@ -112,7 +124,7 @@ module Searchkick
       response = client.bulk(body: items)
       if response["errors"]
         first_with_error = response["items"].map do |item|
-          (item["index"] || item["delete"])
+          (item["index"] || item["delete"] || item["update"])
         end.find { |item| item["error"] }
         raise Searchkick::ImportError, "#{first_with_error["error"]} on item with id '#{first_with_error["_id"]}'"
       end

data/lib/searchkick/index.rb

@@ -177,7 +177,6 @@ module Searchkick
         client.search(
           index: name,
           body: {
-            fields: [],
             query: {match_all: {}},
             size: 0
           }

data/lib/searchkick/index_options.rb

@@ -179,7 +179,7 @@ module Searchkick
         if synonyms.any?
           settings[:analysis][:filter][:searchkick_synonym] = {
             type: "synonym",
-            synonyms: synonyms.select { |s| s.size > 1 }.map { |s| s.join(",") }
+            synonyms: synonyms.select { |s| s.size > 1 }.map { |s| s.is_a?(Array) ? s.join(",") : s }
           }
           # choosing a place for the synonym filter when stemming is not easy
           # https://groups.google.com/forum/#!topic/elasticsearch/p7qcQlgHdB8

data/lib/searchkick/query.rb

@@ -132,21 +132,23 @@ module Searchkick
         pp options
         puts
 
-        puts "Model Search Data"
-        begin
-          pp klass.first(3).map { |r| {index: searchkick_index.record_data(r).merge(data: searchkick_index.send(:search_data, r))}}
-        rescue => e
-          puts "#{e.class.name}: #{e.message}"
-        end
-        puts
+        if searchkick_index
+          puts "Model Search Data"
+          begin
+            pp klass.first(3).map { |r| {index: searchkick_index.record_data(r).merge(data: searchkick_index.send(:search_data, r))}}
+          rescue => e
+            puts "#{e.class.name}: #{e.message}"
+          end
+          puts
 
-        puts "Elasticsearch Mapping"
-        puts JSON.pretty_generate(searchkick_index.mapping)
-        puts
+          puts "Elasticsearch Mapping"
+          puts JSON.pretty_generate(searchkick_index.mapping)
+          puts
 
-        puts "Elasticsearch Settings"
-        puts JSON.pretty_generate(searchkick_index.settings)
-        puts
+          puts "Elasticsearch Settings"
+          puts JSON.pretty_generate(searchkick_index.settings)
+          puts
+        end
 
         puts "Elasticsearch Query"
         puts to_curl

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/test/synonyms_test.rb

@@ -51,4 +51,12 @@ class SynonymsTest < Minitest::Test
     store_names ["Creature", "Beast", "Dragon"], Animal
     assert_search "animal", ["Creature", "Beast"], {}, Animal
   end
+
+  def test_directional
+    store_names ["Lightbulb", "Green Onions", "Led"]
+    assert_search "led", ["Lightbulb", "Led"]
+    assert_search "Lightbulb", ["Lightbulb"]
+    assert_search "Halogen Lamp", ["Lightbulb"]
+    assert_search "onions", ["Green Onions"]
+  end
 end

data/test/test_helper.rb

@@ -273,7 +273,9 @@ class Product
       ["saranwrap", "plasticwrap"],
       ["qtip", "cottonswab"],
       ["burger", "hamburger"],
-      ["bandaid", "bandag"]
+      ["bandaid", "bandag"],
+      "lightbulb => led,lightbulb",
+      "lightbulb => halogenlamp"
     ],
     autocomplete: [:name],
     suggest: [:name, :color],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel