elastic_search_framework 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39a2a5f0c0573e1ce1ea95fe0206a05a2228bf2fb9e1a99f04e61f6fd64ced47
-  data.tar.gz: 1ccf3eec2961929a4c042585131f2dffa16ddddac011536ee71b1d08582b33a3
+  metadata.gz: 86c6e8a7207b86a434d1bfcb90760b09f0e402fe0ee5cc3da4be5403da4d9f07
+  data.tar.gz: 2463823e5f08a1c24dac6e10d240646a60e2ead9f7bd31a9ff1a1c50a870b6d4
 SHA512:
-  metadata.gz: 63890595521aa8816cef97190b39491d8f7f62d890e293f5311b354c9101f016dc9da630208cb6b8e0d90cf9e026b86a5e5f6390c787b02dc6c7ba03183be064
-  data.tar.gz: a5429fd019a6cf5b6ad3606c44dc42380f49c4f07f6dec35b5abbeb2676e1095a15b681e2f92915dbd01c386acb24e9217a63a64a700657c2d0d8348232e4f8e
+  metadata.gz: 91f9f1fb76a537e8a8cc6631398e6776b26dc0fa59164ed97f017c650d4334e3eae36971f6c5324b7354087df0713badb2a52b8ef04c798d6105668070752935
+  data.tar.gz: dcf4530566639e57b4cf7bd8c80a7230c1e2fdd19af5e58a2d5d6207cc50ccd98c920059e12ed89d1c222b5e7eb639166f19125ab7a741e993ee5fe22b4a9b73

data/lib/elastic_search_framework/repository.rb

@@ -13,7 +13,7 @@ module ElasticSearchFramework
         client.request(request)
       end
 
-      unless is_valid_response?(response.code)
+      unless valid_response?(response.code)
         raise ElasticSearchFramework::Exceptions::IndexError.new(
             "An error occurred setting an index document. Response: #{response.body} | Code: #{response.code}"
         )
@@ -30,7 +30,7 @@ module ElasticSearchFramework
         client.request(request)
       end
 
-      if is_valid_response?(response.code)
+      if valid_response?(response.code)
         result = JSON.load(response.body)
         hash_helper.indifferent!(result)
         return result
@@ -52,7 +52,7 @@ module ElasticSearchFramework
         client.request(request)
       end
 
-      if is_valid_response?(response.code) || Integer(response.code) == 404
+      if valid_response?(response.code) || Integer(response.code) == 404
         return true
       else
         raise ElasticSearchFramework::Exceptions::IndexError.new(
@@ -70,7 +70,7 @@ module ElasticSearchFramework
         client.request(request)
       end
 
-      if is_valid_response?(response.code)
+      if valid_response?(response.code)
         result = JSON.parse(response.body)
         hash_helper.indifferent!(result)
         if count
@@ -83,6 +83,27 @@ module ElasticSearchFramework
       end
     end
 
+    def json_query(index_name:, json_query:, type: 'default')
+      uri = URI("#{host}/#{index_name}/#{type}/_search")
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.body = json_query
+
+      response = with_client do |client|
+        client.request(request)
+      end
+
+      if valid_response?(response.code)
+        result = JSON.parse(response.body)
+        return result['hits']
+      else
+        raise(
+          ElasticSearchFramework::Exceptions::IndexError,
+          "An error occurred executing an index query. Response: #{response.body}"
+        )
+      end
+    end
+
     def client
       @client ||= Net::HTTP.new(host_uri.host, host_uri.port).tap do |c|
         c.use_ssl = host_uri.scheme == 'https'
@@ -103,8 +124,8 @@ module ElasticSearchFramework
       @read_timeout ||= Integer(ENV['CONNECTION_OPEN_TIMEOUT'] ||  1)
     end
 
-    def is_valid_response?(status)
-      [200,201,202].include?(Integer(status))
+    def valid_response?(status)
+      [200, 201, 202].include?(Integer(status))
     end
 
     def host

data/lib/elastic_search_framework/version.rb

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

data/spec/{repository_spec.rb → elastic_search_framework/repository_spec.rb}

@@ -121,6 +121,116 @@ RSpec.describe ElasticSearchFramework::Repository do
     end
   end
 
+  describe '#json_query' do
+    before do
+      ExampleIndex.delete
+      ExampleIndex.create
+
+      subject.set(index: ExampleIndex, entity: item1)
+      subject.set(index: ExampleIndex, entity: item2)
+      subject.set(index: ExampleIndex, entity: item3)
+      subject.set(index: ExampleIndex, entity: item4)
+      sleep 1
+    end
+
+    it 'returns the expected query results' do
+      result_query = {
+        'query' => {
+          'bool' => {
+            'must' => {
+              'match' => {
+                'name' => 'fred'
+              }
+            }
+          }
+        }
+      }
+      results = subject.json_query(index_name: 'test_example_index', json_query: result_query.to_json)
+      expect(results['hits'].length).to eq 1
+      expect(results['hits'][0]['_source']['name']).to eq item1.name
+      expect(results['hits'][0]['_source']['id']).to eq item1.id
+      expect(results['hits'][0]['_source']['timestamp']).to eq item1.timestamp
+      expect(results['hits'][0]['_source']['number']).to eq item1.number
+
+      example_one = {
+        'query' => {
+          'range' => {
+            'number' => {
+              'gt' => 5
+            }
+          }
+        }
+      }
+      example_two = {
+        'query' => {
+          'range' => {
+            'number' => {
+              'gte' => 15
+            }
+          }
+        }
+      }
+      example_three = {
+        'query' => {
+          'bool' => {
+            'must_not' => {
+              'match' => {
+                'name' => 'fred'
+              }
+            }
+          }
+        }
+      }
+      results = subject.json_query(index_name: 'test_example_index', json_query: example_one.to_json)
+      expect(results['hits'].length).to eq 3
+
+      results = subject.json_query(index_name: 'test_example_index', json_query: example_two.to_json)
+      expect(results['hits'].length).to eq 2
+
+      results = subject.json_query(index_name: 'test_example_index', json_query: example_three.to_json)
+      expect(results['hits'].length).to eq 3
+    end
+
+    context 'when an error occurs' do
+      it 'raises an ElasticSearchFramework::Exceptions::IndexError' do
+        example = {
+          'query' => {
+            'bool' => {
+              'must_not' => {
+                'name' => 'fred'
+              }
+            }
+          }
+        }
+
+        response_body = {
+          'error' => {
+            'root_cause' => [
+              {
+                'type' => 'parsing_exception',
+                'reason' => '[name] query malformed, no start_object after query name',
+                'line' => 1,
+                'col' => 38
+              }
+            ],
+            'type' => 'parsing_exception',
+            'reason' => '[name] query malformed, no start_object after query name',
+            'line' => 1,
+            'col' => 38
+          },
+          'status' => 400
+        }
+
+        expect{ subject.json_query(index_name: 'test_example_index', json_query: example.to_json) }
+          .to raise_error(ElasticSearchFramework::Exceptions::IndexError, "An error occurred executing an index query. Response: #{response_body.to_json}")
+      end
+    end
+
+    after do
+      ExampleIndex.delete
+    end
+  end
+
   describe '#host' do
     it 'should return the expected host based on default host & port values' do
       expect(subject.host).to eq "#{ElasticSearchFramework.host}:#{ElasticSearchFramework.port}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_search_framework
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - vaughanbrittonsage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,10 +123,10 @@ files:
 - lib/elastic_search_framework/query.rb
 - lib/elastic_search_framework/repository.rb
 - lib/elastic_search_framework/version.rb
+- spec/elastic_search_framework/index_spec.rb
+- spec/elastic_search_framework/query_spec.rb
+- spec/elastic_search_framework/repository_spec.rb
 - spec/example_index.rb
-- spec/index_spec.rb
-- spec/query_spec.rb
-- spec/repository_spec.rb
 - spec/spec_helper.rb
 - spec/test_item.rb
 homepage: https://github.com/sage/elastic_search_framework