Merge pull request #18 from Sage/set_op_type

Adds support for `op_type` to be supplied for `ElasticSearchFramework::Repository#set`

Author: Cosima Radu

.travis.yml

@@ -3,6 +3,9 @@ rvm:
 - 2.3.0
 services:
 - elasticsearch
+before_install:
+- find /home/travis/.rvm/rubies -wholename '*default/bundler-*.gemspec' -delete
+- gem install bundler -v '< 2'
 before_script:
 - sleep 10
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v2.3.0
+Adds support for `op_type` to be supplied for `ElasticSearchFramework::Repository#set` to allow control of PUT behaviour in create scenarios.
+See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/docs-index_.html#operation-type) for more information and accepted values.
+
+## v2.2.0
+Adds index alias support.
+
 ## v2.1.0
 Ensures that the read timeout is set to either the value of `ENV['CONNECTION_READ_TIMEOUT']` or `5` as a default.
 Previously this was being set to the value of `ENV['CONNECTION_OPEN_TIMEOUT']` or `1` as a default.

lib/elastic_search_framework/repository.rb

@@ -1,8 +1,8 @@
 module ElasticSearchFramework
   class Repository
 
-    def set(index:, entity:, type: 'default')
-      uri = URI("#{host}/#{index.full_name}/#{type.downcase}/#{get_id_value(index: index, entity: entity)}")
+    def set(index:, entity:, type: 'default', op_type: 'index')
+      uri = URI("#{host}/#{index.full_name}/#{type.downcase}/#{get_id_value(index: index, entity: entity)}?op_type=#{op_type}")
       hash = hash_helper.to_hash(entity)
 
       request = Net::HTTP::Put.new(uri.request_uri)
@@ -13,12 +13,15 @@ def set(index:, entity:, type: 'default')
         client.request(request)
       end
 
-      unless valid_response?(response.code)
+      if valid_response?(response.code)
+        return true
+      elsif op_type == 'create' && Integer(response.code) == 409
+        return true
+      else
         raise ElasticSearchFramework::Exceptions::IndexError.new(
             "An error occurred setting an index document. Response: #{response.body} | Code: #{response.code}"
         )
       end
-      return true
     end
 
     def get(index:, id:, type: 'default')

lib/elastic_search_framework/version.rb

@@ -1,3 +1,3 @@
 module ElasticSearchFramework
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

spec/elastic_search_framework/repository_spec.rb

@@ -63,22 +63,40 @@
       ExampleIndexWithId.create
     end
 
-    it 'should create, read and delete an index document' do
-      subject.set(index: ExampleIndex, entity: item1)
-      subject.set(index: ExampleIndex, entity: item2)
-      subject.set(index: ExampleIndex, entity: item5)
-      index_item1 = subject.get(index: ExampleIndex, id: item1.id)
-      expect(index_item1[:id]).to eq item1.id
-      expect(index_item1[:name]).to eq item1.name
-      expect(index_item1[:timestamp]).to eq item1.timestamp
-      expect(index_item1[:number]).to eq item1.number
-      index_item2 = subject.get(index: ExampleIndex, id: item2.id)
-      expect(index_item2[:id]).to eq item2.id
-      expect(index_item2[:name]).to eq item2.name
-      expect(index_item2[:timestamp]).to eq item2.timestamp
-      expect(index_item2[:number]).to eq item2.number
-      subject.drop(index: ExampleIndex, id: item1.id)
-      expect(subject.get(index: ExampleIndex, id: item1.id)).to be_nil
+    context 'PUT with op_type: index' do
+      it 'should create, read and delete an index document' do
+        subject.set(index: ExampleIndex, entity: item1)
+        subject.set(index: ExampleIndex, entity: item1.tap { |i| i.timestamp += 100 })
+        subject.set(index: ExampleIndex, entity: item1.tap { |i| i.timestamp += 100 }, op_type: 'index')
+        subject.set(index: ExampleIndex, entity: item2)
+        subject.set(index: ExampleIndex, entity: item5)
+        index_item1 = subject.get(index: ExampleIndex, id: item1.id)
+        expect(index_item1[:id]).to eq item1.id
+        expect(index_item1[:name]).to eq item1.name
+        expect(index_item1[:timestamp]).to eq item1.timestamp
+        expect(index_item1[:number]).to eq item1.number
+        index_item2 = subject.get(index: ExampleIndex, id: item2.id)
+        expect(index_item2[:id]).to eq item2.id
+        expect(index_item2[:name]).to eq item2.name
+        expect(index_item2[:timestamp]).to eq item2.timestamp
+        expect(index_item2[:number]).to eq item2.number
+        subject.drop(index: ExampleIndex, id: item1.id)
+        expect(subject.get(index: ExampleIndex, id: item1.id)).to be_nil
+      end
+    end
+
+    context 'PUT with op_type: create' do
+      let!(:original_timestamp) { item1.timestamp }
+
+      it 'should not update item' do
+        subject.set(index: ExampleIndex, entity: item1)
+        subject.set(index: ExampleIndex, entity: item1.tap { |i| i.timestamp += 100 }, op_type: 'create')
+        index_item1 = subject.get(index: ExampleIndex, id: item1.id)
+        expect(index_item1[:id]).to eq item1.id
+        expect(index_item1[:name]).to eq item1.name
+        expect(index_item1[:timestamp]).to eq original_timestamp
+        expect(index_item1[:number]).to eq item1.number
+      end
     end
 
     after do