opensearch-ruby 2.0.3 → 3.4.0

data/lib/opensearch/transport/transport/http/manticore.rb

@@ -0,0 +1,188 @@
+# 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.
+
+require 'manticore'
+
+module OpenSearch
+  module Transport
+    module Transport
+      module HTTP
+        # Alternative HTTP transport implementation for JRuby,
+        # using the [_Manticore_](https://github.com/cheald/manticore) client,
+        #
+        # @example HTTP
+        #
+        #     require 'opensearch/transport/transport/http/manticore'
+        #
+        #     client = OpenSearch::Client.new transport_class: OpenSearch::Transport::Transport::HTTP::Manticore
+        #
+        #     client.transport.connections.first.connection
+        #     => #<Manticore::Client:0x56bf7ca6 ...>
+        #
+        #     client.info['status']
+        #     => 200
+        #
+        #  @example HTTPS (All SSL settings are optional,
+        #                  see http://www.rubydoc.info/gems/manticore/Manticore/Client:initialize)
+        #
+        #     require 'opensearch/transport/transport/http/manticore'
+        #
+        #     client = OpenSearch::Client.new \
+        #       url: 'https://opensearch.example.com',
+        #       transport_class: OpenSearch::Transport::Transport::HTTP::Manticore,
+        #       ssl: {
+        #         truststore: '/tmp/truststore.jks',
+        #         truststore_password: 'password',
+        #         keystore: '/tmp/keystore.jks',
+        #         keystore_password: 'secret',
+        #       }
+        #
+        #     client.transport.connections.first.connection
+        #     => #<Manticore::Client:0xdeadbeef ...>
+        #
+        #     client.info['status']
+        #     => 200
+        #
+        # @see Transport::Base
+        #
+        class Manticore
+          include Base
+
+          def initialize(arguments = {}, &block)
+            @manticore = build_client(arguments[:options] || {})
+            super(arguments, &block)
+          end
+
+          # Should just be run once at startup
+          def build_client(options = {})
+            client_options = options[:transport_options] || {}
+            client_options[:ssl] = options[:ssl] || {}
+
+            @manticore = ::Manticore::Client.new(client_options)
+          end
+
+          # Performs the request by invoking {Transport::Base#perform_request} with a block.
+          #
+          # @return [Response]
+          # @see    Transport::Base#perform_request
+          #
+          def perform_request(method, path, params = {}, body = nil, headers = nil, opts = {})
+            super do |connection, url|
+              params[:body] = __convert_to_json(body) if body
+              params[:headers] = headers if headers
+              params = params.merge @request_options
+              case method
+              when "GET"
+                resp = connection.connection.get(url, params)
+              when "HEAD"
+                resp = connection.connection.head(url, params)
+              when "PUT"
+                resp = connection.connection.put(url, params)
+              when "POST"
+                resp = connection.connection.post(url, params)
+              when "DELETE"
+                resp = connection.connection.delete(url, params)
+              else
+                raise ArgumentError, "Method #{method} not supported"
+              end
+              Response.new resp.code, resp.read_body, resp.headers
+            end
+          end
+
+          # Builds and returns a collection of connections.
+          # Each connection is a Manticore::Client
+          #
+          # @return [Connections::Collection]
+          #
+          def __build_connections
+            @request_options = {}
+            apply_headers(@request_options, options[:transport_options])
+            apply_headers(@request_options, options)
+
+            Connections::Collection.new \
+              connections: hosts.map { |host|
+                host[:protocol]   = host[:scheme] || DEFAULT_PROTOCOL
+                host[:port]     ||= DEFAULT_PORT
+
+                host.delete(:user)     # auth is not supported here.
+                host.delete(:password) # use the headers
+
+                Connections::Connection.new \
+                  host: host,
+                  connection: @manticore
+              },
+              selector_class: options[:selector_class],
+              selector: options[:selector]
+          end
+
+          # Closes all connections by marking them as dead
+          # and closing the underlying HttpClient instances
+          #
+          # @return [Connections::Collection]
+          #
+          def __close_connections
+            # The Manticore adapter uses a single long-lived instance
+            # of Manticore::Client, so we don't close the connections.
+          end
+
+          # Returns an array of implementation specific connection errors.
+          #
+          # @return [Array]
+          #
+          def host_unreachable_exceptions
+            [
+              ::Manticore::Timeout,
+              ::Manticore::SocketException,
+              ::Manticore::ClientProtocolException,
+              ::Manticore::ResolutionFailure
+            ]
+          end
+
+          private
+
+          def apply_headers(request_options, options)
+            headers = (options && options[:headers]) || {}
+            headers[CONTENT_TYPE_STR] = find_value(headers, CONTENT_TYPE_REGEX) || DEFAULT_CONTENT_TYPE
+            headers[USER_AGENT_STR] = find_value(headers, USER_AGENT_REGEX) || user_agent_header
+            headers[ACCEPT_ENCODING] = GZIP if use_compression?
+            request_options.merge!(headers: headers)
+          end
+
+          def user_agent_header
+            @user_agent_header ||= begin
+              meta = ["RUBY_VERSION: #{JRUBY_VERSION}"]
+              if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+                meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+              end
+              meta << "Manticore #{::Manticore::VERSION}"
+              "opensearch-ruby/#{VERSION} (#{meta.join('; ')})"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/transport/transport/loggable.rb

@@ -0,0 +1,92 @@
+# 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 to encapsulate all logging functionality.
+  #
+  # @since 7.0.0
+  module Loggable
+    # Log a debug message.
+    #
+    # @example Log a debug message.
+    #   log_debug('Message')
+    #
+    # @param [ String ] message The message to log.
+    #
+    # @since 7.0.0
+    def log_debug(message)
+      logger.debug(message) if logger&.debug?
+    end
+
+    # Log an error message.
+    #
+    # @example Log an error message.
+    #   log_error('Message')
+    #
+    # @param [ String ] message The message to log.
+    #
+    # @since 7.0.0
+    def log_error(message)
+      logger.error(message) if logger&.error?
+    end
+
+    # Log a fatal message.
+    #
+    # @example Log a fatal message.
+    #   log_fatal('Message')
+    #
+    # @param [ String ] message The message to log.
+    #
+    # @since 7.0.0
+    def log_fatal(message)
+      logger.fatal(message) if logger&.fatal?
+    end
+
+    # Log an info message.
+    #
+    # @example Log an info message.
+    #   log_info('Message')
+    #
+    # @param [ String ] message The message to log.
+    #
+    # @since 7.0.0
+    def log_info(message)
+      logger.info(message) if logger&.info?
+    end
+
+    # Log a warn message.
+    #
+    # @example Log a warn message.
+    #   log_warn('Message')
+    #
+    # @param [ String ] message The message to log.
+    #
+    # @since 7.0.0
+    def log_warn(message)
+      logger.warn(message) if logger&.warn?
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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 Transport
+    module Transport
+      # Wraps the response from OpenSearch.
+      #
+      class Response
+        attr_reader :status, :body, :headers
+
+        # @param status  [Integer] Response status code
+        # @param body    [String]  Response body
+        # @param headers [Hash]    Response headers
+        def initialize(status, body, headers = {})
+          @status = status
+          @body = body
+          @headers = headers
+          @body = body.force_encoding('UTF-8') if body.respond_to?(:force_encoding) && body.encoding != Encoding::UTF_8
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/transport/transport/serializer/multi_json.rb

@@ -0,0 +1,61 @@
+# 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 Transport
+    module Transport
+      module Serializer
+        # An abstract class for implementing serializer implementations
+        #
+        module Base
+          # @param transport [Object] The instance of transport which uses this serializer
+          #
+          def initialize(transport = nil)
+            @transport = transport
+          end
+        end
+
+        # A default JSON serializer (using [MultiJSON](http://rubygems.org/gems/multi_json))
+        #
+        class MultiJson
+          include Base
+
+          # De-serialize a Hash from JSON string
+          #
+          def load(string, options = {})
+            ::MultiJson.load(string, options)
+          end
+
+          # Serialize a Hash to JSON string
+          #
+          def dump(object, options = {})
+            ::MultiJson.dump(object, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/transport/transport/sniffer.rb

@@ -0,0 +1,110 @@
+# 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 Transport
+    module Transport
+      # Handles node discovery ("sniffing")
+      #
+      class Sniffer
+        PROTOCOL = 'http'
+
+        attr_reader   :transport
+        attr_accessor :timeout
+
+        # @param transport [Object] A transport instance
+        #
+        def initialize(transport)
+          @transport = transport
+          @timeout   = transport.options[:sniffer_timeout] || 1
+        end
+
+        # Retrieves the node list from the OpenSearch's
+        # _Nodes Info API_
+        # and returns a normalized Array of information suitable for passing to transport.
+        #
+        # Shuffles the collection before returning it when the `randomize_hosts` option is set for transport.
+        #
+        # @return [Array<Hash>]
+        # @raise  [SnifferTimeoutError]
+        #
+        def hosts
+          Timeout.timeout(timeout, SnifferTimeoutError) do
+            nodes = perform_sniff_request.body
+
+            hosts = nodes['nodes'].map do |id, info|
+              next unless info[PROTOCOL]
+              host, port = parse_publish_address(info[PROTOCOL]['publish_address'])
+
+              {
+                id: id,
+                name: info['name'],
+                version: info['version'],
+                host: host,
+                port: port,
+                roles: info['roles'],
+                attributes: info['attributes']
+              }
+            end.compact
+
+            hosts.shuffle! if transport.options[:randomize_hosts]
+            hosts
+          end
+        end
+
+        private
+
+        def perform_sniff_request
+          transport.perform_request(
+            'GET', '_nodes/http', {}, nil, nil,
+            reload_on_failure: false
+          )
+        end
+
+        def parse_publish_address(publish_address)
+          # publish_address is in the format hostname/ip:port
+          if publish_address =~ %r{/}
+            parts = publish_address.partition('/')
+            [parts[0], parse_address_port(parts[2])[1]]
+          else
+            parse_address_port(publish_address)
+          end
+        end
+
+        def parse_address_port(publish_address)
+          # address is ipv6
+          if publish_address =~ /[\[\]]/
+            if (parts = publish_address.match(/\A\[(.+)\](?::(\d+))?\z/))
+              [parts[1], parts[2]]
+            end
+          else
+            publish_address.split(':')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/transport.rb

@@ -0,0 +1,44 @@
+# 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.
+
+require 'uri'
+require 'time'
+require 'timeout'
+require 'multi_json'
+require 'faraday'
+
+require 'opensearch/transport/transport/loggable'
+require 'opensearch/transport/transport/serializer/multi_json'
+require 'opensearch/transport/transport/sniffer'
+require 'opensearch/transport/transport/response'
+require 'opensearch/transport/transport/errors'
+require 'opensearch/transport/transport/base'
+require 'opensearch/transport/transport/connections/selector'
+require 'opensearch/transport/transport/connections/connection'
+require 'opensearch/transport/transport/connections/collection'
+require 'opensearch/transport/transport/http/faraday'
+require 'opensearch/transport/client'
+require 'opensearch/transport/redacted'

data/lib/opensearch/version.rb

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

data/lib/opensearch-dsl.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.
+#
+# 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.
+
+require 'opensearch/dsl'

data/lib/opensearch.rb

@@ -43,12 +43,13 @@ module OpenSearch
     end
 
     def method_missing(name, *args, &block)
-      if name == :perform_request
-        verify_open_search unless @verified
-        @transport.perform_request(*args, &block)
-      else
-        super
-      end
+      return super unless name == :perform_request
+      verify_open_search unless @verified
+      @transport.perform_request(*args, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name == :perform_request || super
     end
 
     private
@@ -78,14 +79,13 @@ module OpenSearch
       raise OpenSearch::UnsupportedProductError if version.nil?
 
       # The client supports all the versions of OpenSearch
-      if distribution == 'opensearch'
-        @verified = true
-      elsif Gem::Version.new(version) >= Gem::Version.new('6.0.0') &&
-        Gem::Version.new(version) < Gem::Version.new('8.0.0')
-        @verified = true
-      else
+      if distribution != 'opensearch' &&
+         (Gem::Version.new(version) < Gem::Version.new('6.0.0') ||
+           Gem::Version.new(version) >= Gem::Version.new('8.0.0'))
         raise OpenSearch::UnsupportedProductError
       end
+
+      @verified = true
     end
 
     def open_search_validation_request

data/opensearch-ruby.gemspec

@@ -0,0 +1,69 @@
+# 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.
+
+require_relative './lib/opensearch/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'opensearch-ruby'
+  s.version       = OpenSearch::VERSION
+  s.authors       = ['Elastic', 'OpenSearch Contributors']
+  s.email         = 'opensearch@amazon.com'
+  s.summary       = 'Ruby Client for OpenSearch'
+  s.homepage      = 'https://github.com/opensearch-project/opensearch-ruby'
+  s.license       = 'Apache-2.0'
+  s.description   = <<~DESC
+    OpenSearch Ruby is a Ruby client for OpenSearch. You can use the client to
+    execute OpenSearch API commands, and build OpenSearch queries and aggregations
+    using the included OpenSearch DSL.
+  DESC
+  s.metadata = {
+    'homepage_uri' => 'https://github.com/opensearch-project/opensearch-ruby',
+    'documentation_uri' => 'https://rubydoc.info/gems/opensearch-ruby',
+    'source_code_uri' => 'https://github.com/opensearch-project/opensearch-ruby/tree/main',
+    'bug_tracker_uri' => 'https://github.com/opensearch-project/opensearch-ruby/issues',
+    'changelog_uri' => 'https://github.com/opensearch-project/opensearch-ruby/blob/main/CHANGELOG.md'
+  }
+
+  s.files         = Dir['lib/**/*', '*.gemspec']
+  s.test_files    = Dir['spec**/*', 'test/**/*', 'features/**/*']
+  s.require_paths = ['lib']
+  s.bindir        = 'bin'
+  s.executables   = 'opensearch_ruby_console'
+
+  s.extra_rdoc_files  = %w[README.md USER_GUIDE.md LICENSE.txt]
+  s.rdoc_options      = ['--charset=UTF-8']
+
+  signing_key = File.expand_path('gem-private_key.pem')
+  if $PROGRAM_NAME.end_with?('gem') && ARGV.first == 'build' && File.exist?(signing_key)
+    s.signing_key = signing_key
+    s.cert_chain  = ['.github/opensearch-rubygems.pem']
+  end
+
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_dependency 'faraday', '>= 1.0', '< 3'
+  s.add_dependency 'multi_json', '>= 1.0'
+end