elastic-rails 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a85d4715234d67d4dac798756ad8c63b62b8aeb2
-  data.tar.gz: fa4bb1a83eae9d73ab8c1ce7717f4232922bd6f0
+  metadata.gz: c0f277dfbb48f36dd5d37aec9678897754b6b348
+  data.tar.gz: 4f799186d83a23ab54aff5c11fcb482c461536e5
 SHA512:
-  metadata.gz: c95fda8f2273c68285ee7bfc02c7f5b01bceccdfef74c3ad2dfa86d8d5cd27420a4c4598c608ba535900c2268030dea3ced38bbed62db35a6b0f037c3630866d
-  data.tar.gz: 1600194a988639918c4810d0bfebf9be14c24c9b9f78eb2ed64b9f64ed8e46ae82c03c2b38d8c563f229f42910c2823284ec8fafd34097ff8bd41f1b77484c10
+  metadata.gz: 2a1ed07c2514ef377743f87b8761b1e4005529a56781e6441219e9010a98e9edb63b715d7dfdbeb641e0f058da8251d2a58a9b9bab0ef86f8ad96b40f82d7432
+  data.tar.gz: 86955585a269003324f70a85fea21bcffcd4fb284a3c50655bc078958c0b845569f5ea2f7b4c6978b1dfd78925d4bf579cefa84ebf1a9cbd7634bc5b244a5d9e

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'elastic'
+gem 'elastic-rails'
 ```
 
 And then execute:
@@ -18,10 +18,49 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install elastic
+    $ gem install elastic-rails
+
+Finally execute the initialization script:
+
+    $ rails g es:init
 
 ## Usage
 
+Start by creating an index over a model (You can also index non-activerecord objects)
+
+    rails g es:index Bike
+
+This will generate a new index definition file in `app/indices`
+
+Add some fields to the index
+
+TODO
+
+Every time you create or change and index you will neeed to synchronize the Elasticsearch index mappings:
+
+     rake es:migrate
+
+If you already have some data that needs to be indexed then run the reindex task:
+
+     rake es:reindex
+
+To add additional data call the index `import` or the model's `index_now` or `index_later` methods:
+
+```ruby
+some_bike.index_now # this will reindex only one record
+some_bike.index_later # this will queue a reindexing job on the record
+BikeIndex.import([bike_1, bike_2, bike_3]) # this will perform a bulk insertion
+```
+
+After some data has been added you can start searching:
+
+```ruby
+BikeIndex.must(brand: 'Trek', size: 'M').should(year: { gte: 2015 }).avg(:price)
+
+BikeIndex.must(origin: 'China').segment(:brand).each { |brand, bikes|   }
+```
+
+
 TODO: Write usage instructions here
 
 ## Development

data/lib/elastic/commands/import_index_documents.rb

@@ -1,6 +1,6 @@
 module Elastic::Commands
   class ImportIndexDocuments < Elastic::Support::Command.new(
-    :index, collection: nil, cache_size: 10000, verbose: false
+    :index, collection: nil, batch_size: 10000, verbose: false
   )
     def perform
       if collection.present?
@@ -27,7 +27,7 @@ module Elastic::Commands
 
     def queue(_object)
       cache << render_for_es(_object)
-      flush if cache.length >= cache_size
+      flush if cache.length >= batch_size
     end
 
     def flush

data/lib/elastic/configuration.rb

@@ -4,7 +4,8 @@ module Elastic
       host: '127.0.0.1',
       port: 9200,
       page_size: 20,
-      coord_similarity: true
+      coord_similarity: true,
+      import_batch_size: 10_000
     }
 
     extend self
@@ -47,6 +48,10 @@ module Elastic
       @config[:logger] || default_logger
     end
 
+    def import_batch_size
+      @config[:import_batch_size]
+    end
+
     private
 
     def config

data/lib/elastic/core/adaptor.rb

@@ -67,7 +67,10 @@ module Elastic::Core
         { 'index' => doc.merge('_index' => index_name) }
       end
 
-      api_client.bulk body: body
+      retry_on_temporary_error('bulk indexing') do
+        api_client.bulk body: body
+      end
+
       self
     end
 
@@ -90,6 +93,17 @@ module Elastic::Core
 
     private
 
+    def retry_on_temporary_error(_action, retries: 3)
+      return yield
+    rescue Elasticsearch::Transport::Transport::Errors::ServiceUnavailable,
+           Elasticsearch::Transport::Transport::Errors::GatewayTimeout => exc
+      raise if retries <= 0
+
+      Configuration.logger.warn("#{exc.class} error during '#{_action}', retrying!")
+      retries -= 1
+      retry
+    end
+
     def api_client
       Elastic::Configuration.api_client
     end

data/lib/elastic/type.rb

@@ -18,6 +18,14 @@ module Elastic
       @suffix = _value
     end
 
+    def self.import_batch_size
+      @import_batch_size || Configuration.import_batch_size
+    end
+
+    def self.import_batch_size=(_value)
+      @import_batch_size = _value
+    end
+
     def self.adaptor
       @adaptor ||= Elastic::Core::Adaptor.new(suffix)
     end
@@ -26,17 +34,31 @@ module Elastic
       @mapping ||= load_mapping
     end
 
-    def self.reindex(verbose: true)
+    def self.reindex(verbose: true, batch_size: nil)
       drop
       mapping.migrate
-      Commands::ImportIndexDocuments.for index: self, verbose: verbose
+      batch_size = batch_size || import_batch_size
+
+      Commands::ImportIndexDocuments.for(
+        index: self,
+        verbose: verbose,
+        batch_size: batch_size
+      )
+
       ensure_full_mapping
       self
     end
 
-    def self.import(_collection)
+    def self.import(_collection, batch_size: nil)
       enforce_mapping!
-      Commands::ImportIndexDocuments.for index: self, collection: _collection
+      batch_size = batch_size || import_batch_size
+
+      Commands::ImportIndexDocuments.for(
+        index: self,
+        collection: _collection,
+        batch_size: batch_size
+      )
+
       ensure_full_mapping
       self
     end

data/lib/elastic/version.rb

@@ -1,3 +1,3 @@
 module Elastic
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch