algoliasearch-rails 1.15.1 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e2aa7b700a1456246e3433c6b6c8a36803df9de
-  data.tar.gz: 2fe47b07529091cb7854dad7e4bbdb253bab934d
+  metadata.gz: 896c5f230813d18ff8e9690822d0a4306333db91
+  data.tar.gz: aebeff6835f6dd017dede213dcce29671cf3ef6b
 SHA512:
-  metadata.gz: a9256c815fa8fcd96eb7702a446f9b8d5f592c6f668b773816478f11495e5ffcfc3fd7ffbb0eeca2864a6bed654f6432eecba0b5eec9605b2a0d61bcd40d361c
-  data.tar.gz: b7bf19b0adade7b484fde9f1084ad7e66dd8a3cce947bd3df65c856f26b55f19663e6f45f0b84a433b63e3e9b204c247013039a6c9516ef0b08cd41dec815b18
+  metadata.gz: 5e53db4e89af8d4ed8432f6cb918d62050348d7ebc6ee54f42839714a695f0199a7c6c65d17e1a9341c88b76751b305eca24919dbd7f91f0e765388215ecbe11
+  data.tar.gz: 7a11bf529e54d4b2024b0e0947baa7d1c985246945eafc910513301b7a79525609dd102f465119a9e68ca09ddc5e047966ba43e743467b905dfb9a4aba3efaa8

data/.travis.yml

@@ -38,6 +38,8 @@ matrix:
   #   env: RAILS_VERSION=4.2
   # - rvm: rbx-3.20
   #   env: RAILS_VERSION=5.0
+  allow_failures:
+  - rvm: rbx-2
 install: rm -f Gemfile.lock && bundle install
 cache: bundler
 env:

data/ChangeLog

@@ -1,5 +1,10 @@
 CHANGELOG
 
+2016-10-02 1.16.0
+
+      * Upgrade `algoliasearch` to 1.12.0
+      * Add `search_facet` method
+
 2016-10-02 1.15.1
 
       * Missing `advancedSyntax` index setting forward

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem 'json', '~> 1.5', '>= 1.5.1'
-gem 'algoliasearch', '~> 1.11.0'
+gem 'algoliasearch', '~> 1.12.0'
 gem 'rubysl', '~> 2.0', :platform => :rbx
 
 group :test do
@@ -13,11 +13,18 @@ group :test do
     gem 'addressable', '<= 2.2.7'
     gem 'rack-cache', '< 1.3'
     gem 'mime-types', '< 2.6'
+    gem 'net-http-persistent', '< 3.0'
   elsif defined?(RUBY_VERSION) && RUBY_VERSION == "1.9.3"
     if Gem::Version.new(ENV['RAILS_VERSION'] || '3.2.0') >= Gem::Version.new('4.0')
       gem 'mime-types', '~> 2.6'
     end
   end
+  if defined?(RUBY_VERSION) &&
+     defined?(RUBY_ENGINE) &&
+     RUBY_ENGINE == 'ruby' &&
+     Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1')
+    gem 'net-http-persistent', '< 3.0'
+  end
   gem 'rspec', '>= 2.5.0', '< 3.0'
   gem 'sqlite3', :platform => [:rbx, :ruby]
   gem 'jdbc-sqlite3', :platform => :jruby

data/Gemfile.lock

@@ -39,8 +39,8 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.4.0)
-    algoliasearch (1.11.0)
-      httpclient (~> 2.8.2)
+    algoliasearch (1.12.0)
+      httpclient (~> 2.8.2.4)
       json (>= 1.5.1)
     arel (7.1.0)
     backports (3.6.8)
@@ -66,7 +66,7 @@ GEM
     globalid (0.3.6)
       activesupport (>= 4.1.0)
     highline (1.7.8)
-    httpclient (2.8.2.2)
+    httpclient (2.8.2.4)
     i18n (0.7.0)
     json (1.8.3)
     kaminari (0.17.0)
@@ -372,7 +372,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord-jdbc-adapter
   activerecord-jdbcsqlite3-adapter
-  algoliasearch (~> 1.11.0)
+  algoliasearch (~> 1.12.0)
   jdbc-sqlite3
   json (~> 1.5, >= 1.5.1)
   kaminari

data/README.md

@@ -7,7 +7,7 @@ Algolia Search for Rails
 
 This gem let you easily integrate the Algolia Search API to your favorite ORM. It's based on the [algoliasearch-client-ruby](https://github.com/algolia/algoliasearch-client-ruby) gem. Rails 3.x, 4.x and 5.x are all supported.
 
-You might be interested in the sample Ruby on Rails application providing a ```autocomplete.js```-based auto-completion and ```instantsearch.js```-based instant search results page: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
+You might be interested in the sample Ruby on Rails application providing a `autocomplete.js`-based auto-completion and `instantsearch.js`-based instant search results page: [algoliasearch-rails-example](https://github.com/algolia/algoliasearch-rails-example/).
 
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-rails.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-rails) [![Gem Version](https://badge.fury.io/rb/algoliasearch-rails.svg)](http://badge.fury.io/rb/algoliasearch-rails) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-rails.svg)](https://codeclimate.com/github/algolia/algoliasearch-rails) ![ActiveRecord](https://img.shields.io/badge/ActiveRecord-yes-blue.svg?style=flat-square) ![Mongoid](https://img.shields.io/badge/Mongoid-yes-blue.svg?style=flat-square) ![Sequel](https://img.shields.io/badge/Sequel-yes-blue.svg?style=flat-square)
 
@@ -28,6 +28,7 @@ Table of Content
 1. [Tags](#tags)
 1. [Search](#search)
 1. [Faceting](#faceting)
+1. [Facet search](#facet-search)
 1. [Group by](#group-by)
 1. [Geo-search](#geo-search)
 1. [Caveats](#caveats)
@@ -161,7 +162,7 @@ Traditional search implementations tend to have search logic and functionality o
 
 Implementing search on the backend is no longer necessary. In fact, in most cases it is harmful to performance because of added network and processing latency. We highly recommend the usage of our [JavaScript API Client](https://github.com/algolia/algoliasearch-client-js) issuing all search requests directly from the end user's browser, mobile device, or client. It will reduce the overall search latency while offloading your servers at the same time.
 
-The JS API client is part of the gem, just require ```algolia/v3/algoliasearch.min``` somewhere in your JavaScript manifest, for example in ```application.js``` if you are using Rails 3.1+:
+The JS API client is part of the gem, just require `algolia/v3/algoliasearch.min` somewhere in your JavaScript manifest, for example in `application.js` if you are using Rails 3.1+:
 
 ```javascript
 //= require algolia/v3/algoliasearch.min
@@ -223,7 +224,7 @@ Then, as soon as you use the `search` method, the returning results will be a pa
 
 ### Notes
 
-All methods injected by the ```AlgoliaSearch``` include are prefixed by ```algolia_``` and aliased to the associated short names if they aren't already defined.
+All methods injected by the `AlgoliaSearch` include are prefixed by `algolia_` and aliased to the associated short names if they aren't already defined.
 
 ```ruby
 Contact.algolia_reindex! # <=> Contact.reindex!
@@ -472,7 +473,7 @@ class Profile < ActiveRecord::Base
 end
 ```
 
-### Custom ```objectID```
+### Custom `objectID`
 
 By default, the `objectID` is based on your record's `id`. You can change this behavior specifying the `:id` option (be sure to use a uniq field).
 
@@ -487,7 +488,7 @@ end
 
 ### Restrict indexing to a subset of your data
 
-You can add constraints controlling if a record must be indexed by using options the ```:if``` or ```:unless``` options.
+You can add constraints controlling if a record must be indexed by using options the `:if` or `:unless` options.
 
 It allows you to do conditional indexing on a per document basis.
 
@@ -508,7 +509,7 @@ class Post < ActiveRecord::Base
 end
 ```
 
-**Notes:** As soon as you use those constraints, ```addObjects``` and ```deleteObjects``` calls will be performed in order to keep the index synced with the DB (The state-less gem doesn't know if the object don't match your constraints anymore or never matched, so we force ADD/DELETE operations to be sent). You can work-around this behavior creating a `_changed?` method:
+**Notes:** As soon as you use those constraints, `addObjects` and `deleteObjects` calls will be performed in order to keep the index synced with the DB (The state-less gem doesn't know if the object don't match your constraints anymore or never matched, so we force ADD/DELETE operations to be sent). You can work-around this behavior creating a `_changed?` method:
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -543,7 +544,7 @@ MyModel.index_objects MyModel.limit(5)
 
 ### Sanitizer
 
-You can sanitize all your attributes using the ```sanitize``` option. It will strip all HTML tags from your attributes.
+You can sanitize all your attributes using the `sanitize` option. It will strip all HTML tags from your attributes.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -565,7 +566,7 @@ gem 'rails-html-sanitizer'
 
 ### UTF-8 Encoding
 
-You can force the UTF-8 encoding of all your attributes using the ```force_utf8_encoding``` option:
+You can force the UTF-8 encoding of all your attributes using the `force_utf8_encoding` option:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -875,7 +876,7 @@ p json_answer['hits']
 p json_answer['facets']
 ```
 
-Search parameters can be specified either through the index's [settings](https://github.com/algolia/algoliasearch-client-ruby#index-settings) statically in your model or dynamically at search time specifying [search parameters](https://github.com/algolia/algoliasearch-client-ruby#search) as second argument of the ```search``` method:
+Search parameters can be specified either through the index's [settings](https://github.com/algolia/algoliasearch-client-ruby#index-settings) statically in your model or dynamically at search time specifying [search parameters](https://github.com/algolia/algoliasearch-client-ruby#search) as second argument of the `search` method:
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -892,6 +893,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
+
 ```ruby
 # dynamical search parameters
 p Contact.raw_search("jon doe", { :hitsPerPage => 5, :page => 2 })
@@ -899,7 +901,7 @@ p Contact.raw_search("jon doe", { :hitsPerPage => 5, :page => 2 })
 
 ### Faceting
 
-Facets can be retrieved calling the extra ```facets``` method of the search answer.
+Facets can be retrieved calling the extra `facets` method of the search answer.
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -914,6 +916,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
+
 ```ruby
 hits = Contact.search("jon doe", { :facets => '*' })
 p hits                    # ORM-compliant array of objects
@@ -922,11 +925,31 @@ p hits.facets['company']  # facet values+count of facet 'company'
 p hits.facets['zip_code'] # facet values+count of facet 'zip_code'
 ```
 
+
 ```ruby
 raw_json = Contact.raw_search("jon doe", { :facets => '*' })
 p raw_json['facets']
 ```
 
+### Facet search
+
+You can also search for facet values.
+
+```ruby
+Product.search_facet('category', 'Headphones') # Array of {value, highlighted, count}
+```
+
+This method can also take any parameter a query can take.
+This will adjust the search to only hits which would have matched the query.
+
+```ruby
+# Only sends back the categories containing red Apple products (and only counts those)
+Product.search_facet('category', 'phone', {
+  query: 'red',
+  filters: 'brand:Apple'
+}) # Array of phone categories linked to red Apple products
+```
+
 ### Group by
 
 More info on distinct for grouping can be found
@@ -964,7 +987,7 @@ At query time, specify <code>{ aroundLatLng: "37.33, -121.89", aroundRadius: 500
 
 ### Caveats
 
-This gem makes intensive use of Rails' callbacks to trigger the indexing tasks. If you're using methods bypassing ```after_validation```, ```before_save``` or ```after_commit``` callbacks, it will not index your changes. For example: ```update_attribute``` doesn't perform validations checks, to perform validations when updating use ```update_attributes```.
+This gem makes intensive use of Rails' callbacks to trigger the indexing tasks. If you're using methods bypassing `after_validation`, `before_save` or `after_commit` callbacks, it will not index your changes. For example: `update_attribute` doesn't perform validations checks, to perform validations when updating use `update_attributes`.
 
 ### Timeouts
 
@@ -986,7 +1009,7 @@ AlgoliaSearch.configuration = {
 
 To run the specs, please set the <code>ALGOLIA_APPLICATION_ID</code> and <code>ALGOLIA_API_KEY</code> environment variables. Since the tests are creating and removing indexes, DO NOT use your production account.
 
-You may want to disable all indexing (add, update & delete operations) API calls, you can set the ```disable_indexing``` option:
+You may want to disable all indexing (add, update & delete operations) API calls, you can set the `disable_indexing` option:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -1026,3 +1049,4 @@ describe 'With a mocked client' do
 
 end
 ```
+

data/VERSION

@@ -1 +1 @@
-1.15.1
+1.16.0

data/lib/algoliasearch-rails.rb

@@ -301,6 +301,7 @@ module AlgoliaSearch
         alias_method :clear_index!, :algolia_clear_index! unless method_defined? :clear_index!
         alias_method :search, :algolia_search unless method_defined? :search
         alias_method :raw_search, :algolia_raw_search unless method_defined? :raw_search
+        alias_method :search_facet, :algolia_search_facet unless method_defined? :search_facet
         alias_method :index, :algolia_index unless method_defined? :index
         alias_method :index_name, :algolia_index_name unless method_defined? :index_name
         alias_method :must_reindex?, :algolia_must_reindex? unless method_defined? :must_reindex?
@@ -600,6 +601,13 @@ module AlgoliaSearch
       res
     end
 
+    def algolia_search_facet(facet, text, params = {})
+      index_name = params.delete(:index) || params.delete('index') || params.delete(:slave) || params.delete('slave')
+      index = algolia_index(index_name)
+      query = Hash[params.map { |k, v| [k.to_s, v.to_s] }]
+      index.search_facet(facet, text, query)['facetHits']
+    end
+
     def algolia_index(name = nil)
       if name
         algolia_configurations.each do |o, s|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.16.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -183,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM
 test_files: []
-has_rdoc: