elasticsearch-documents 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09242c5b4dacbea5a8df8b92589cf7da49491d1c
-  data.tar.gz: b26f6777634d3e6e37207eafb0ed96e1def983d7
+  metadata.gz: d5c254c644e1b8f9f4649a463816664305479ce7
+  data.tar.gz: d37eb314977344a51a554bd20799f924c954e4cc
 SHA512:
-  metadata.gz: 5d7bb17681d33ef53bc909f4089be04971ca9f3b8f355a689f179cf5918ec7e36d1365de24c35aa05920f8ea50df01cef220e36364e17e433c4ac4e856339432
-  data.tar.gz: c778f6377d6243a1999c4edb25daf9a0c3a768f1d8ccd42756c520021d0f6bc0b59e8fdbf37bc9e8f68a2ab7dab2ec6e0d2740f98ea1df9718d7eb516f2b0826
+  metadata.gz: 5101e3b59ff7ef130591279d0076c0480eeabe93cff21c19f69fffc5f3ba0bed89f87ba1f92c1ed90000c347d37725cb28098c1dbbd6b338e43318231eeccc9c
+  data.tar.gz: e6a6e3980de1d94f54a4976ef558371e468dd1b126c7260c01ed500a1a2389670ced05b63c96da99e50ce57e0e473710e3175706b57d53a6c365d04315a16cf3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+

data/README.md

@@ -1,6 +1,9 @@
 # Elasticsearch::Extensions::Documents
 
-A service wrapper to manage Elasticsearch index documents
+A service wrapper to manage Elasticsearch index documents. Built on the
+[`elasticsearch-ruby`][es-ruby-gem] Gem.
+
+[![Build Status](https://travis-ci.org/ryanhouston/elasticsearch-documents.png?branch=master)](https://travis-ci.org/ryanhouston/elasticsearch-documents)
 
 ## Installation
 
@@ -19,7 +22,8 @@ Or install it yourself as:
 ## Configuration
 
 Before making any calls to Elasticsearch you need to configure the `Documents`
-extension.
+extension. Configuration options namespaced under 'client' are passed through to
+[`Elasticsearch::Client`](https://github.com/elasticsearch/elasticsearch-ruby/blob/a7bbdbf2a96168c1b33dca46ee160d2d4d75ada0/elasticsearch-transport/lib/elasticsearch/transport/client.rb).
 
 ```ruby
 ES_MAPPINGS = {
@@ -42,12 +46,11 @@ ES_SETTINGS = {
 }
 
 Elasticsearch::Extensions::Documents.configure do |config|
-  config.url        = 'http://example.com:9200' # your elasticsearch endpoint
   config.index_name = 'test_index'              # the name of your index
   config.mappings   = ES_MAPPINGS               # a hash containing your index mappings
   config.settings   = ES_SETTINGS               # a hash containing your index settings
-  config.logger     = Logger.new(STDOUT)        # the logger to use. (defaults to Logger.new(STDOUT)
-  config.log        = true                      # if the elasticsearch-ruby should provide logging
+  config.client.url = 'http://example.com:9200' # your elasticsearch endpoint
+  config.client.logger = Rails.logger           # the logger to use. (defaults to Logger.new(STDERR))
 end
 ```
 
@@ -56,16 +59,16 @@ could live in an initializer like `config/initializers/elasticsearch.rb`.
 
 ## Usage
 
-The `Documents` extension builds on the
-`elasticsearch-ruby` Gem adding conventions and helper classes to aide in the
-serialization and flow of data between your application code and the
-elasticsearch-ruby interface. To accomplish this the application data models
-will be serialized into `Document`s that can be indexed and searched with the
-`elasticsearch-ruby` Gem.
+The `Documents` extension builds on the [`elasticsearch-ruby`][es-ruby-gem] Gem
+adding conventions and helper classes to aide in the serialization and flow of
+data between your application code and the elasticsearch-ruby client. To
+accomplish this the application data models will be serialized into instances
+of `Document` classes.  These `Document` instances are then indexed and searched
+with wrappers around the `elasticsearch-ruby` client.
 
 ### Saving a Document
-If your application has a model called `User` that you wanted to index you would
-create a `Document` that defined how the `User` is stored in the index.
+Assume your application has a `User` model. To index the `User` records you
+define a `Document` that maps `User` records to a search index mapping.
 
 ```ruby
 class UserDocument < Elasticsearch::Extensions::Documents::Document
@@ -124,7 +127,8 @@ end
 ```
 
 You could elaborate on this class with a constructor that takes the search
-term and other options specific to your use case as arguments.
+term and other options specific to your use case as arguments. The impoortant
+part is to define the `#as_hash` method.
 
 You can then call the `#execute` method to run the query. The Elasticsearch JSON
 response will be returned in whole wrapped in a
@@ -203,6 +207,23 @@ indexer.reindex do |indexer|
   indexer.bulk_index(documents)
 end
 ```
+
+By default the call to `#reindex` will create the index if it does not yet
+exist. If the index already exists it will be left in place and the documents
+provided to be indexed will be added or updated as needed. You can force the
+index to be dropped and recreated during the reindex process by passing the
+`force_create: true` option:
+
+```ruby
+indexer.reindex(force_create: true) do |indexer|
+  # bulk index those documents into a fresh index
+end
+```
+
+Different reindexing strategies may be added in the future to allow "zero
+downtime reindexing". This could be accomplished using index names with a
+timestamp appended and index aliases.
+
 ## Contributing
 
 1. Fork it
@@ -213,5 +234,6 @@ end
 
 
 [es-query-dsl]: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html
+[es-ruby-gem]: https://github.com/elasticsearch/elasticsearch-ruby
 [es-ruby-search-src]: https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-api/lib/elasticsearch/api/actions/search.rb
 

data/elasticsearch-documents.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 2.14"
 
   spec.add_runtime_dependency "elasticsearch"
   spec.add_runtime_dependency "hashie"

data/lib/elasticsearch/extensions/documents.rb

@@ -1,5 +1,6 @@
 require "elasticsearch"
 require "logger"
+require "ostruct"
 require "elasticsearch/extensions/documents/version"
 require "elasticsearch/extensions/documents/document"
 require "elasticsearch/extensions/documents/index"
@@ -15,14 +16,11 @@ module Elasticsearch
         attr_accessor :client, :configuration
 
         def client
-          @client ||= Elasticsearch::Client.new({
-            host: self.configuration.url,
-            log:  self.configuration.log,
-          })
+          Elasticsearch::Client.new(configuration.client.marshal_dump)
         end
 
         def configure
-          self.configuration ||= Configuration.new
+          self.configuration ||= OpenStruct.new(client: OpenStruct.new)
           yield configuration
         end
 
@@ -31,16 +29,7 @@ module Elasticsearch
         end
 
         def logger
-          self.configuration.logger
-        end
-      end
-
-      class Configuration
-        attr_accessor :url, :index_name, :mappings, :settings, :log, :logger
-
-        def initialize
-          @logger = Logger.new(STDOUT)
-          @log    = true
+          self.configuration.client.logger ||= Logger.new(STDERR)
         end
       end
 

data/lib/elasticsearch/extensions/documents/indexer.rb

@@ -28,9 +28,12 @@ module Elasticsearch
           end
         end
 
-        def reindex(&block)
-          drop_index
+        def reindex(options = {}, &block)
+          force_create = options.fetch(:force_create) { false }
+
+          drop_index if force_create
           create_index
+
           block.call(self) if block_given?
         end
 

data/lib/elasticsearch/extensions/documents/version.rb

@@ -1,7 +1,7 @@
 module Elasticsearch
   module Extensions
     module Documents
-      VERSION = "0.0.1"
+      VERSION = "0.1.0"
     end
   end
 end

data/spec/elasticsearch/extensions/documents/indexer_spec.rb

@@ -83,10 +83,20 @@ module Elasticsearch
 
         describe '#reindex' do
 
-          it 'drops the index if exists' do
-            indices.stub(:exists).and_return(true)
-            expect(indexer).to receive(:drop_index)
-            indexer.reindex
+          context 'with the :force_create option' do
+            it 'drops the index if exists' do
+              indices.stub(:exists).and_return(true)
+              expect(indexer).to receive(:drop_index)
+              indexer.reindex(force_create: true)
+            end
+          end
+
+          context 'without the :force_create option' do
+            it 'does not drop the index if exists' do
+              indices.stub(:exists).and_return(true)
+              expect(indexer).not_to receive(:drop_index)
+              indexer.reindex
+            end
           end
 
           it 'creates a new index' do

data/spec/elasticsearch/extensions/documents_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'logger'
+
+module Elasticsearch::Extensions
+  describe Documents do
+
+    before(:each) { reset_configuration }
+
+    describe '.configuration' do
+      subject(:config) { Documents.configuration }
+
+      its(:index_name) { should eql 'test_index' }
+      its(:mappings) { should eql :fake_mappings  }
+      its(:settings) { should eql :fake_settings  }
+    end
+
+    describe '.client' do
+      subject(:client) { Documents.client }
+
+      it 'creates an instance of Elasticsearch::Transport::Client' do
+        expect(client).to be_instance_of Elasticsearch::Transport::Client
+      end
+
+      it 'provides a new client instance for each call' do
+        c1 = Documents.client
+        c2 = Documents.client
+        expect(c1).not_to equal c2
+      end
+
+      it 'instantiates the client with the config.client settings' do
+        Documents.configure do |config|
+          config.client.url = 'http://example.com:9200/es'
+          config.client.logger = :app_logger
+          config.client.tracer = :app_tracer
+        end
+
+        expect(Elasticsearch::Client).to receive(:new) do |options|
+          expect(options[:url]).to eq 'http://example.com:9200/es'
+          expect(options[:logger]).to eq :app_logger
+          expect(options[:tracer]).to eq :app_tracer
+        end
+        Documents.client
+      end
+    end
+
+    describe '.index_name' do
+      specify { expect(Documents.index_name).to eq 'test_index' }
+    end
+
+    describe '.logger' do
+      it 'provides a default logger if none is given' do
+        expect(Documents.logger).to be_kind_of Logger
+      end
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,18 +1,29 @@
 require 'elasticsearch-documents'
 
+def reset_configuration
+  Elasticsearch::Extensions::Documents.configuration = nil
+  configure_documents
+end
+
+def configure_documents
+  Elasticsearch::Extensions::Documents.configure do |config|
+    config.index_name = 'test_index'
+    config.settings   = :fake_settings
+    config.mappings   = :fake_mappings
+    config.client.url = 'http://example.com:9200'
+  end
+end
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
   config.order = 'random'
-end
 
-Elasticsearch::Extensions::Documents.configure do |config|
-  config.url        = 'http://example.com:9200'
-  config.index_name = 'test_index'
-  config.settings   = :fake_settings
-  config.mappings   = :fake_mappings
+  config.before(:suite) do
+    configure_documents
+  end
 end
 
 class TestDocumentsDocument < Elasticsearch::Extensions::Documents::Document

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-documents
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan Houston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,12 +103,12 @@ files:
 - lib/elasticsearch/extensions/documents/queryable.rb
 - lib/elasticsearch/extensions/documents/utils.rb
 - lib/elasticsearch/extensions/documents/version.rb
-- spec/elasticsearch/extensions/documentor_spec.rb
 - spec/elasticsearch/extensions/documents/document_spec.rb
 - spec/elasticsearch/extensions/documents/index_spec.rb
 - spec/elasticsearch/extensions/documents/indexer_spec.rb
 - spec/elasticsearch/extensions/documents/queryable_spec.rb
 - spec/elasticsearch/extensions/documents/utils_spec.rb
+- spec/elasticsearch/extensions/documents_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/RyanHouston/elasticsearch-documents
 licenses:
@@ -129,15 +130,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A service wrapper to manage elasticsearch index documents
 test_files:
-- spec/elasticsearch/extensions/documentor_spec.rb
 - spec/elasticsearch/extensions/documents/document_spec.rb
 - spec/elasticsearch/extensions/documents/index_spec.rb
 - spec/elasticsearch/extensions/documents/indexer_spec.rb
 - spec/elasticsearch/extensions/documents/queryable_spec.rb
 - spec/elasticsearch/extensions/documents/utils_spec.rb
+- spec/elasticsearch/extensions/documents_spec.rb
 - spec/spec_helper.rb

data/spec/elasticsearch/extensions/documentor_spec.rb

@@ -1,50 +0,0 @@
-require 'spec_helper'
-require 'logger'
-
-module Elasticsearch::Extensions
-  describe Documents do
-
-    let(:logger) { Logger.new(STDOUT) }
-    before do
-      Documents.configure do |config|
-        config.logger     = logger
-        config.log        = true
-      end
-    end
-
-    describe '.configuration' do
-      subject(:config) { Documents.configuration }
-
-      specify { expect(config.url).to eql 'http://example.com:9200' }
-      specify { expect(config.index_name).to eql 'test_index' }
-      specify { expect(config.mappings).to eql( :fake_mappings ) }
-      specify { expect(config.settings).to eql( :fake_settings ) }
-      specify { expect(config.logger).to equal logger }
-      specify { expect(config.logger).to be_true }
-    end
-
-    describe '.client' do
-      subject(:client) { Documents.client }
-
-      it 'creates an instance of Elasticsearch::Transport::Client' do
-        expect(client).to be_instance_of Elasticsearch::Transport::Client
-      end
-
-      it 'caches the client instance' do
-        c1 = Documents.client
-        c2 = Documents.client
-        expect(c1).to equal c2
-      end
-    end
-
-    describe '.index_name' do
-      specify { expect(Documents.index_name).to eq 'test_index' }
-    end
-
-    describe '.logger' do
-      specify { expect(Documents.logger).to equal logger }
-    end
-
-  end
-end
-