searchkick 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35f9202e63447e7c182bd2a34737e7a519888e91
-  data.tar.gz: 19a7a8d24dd5ff687687e235c64971cb979f42f2
+  metadata.gz: c83a41bfb177e764c6a5862ce0c4a2c44982986c
+  data.tar.gz: 1978b3e1fe918e5654c1b3835aa327abd76931b3
 SHA512:
-  metadata.gz: 762a4b1e6ce4a31e2a3d75ac235954222f26c3d5361d0bb8fd1504aeaf3f294c0f569a15208d1e2e38428715bdaa1bdc879356b2040bff5bb313f763e3091ccc
-  data.tar.gz: 1f7c6ea8338b6fe7479a22a55d523a753903fd703f142522806b83926be3cf3b20d10b1b2c39eb507657af97f48e84372d1c6cb102e10fe6a05ea40031eefe16
+  metadata.gz: f8bcea422ad62e709ff1639973d2cb9f729fef6d1103de9e9f0fa7fdbfe1099c0291544aa01256e5ddff44593b05bc4241fa4f377da5289082e19fbfa1c5fa02
+  data.tar.gz: bb797236441c2119490b05a8f4ee62afe98d69be313feec80e86a58256a2a4eb5c6d680ec7f78c84e0309f6e7b465c9c097e66d92fa9bb9889c83847483a1802

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.1
+
+- Added support for `{lat: lat, lon: lon}` as preferred format for locations
+
 ## 1.1.0
 
 - Added `below` option to misspellings to improve performance

data/README.md

