opensearch-api 1.0.0 → 2.2.0

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

@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
+require 'spec_helper'
+
+describe 'client#create_pit' do
+  let(:expected_args) do
+    [
+      'POST',
+      'movies,books/_search/point_in_time',
+      { keep_alive: '1m',
+        preference: :random,
+        routing: :route,
+        expand_wildcards: :open,
+        allow_partial_pit_creation: false },
+      nil
+    ]
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.create_pit(keep_alive: '1m')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.create_pit(index: 'movies')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'does not accept unregistered params' do
+    expect {
+      client.create_pit(index: 'movies', keep_alive: '1m', something: 42)
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request with all optional params' do
+    expect(client_double.create_pit(
+      index: %w[movies books],
+      keep_alive: '1m',
+      preference: :random,
+      routing: :route,
+      expand_wildcards: :open,
+      allow_partial_pit_creation: false
+    )).to eq({})
+  end
+end

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

@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
+require 'spec_helper'
+
+describe 'client#delete_all_pits' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_search/point_in_time/_all',
+      {},
+      nil
+    ]
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'does not accept unregistered params' do
+    expect {
+      client.delete_all_pits(something: :else)
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request with all optional params' do
+    expect(client_double.delete_all_pits).to eq({})
+  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/delete_pit_spec.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
+require 'spec_helper'
+
+describe 'client#delete_pit' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_search/point_in_time',
+      {},
+      { pit_id: ['abc'] }
+    ]
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.delete_pit
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'does not accept unregistered params' do
+    expect {
+      client.delete_pit(body: {}, something: :else)
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request with all optional params' do
+    expect(client_double.delete_pit(body: { pit_id: ['abc'] })).to eq({})
+  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_all_pits_spec.rb

@@ -0,0 +1,35 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+
+require 'spec_helper'
+
+describe 'client#get_all_pits' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_search/point_in_time/_all',
+      {},
+      nil
+    ]
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'does not accept unregistered params' do
+    expect {
+      client.get_all_pits(something: :else)
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request with all optional params' do
+    expect(client_double.get_all_pits).to eq({})
+  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
 

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

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

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

@@ -49,11 +49,11 @@ describe 'client#get_script' do
   context 'when the `lang` parameter is specificed' do
 
     let(:params) do
-      { master_timeout: '1s' }
+      { cluster_manager_timeout: '1s' }
     end
 
     it 'performs the request' do
-      expect(client_double.get_script(master_timeout: '1s', id: 'foo')).to eq({})
+      expect(client_double.get_script(cluster_manager_timeout: '1s', id: 'foo')).to eq({})
     end
   end
 end

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

@@ -45,7 +45,6 @@ describe 'Hashie' do
                 "hits": [
                   {
                     "_index": "myindex",
-                    "_type": "mytype",
                     "_id": "1",
                     "_score": 0.51104903,
                     "_source": {
@@ -63,7 +62,6 @@ describe 'Hashie' do
               },
               "facets": {
                 "tags": {
-                  "_type": "terms",
                   "missing": 0,
                   "total": 10,
                   "other": 0,

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

@@ -47,7 +47,7 @@ describe 'client#index' do
   end
 
   let(:url) do
-    'foo/bar'
+    'foo/_doc'
   end
 
   let(:body) do
@@ -60,12 +60,12 @@ describe 'client#index' do
 
   it 'requires the :index argument' do
     expect {
-      client.index(type: 'bar')
+      client.index()
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.index(index: 'foo', type: 'bar', body: body)).to eq({})
+    expect(client_double.index(index: 'foo', body: body)).to eq({})
   end
 
   context 'when a specific id is provided' do
@@ -75,11 +75,11 @@ describe 'client#index' do
     end
 
     let(:url) do
-      'foo/bar/1'
+      'foo/_doc/1'
     end
 
     it 'performs the request' do
-      expect(client_double.index(index: 'foo', type: 'bar', id: '1', body: body)).to eq({})
+      expect(client_double.index(index: 'foo', id: '1', body: body)).to eq({})
     end
   end
 
@@ -90,7 +90,7 @@ describe 'client#index' do
     end
 
     let(:url) do
-      'foo/bar'
+      'foo/_doc'
     end
 
     let(:params) do
@@ -98,7 +98,7 @@ describe 'client#index' do
     end
 
     it 'passes the URL params' do
-      expect(client_double.index(index: 'foo', type: 'bar', op_type: 'create', body: body)).to eq({})
+      expect(client_double.index(index: 'foo', op_type: 'create', body: body)).to eq({})
     end
 
     context 'when a specific id is provided' do
@@ -108,7 +108,7 @@ describe 'client#index' do
       end
 
       let(:url) do
-        'foo/bar/1'
+        'foo/_doc/1'
       end
 
       let(:params) do
@@ -116,7 +116,7 @@ describe 'client#index' do
       end
 
       it 'passes the URL params' do
-        expect(client_double.index(index: 'foo', type: 'bar', id: '1', op_type: 'create', body: body)).to eq({})
+        expect(client_double.index(index: 'foo', id: '1', op_type: 'create', body: body)).to eq({})
       end
     end
   end
@@ -127,11 +127,11 @@ describe 'client#index' do
     end
 
     let(:url) do
-      'foo/bar%2Fbam/123'
+      'foo%5Ebar/_doc/123'
     end
 
     it 'URL-escapes the parts' do
-      expect(client_double.index(index: 'foo', type: 'bar/bam', id: '123', body: body)).to eq({})
+      expect(client_double.index(index: 'foo^bar', id: '123', body: body)).to eq({})
     end
   end
 
@@ -139,7 +139,7 @@ describe 'client#index' do
 
     it 'raises and ArgumentError' do
       expect {
-        client.index(index: 'foo', type: 'bar', id: '1', qwerty: 'yuiop')
+        client.index(index: 'foo', id: '1', qwerty: 'yuiop')
       }.to raise_exception(ArgumentError)
     end
   end

data/spec/opensearch/api/actions/indices/clone_spec.rb

@@ -88,7 +88,7 @@ describe 'client.indices#clone' do
     let(:params) do
       {
           timeout: '1s',
-          master_timeout: '10s',
+          cluster_manager_timeout: '10s',
           wait_for_active_shards: 1
       }
     end
@@ -97,7 +97,7 @@ describe 'client.indices#clone' do
       expect(client_double.indices.clone(index: 'my_source_index',
                                          target: 'my_target_index',
                                          timeout: '1s',
-                                         master_timeout: '10s',
+                                         cluster_manager_timeout: '10s',
                                          wait_for_active_shards: 1)).to eq({})
     end
   end