opensearch-ruby 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfe78362c6e8419468eee1d2e0ed0810e85d6ef32b437b0f4f9ddfe92bb079d
-  data.tar.gz: 439186758b24c9793796122a1ed77495f0849dac72b1fa7ffaaa68f2619ea56d
+  metadata.gz: 419497e48fbb6859275f24629079b21861fcca68bebb7f91254e8d912e216ced
+  data.tar.gz: 4de9071cd2a940c459864ddc4e89fa27e837ce74f3cfd3cfa719ac2ef3f534a5
 SHA512:
-  metadata.gz: 9447ff69ca3872f90ba4a22bcff45f4002ab4f7e49bfdc6905d78a33be55522fcc855f1d31722d0c27ddc86448d6911489148cd326393c2dcc22e5ca542be591
-  data.tar.gz: '016245184b5d758b4712dd9b9307189ce3310628cfaad9db5ca774ac7b1e5b5114f8216bb95e2a1511f498112120878b75d2f86065ac94677d27307bf38e32ac'
+  metadata.gz: df16ea05cb84a645a968ba8c4431b7be168fbaa47c841d02acd2015f46b82b57f7ebf3b8cea3e70b886379fe4ac2e6d73d79e92009baf85ac563a52f1806c5bf
+  data.tar.gz: f63990cbb5dc776c28aa88ff2e53db4861e75be8c97595784e2a7dd25ad9b4990e0878c90d5f831f3fe7d07a046f6577d98766b1e793cf8ef5ee60f4d4dc7768

data/USER_GUIDE.md

@@ -13,8 +13,8 @@ To add the client to your project, install it using [RubyGems](https://rubygems.
 `gem install opensearch-ruby`
 
 or add it to your Gemfile:
-```
-gem opensearch-ruby
+```ruby
+gem 'opensearch-ruby'
 ```
 and run:
 ```
@@ -23,7 +23,9 @@ bundle install
 
 Import the client:
 
-`require 'opensearch'`
+```ruby
+require 'opensearch'
+```
 
 ## Basic Usage
 ```ruby
@@ -138,6 +140,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/actions/search.rb

@@ -48,6 +48,7 @@ module OpenSearch
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @option arguments [List] :routing A comma-separated list of specific routing values
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_pipeline Customizable sequence of processing stages applied to search queries.
       # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch)
       # @option arguments [Number] :size Number of hits to return (default: 10)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
@@ -128,6 +129,7 @@ module OpenSearch
         q
         routing
         scroll
+        search_pipeline
         search_type
         size
         sort

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/dsl/search/options.rb

@@ -55,10 +55,10 @@ module OpenSearch
           define_method name do |*args|
             @hash[name] = args.pop
           end
+        end
 
-          define_method name.to_s.gsub(/^_(.*)/, '\1') do |*args|
-            @hash[name] = args.pop
-          end
+        def source(*args)
+          @hash[:_source] = args.pop
         end
 
         # Returns true when there are no search options defined

data/lib/opensearch/dsl/search/queries/match.rb

@@ -59,7 +59,6 @@ module OpenSearch
           option_method :lenient
           option_method :zero_terms_query
           option_method :cutoff_frequency
-          option_method :max_expansions
         end
       end
     end

data/lib/opensearch/transport/client.rb

@@ -24,8 +24,6 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'base64'
-
 module OpenSearch
   module Transport
     # Handles communication with an OpenSearch cluster.
@@ -225,7 +223,8 @@ module OpenSearch
         return unless arguments[:cloud_id] && !arguments[:cloud_id].empty?
 
         name = arguments[:cloud_id].split(':')[0]
-        cloud_url, opensearch_instance = Base64.decode64(arguments[:cloud_id].gsub("#{name}:", '')).split('$')
+        base64_decoded = arguments[:cloud_id].gsub("#{name}:", '').unpack1('m')
+        cloud_url, opensearch_instance = base64_decoded.split('$')
 
         if cloud_url.include?(':')
           url, port = cloud_url.split(':')
@@ -355,7 +354,8 @@ module OpenSearch
       # Encode credentials for the Authorization Header
       # Credentials is the base64 encoding of id and api_key joined by a colon
       def __encode(api_key)
-        Base64.strict_encode64([api_key[:id], api_key[:api_key]].join(':'))
+        joined = [api_key[:id], api_key[:api_key]].join(':')
+        [joined].pack('m0')
       end
     end
   end

data/lib/opensearch/transport/transport/base.rb

@@ -104,9 +104,7 @@ module OpenSearch
         # @see Sniffer#hosts
         #
         def reload_connections!
-          puts hosts
           hosts = sniffer.hosts
-          puts hosts
           __rebuild_connections hosts: hosts, options: options
           self
         rescue SnifferTimeoutError

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.2.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.2.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: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,7 +143,6 @@ files:
 - lib/opensearch/api/actions/delete_all_pits.rb
 - lib/opensearch/api/actions/delete_by_query.rb
 - lib/opensearch/api/actions/delete_by_query_rethrottle.rb
-- lib/opensearch/api/actions/delete_by_rethrottle.rb
 - lib/opensearch/api/actions/delete_pit.rb
 - lib/opensearch/api/actions/delete_script.rb
 - lib/opensearch/api/actions/exists.rb
@@ -159,6 +158,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 +327,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

metadata.gz.sig

@@ -1,2 +1,3 @@
-�H���5L�۹/���c��^�y?��#W��X%ˬ��+i]�4UiL�)=k_���
-nt���0�5
+%
+�>f�j�L+<F�Z�$��
@�,OFfy��~��!q�
+

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

@@ -1,55 +0,0 @@
-# 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.
-#
-# Licensed to Elasticsearch B.V. under one or more contributor
-# license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright
-# ownership. Elasticsearch B.V. licenses this file to you under
-# the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
-# under the License.
-
-module OpenSearch
-  module API
-    module Actions
-      # The value of requests_per_second can be changed on a running delete by query using the _rethrottle API
-      #
-      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
-      #
-      #
-      def delete_by_query_rethrottle(arguments = {})
-        raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
-
-        method = OpenSearch::API::HTTP_POST
-        path   = "_delete_by_query/#{arguments[:task_id]}/_rethrottle"
-        params = OpenSearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
-
-        perform_request(method, path, params, body).body
-      end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.2.0
-      ParamsRegistry.register(:delete_by_query_rethrottle, [
-        :requests_per_second
-      ].freeze)
-    end
-  end
-end