[STORE] Added a update method for the repository Store module

karmi · karmi · commit b97491a4eeed · 2014-05-27T11:48:14.000+02:00
Allows to use Elasticsearch's "Update API" to update the document
either with partial document or a script.

Examples in tests and the README.
diff --git a/elasticsearch-persistence/README.md b/elasticsearch-persistence/README.md
@@ -322,6 +322,22 @@ repository.save(note)
 # => {"_index"=>"notes_development", "_type"=>"my_note", "_id"=>"1", "_version"=>1, "created"=>true}
 ```
 
+The `update` method allows you to perform a partial update of a document in the repository.
+Use either a partial document:
+
+```ruby
+repository.update id: 1, title: 'UPDATED',  tags: []
+# => {"_index"=>"notes_development", "_type"=>"note", "_id"=>"1", "_version"=>2}
+```
+
+Or a script (optionally with parameters):
+
+```ruby
+repository.update 1, script: 'if (!ctx._source.tags.contains(t)) { ctx._source.tags += t }', params: { t: 'foo' }
+# => {"_index"=>"notes_development", "_type"=>"note", "_id"=>"1", "_version"=>3}
+```
+
+
 The `delete` method allows to remove objects from the repository (pass either the object itself or its ID):
 
 ```ruby
diff --git a/elasticsearch-persistence/lib/elasticsearch/persistence/repository/store.rb b/elasticsearch-persistence/lib/elasticsearch/persistence/repository/store.rb
@@ -15,6 +15,41 @@ def save(document, options={})
           client.index( { index: index_name, type: type, id: id, body: serialized }.merge(options) )
         end
 
+        # Update the serialized object in Elasticsearch with partial data or script
+        #
+        def update(document, options={})
+          case
+            when document.is_a?(String) || document.is_a?(Integer)
+              id = document
+            when document.respond_to?(:to_hash)
+              serialized = document.to_hash
+              id = __extract_id_from_document(serialized)
+            else
+              raise ArgumentError, "Expected a document ID or a Hash-like object, #{document.class} given"
+          end
+
+          type = options.delete(:type) || \
+                 (defined?(serialized) && serialized && serialized.delete(:type)) || \
+                 document_type || \
+                 __get_type_from_class(klass)
+
+          if defined?(serialized) && serialized
+            body = if serialized[:script]
+                       serialized.select { |k, v| [:script, :params, :upsert].include? k }
+                     else
+                       { doc: serialized }
+                   end
+          else
+            body = {}
+            body.update( doc: options.delete(:doc)) if options[:doc]
+            body.update( script: options.delete(:script)) if options[:script]
+            body.update( params: options.delete(:params)) if options[:params]
+            body.update( upsert: options.delete(:upsert)) if options[:upsert]
+          end
+
+          client.update( { index: index_name, type: type, id: id, body: body }.merge(options) )
+        end
+
         # Remove the serialized object or document with specified ID from Elasticsearch
         #
         def delete(document, options={})
diff --git a/elasticsearch-persistence/test/integration/repository/customized_class_test.rb b/elasticsearch-persistence/test/integration/repository/customized_class_test.rb
@@ -44,6 +44,20 @@ def to_hash
           assert_not_nil Elasticsearch::Persistence.client.get index: 'my_notes', type: 'my_note', id: '1'
         end
 
+        should "update the document" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, doc: { title: 'UPDATED' }
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "update the document with a script" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, script: 'ctx._source.title = "UPDATED"'
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
         should "delete the object" do
           note = My::Note.new id: 1, title: 'Test'
           @repository.save note
diff --git a/elasticsearch-persistence/test/integration/repository/default_class_test.rb b/elasticsearch-persistence/test/integration/repository/default_class_test.rb
@@ -34,6 +34,25 @@ def to_hash
           assert_equal 'Test', @repository.find(response['_id']).attributes['title']
         end
 
+        should "update the document" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, type: 'note', doc: { title: 'UPDATED' }
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "update the document with a script" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, type: 'note', script: 'ctx._source.title = "UPDATED"'
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "save the document with an upsert" do
+          @repository.update 1, type: 'note', script: 'ctx._source.clicks += 1', upsert: { clicks: 1 }
+          assert_equal 1, @repository.find(1).attributes['clicks']
+        end
+
         should "delete an object" do
           note = Note.new(id: '1', title: 'Test')
 
diff --git a/elasticsearch-persistence/test/integration/repository/virtus_model_test.rb b/elasticsearch-persistence/test/integration/repository/virtus_model_test.rb
@@ -9,16 +9,28 @@ class RepositoryWithVirtusIntegrationTest < Elasticsearch::Test::IntegrationTest
       class ::Page
         include Virtus.model
 
+        attribute :id,        String, writer: :private
         attribute :title,     String
         attribute :views,     Integer, default: 0
         attribute :published, Boolean, default: false
-        attribute :slug,      String,  default: lambda { |page, attribute| page.title.downcase.gsub(' ', '-') }
+        attribute :slug,      String,  default: lambda { |page, attr| page.title.downcase.gsub(' ', '-') }
+
+        def set_id(id)
+          self.id = id
+        end
       end
 
       context "The repository with a Virtus model" do
         setup do
           @repository = Elasticsearch::Persistence::Repository.new do
             index :pages
+            klass Page
+
+            def deserialize(document)
+              page = klass.new document['_source']
+              page.set_id document['_id']
+              page
+            end
           end
         end
 
@@ -38,6 +50,63 @@ class ::Page
                                                                type: 'page',
                                                                id: id
         end
+
+        should "update the object with a partial document" do
+          response = @repository.save Page.new(title: 'Test')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_equal 'Test', page.title
+
+          @repository.update page.id, doc: { title: 'UPDATE' }
+
+          page = @repository.find(id)
+          assert_equal 'UPDATE', page.title
+        end
+
+        should "update the object with a Hash" do
+          response = @repository.save Page.new(title: 'Test')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_equal 'Test', page.title
+
+          @repository.update id: page.id, title: 'UPDATE'
+
+          page = @repository.find(id)
+          assert_equal 'UPDATE', page.title
+        end
+
+        should "update the object with a script" do
+          response = @repository.save Page.new(title: 'Test Page')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_not_nil page.id
+          assert_equal 0, page.views
+
+          @repository.update page.id, script: 'ctx._source.views += 1'
+
+          page = @repository.find(id)
+          assert_equal 1, page.views
+
+          @repository.update id: page.id, script: 'ctx._source.views += 1'
+
+          page = @repository.find(id)
+          assert_equal 2, page.views
+        end
+
+        should "update the object with a script and params" do
+          response = @repository.save Page.new(title: 'Test Page')
+
+          @repository.update id: response['_id'], script: 'ctx._source.views += count', params: { count: 3 }
+
+          page = @repository.find(response['_id'])
+          assert_equal 3, page.views
+        end
       end
 
     end
diff --git a/elasticsearch-persistence/test/unit/repository_store_test.rb b/elasticsearch-persistence/test/unit/repository_store_test.rb
@@ -5,7 +5,10 @@ class Elasticsearch::Persistence::RepositoryStoreTest < Test::Unit::TestCase
     class MyDocument; end
 
     setup do
-      @shoulda_subject = Class.new() { include Elasticsearch::Persistence::Repository::Store }.new
+      @shoulda_subject = Class.new() do
+        include Elasticsearch::Persistence::Repository::Store
+        include Elasticsearch::Persistence::Repository::Naming
+      end.new
       @shoulda_subject.stubs(:index_name).returns('test')
     end
 
@@ -85,6 +88,114 @@ class MyDocument; end
       end
     end
 
+    context "update" do
+      should "get the ID from first argument and :doc from options" do
+        subject.expects(:serialize).never
+        subject.expects(:document_type).returns('mydoc')
+        subject.expects(:__extract_id_from_document).never
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({doc: { foo: 'bar' }}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update('1', doc: { foo: 'bar' })
+      end
+
+      should "get the ID from first argument and :script from options" do
+        subject.expects(:document_type).returns('mydoc')
+        subject.expects(:__extract_id_from_document).never
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({script: 'ctx._source.foo += 1'}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update('1', script: 'ctx._source.foo += 1')
+      end
+
+      should "get the ID from first argument and :script with :upsert from options" do
+        subject.expects(:document_type).returns('mydoc')
+        subject.expects(:__extract_id_from_document).never
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({script: 'ctx._source.foo += 1', upsert: { foo: 1 }}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update('1', script: 'ctx._source.foo += 1', upsert: { foo: 1 })
+      end
+
+      should "get the ID and :doc from document" do
+        subject.expects(:document_type).returns('mydoc')
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({doc: { foo: 'bar' }}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update(id: '1', foo: 'bar')
+      end
+
+      should "get the ID and :script from document" do
+        subject.expects(:document_type).returns('mydoc')
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({script: 'ctx._source.foo += 1'}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update(id: '1', script: 'ctx._source.foo += 1')
+      end
+
+      should "get the ID and :script with :upsert from document" do
+        subject.expects(:document_type).returns('mydoc')
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',     arguments[:id]
+          assert_equal 'mydoc', arguments[:type]
+          assert_equal({script: 'ctx._source.foo += 1', upsert: { foo: 1 } }, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update(id: '1', script: 'ctx._source.foo += 1', upsert: { foo: 1 })
+      end
+
+      should "override the type from params" do
+        subject.expects(:document_type).never
+
+        client = mock
+        client.expects(:update).with do |arguments|
+          assert_equal '1',   arguments[:id]
+          assert_equal 'foo', arguments[:type]
+          assert_equal({script: 'ctx._source.foo += 1'}, arguments[:body])
+        end
+        subject.expects(:client).returns(client)
+
+        subject.update(id: '1', script: 'ctx._source.foo += 1', type: 'foo')
+      end
+
+      should "raise an exception when passed incorrect argument" do
+        assert_raise(ArgumentError) { subject.update(MyDocument.new, foo: 'bar') }
+      end
+    end
+
     context "delete" do
       should "get type from klass when passed only ID" do
         subject.expects(:serialize).never
