elastic_search_framework 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c6e8a7207b86a434d1bfcb90760b09f0e402fe0ee5cc3da4be5403da4d9f07
-  data.tar.gz: 2463823e5f08a1c24dac6e10d240646a60e2ead9f7bd31a9ff1a1c50a870b6d4
+  metadata.gz: 39f01fc19a6b4b23c55c54b9c59441ebc4f565db4365096c00031b8e0d28bd46
+  data.tar.gz: 9a050c4f8a88f6faf6348e01c987999e6fe20cac33058c07b66e11b267641d21
 SHA512:
-  metadata.gz: 91f9f1fb76a537e8a8cc6631398e6776b26dc0fa59164ed97f017c650d4334e3eae36971f6c5324b7354087df0713badb2a52b8ef04c798d6105668070752935
-  data.tar.gz: dcf4530566639e57b4cf7bd8c80a7230c1e2fdd19af5e58a2d5d6207cc50ccd98c920059e12ed89d1c222b5e7eb639166f19125ab7a741e993ee5fe22b4a9b73
+  metadata.gz: 70dc6b3b99fb07405ecf51256393e5dc5534793960197a19f701f85eb28af5ad8fe53723089f009b3e6eecc26b0b26295a37c970c280463188dfdec5d478a23a
+  data.tar.gz: 1c356af13948e1d11e3011075bd4095eb9fa6c410558708278aabf89c0d3c42e90403eb5a94fcb8d8801570b6cd94e6a3663fc42f15817c716270784482722c0

data/lib/elastic_search_framework/index.rb

@@ -18,26 +18,21 @@ module ElasticSearchFramework
       end
     end
 
-    def mapping(name:, field:, type:, index:)
-
+    def mapping(name:, field:, **options)
       unless instance_variable_defined?(:@elastic_search_index_mappings)
         instance_variable_set(:@elastic_search_index_mappings, {})
       end
 
       mappings = instance_variable_get(:@elastic_search_index_mappings)
 
-      if mappings[name] == nil
-        mappings[name] = {}
-      end
+      mappings[name] = {} if mappings[name].nil?
 
-      mappings[name][field] = { type: type, index: index}
+      mappings[name][field] = options
 
       instance_variable_set(:@elastic_search_index_mappings, mappings)
-
     end
 
     def create
-
       if !valid?
         raise ElasticSearchFramework::Exceptions::IndexError.new("[#{self.class}] - Invalid Index description specified.")
       end
@@ -50,7 +45,6 @@ module ElasticSearchFramework
       payload = create_payload(description: description, mappings: mappings)
 
       put(payload: payload)
-
     end
 
     def put(payload:)
@@ -65,7 +59,7 @@ module ElasticSearchFramework
       end
 
       unless is_valid_response?(response.code)
-        if response.body.dig(:error, :root_cause, 0, :type) == 'index_already_exists_exception'
+        if JSON.parse(response.body, symbolize_names: true).dig(:error, :root_cause, 0, :type) == 'index_already_exists_exception'
           # We get here because the `exists?` check in #create is non-atomic
           ElasticSearchFramework.logger.warn "[#{self.class}] - Failed to create preexisting index. | Response: #{response.body}"
         else
@@ -112,12 +106,11 @@ module ElasticSearchFramework
 
       if description[:shards] != nil
         payload[:settings] = {
-            number_of_shards: Integer(description[:shards])
+          number_of_shards: Integer(description[:shards])
         }
       end
 
       if mappings.keys.length > 0
-
         payload[:mappings] = {}
 
         mappings.keys.each do |name|
@@ -125,10 +118,7 @@ module ElasticSearchFramework
               properties: {}
           }
           mappings[name].keys.each do |field|
-            payload[:mappings][name][:properties][field] = {
-                type: mappings[name][field][:type],
-                index: mappings[name][field][:index]
-            }
+            payload[:mappings][name][:properties][field] = mappings[name][field]
           end
         end
 

data/lib/elastic_search_framework/repository.rb

@@ -87,6 +87,7 @@ module ElasticSearchFramework
       uri = URI("#{host}/#{index_name}/#{type}/_search")
 
       request = Net::HTTP::Get.new(uri.request_uri)
+      request.content_type = 'application/json'
       request.body = json_query
 
       response = with_client do |client|

data/lib/elastic_search_framework/version.rb

@@ -1,3 +1,3 @@
 module ElasticSearchFramework
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

data/spec/elastic_search_framework/index_spec.rb

@@ -1,5 +1,4 @@
 RSpec.describe ElasticSearchFramework::Index do
-
   describe '#description' do
     it 'should return the index details' do
       expect(ExampleIndex.description).to be_a(Hash)
@@ -10,6 +9,31 @@ RSpec.describe ElasticSearchFramework::Index do
     end
   end
 
+  describe '#index' do
+    before { ExampleIndex.create unless ExampleIndex.exists? }
+    context 'when the instance variable is not defined' do
+      before { allow(ExampleIndex).to receive(:instance_variable_defined?).and_return(true) }
+      it 'raises an index error' do
+        expect { ExampleIndex.index(name: 'test') }.to raise_error(
+          ElasticSearchFramework::Exceptions::IndexError,
+          "[Class] - Duplicate index description. Name: test | Shards: ."
+        )
+      end
+    end
+  end
+
+  describe '#id' do
+    context 'when the instance variable is not defined' do
+      before { allow(ExampleIndex).to receive(:instance_variable_defined?).and_return(true) }
+      it 'raises an index error' do
+        expect { ExampleIndex.id('name') }.to raise_error(
+          ElasticSearchFramework::Exceptions::IndexError,
+          "[Class] - Duplicate index id. Field: name."
+        )
+      end
+    end
+  end
+
   describe '#full_name' do
     let(:namespace) { 'uat' }
     let(:namespace_delimiter) { '.' }
@@ -20,6 +44,14 @@ RSpec.describe ElasticSearchFramework::Index do
     it 'should return the full index name including namespace and delimiter' do
       expect(ExampleIndex.full_name).to eq "#{ElasticSearchFramework.namespace}#{ElasticSearchFramework.namespace_delimiter}#{ExampleIndex.description[:name]}"
     end
+
+    context 'when the namespace is nil' do
+      before { ElasticSearchFramework.namespace = nil }
+
+      it 'returns the description name downcased' do
+        expect(ExampleIndex.full_name).to eq 'example_index'
+      end
+    end
   end
 
   describe '#mapping' do
@@ -46,18 +78,40 @@ RSpec.describe ElasticSearchFramework::Index do
   end
 
   describe '#create' do
-    before do
-      if ExampleIndex.exists?
+    context 'when index is valid and does not exist' do
+      before { ExampleIndex.delete if ExampleIndex.exists? }
+
+      it 'should create an index' do
+        expect(ExampleIndex.exists?).to be false
+        ExampleIndex.create
+        expect(ExampleIndex.exists?).to be true
+      end
+
+      after do
         ExampleIndex.delete
       end
     end
-    it 'should create an index' do
-      expect(ExampleIndex.exists?).to be false
-      ExampleIndex.create
-      expect(ExampleIndex.exists?).to be true
+
+    context 'when index is not valid' do
+      before { allow(ExampleIndex).to receive(:valid?).and_return(false) }
+
+      it 'raises an error' do
+        expect(ExampleIndex.exists?).to be false
+        expect { ExampleIndex.create }.to raise_error(
+          ElasticSearchFramework::Exceptions::IndexError,
+          '[Class] - Invalid Index description specified.'
+        )
+      end
     end
-    after do
-      ExampleIndex.delete
+
+    context 'when index is valid but already exists' do
+      before { ExampleIndex.delete if ExampleIndex.exists? }
+
+      it 'does not try to create a new index' do
+        allow(ExampleIndex).to receive(:exists?).and_return(true)
+        expect(ExampleIndex).not_to receive(:put)
+        ExampleIndex.create
+      end
     end
   end
 
@@ -94,6 +148,48 @@ RSpec.describe ElasticSearchFramework::Index do
     end
   end
 
+  describe '#put' do
+    let(:payload) { {} }
+    context 'when there is a valid response' do
+      before { allow(ExampleIndex).to receive(:is_valid_response?).and_return(true) }
+
+      it 'returns true' do
+        ExampleIndex.create
+        expect(ExampleIndex.put(payload: payload)).to eq true
+      end
+    end
+
+    context 'when there is not a valid response' do
+      before { allow(ExampleIndex).to receive(:is_valid_response?).and_return(false) }
+
+      context 'when the error is "index_already_exists_exception"' do
+        let(:response_body) { { error: { root_cause: [{ type: 'index_already_exists_exception' }] } } }
+        let(:request) { double }
+
+        before { ExampleIndex.delete if ExampleIndex.exists? }
+        it 'returns true' do
+          allow(request).to receive(:body).and_return(response_body.to_json)
+          allow(request).to receive(:code).and_return(404)
+          allow_any_instance_of(Net::HTTP).to receive(:request).and_return(request)
+          expect(ExampleIndex.put(payload: payload)).to eq true
+        end
+      end
+
+      context 'when the error is not "index_already_exists_exception"' do
+        let(:response_body) { { error: { root_cause: [{ type: 'foo' }] } } }
+        let(:request) { double }
+        it 'raises an IndexError' do
+          allow(request).to receive(:body).and_return(response_body.to_json)
+          allow(request).to receive(:code).and_return(404)
+          allow_any_instance_of(Net::HTTP).to receive(:request).and_return(request)
+          expect { ExampleIndex.put(payload: payload) }.to raise_error(
+            ElasticSearchFramework::Exceptions::IndexError
+          )
+        end
+      end
+    end
+  end
+
   describe '#is_valid_response?' do
     let(:code) { 200 }
     context 'when a 200 response code is returned' do
@@ -182,5 +278,4 @@ RSpec.describe ElasticSearchFramework::Index do
       ExampleIndex.delete_item(id: id, type: type)
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_search_framework
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A lightweight framework to for working with elastic search.