algoliasearch-rails 1.12.1 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0687fa4b4aca95ec66bd4510bad437cbc246232
-  data.tar.gz: 1e37ff5b68c78600c40518ff1567b2a7678a009f
+  metadata.gz: ff6182784c89b9f5b8b139e15939bcc3aab827d5
+  data.tar.gz: f5d523d2c98723a91ade26e2a4945bdb41f81af7
 SHA512:
-  metadata.gz: 460f63d74615acde329a19f174527b60f4eed599ddff0eba4fd703ffb9ff751dce3cf7c8e09128452eff49ada7ee70ad8199bbf5eec3ae54168e6aed89df158a
-  data.tar.gz: a4c6fa6eaccc32d945c1f79d843d4f092e0f085cdd6cc38a9d447bd1c9ff533ed9dd068564afa05bf4e10ecc42fcf05114eaccfbbb4b5eff3d736a6273d58765
+  metadata.gz: 82f1d265c3d176f03b0ec53902dcc7a4ad22eb6f5b3b9811c17d07060638820ef3dccdddd2051df13f44df78bbcbac845fafbaaab9beb0bc1b4f771fc23442ed
+  data.tar.gz: 9217e898e4933f731bec9dc54841791bd45be21ef3d0a4fa7b65d46301a3392395237a930be7ec049f23c321f15905f8181dd34921d5876404be796249989048

data/.travis.yml

@@ -6,8 +6,8 @@ rvm:
 - 1.8.7
 - 1.9.3
 - 2.0.0
-- 2.1.0
-- 2.2.0
+- 2.1
+- 2.2
 - jruby
 - rbx-2
 env:

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2015-05-28 1.12.2
+
+      * Add a new `raise_on_failure` option, controlling whereas exceptions are raised while trying to reach Algolia's API.
+
 2015-05-12 1.12.1
 
       * Upgrade to algoliasearch-client-js 3.3.0

data/README.md

@@ -187,7 +187,7 @@ Options
 
 #### Auto-indexing & asynchronism
 
-Each time a record is saved; it will be - asynchronously - indexed. On the other hand, each time a record is destroyed, it will be - asynchronously - removed from the index.
+Each time a record is saved; it will be - asynchronously - indexed. On the other hand, each time a record is destroyed, it will be - asynchronously - removed from the index. That means that a network call with the ADD/DELETE operation is sent **synchronously** to the Algolia API but then the engine will **asynchronously** process the operation (so if you do a search just after, the results may not reflect it yet).
 
 You can disable auto-indexing and auto-removing setting the following options:
 
@@ -211,7 +211,7 @@ end
 Contact.reindex! # will use batch operations
 ```
 
-You can force indexing and removing to be synchronous by setting the following option:
+You can force indexing and removing to be synchronous (in that case the gem will call the `wait_task` method to ensure the operation has been taken into account once the method returns) by setting the following option: (this is **NOT** recommended, except for testing purpose)
 
 ```ruby
 class Contact < ActiveRecord::Base
@@ -223,6 +223,22 @@ class Contact < ActiveRecord::Base
 end
 ```
 
+#### Exceptions
+
+You can disable exceptions that could be raised while trying to reach Algolia's API by using the `raise_on_failure` option:
+
+```ruby
+class Contact < ActiveRecord::Base
+  include AlgoliaSearch
+
+  # only raise exceptions in development env
+  algoliasearch raise_on_failure: Rails.env.development? do
+    attribute :first_name, :last_name, :email
+  end
+end
+```
+
+
 #### Custom index name
 
 By default, the index name will be the class name, e.g. "Contact". You can customize the index name by using the `index_name` option:

data/VERSION

@@ -1 +1 @@
-1.12.1
+1.12.2

data/lib/algoliasearch-rails.rb

@@ -17,6 +17,8 @@ if defined? Rails
   end
 end
 
+require 'logger'
+
 module AlgoliaSearch
 
   class NotConfigured < StandardError; end
@@ -205,6 +207,58 @@ module AlgoliaSearch
     end
   end
 
+  # this class wraps an Algolia::Index object ensuring all raised exceptions
+  # are correctly logged or thrown depending on the `raise_on_failure` option
+  class SafeIndex
+    def initialize(name, raise_on_failure)
+      @index = ::Algolia::Index.new(name)
+      @raise_on_failure = raise_on_failure.nil? || raise_on_failure
+    end
+
+    ::Algolia::Index.instance_methods(false).each do |m|
+      define_method(m) do |*args|
+        SafeIndex.log_or_throw(m) do
+          @index.send(m, *args)
+        end
+      end
+    end
+
+    # special handling of wait_task to handle null task_id
+    def wait_task(task_id)
+      return if task_id.nil? && !@raise_on_failure # ok
+      SafeIndex.log_or_throw(:wait_task) do
+        @index.wait_task(task_id)
+      end
+    end
+
+    # expose move as well
+    def self.move_index(old_name, new_name)
+      SafeIndex.log_or_throw(:move_index) do
+        ::Algolia.move_index(old_name, new_name)
+      end
+    end
+
+    private
+    def self.log_or_throw(method, &block)
+      begin
+        yield
+      rescue Algolia::AlgoliaError => e
+        raise e if @raise_on_failure
+        # log the error
+        (Rails.logger || Logger.new(STDOUT)).error("[algoliasearch-rails] #{e.message}")
+        # return something
+        case method.to_s
+        when 'search'
+          # some attributes are required
+          { 'hits' => [], 'hitsPerPage' => 0, 'page' => 0, 'facets' => {}, 'error' => e }
+        else
+          # empty answer
+          { 'error' => e }
+        end
+      end
+    end
+  end
+
   # these are the class methods added when AlgoliaSearch is included
   module ClassMethods
 
@@ -353,7 +407,7 @@ module AlgoliaSearch
           tmp_index.save_objects(objects)
         end
 
-        move_task = ::Algolia.move_index(tmp_index.name, index_name)
+        move_task = SafeIndex.move_index(tmp_index.name, index_name)
         tmp_index.wait_task(move_task["taskID"]) if synchronous == true
       end
       nil
@@ -526,7 +580,7 @@ module AlgoliaSearch
       options ||= algoliasearch_options
       settings ||= algoliasearch_settings
       return @algolia_indexes[settings] if @algolia_indexes[settings]
-      @algolia_indexes[settings] = Algolia::Index.new(algolia_index_name(options))
+      @algolia_indexes[settings] = SafeIndex.new(algolia_index_name(options), algoliasearch_options[:raise_on_failure])
       current_settings = @algolia_indexes[settings].get_settings rescue nil # if the index doesn't exist
       if !algolia_indexing_disabled?(options) && (index_settings || algoliasearch_settings_changed?(current_settings, settings.to_settings))
         index_settings ||= settings.to_settings

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.12.2
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.14
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.15
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: AlgoliaSearch integration to your favorite ORM
@@ -117,9 +117,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .document
-- .rspec
-- .travis.yml
+- ".document"
+- ".rspec"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -172,17 +172,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM