searchkick 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edbfa8b338d8ddc3b4bcef4755151c98c7afeb30
-  data.tar.gz: aa1e1fbda8e995dfeb22cb005b5fc755020980bf
+  metadata.gz: 8b5ae6918d441a036655f1e686a97994c27cd3d0
+  data.tar.gz: 8bfc3d79c77b03afefb8791c0663bb26cd6e6bda
 SHA512:
-  metadata.gz: 531313b35dae913d8d999fe3283c2a2535ada666c58c567cc385ac6574dbec0015bf65f2dbacdc1ac07b18eaca31d40aa776d968d1cb36db16f06dc34de633af
-  data.tar.gz: c3bd0aaee05a28b95d2884104144bc7058f26bd3b2c5eba75c68b02022c203bd3326fdfe99702139d264d386f92879467afb69f783a354662f188ead85788086
+  metadata.gz: b3883c5f4da5b1012e41350f3cc5356c9570d3482d8b9e7fe2bfd660de54b4028cee9841259c23e2f9eace042eb7c0d523ef43afd27c118dce156990980b49ea
+  data.tar.gz: dd6cb042bd1de8627abe1f3aa61150684cf8f6d9235943b1b5f149d612fa26bface7b71ff019497ed76b0577019510bc6ff22ff152f78fde7de9443b81bb08ee

data/README.md

@@ -16,8 +16,6 @@ Plus:
 - reindex without downtime
 - continually improve results from conversions - **pretty awesome**
 
-Powered by Elasticsearch
-
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com)
 
 ## Get Started
@@ -54,7 +52,6 @@ And to query, use:
 products = Product.search "2% Milk"
 products.each do |product|
   puts product.name
-  puts product._score # added by searchkick - between 0 and 1
 end
 ```
 
@@ -147,7 +144,7 @@ Choose what data is indexed.
 
 ```ruby
 class Product < ActiveRecord::Base
-  def _source
+  def search_data
     as_json only: [:name, :active], include: {brand: {only: [:city]}}
     # or equivalently
     {
@@ -161,11 +158,11 @@ class Product < ActiveRecord::Base
 end
 ```
 
-Searchkick uses `find_in_batches` to import documents.  To eager load associations, use the `searchkick_import` scope.
+Searchkick uses `find_in_batches` to import documents.  To eager load associations, use the `search_import` scope.
 
 ```ruby
 class Product < ActiveRecord::Base
-  scope :searchkick_import, includes(:searches)
+  scope :search_import, includes(:searches)
 end
 ```
 
@@ -188,7 +185,7 @@ Add conversions to the index.
 class Product < ActiveRecord::Base
   has_many :searches
 
-  def _source
+  def search_data
     {
       name: name,
       conversions: searches.group("query").count
@@ -218,18 +215,32 @@ Product.search "2% Milk", facets: {store_id: {where: {in_stock: true}}}
 
 ## Deployment
 
-### Bonsai on Heroku
+### Heroku
 
-Install the add-on:
+Choose an add-on: [SearchBox](https://addons.heroku.com/searchbox), [Bonsai](https://addons.heroku.com/bonsai), or [Found](https://addons.heroku.com/foundelasticsearch).
 
 ```sh
+# SearchBox
+heroku addons:add searchbox:starter
+
+# Bonsai
 heroku addons:add bonsai
+
+# Found
+heroku addons:add foundelasticsearch
 ```
 
-And create an initializer `config/initializers/bonsai.rb` with:
+And create an initializer `config/initializers/elasticsearch.rb` with:
 
 ```ruby
+# SearchBox
+ENV["ELASTICSEARCH_URL"] = ENV["SEARCHBOX_URL"]
+
+# Bonsai
 ENV["ELASTICSEARCH_URL"] = ENV["BONSAI_URL"]
+
+# Found
+ENV["ELASTICSEARCH_URL"] = ENV["FOUNDELASTICSEARCH_URL"]
 ```
 
 Then deploy and reindex:

data/lib/searchkick/model.rb

@@ -13,18 +13,17 @@ module Searchkick
         tire do
           index_name options[:index_name] || [klass.model_name.plural, ENV["RACK_ENV"] || "development"].join("_")
         end
-        attr_accessor :_score
 
         def reindex
           update_index
         end
 
-        def _source
+        def search_data
           as_json
         end
 
         def to_indexed_json
-          source = _source
+          source = search_data
           if self.class.instance_variable_get("@searchkick_options")[:conversions] and source[:conversions]
             source[:conversions] = source[:conversions].map{|k, v| {query: k, count: v} }
           end

data/lib/searchkick/reindex.rb

@@ -10,7 +10,7 @@ module Searchkick
       index.create searchkick_index_options
 
       # use scope for import
-      scope = respond_to?(:searchkick_import) ? searchkick_import : self
+      scope = respond_to?(:search_import) ? search_import : self
       scope.find_in_batches do |batch|
         index.import batch
       end

data/lib/searchkick/search.rb

@@ -137,9 +137,6 @@ module Searchkick
           end
         end
 
-      collection.each_with_hit do |model, hit|
-        model._score = hit["_score"].to_f / collection.max_score
-      end
       collection
     end
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/searchkick_test.rb

@@ -14,10 +14,9 @@ class Product < ActiveRecord::Base
     ],
     settings: {
       number_of_shards: 1
-    },
-    conversions: true
+    }
 
-  def _source
+  def search_data
     as_json.merge conversions: searches.group("query").count
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane