opensearch-api 1.0.0 → 2.0.2

data/lib/opensearch/api/actions/search.rb

@@ -30,7 +30,6 @@ module OpenSearch
       # Returns results matching a query.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [String] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
@@ -87,21 +86,16 @@ module OpenSearch
         headers = arguments.delete(:headers) || {}
 
         arguments = arguments.clone
-        arguments[:index] = UNDERSCORE_ALL if !arguments[:index] && arguments[:type]
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = if arguments[:body]
                    OpenSearch::API::HTTP_POST
                  else
                    OpenSearch::API::HTTP_GET
                  end
 
-        path = if _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
-               elsif _index
+        path = if _index
                  "#{Utils.__listify(_index)}/_search"
                else
                  "_search"

data/lib/opensearch/api/actions/search_template.rb

@@ -30,7 +30,6 @@ module OpenSearch
       # Allows to use the Mustache language to pre-render a search definition.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
@@ -62,12 +61,8 @@ module OpenSearch
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = OpenSearch::API::HTTP_POST
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search/template"
-                 elsif _index
+        path   = if _index
                    "#{Utils.__listify(_index)}/_search/template"
                  else
                    "_search/template"

data/lib/opensearch/api/actions/termvectors.rb

@@ -31,7 +31,6 @@ module OpenSearch
       #
       # @option arguments [String] :index The index in which the document resides. (*Required*)
       # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @option arguments [String] :type The type of the document.
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
       # @option arguments [List] :fields A comma-separated list of fields to return.
@@ -63,8 +62,6 @@ module OpenSearch
 
         _id = arguments.delete(:id)
 
-        _type = arguments.delete(:type)
-
         method = if arguments[:body]
                    OpenSearch::API::HTTP_POST
                  else
@@ -72,11 +69,7 @@ module OpenSearch
                  end
 
         endpoint = arguments.delete(:endpoint) || '_termvectors'
-        path = if _index && _type && _id
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
-               elsif _index && _type
-                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
-               elsif _index && _id
+        path = if _index && _id
                  "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
                else
                  "#{Utils.__listify(_index)}/#{endpoint}"

data/lib/opensearch/api/actions/update.rb

@@ -31,7 +31,6 @@ module OpenSearch
       #
       # @option arguments [String] :id Document ID
       # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document *Deprecated*
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
       # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
@@ -66,14 +65,8 @@ module OpenSearch
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = OpenSearch::API::HTTP_POST
-        path   = if _index && _type && _id
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_update"
-                 else
-                   "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
-                 end
+        path   = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]

data/lib/opensearch/api/actions/update_by_query.rb

@@ -31,7 +31,6 @@ module OpenSearch
       # for example to pick up a mapping change.
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (*Required*)
-      # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [String] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
@@ -85,14 +84,8 @@ module OpenSearch
 
         _index = arguments.delete(:index)
 
-        _type = arguments.delete(:type)
-
         method = OpenSearch::API::HTTP_POST
-        path   = if _index && _type
-                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_update_by_query"
-                 else
-                   "#{Utils.__listify(_index)}/_update_by_query"
-                 end
+        path   = "#{Utils.__listify(_index)}/_update_by_query"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         body = arguments[:body]

data/lib/opensearch/api/utils.rb

@@ -40,7 +40,7 @@ module OpenSearch
       # @api private
       def __escape(string)
         return string if string == '*'
-        defined?(EscapeUtils) ? EscapeUtils.escape_url(string.to_s) : CGI.escape(string.to_s)
+        CGI.escape(string.to_s)
       end
 
       # Create a "list" of values from arguments, ignoring nil values and encoding special characters.

data/lib/opensearch/api/version.rb

@@ -26,6 +26,6 @@
 
 module OpenSearch
   module API
-    VERSION = '1.0.0'.freeze
+    VERSION = '2.0.2'.freeze
   end
 end

data/lib/opensearch/api.rb

@@ -42,7 +42,7 @@ module OpenSearch
 
     COMMON_PARAMS = [
       :ignore,                        # Client specific parameters
-      :index, :type, :id,             # :index/:type/:id
+      :index, :id,                    # :index/:id
       :body,                          # Request body
       :node_id,                       # Cluster
       :name,                          # Alias, template, settings, warmer, ...

data/opensearch-api.gemspec

@@ -79,7 +79,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'hashie'
 
   s.add_development_dependency 'cane'
-  s.add_development_dependency 'escape_utils' unless defined? JRUBY_VERSION
   s.add_development_dependency 'jbuilder'
   s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   s.add_development_dependency 'simplecov'

data/spec/opensearch/api/actions/bulk_spec.rb

@@ -47,22 +47,22 @@ describe 'client#bulk' do
 
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
-        {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}}
+        {"index":{"_index":"myindexA","_id":"1"}}
         {"title":"Test"}
-        {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
+        {"update":{"_index":"myindexB","_id":"2"}}
         {"doc":{"title":"Update"}}
-        {"delete":{"_index":"myindexC","_type":"mytypeC","_id":"3"}}
-        {"index":{"_index":"myindexD","_type":"mytype","_id":"1"}}
+        {"delete":{"_index":"myindexC","_id":"3"}}
+        {"index":{"_index":"myindexD","_id":"1"}}
         {"data":"MYDATA"}
       PAYLOAD
     end
 
     it 'performs the request' do
       expect(client_double.bulk(:body => [
-          { :index =>  { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
-          { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } },
-          { :delete => { :_index => 'myindexC', :_type => 'mytypeC', :_id => '3' } },
-          { :index =>  { :_index => 'myindexD', :_type => 'mytype', :_id => '1', :data => { :data => 'MYDATA' } } },
+          { :index =>  { :_index => 'myindexA', :_id => '1', :data => { :title => 'Test' } } },
+          { :update => { :_index => 'myindexB', :_id => '2', :data => { :doc => { :title => 'Update' } } } },
+          { :delete => { :_index => 'myindexC', :_id => '3' } },
+          { :index =>  { :_index => 'myindexD', :_id => '1', :data => { :data => 'MYDATA' } } },
       ])).to eq({})
     end
   end
@@ -80,13 +80,13 @@ describe 'client#bulk' do
 
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
-        {"update":{"_index":"myindex","_type":"mytype","_id":"1"}}
+        {"update":{"_index":"myindex","_id":"1"}}
         {"doc":{"data":{"title":"Update"}}}
       PAYLOAD
     end
 
     it 'performs the request' do
-      expect(client_double.bulk(body:[ { :update => { :_index => 'myindex', :_type => 'mytype', :_id => '1' } },
+      expect(client_double.bulk(body:[ { :update => { :_index => 'myindex', :_id => '1' } },
                                        { :doc => { :data => { :title => 'Update' } } } ])).to eq({})
     end
   end
@@ -134,15 +134,4 @@ describe 'client#bulk' do
       expect(client_double.bulk(index: 'foo^bar', body: [])).to eq({})
     end
   end
-
-  context 'when the type is provided' do
-
-    let(:url) do
-      'myindex/mytype/_bulk'
-    end
-
-    it 'performs the request' do
-      expect(client_double.bulk(index: 'myindex', type: 'mytype', body: [])).to eq({})
-    end
-  end
 end

data/spec/opensearch/api/actions/count_spec.rb

@@ -42,12 +42,12 @@ describe 'client#count' do
     expect(client_double.count).to eq({})
   end
 
-  context 'when an index and type are specified' do
+  context 'when an index is specified' do
 
     let(:expected_args) do
       [
         'POST',
-        'foo,bar/t1,t2/_count',
+        'foo,bar/_count',
         {},
         nil,
         {}
@@ -55,7 +55,7 @@ describe 'client#count' do
     end
 
     it 'performs the request' do
-      expect(client_double.count(index: ['foo','bar'], type: ['t1','t2'])).to eq({})
+      expect(client_double.count(index: ['foo','bar'])).to eq({})
     end
   end
 

data/spec/opensearch/api/actions/create_document_spec.rb

@@ -31,7 +31,7 @@ describe 'client#create_document' do
   let(:expected_args) do
     [
         'PUT',
-        'foo/bar/123',
+        'foo/_doc/123',
         { op_type: 'create' },
         { foo: 'bar' },
         {}
@@ -39,7 +39,7 @@ describe 'client#create_document' do
   end
 
   it 'performs the request' do
-    expect(client_double.create(index: 'foo', type: 'bar', id: '123', body: { foo: 'bar'})).to eq({})
+    expect(client_double.create(index: 'foo', id: '123', body: { foo: 'bar'})).to eq({})
   end
 
   context 'when the request needs to be URL-escaped' do
@@ -47,7 +47,7 @@ describe 'client#create_document' do
     let(:expected_args) do
       [
           'PUT',
-          'foo/bar%2Fbam/123',
+          'foo%5Ebar/_doc/123',
           { op_type: 'create' },
           {},
           {}
@@ -55,7 +55,7 @@ describe 'client#create_document' do
     end
 
     it 'performs the request' do
-      expect(client_double.create(index: 'foo', type: 'bar/bam', id: '123', body: {})).to eq({})
+      expect(client_double.create(index: 'foo^bar', id: '123', body: {})).to eq({})
     end
   end
 
@@ -64,7 +64,7 @@ describe 'client#create_document' do
     let(:expected_args) do
       [
           'PUT',
-          'foo/bar/1',
+          'foo/_doc/1',
           { op_type: 'create' },
           { foo: 'bar' },
           {}
@@ -72,7 +72,7 @@ describe 'client#create_document' do
     end
 
     it 'updates the arguments with the `op_type`' do
-      expect(client_double.create(index: 'foo', type: 'bar', id: 1, body: { foo: 'bar' })).to eq({})
+      expect(client_double.create(index: 'foo', id: 1, body: { foo: 'bar' })).to eq({})
     end
   end
 
@@ -81,7 +81,7 @@ describe 'client#create_document' do
     let(:expected_args) do
       [
           'POST',
-          'foo/bar',
+          'foo/_doc',
           { },
           { foo: 'bar' },
           {}
@@ -89,7 +89,7 @@ describe 'client#create_document' do
     end
 
     it 'updates the arguments with the `op_type`' do
-      expect(client_double.create(index: 'foo', type: 'bar', body: { foo: 'bar' })).to eq({})
+      expect(client_double.create(index: 'foo', body: { foo: 'bar' })).to eq({})
     end
   end
 end

data/spec/opensearch/api/actions/delete_by_query_spec.rb

@@ -48,23 +48,6 @@ describe 'client#delete_by_query' do
     expect(client_double.delete_by_query(index: 'foo', body: { term: {} })).to eq({})
   end
 
-  context 'when the type argument is provided' do
-
-    let(:expected_args) do
-      [
-        'POST',
-        'foo/tweet,post/_delete_by_query',
-        {},
-        { term: {} },
-        {}
-      ]
-    end
-
-    it 'performs the request' do
-      expect(client_double.delete_by_query(index: 'foo', type: ['tweet', 'post'], body: { term: {} })).to eq({})
-    end
-  end
-
   context 'when a query is provided' do
     let(:expected_args) do
       [

data/spec/opensearch/api/actions/delete_document_spec.rb

@@ -31,7 +31,7 @@ describe 'client#delete' do
   let(:expected_args) do
     [
         'DELETE',
-        'foo/bar/1',
+        'foo/_doc/1',
         params,
         nil,
         {}
@@ -48,18 +48,18 @@ describe 'client#delete' do
 
   it 'requires the :index argument' do
     expect {
-      client.delete(type: 'bar', id: '1')
+      client.delete(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.delete(index: 'foo', type: 'bar')
+      client.delete(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.delete(index: 'foo', type: 'bar', id: '1')).to eq({})
+    expect(client_double.delete(index: 'foo', id: '1')).to eq({})
   end
 
   context 'when url params are provided' do
@@ -69,7 +69,7 @@ describe 'client#delete' do
     end
 
     it 'performs the request' do
-      expect(client_double.delete(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+      expect(client_double.delete(index: 'foo', id: '1', routing: 'abc123')).to eq({})
     end
   end
 
@@ -77,7 +77,7 @@ describe 'client#delete' do
 
     it 'raises an ArgumentError' do
       expect {
-        client.delete(index: 'foo', type: 'bar', id: '1', qwertypoiuy: 'asdflkjhg')
+        client.delete(index: 'foo', id: '1', qwertypoiuy: 'asdflkjhg')
       }.to raise_exception(ArgumentError)
     end
   end
@@ -87,7 +87,7 @@ describe 'client#delete' do
     let(:expected_args) do
       [
           'DELETE',
-          'foo%5Ebar/bar%2Fbam/1',
+          'foo%5Ebar/_doc/1',
           params,
           nil,
           {}
@@ -95,7 +95,7 @@ describe 'client#delete' do
     end
 
     it 'escapes the url params' do
-      expect(client_double.delete(index: 'foo^bar', type: 'bar/bam', id: 1)).to eq({})
+      expect(client_double.delete(index: 'foo^bar', id: 1)).to eq({})
     end
   end
 
@@ -107,14 +107,14 @@ describe 'client#delete' do
 
     it 'raises the exception' do
       expect {
-        client.delete(index: 'foo', type: 'bar', id: 'XXX')
+        client.delete(index: 'foo', id: 'XXX')
       }.to raise_exception(NotFound)
     end
 
     context 'when the :ignore option is provided' do
 
       it 'does not raise the NotFound exception' do
-        expect(client.delete(index: 'foo', type: 'bar', id: 1, ignore: 404)).to eq(false)
+        expect(client.delete(index: 'foo', id: 1, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/opensearch/api/actions/exists_document_spec.rb

@@ -43,7 +43,7 @@ describe 'client#exists' do
   end
 
   let(:url) do
-    'foo/bar/1'
+    'foo/_doc/1'
   end
 
   let(:client) do
@@ -52,13 +52,13 @@ describe 'client#exists' do
 
   it 'requires the :index argument' do
     expect {
-      client.exists(type: 'bar', id: '1')
+      client.exists(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.exists(index: 'foo', type: 'bar')
+      client.exists(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
@@ -74,7 +74,7 @@ describe 'client#exists' do
   end
 
   it 'is aliased to a predicated method' do
-    expect(client_double.exists?(index: 'foo', type: 'bar', id: '1')).to eq(true)
+    expect(client_double.exists?(index: 'foo', id: '1')).to eq(true)
   end
 
   context 'when URL parameters are provided' do
@@ -84,18 +84,18 @@ describe 'client#exists' do
     end
 
     it 'passes the parameters' do
-      expect(client_double.exists(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq(true)
+      expect(client_double.exists(index: 'foo', id: '1', routing: 'abc123')).to eq(true)
     end
   end
 
   context 'when the request needs to be URL-escaped' do
 
     let(:url) do
-      'foo/bar%2Fbam/1'
+      'foo%5Ebar/_doc/1'
     end
 
     it 'URL-escapes the characters' do
-      expect(client_double.exists(index: 'foo', type: 'bar/bam', id: '1')).to eq(true)
+      expect(client_double.exists(index: 'foo^bar', id: '1')).to eq(true)
     end
   end
 
@@ -106,7 +106,7 @@ describe 'client#exists' do
     end
 
     it 'returns false' do
-      expect(client_double.exists(index: 'foo', type: 'bar', id: '1')).to eq(false)
+      expect(client_double.exists(index: 'foo', id: '1')).to eq(false)
     end
   end
 
@@ -117,7 +117,7 @@ describe 'client#exists' do
     end
 
     it 'returns false' do
-      expect(client_double.exists(index: 'foo', type: 'bar', id: '1')).to eq(false)
+      expect(client_double.exists(index: 'foo', id: '1')).to eq(false)
     end
   end
 
@@ -129,7 +129,7 @@ describe 'client#exists' do
 
     it 'raises the error' do
       expect {
-        client_double.exists(index: 'foo', type: 'bar', id: '1')
+        client_double.exists(index: 'foo', id: '1')
       }.to raise_exception(StandardError)
     end
   end

data/spec/opensearch/api/actions/explain_document_spec.rb

@@ -48,7 +48,7 @@ describe 'client#explain' do
   end
 
   let(:url) do
-    'foo/bar/1/_explain'
+    'foo/_explain/1'
   end
 
   let(:client) do
@@ -57,18 +57,18 @@ describe 'client#explain' do
 
   it 'requires the :index argument' do
     expect {
-      client.explain(type: 'bar', id: '1')
+      client.explain(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.explain(index: 'foo', type: 'bar')
+      client.explain(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
   
   it 'performs the request' do
-    expect(client_double.explain(index: 'foo', type: 'bar', id: 1, body: {})).to eq({})
+    expect(client_double.explain(index: 'foo', id: 1, body: {})).to eq({})
   end
 
   context 'when a query is provided' do
@@ -82,7 +82,7 @@ describe 'client#explain' do
     end
 
     it 'passes the query' do
-      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', q: 'abc123')).to eq({})
+      expect(client_double.explain(index: 'foo', id: '1', q: 'abc123')).to eq({})
     end
   end
 
@@ -92,17 +92,17 @@ describe 'client#explain' do
     end
 
     it 'passes the query definition' do
-      expect(client_double.explain(index: 'foo', type: 'bar', id: '1', body: { query: { match: {} } })).to eq({})
+      expect(client_double.explain(index: 'foo', id: '1', body: { query: { match: {} } })).to eq({})
     end
   end
 
   context 'when the request needs to be URL-escaped' do
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_explain'
+      'foo%5Ebar/_explain/1'
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.explain(index: 'foo^bar', type: 'bar/bam', id: '1', body: { })).to eq({})
+      expect(client_double.explain(index: 'foo^bar', id: '1', body: { })).to eq({})
     end
   end
 end

data/spec/opensearch/api/actions/get_document_source_spec.rb

@@ -43,7 +43,7 @@ describe 'client#get_source' do
   end
 
   let(:url) do
-    'foo/bar/1/_source'
+    'foo/_source/1'
   end
 
   let(:client) do
@@ -52,13 +52,13 @@ describe 'client#get_source' do
 
   it 'requires the :index argument' do
     expect {
-      client.get_source(type: 'bar', id: '1')
+      client.get_source(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.get_source(index: 'foo', type: 'bar')
+      client.get_source(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
@@ -80,18 +80,18 @@ describe 'client#get_source' do
     end
 
     it 'Passes the URL params' do
-      expect(client_double.get_source(index: 'foo', type: 'bar', id: '1', routing: 'abc123')).to eq({})
+      expect(client_double.get_source(index: 'foo', id: '1', routing: 'abc123')).to eq({})
     end
   end
 
   context 'when the request needs to be URL-escaped' do
 
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_source'
+      'foo%5Ebar/_source/1'
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.get_source(index: 'foo^bar', type: 'bar/bam', id: '1')).to eq({})
+      expect(client_double.get_source(index: 'foo^bar', id: '1')).to eq({})
     end
   end