opensearch-ruby 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfe78362c6e8419468eee1d2e0ed0810e85d6ef32b437b0f4f9ddfe92bb079d
-  data.tar.gz: 439186758b24c9793796122a1ed77495f0849dac72b1fa7ffaaa68f2619ea56d
+  metadata.gz: 3c9fdb7a7db88f76450b0e373a298a2246d6553705ca3692e10f40137b413f5c
+  data.tar.gz: 8b83c460d6f2104464423c7d8c757be42128af498eb3fc7d838455fc65a04203
 SHA512:
-  metadata.gz: 9447ff69ca3872f90ba4a22bcff45f4002ab4f7e49bfdc6905d78a33be55522fcc855f1d31722d0c27ddc86448d6911489148cd326393c2dcc22e5ca542be591
-  data.tar.gz: '016245184b5d758b4712dd9b9307189ce3310628cfaad9db5ca774ac7b1e5b5114f8216bb95e2a1511f498112120878b75d2f86065ac94677d27307bf38e32ac'
+  metadata.gz: e23fad0916d26017323185c0b6f44067724deb5e66a0b849ebf042e90342f6941033bea8903b7eeac7f7eadbf1b35998d6f366c3187659c6194684c730908a49
+  data.tar.gz: a2c5a7945ef0442eb9e725fede191d37cefa04625c716400528322fa638ad5899e7e8b77f03de73511dabfa252aff4c0564e9f7f52852761020ba5958a949eab

data/USER_GUIDE.md

@@ -138,6 +138,7 @@ response = client.search index: index_name, body: search {
 - [Advanced Index Actions](guides/advanced_index_actions.md)
 - [Index Templates](guides/index_template.md)
 - [Transport Options](guides/transport_options.md)
+- [Custom HTTP Requests](guides/json.md)
 
 ## Amazon OpenSearch Service
 

data/lib/opensearch/api/actions/http/connect.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized CONNECT request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def connect(url, headers: {}, body: nil, params: {})
+          request('CONNECT', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/delete.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized DELETE request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def delete(url, headers: {}, body: nil, params: {})
+          request('DELETE', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/get.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized GET request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def get(url, headers: {}, body: nil, params: {})
+          request('GET', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/head.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized HEAD request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def head(url, headers: {}, body: nil, params: {})
+          request('HEAD', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/options.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized OPTIONS request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def options(url, headers: {}, body: nil, params: {})
+          request('OPTIONS', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/patch.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized PATCH request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def patch(url, headers: {}, body: nil, params: {})
+          request('PATCH', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/post.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized POST request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def post(url, headers: {}, body: nil, params: {})
+          request('POST', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/put.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized PUT request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def put(url, headers: {}, body: nil, params: {})
+          request('PUT', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/request.rb

@@ -0,0 +1,27 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        private
+
+        def request(method, url, headers: {}, body: nil, params: {})
+          body = OpenSearch::API::Utils.__bulkify(body) if body.is_a?(Array)
+          headers.merge!('Content-Type' => 'application/x-ndjson') if body.is_a?(Array)
+
+          perform_request(method, url, params, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/http/trace.rb

@@ -0,0 +1,28 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions
+        # Make a customized TRACE request.
+        #
+        # @option arguments [String] :url Relative path to the endpoint (e.g. 'cat/indices/books,movies') (*Required*)
+        # @option arguments [Hash] :params Querystring parameters to be appended to the path
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [String | Hash | Array<Hash>] :body The body of the request
+        def trace(url, headers: {}, body: nil, params: {})
+          request('TRACE', url, headers: headers, body: body, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/namespace/http.rb

@@ -0,0 +1,30 @@
+# 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.
+
+# This code was generated from OpenSearch API Spec.
+# Update the code generation logic instead of modifying this file directly.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Http
+      module Actions; end
+
+      # Client for the "http" namespace (includes the Http::Actions methods)
+      class HttpClient
+        include Http::Actions
+        include Common::Client
+        include Common::Client::Base
+      end
+
+      # Proxy method for HttpClient, available in the receiving object
+      def http
+        @http ||= HttpClient.new(self)
+      end
+    end
+  end
+end

data/lib/opensearch/api.rb

@@ -79,6 +79,7 @@ module OpenSearch
                 OpenSearch::API::Cluster,
                 OpenSearch::API::DanglingIndices,
                 OpenSearch::API::Features,
+                OpenSearch::API::Http,
                 OpenSearch::API::Indices,
                 OpenSearch::API::Ingest,
                 OpenSearch::API::Nodes,

data/lib/opensearch/transport/transport/response.rb

@@ -39,7 +39,7 @@ module OpenSearch
           @status = status
           @body = body
           @headers = headers
-          @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding)
+          @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding) && body.encoding != Encoding::UTF_8
         end
       end
     end

data/lib/opensearch/version.rb

@@ -25,5 +25,5 @@
 # under the License.
 
 module OpenSearch
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/test/transport/unit/response_test.rb

@@ -28,8 +28,7 @@ require_relative '../test_helper'
 
 class OpenSearch::Transport::Transport::ResponseTest < Minitest::Test
   context "Response" do
-
-    should "force-encode the body into UTF" do
+    should "force-encode the body into UTF-8" do
       body = "Hello Encoding!".encode(Encoding::ISO_8859_1)
       assert_equal 'ISO-8859-1', body.encoding.name
 
@@ -37,5 +36,11 @@ class OpenSearch::Transport::Transport::ResponseTest < Minitest::Test
       assert_equal 'UTF-8', response.body.encoding.name
     end
 
+    should "not force-encode the body if it is already encoded as UTF-8" do
+      body = "Hello Frozen!".freeze
+      response = OpenSearch::Transport::Transport::Response.new 200, body
+
+      assert_equal body, response.body
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opensearch-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Elastic
@@ -31,7 +31,7 @@ cert_chain:
   1DlemA1SsUBIoF7CwtVd/RTG/K1iT6nBD08fdKxodMhI5ujkP3N7gkxzRf6aKN4z
   glnDJYZjluKBUsKTOLdPW1CZpb0AHLpNqDf8SVHsPFk=
   -----END CERTIFICATE-----
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,6 +159,16 @@ files:
 - lib/opensearch/api/actions/get_script_context.rb
 - lib/opensearch/api/actions/get_script_languages.rb
 - lib/opensearch/api/actions/get_source.rb
+- lib/opensearch/api/actions/http/connect.rb
+- lib/opensearch/api/actions/http/delete.rb
+- lib/opensearch/api/actions/http/get.rb
+- lib/opensearch/api/actions/http/head.rb
+- lib/opensearch/api/actions/http/options.rb
+- lib/opensearch/api/actions/http/patch.rb
+- lib/opensearch/api/actions/http/post.rb
+- lib/opensearch/api/actions/http/put.rb
+- lib/opensearch/api/actions/http/request.rb
+- lib/opensearch/api/actions/http/trace.rb
 - lib/opensearch/api/actions/index.rb
 - lib/opensearch/api/actions/indices/add_block.rb
 - lib/opensearch/api/actions/indices/analyze.rb
@@ -318,6 +328,7 @@ files:
 - lib/opensearch/api/namespace/common.rb
 - lib/opensearch/api/namespace/dangling_indices.rb
 - lib/opensearch/api/namespace/features.rb
+- lib/opensearch/api/namespace/http.rb
 - lib/opensearch/api/namespace/indices.rb
 - lib/opensearch/api/namespace/ingest.rb
 - lib/opensearch/api/namespace/nodes.rb