@@ -29,13 +29,9 @@ Plus:
 
 [![Build Status](https://travis-ci.org/ankane/searchkick.svg?branch=master)](https://travis-ci.org/ankane/searchkick)
 
-We highly recommend tracking queries and conversions
-
-:zap: [Searchjoy](https://github.com/ankane/searchjoy) makes it easy
-
 ## Get Started
 
-[Install Elasticsearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
+[Install Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
 
 ```sh
 brew install elasticsearch
@@ -72,7 +68,7 @@ products.each do |product|
 end
 ```
 
-Searchkick supports the complete [Elasticsearch Search API](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html). As your search becomes more advanced, we recommend you use the [Elasticsearch DSL](#advanced) for maximum flexibility.
+Searchkick supports the complete [Elasticsearch Search API](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html). As your search becomes more advanced, we recommend you use the [Elasticsearch DSL](#advanced) for maximum flexibility.
 
 ### Queries
 
@@ -111,7 +107,7 @@ Order
 order: {_score: :desc} # most relevant first - default
 ```
 
-[All of these sort options are supported](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-sort.html)
+[All of these sort options are supported](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html)
 
 Limit / offset
 
@@ -303,13 +299,13 @@ You can change this with:
 Product.search "zucini", misspellings: {edit_distance: 2} # zucchini
 ```
 
-To improve performance for correctly spelled queries (which should be a majority for most applications), Searchkick can first perform a search without misspellings, and if there are few results, perform another with them. [master]
+To improve performance for correctly spelled queries (which should be a majority for most applications), Searchkick can first perform a search without misspellings, and if there are too few results, perform another with them.
 
 ```ruby
 Product.search "zuchini", misspellings: {below: 5}
 ```
 
-If there are fewer than 5 results, a 2nd search is performed for misspellings.
+If there are fewer than 5 results, a 2nd search is performed with misspellings enabled. The result of this query is returned.
 
 Turn off misspellings with:
 
@@ -426,33 +422,38 @@ class Image < ActiveRecord::Base
 end
 ```
 
-### Keep Getting Better
+### Analytics
 
-Searchkick uses conversion data to learn what users are looking for.  If a user searches for “ice cream” and adds Ben & Jerry’s Chunky Monkey to the cart (our conversion metric at Instacart), that item gets a little more weight for similar searches.
+We highly recommend tracking searches and conversions.
 
-The first step is to define your conversion metric and start tracking conversions.  The database works well for low volume, but feel free to use Redis or another datastore.
+[Searchjoy](https://github.com/ankane/searchjoy) makes it easy.
 
 ```ruby
-class Search < ActiveRecord::Base
-  belongs_to :product
-  # fields: id, query, searched_at, converted_at, product_id
-end
+Product.search "apple", track: {user_id: current_user.id}
 ```
 
+[See the docs](https://github.com/ankane/searchjoy) for how to install and use.
+
+### Keep Getting Better
+
+Searchkick can use conversion data to learn what users are looking for.  If a user searches for “ice cream” and adds Ben & Jerry’s Chunky Monkey to the cart (our conversion metric at Instacart), that item gets a little more weight for similar searches.
+
+The first step is to define your conversion metric and start tracking conversions.  The database works well for low volume, but feel free to use Redis or another datastore.
+
 You do **not** need to clean up the search queries.  Searchkick automatically treats `apple` and `APPLES` the same.
 
 Next, add conversions to the index.
 
 ```ruby
 class Product < ActiveRecord::Base
-  has_many :searches
+  has_many :searches, class_name: "Searchjoy::Search"
 
   searchkick conversions: "conversions" # name of field
 
   def search_data
     {
       name: name,
-      conversions: searches.group("query").count
+      conversions: searches.group(:query).uniq.count(:user_id)
       # {"ice cream" => 234, "chocolate" => 67, "cream" => 2}
     }
   end
@@ -471,14 +472,12 @@ Order results differently for each user.  For example, show a user’s previousl
 
 ```ruby
 class Product < ActiveRecord::Base
-
   def search_data
     {
       name: name,
       orderer_ids: orders.pluck(:user_id) # boost this product for these users
     }
   end
-
 end
 ```
 
@@ -488,7 +487,7 @@ Reindex and search with:
 Product.search "milk", boost_where: {orderer_ids: current_user.id}
 ```
 
-### Autocomplete
+### Instant Search / Autocomplete
 
 Autocomplete predicts what a user will type, making the search experience faster and easier.
 
@@ -499,15 +498,15 @@ Autocomplete predicts what a user will type, making the search experience faster
 First, specify which fields use this feature.  This is necessary since autocomplete can increase the index size significantly, but don’t worry - this gives you blazing faster queries.
 
 ```ruby
-class City < ActiveRecord::Base
-  searchkick match: :word_start
+class Book < ActiveRecord::Base
+  searchkick match: :word_start, searchable: [:title, :author]
 end
 ```
 
 Reindex and search with:
 
 ```ruby
-City.search "san fr", fields: [:name]
+Book.search "tipping poi"
 ```
 
 Typically, you want to use a JavaScript library like [typeahead.js](http://twitter.github.io/typeahead.js/) or [jQuery UI](http://jqueryui.com/autocomplete/).
@@ -517,10 +516,15 @@ Typically, you want to use a JavaScript library like [typeahead.js](http://twitt
 First, add a route and controller action.
 
 ```ruby
-# app/controllers/cities_controller.rb
-class CitiesController < ApplicationController
+# app/controllers/books_controller.rb
+class BooksController < ApplicationController
   def autocomplete
-    render json: City.search(params[:query], fields: [:name], limit: 10).map(&:name)
+    render json: Book.search(params[:query], {
+      fields: ["title^5", "author"],
+      limit: 10,
+      load: false,
+      misspellings: {below: 5}
+    }).map(&:title)
   end
 end
 ```
@@ -534,8 +538,8 @@ Then add the search box and JavaScript code to a view.
 <script src="typeahead.js"></script>
 <script>
   $("#query").typeahead({
-    name: "city",
-    remote: "/cities/autocomplete?query=%QUERY"
+    name: "book",
+    remote: "/books/autocomplete?query=%QUERY"
   });
 </script>
 ```
@@ -559,7 +563,7 @@ products.suggestions # ["peanut butter"]
 
 ### Aggregations
 
-[Aggregations](http://www.elasticsearch.org/guide/reference/api/search/facets/) provide aggregated search data.
+[Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-facets.html) provide aggregated search data.
 
 ![Aggregations](http://ankane.github.io/searchkick/facets.png)
 
@@ -757,7 +761,7 @@ Additional options, including fragment size, can be specified for each field:
 Band.search "cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 200}}}
 ```
 
-You can find available highlight options in the [Elasticsearch reference](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html#_highlighted_fragments).
+You can find available highlight options in the [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html#_highlighted_fragments).
 
 ### Similar Items
 
@@ -775,7 +779,7 @@ class City < ActiveRecord::Base
   searchkick locations: ["location"]
 
   def search_data
-    attributes.merge location: [latitude, longitude]
+    attributes.merge location: {lat: latitude, lon: longitude}
   end
 end
 ```
@@ -783,13 +787,13 @@ end
 Reindex and search with:
 
 ```ruby
-City.search "san", where: {location: {near: [37, -114], within: "100mi"}} # or 160km
+City.search "san", where: {location: {near: {lat: 37, lon: -114}, within: "100mi"}} # or 160km
 ```
 
 Bounded by a box
 
 ```ruby
-City.search "san", where: {location: {top_left: [38, -123], bottom_right: [37, -122]}}
+City.search "san", where: {location: {top_left: {lat: 38, lon: -123}, bottom_right: {lat: 37, lon: -122}}}
 ```
 
 ### Boost By Distance
@@ -797,13 +801,13 @@ City.search "san", where: {location: {top_left: [38, -123], bottom_right: [37, -
 Boost results by distance - closer results are boosted more
 
 ```ruby
-City.search "san", boost_by_distance: {field: :location, origin: [37, -122]}
+City.search "san", boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}}
 ```
 
-Also supports [additional options](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions)
+Also supports [additional options](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions)
 
 ```ruby
-City.search "san", boost_by_distance: {field: :location, origin: [37, -122], function: :linear, scale: "30mi", decay: 0.5}
+City.search "san", boost_by_distance: {field: :location, origin: {lat: 37, lon: -122}, function: :linear, scale: "30mi", decay: 0.5}
 ```
 
 ### Routing
@@ -893,7 +897,7 @@ Searchkick uses `ENV["ELASTICSEARCH_URL"]` for the Elasticsearch server.  This d
 
 ### Heroku
 
-Choose an add-on: [SearchBox](https://elements.heroku.com/addons/searchbox), [Bonsai](https://elements.heroku.com/addons/bonsai), or [Found](https://addons.heroku.com/foundelasticsearch).
+Choose an add-on: [SearchBox](https://elements.heroku.com/addons/searchbox), [Bonsai](https://elements.heroku.com/addons/bonsai), or [Found](https://elements.heroku.com/addons/foundelasticsearch).
 
 ```sh
 # SearchBox
@@ -917,18 +921,38 @@ heroku run rake searchkick:reindex CLASS=Product
 
 ### Amazon Elasticsearch Service
 
-You must use an [IP-based access policy](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-gsg-search.html) for Searchkick to work.
-
-Include `elasticsearch 1.0.14` or greater in your Gemfile.
+Include `elasticsearch 1.0.15` or greater in your Gemfile.
 
 ```ruby
-gem "elasticsearch", ">= 1.0.14"
+gem "elasticsearch", ">= 1.0.15"
 ```
 
 Create an initializer `config/initializers/elasticsearch.rb` with:
 
 ```ruby
-ENV["ELASTICSEARCH_URL"] = "http://es-domain-1234.us-east-1.es.amazonaws.com"
+ENV["ELASTICSEARCH_URL"] = "https://es-domain-1234.us-east-1.es.amazonaws.com"
+```
+
+To use signed request, include in your Gemfile:
+
+```ruby
+gem 'faraday_middleware-aws-signers-v4'
+```
+
+and add to your initializer:
+
+```ruby
+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
 ```
 
 Then deploy and reindex:
@@ -976,7 +1000,7 @@ Create an initializer `config/initializers/elasticsearch.rb` with multiple hosts
 Searchkick.client = Elasticsearch::Client.new(hosts: ["localhost:9200", "localhost:9201"], retry_on_failure: true)
 ```
 
-See [elasticsearch-transport](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
+See [elasticsearch-transport](https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
 
 ### Lograge
 
@@ -994,7 +1018,7 @@ See [Production Rails](https://github.com/ankane/production_rails) for other goo
 
 ## Advanced
 
-Prefer to use the [Elasticsearch DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) but still want awesome features like zero-downtime reindexing?
+Prefer to use the [Elasticsearch DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-queries.html) but still want awesome features like zero-downtime reindexing?
 
 ### Advanced Mapping
 
@@ -1147,7 +1171,7 @@ class Product < ActiveRecord::Base
 end
 ```
 
-Use [Okapi BM25](https://www.elastic.co/guide/en/elasticsearch/guide/current/pluggable-similarites.html) for ranking [master]
+Use [Okapi BM25](https://www.elastic.co/guide/en/elasticsearch/guide/current/pluggable-similarites.html) for ranking
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -1218,7 +1242,7 @@ Product.search "ah", misspellings: {prefix_length: 2} # ah, no aha
 
 ## Large Data Sets
 
-For large data sets, check out [Keeping Elasticsearch in Sync](https://www.found.no/foundation/keeping-elasticsearch-in-sync/).  Searchkick will make this easy in the future.
+For large data sets, check out [Keeping Elasticsearch in Sync](https://www.elastic.co/blog/found-keeping-elasticsearch-in-sync).  Searchkick will make this easy in the future.
 
 ## Testing
 
@@ -1314,7 +1338,7 @@ Before `0.3.0`, locations were indexed incorrectly. When upgrading, be sure to r
 
 ### Inconsistent Scores
 
-Due to the distributed nature of Elasticsearch, you can get incorrect results when the number of documents in the index is low.  You can [read more about it here](http://www.elasticsearch.org/blog/understanding-query-then-fetch-vs-dfs-query-then-fetch/).  To fix this, do:
+Due to the distributed nature of Elasticsearch, you can get incorrect results when the number of documents in the index is low.  You can [read more about it here](https://www.elastic.co/blog/understanding-query-then-fetch-vs-dfs-query-then-fetch).  To fix this, do:
 
 ```ruby
 class Product < ActiveRecord::Base

data/lib/searchkick/index.rb

@@ -568,10 +568,11 @@ module Searchkick
       # locations
       (options[:locations] || []).map(&:to_s).each do |field|
         if source[field]
-          if source[field].first.is_a?(Array) # array of arrays
-            source[field] = source[field].map { |a| a.map(&:to_f).reverse }
+          if !source[field].is_a?(Hash) && (source[field].first.is_a?(Array) || source[field].first.is_a?(Hash))
+            # multiple locations
+            source[field] = source[field].map { |a| location_value(a) }
           else
-            source[field] = source[field].map(&:to_f).reverse
+            source[field] = location_value(source[field])
           end
         end
       end
@@ -581,6 +582,16 @@ module Searchkick
       source.as_json
     end
 
+    def location_value(value)
+      if value.is_a?(Array)
+        value.map(&:to_f).reverse
+      elsif value.is_a?(Hash)
+        {lat: value[:lat].to_f, lon: value[:lon].to_f}
+      else
+        value
+      end
+    end
+
     # change all BigDecimal values to floats due to
     # https://github.com/rails/rails/issues/6033
     # possible loss of precision :/

data/lib/searchkick/query.rb

@@ -599,7 +599,7 @@ module Searchkick
               when :near
                 filters << {
                   geo_distance: {
-                    field => op_value.map(&:to_f).reverse,
+                    field => location_value(op_value),
                     distance: value[:within] || "50mi"
                   }
                 }
@@ -607,8 +607,8 @@ module Searchkick
                 filters << {
                   geo_bounding_box: {
                     field => {
-                      top_left: op_value.map(&:to_f).reverse,
-                      bottom_right: value[:bottom_right].map(&:to_f).reverse
+                      top_left: location_value(op_value),
+                      bottom_right: location_value(value[:bottom_right])
                     }
                   }
                 }
@@ -699,6 +699,14 @@ module Searchkick
       end
     end
 
+    def location_value(value)
+      if value.is_a?(Array)
+        value.map(&:to_f).reverse
+      else
+        value
+      end
+    end
+
     def below12?
       below_version?("1.2.0")
     end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/test/test_helper.rb

@@ -226,8 +226,8 @@ class Product
     serializable_hash.except("id").merge(
       conversions: conversions,
       user_ids: user_ids,
-      location: [latitude, longitude],
-      multiple_locations: [[latitude, longitude], [0, 0]],
+      location: {lat: latitude, lon: longitude},
+      multiple_locations: [{lat: latitude, lon: longitude}, {lat: 0, lon: 0}],
       aisle: aisle
     )
   end

data/test/where_test.rb

@@ -111,6 +111,14 @@ class WhereTest < Minitest::Test
     assert_search "san", ["San Francisco"], where: {location: {near: [37.5, -122.5]}}
   end
 
+  def test_near_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000}
+    ]
+    assert_search "san", ["San Francisco"], where: {location: {near: {lat: 37.5, lon: -122.5}}}
+  end
+
   def test_near_within
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
@@ -120,6 +128,15 @@ class WhereTest < Minitest::Test
     assert_search "san", ["San Francisco", "San Antonio"], where: {location: {near: [37, -122], within: "2000mi"}}
   end
 
+  def test_near_within_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_search "san", ["San Francisco", "San Antonio"], where: {location: {near: {lat: 37, lon: -122}, within: "2000mi"}}
+  end
+
   def test_top_left_bottom_right
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
@@ -128,6 +145,14 @@ class WhereTest < Minitest::Test
     assert_search "san", ["San Francisco"], where: {location: {top_left: [38, -123], bottom_right: [37, -122]}}
   end
 
+  def test_top_left_bottom_right_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000}
+    ]
+    assert_search "san", ["San Francisco"], where: {location: {top_left: {lat: 38, lon: -123}, bottom_right: {lat: 37, lon: -122}}}
+  end
+
   def test_multiple_locations
     store [
       {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
@@ -135,4 +160,12 @@ class WhereTest < Minitest::Test
     ]
     assert_search "san", ["San Francisco"], where: {multiple_locations: {near: [37.5, -122.5]}}
   end
+
+  def test_multiple_locations_hash
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000}
+    ]
+    assert_search "san", ["San Francisco"], where: {multiple_locations: {near: {lat: 37.5, lon: -122.5}}}
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Searchkick learns what your users are looking for. As more people search,
@@ -216,4 +216,3 @@ test_files:
 - test/synonyms_test.rb
 - test/test_helper.rb
 - test/where_test.rb
-has_rdoc: