elastomer-client 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cd17dd15348e159466cead916479b5bcf68b80b
-  data.tar.gz: b2f0b0e2455ad13ed6a3a1670cf20a58e6239501
+  metadata.gz: e82302d43fced9352f7a34365d970c5c68372244
+  data.tar.gz: 5a5125d962c5648390e13d20ff15de07dc63d117
 SHA512:
-  metadata.gz: c9c2a2798145fa90c3291459de33dcdf01c1ad806b64e19b719fb6f5679c3b4b165583cb3ee4101a1f3e17879d15da93c350e88703256c1fab9755df80eda187
-  data.tar.gz: ce53c9838c420f6932d7792a088bdcd6ea7d3735e12f3df51d52459cc849b934cc91ff0703317574ad01ab75d0ca91ad0ef839d55cf7988a7417b499e52fcaed
+  metadata.gz: d1359ce4cb196c178ad8015e9b351ac5cdc227dbdd1b68b4ba0eef12fba520e6e12f83b3112dadef8b07f3977736999ada69850e853f34be366d9aa89212ed4f
+  data.tar.gz: 9c3973a14dd4a064c15b012cde567ab12bc1692937d38969784ef728b60e61cd7f562d8cf77446beef089f6fa5fa2083ea3647c6628f5e9fc99e0f526896351d

data/elastomer-client.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "minitest","~> 4.7"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "debugger", "~> 1.6.8"
 end

data/lib/elastomer/client/bulk.rb

@@ -18,12 +18,12 @@ module Elastomer
     #
     # Examples
     #
-    #   bulk( request_body, :index => 'default-index' )
+    #   bulk(request_body, :index => 'default-index')
     #
-    #   bulk( :index => 'default-index' ) do |b|
-    #     b.index( document1 )
-    #     b.index( document2 )
-    #     b.delete( document3 )
+    #   bulk(:index => 'default-index') do |b|
+    #     b.index(document1)
+    #     b.index(document2, :_type => 'default-type')
+    #     b.delete(document3)
     #     ...
     #   end
     #
@@ -118,58 +118,60 @@ module Elastomer
       end
 
       # Add an index action to the list of bulk actions to be performed when
-      # the bulk API call is made. The `_id` of the document cannot be `nil`
-      # or empty. If this is the case then we remove the `_id` and allow
-      # ElasticSearch to generate one.
+      # the bulk API call is made. Parameters can be provided in the
+      # parameters hash (underscore prefix optional) or in the document
+      # hash (underscore prefix required).
       #
       # document - The document to index as a Hash or JSON encoded String
-      # params   - Parameters for the index action (as a Hash)
+      # params   - Parameters for the index action (as a Hash) (optional)
+      #
+      # Examples
+      #   index({"foo" => "bar"}, {:_id => 1, :_type => "foo"}
+      #   index({"foo" => "bar"}, {:id => 1, :type => "foo"}
+      #   index("foo" => "bar", "_id" => 1, "_type" => "foo")
       #
       # Returns the response from the bulk call if one was made or nil.
       def index( document, params = {} )
-        unless String === document
-          overrides = from_document(document)
-          params = params.merge overrides
-        end
-        params.delete(:_id) if params[:_id].nil? || params[:_id].to_s.empty?
-
+        params = prepare_params(document, params)
         add_to_actions({:index => params}, document)
       end
       alias :add :index
 
       # Add a create action to the list of bulk actions to be performed when
-      # the bulk API call is made. The `_id` of the document cannot be `nil`
-      # or empty.
+      # the bulk API call is made. Parameters can be provided in the
+      # parameters hash (underscore prefix optional) or in the document
+      # hash (underscore prefix required).
       #
       # document - The document to create as a Hash or JSON encoded String
-      # params   - Parameters for the create action (as a Hash)
+      # params   - Parameters for the create action (as a Hash) (optional)
+      #
+      # Examples
+      #   create({"foo" => "bar"}, {:_id => 1}
+      #   create({"foo" => "bar"}, {:id => 1}
+      #   create("foo" => "bar", "_id" => 1)
       #
       # Returns the response from the bulk call if one was made or nil.
       def create( document, params )
-        unless String === document
-          overrides = from_document(document)
-          params = params.merge overrides
-        end
-        params.delete(:_id) if params[:_id].nil? || params[:_id].to_s.empty?
-
+        params = prepare_params(document, params)
         add_to_actions({:create => params}, document)
       end
 
       # Add an update action to the list of bulk actions to be performed when
-      # the bulk API call is made. The `_id` of the document cannot be `nil`
-      # or empty.
+      # the bulk API call is made. Parameters can be provided in the parameters 
+      # hash (underscore prefix optional) or in the document hash (underscore
+      # prefix required).
       #
       # document - The document to update as a Hash or JSON encoded String
-      # params   - Parameters for the update action (as a Hash)
+      # params   - Parameters for the update action (as a Hash) (optional)
+      #
+      # Examples
+      #   update({"foo" => "bar"}, {:_id => 1}
+      #   update({"foo" => "bar"}, {:id => 1}
+      #   update("foo" => "bar", "_id" => 1)
       #
       # Returns the response from the bulk call if one was made or nil.
       def update( document, params )
-        unless String === document
-          overrides = from_document(document)
-          params = params.merge overrides
-        end
-        params.delete(:_id) if params[:_id].nil? || params[:_id].to_s.empty?
-
+        params = prepare_params(document, params)
         add_to_actions({:update => params}, document)
       end
 
@@ -177,10 +179,14 @@ module Elastomer
       # the bulk API call is made.
       #
       # params - Parameters for the delete action (as a Hash)
+      #      
+      # Examples
+      #   delete(:_id => 1, :_type => 'foo')
       #
       # Returns the response from the bulk call if one was made or nil.
       def delete( params )
-        add_to_actions :delete => params
+        params = prepare_params(nil, params)
+        add_to_actions({:delete => params})
       end
 
       # Immediately execute a bulk API call with the currently accumulated
@@ -201,6 +207,20 @@ module Elastomer
         @actions.clear
       end
 
+      SPECIAL_KEYS = %w[id type index version version_type routing parent percolator timestamp ttl retry_on_conflict]
+      SPECIAL_KEYS_HASH = SPECIAL_KEYS.inject({}) { |h, k| h[k] = "_#{k}"; h }
+
+      # Internal: convert special key parameters to their wire representation
+      # and apply any override document parameters.
+      def prepare_params(document, params)
+        params = convert_special_keys(params)
+        unless document.nil? || String === document
+          params = from_document(document).merge(params)
+        end
+        params.delete(:_id) if params[:_id].nil? || params[:_id].to_s.empty?
+        params
+      end
+
       # Internal: Extract special keys for bulk indexing from the given
       # `document`. The keys and their values are returned as a Hash from this
       # method. If a value is `nil` then it will be ignored.
@@ -211,15 +231,36 @@ module Elastomer
       def from_document( document )
         opts = {}
 
-        %w[_id _type _index _version _version_type _routing _parent _percolator _timestamp _ttl _retry_on_conflict].each do |field|
+        SPECIAL_KEYS_HASH.values.each do |field|
           key = field.to_sym
-          opts[key] = document.delete field if document[field]
-          opts[key] = document.delete key   if document[key]
+          opts[key] = document.delete field if document.key? field
+          opts[key] = document.delete key   if document.key? key
         end
 
         opts
       end
 
+      # Internal: Convert incoming Ruby symbol keys to their special underscore
+      # versions. Maintains API compaibility with the `Docs` API for `index`,
+      # `create`, `update` and `delete`.
+      #
+      # :id -> :_id
+      # 'id' -> '_id'
+      #
+      # params - Hash.
+      #
+      # Returns a new params Hash with the special keys replaced.
+      def convert_special_keys(params)
+        new_params = params.dup
+
+        SPECIAL_KEYS_HASH.each do |k1, k2|
+          new_params[k2] = new_params.delete k1 if new_params.key? k1
+          new_params[k2.to_sym] = new_params.delete k1.to_sym if new_params.key? k1.to_sym
+        end
+
+        new_params
+      end
+
       # Internal: Add the given `action` to the list of actions that will be
       # performed by this bulk request. An optional `document` can also be
       # given.

data/lib/elastomer/client/docs.rb

@@ -267,7 +267,7 @@ Percolate
       # params - Parameters Hash
       #
       # Examples
-      # 
+      #
       #   # request body query
       #   validate(:query_string => {:query => "*:*"})
       #

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 
   def self.version
     VERSION

data/test/client/bulk_test.rb

@@ -223,4 +223,74 @@ describe Elastomer::Client::Bulk do
 
     assert_equal 10, h['hits']['total']
   end
+
+  it 'uses :id from parameters' do
+    response = @index.bulk do |b|
+      document = { :_type => 'tweet', :author => 'pea53', :message => 'just a test tweet' }
+      params = { :id => 'foo' }
+
+      b.index document, params
+    end
+
+    assert_instance_of Fixnum, response['took']
+
+    items = response['items']
+    assert_bulk_index(items[0])
+
+    assert_equal 'foo', items[0]['index']['_id']
+  end
+
+  it 'supports symbol and string parameters' do
+    response = @index.bulk do |b|
+      doc1 = { :author => 'pea53', :message => 'a tweet about foo' }
+      b.index doc1, { :id => 'foo', :type => 'tweet' }
+
+      doc2 = { :author => 'pea53', :message => 'a tweet about bar' }
+      b.index doc2, { 'id' => 'bar', 'type' => 'tweet' }
+    end
+
+    assert_instance_of Fixnum, response['took']
+
+    items = response['items']
+    assert_bulk_index(items[0])
+    assert_bulk_index(items[1])
+
+    assert_equal 'a tweet about foo', @index.docs('tweet').get(:id => 'foo')['_source']['message']
+    assert_equal 'a tweet about bar', @index.docs('tweet').get(:id => 'bar')['_source']['message']
+  end
+
+  it 'doesn\'t override parameters from the document' do
+    document = { :_id => 1, :_type => 'tweet', :author => 'pea53', :message => 'just a test tweet' }
+    params = { :id => 2 }
+
+    response = @index.bulk do |b|
+      b.index document, params
+    end
+
+    assert_instance_of Fixnum, response['took']
+
+    items = response['items']
+    assert_bulk_index(items[0])
+
+    refute_found @index.docs('tweet').get(:id => 1)
+    assert_equal 'just a test tweet', @index.docs('tweet').get(:id => 2)['_source']['message']
+  end
+
+  it 'doesn\'t upgrade non-prefixed keys to parameters' do
+    document = { :id => 1, :type => 'book', :version => 5, :author => 'pea53', :message => 'just a test tweet' }
+    params = { :id => 2, :type => 'tweet' }
+
+    response = @index.bulk do |b|
+      b.index document, params
+    end
+
+    assert_instance_of Fixnum, response['took']
+
+    items = response['items']
+    assert_bulk_index(items[0])
+
+    assert_equal '2', items[0]['index']['_id']
+    assert_equal 'tweet', items[0]['index']['_type']
+    assert_equal 1, items[0]['index']['_version']
+  end
 end

data/test/client/docs_test.rb

@@ -363,26 +363,42 @@ describe Elastomer::Client::Docs do
     end
   end
 
-  def populate!
-    @docs.add \
+  it 'supports bulk operations with the same parameters as docs' do
+    response = @docs.bulk do |b|
+      populate!(b)
+    end
+
+    assert_instance_of Fixnum, response['took']
+
+    response = @docs.get(:id => 1, :type => 'doc1')
+    assert_found response
+    assert_equal 'mojombo', response['_source']['author']
+  end
+
+  # Create/index multiple documents.
+  #
+  # docs - An instance of Elastomer::Client::Docs or Elastomer::Client::Bulk. If
+  #        nil uses the @docs instance variable.
+  def populate!(docs = @docs)
+    docs.add \
       :_id    => 1,
       :_type  => 'doc1',
       :title  => 'the author of gravatar',
       :author => 'mojombo'
 
-    @docs.add \
+    docs.add \
       :_id    => 2,
       :_type  => 'doc1',
       :title  => 'the author of resque',
       :author => 'defunkt'
 
-    @docs.add \
+    docs.add \
       :_id    => 1,
       :_type  => 'doc2',
       :title  => 'the author of logging',
       :author => 'pea53'
 
-    @docs.add \
+    docs.add \
       :_id    => 2,
       :_type  => 'doc2',
       :title  => 'the author of rubber-band',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
 description: |-
   Elastomer is a low level API client for the
                             Elasticsearch HTTP interface.