elasticsearch-serverless 0.0.8.20231031.pre

data/lib/elasticsearch-serverless/api/update.rb

@@ -0,0 +1,77 @@
+# 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.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Actions
+      # Updates a document with a script or partial document.
+      #
+      # @option arguments [String] :id Document ID (*Required*)
+      # @option arguments [String] :index The name of the index (*Required*)
+      # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term.
+      # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
+      # @option arguments [String] :lang The script language. Server default: painless.
+      # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes. Server default: false.
+      # @option arguments [Boolean] :require_alias If true, the destination must be an index alias.
+      # @option arguments [Integer] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs. Server default: 0.
+      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
+      # @option arguments [Time] :timeout Period to wait for dynamic mapping updates and active shards. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m.
+      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard. Server default: 1.
+      # @option arguments [Boolean, String, Array<String>] :_source Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. Server default: true.
+      # @option arguments [String, Array<String>] :_source_excludes Specify the source fields you want to exclude.
+      # @option arguments [String, Array<String>] :_source_includes Specify the source fields you want to retrieve.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body request body
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html
+      #
+      def update(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
+
+        _id = arguments.delete(:id)
+
+        _index = arguments.delete(:index)
+
+        method = ElasticsearchServerless::API::HTTP_POST
+        path   = "#{Utils.listify(_index)}/_update/#{Utils.listify(_id)}"
+        params = Utils.process_params(arguments)
+
+        if Array(arguments[:ignore]).include?(404)
+          Utils.rescue_from_not_found {
+            ElasticsearchServerless::API::Response.new(
+              perform_request(method, path, params, body, headers)
+            )
+          }
+        else
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/update_by_query.rb

@@ -0,0 +1,83 @@
+# 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.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Actions
+      # Performs an update on every document in the index without changing the source,
+      # for example to pick up a mapping change.
+      #
+      # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (+*+). To search all data streams or indices, omit this parameter or use +*+ or +_all+. (*Required*)
+      # @option arguments [Boolean] :allow_no_indices If +false+, the request returns an error if any wildcard expression, index alias, or +_all+ value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting +foo*,bar*+ returns an error if an index starts with +foo+ but no index starts with +bar+. Server default: true.
+      # @option arguments [String] :analyzer Analyzer to use for the query string.
+      # @option arguments [Boolean] :analyze_wildcard If +true+, wildcard and prefix queries are analyzed.
+      # @option arguments [String] :conflicts What to do if update by query hits version conflicts: +abort+ or +proceed+. Server default: abort.
+      # @option arguments [String] :default_operator The default operator for query string query: +AND+ or +OR+. Server default: OR.
+      # @option arguments [String] :df Field to use as default where no field prefix is given in the query string.
+      # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as +open,hidden+. Valid values are: +all+, +open+, +closed+, +hidden+, +none+.
+      # @option arguments [Integer] :from Starting offset (default: 0)
+      # @option arguments [Boolean] :ignore_unavailable If +false+, the request returns an error if it targets a missing or closed index.
+      # @option arguments [Boolean] :lenient If +true+, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
+      # @option arguments [Integer] :max_docs Maximum number of documents to process. Defaults to all documents.
+      # @option arguments [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to +_none+ disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
+      # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default.
+      # @option arguments [Boolean] :refresh If +true+, Elasticsearch refreshes affected shards to make the operation visible to search.
+      # @option arguments [Boolean] :request_cache If +true+, the request cache is used for this request.
+      # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1.
+      # @option arguments [String] :routing Custom value used to route operations to a specific shard.
+      # @option arguments [Time] :scroll Period to retain the search context for scrolling.
+      # @option arguments [Integer] :scroll_size Size of the scroll request that powers the operation. Server default: 1000.
+      # @option arguments [Time] :search_timeout Explicit timeout for each search request.
+      # @option arguments [String] :search_type The type of the search operation. Available options: +query_then_fetch+, +dfs_query_then_fetch+.
+      # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1.
+      # @option arguments [Array<String>] :sort A comma-separated list of <field>:<direction> pairs.
+      # @option arguments [Array<String>] :stats Specific +tag+ of the request for logging and statistical purposes.
+      # @option arguments [Integer] :terminate_after Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.
+      # @option arguments [Time] :timeout Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. Server default: 1m.
+      # @option arguments [Boolean] :version If +true+, returns the document version as part of a hit.
+      # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
+      # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to +all+ or any positive integer up to the total number of shards in the index (+number_of_replicas+1+). Server default: 1.
+      # @option arguments [Boolean] :wait_for_completion If +true+, the request blocks until the operation is complete. Server default: true.
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body request body
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
+      #
+      def update_by_query(arguments = {})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        arguments = arguments.clone
+        headers = arguments.delete(:headers) || {}
+
+        body = arguments.delete(:body)
+
+        _index = arguments.delete(:index)
+
+        method = ElasticsearchServerless::API::HTTP_POST
+        path   = "#{Utils.listify(_index)}/_update_by_query"
+        params = Utils.process_params(arguments)
+
+        ElasticsearchServerless::API::Response.new(
+          perform_request(method, path, params, body, headers)
+        )
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/utils.rb

@@ -0,0 +1,138 @@
+# 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 'json'
+require 'erb'
+
+module ElasticsearchServerless
+  module API
+    module Utils
+      def self.process_params(arguments)
+        arguments = Hash[arguments] unless arguments.is_a?(Hash)
+        Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, listify(v, { escape: false })] : [k, v] }] # Listify Arrays
+      end
+
+      # Convert an array of payloads into Elasticsearch `header\ndata` format
+      #
+      # Supports various different formats of the payload: Array of Strings, Header/Data pairs,
+      # or the conveniency "combined" format where data is passed along with the header
+      # in a single item.
+      #
+      #     Elasticsearch::API::Utils.bulkify [
+      #       { :index =>  { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
+      #       { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } }
+      #     ]
+      #
+      #     # => {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}}
+      #     # => {"title":"Test"}
+      #     # => {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
+      #     # => {"doc":{"title":"Update"}}
+      #
+      def self.bulkify(payload)
+        operations = %w[index create delete update]
+
+        case
+        # Hashes with `:data`
+        when payload.any? { |d|
+               d.is_a?(Hash) && d.values.first.is_a?(Hash) && operations.include?(d.keys.first.to_s) && (d.values.first[:data] || d.values.first['data'])
+             }
+          payload = payload
+                    .inject([]) do |sum, item|
+                      operation, meta = item.to_a.first
+                      meta            = meta.clone
+                      data            = meta.delete(:data) || meta.delete('data')
+
+                      sum << { operation => meta }
+                      sum << data if data
+                      sum
+                    end.map { |item| JSON.dump(item) }
+          payload << '' unless payload.empty?
+        # Array of strings
+        when payload.all? { |d| d.is_a? String }
+          payload << ''
+        # Header/Data pairs
+        else
+          payload = payload.map { |item| JSON.dump(item) }
+          payload << ''
+        end
+
+        payload = payload.join("\n")
+      end
+
+      # Create a "list" of values from arguments, ignoring nil values and encoding special characters.
+      #
+      # @example Create a list from array
+      #     listify(['A','B']) # => 'A,B'
+      #
+      # @example Create a list from arguments
+      #     listify('A','B') # => 'A,B'
+      #
+      # @example Escape values
+      #     listify('foo','bar^bam') # => 'foo,bar%5Ebam'
+      #
+      # @example Do not escape the values
+      #     listify('foo','bar^bam', escape: false) # => 'foo,bar^bam'
+      #
+      # @api private
+      def self.listify(*list)
+        options = list.last.is_a?(Hash) ? list.pop : {}
+
+        escape = options[:escape]
+        Array(list)
+          .flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }
+          .flatten
+          .compact
+          .map { |e| escape == false ? e : escape(e) }
+          .join(',')
+      end
+
+      # URL-escape a string
+      #
+      # @example
+      #     __escape('foo/bar') # => 'foo%2Fbar'
+      #     __escape('bar^bam') # => 'bar%5Ebam'
+      #
+      # @api private
+      def self.escape(string)
+        return string if string == '*'
+
+        ERB::Util.url_encode(string.to_s)
+      end
+
+      # Calls the given block, rescuing from `StandardError`.
+      #
+      # Primary use case is the `:ignore` parameter for API calls.
+      #
+      # Returns `false` if exception contains NotFound in its class name or message,
+      # else re-raises the exception.
+      #
+      # @yield [block] A block of code to be executed with exception handling.
+      #
+      # @api private
+      #
+      def self.rescue_from_not_found(&block)
+        yield
+      rescue StandardError => e
+        if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found/i
+          false
+        else
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api.rb

@@ -0,0 +1,98 @@
+# 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 'elasticsearch-serverless/api/response'
+require 'elasticsearch-serverless/api/utils'
+
+# Require everything in /api
+Dir["#{File.dirname(__FILE__)}/api/**/*.rb"].each { |f| require f}
+
+module ElasticsearchServerless
+  module API
+    include ElasticsearchServerless::API::Actions
+    HTTP_GET    = 'GET'.freeze
+    HTTP_HEAD   = 'HEAD'.freeze
+    HTTP_POST   = 'POST'.freeze
+    HTTP_PUT    = 'PUT'.freeze
+    HTTP_DELETE = 'DELETE'.freeze
+
+    # The serializer class
+    #
+    def self.serializer
+      JSON
+    end
+
+    # Namespace definitions
+    #
+    # Shortcuts for namespaces allows using methods for namespaces:
+    # +client.namespace.action+
+    #
+    module CommonClient
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def perform_request(method, path, params = {}, body = nil, headers = nil)
+        client.perform_request method, path, params, body, headers
+      end
+    end
+
+    # Add new namespaces to this constant
+    #
+    API_NAMESPACES = [
+      :async_search,
+      :cat,
+      :cluster,
+      :enrich,
+      :eql,
+      :graph,
+      :indices,
+      :ingest,
+      :license,
+      :logstash,
+      :search_application,
+      :security,
+      :sql,
+      :synonyms,
+      :transform
+    ].freeze
+
+    UPPERCASE_APIS = ['sql'].freeze
+
+    API_NAMESPACES.each do |namespace|
+      name = namespace.to_s
+      # TODO: consider if we need to do something for APIs that have aliases (if any of these are
+      # available in serverless), like 'ccr', 'ilm', 'ml' and 'slm'
+      module_name = if UPPERCASE_APIS.include?(name)
+                      name.upcase
+                    else
+                      name.split("_").map(&:capitalize).join
+                    end
+      class_name = "#{module_name}Client"
+
+      klass = Class.new(Object) do
+        include CommonClient, Object.const_get("ElasticsearchServerless::API::#{module_name}::Actions")
+      end
+      Object.const_set(class_name, klass)
+      define_method(name) do
+        instance_variable_set("@#{name}", klass.new(self))
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/version.rb

@@ -0,0 +1,22 @@
+# 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 ElasticsearchServerless
+  API_VERSION = '20231031'
+  CLIENT_VERSION = '0.0.8'
+  VERSION = "#{CLIENT_VERSION}.#{API_VERSION}.pre".freeze
+end

data/lib/elasticsearch-serverless.rb

@@ -0,0 +1,105 @@
+# 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 'elastic/transport'
+require 'elasticsearch-serverless/api'
+require 'elasticsearch-serverless/version'
+
+module ElasticsearchServerless
+  class Client
+    include ElasticsearchServerless::API
+
+    VALID_PARAMETERS = [:adapter, :log, :logger, :serializer_class, :trace, :tracer, :headers]
+
+    # Initializes an Elasticsearch Serverless Client
+    #
+    # @param :api_key [String] Base64 String, format used to authenticate with Elasticsearch
+    # @param :url [String] Elasticsearch endpoint
+    # @param :arguments [Hash] Other optional arguments.
+    # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
+    # @option arguments [Boolean] :log Use the default logger (disabled by default)
+    # @option arguments [Object] :logger An instance of a Logger-compatible object
+    # @option arguments [Boolean] :trace Use the default tracer (disabled by default)
+    # @option arguments [Object] :tracer An instance of a Logger-compatible object
+    # @option arguments [Constant] :serializer_class A specific serializer class to use, will be initialized by
+    #                                                the transport and passed the transport instance
+    # @option arguments [Hash] :headers Custom HTTP Request Headers
+    #
+    def initialize(api_key:, url:, arguments: {})
+      validate_arguments(arguments)
+      arguments.merge!(essential_parameters(url, api_key))
+      @transport = Elastic::Transport::Client.new(arguments)
+    end
+
+    def essential_parameters(url, api_key)
+      {
+        host: url,
+        transport_options: {
+          headers: {
+            'Authorization' => "ApiKey #{api_key}",
+            user_agent: user_agent
+          },
+        },
+        compression: true
+      }
+    end
+
+    def validate_arguments(arguments)
+      arguments.map do |k, _|
+        raise ArgumentError, "Parameter #{k}" unless VALID_PARAMETERS.include?(k)
+      end
+    end
+
+    # Metaprogramming for integration with Transport
+    def method_missing(name, *args, &block)
+      if methods.include?(name)
+        super
+      else
+        @transport.send(name, *args, &block)
+      end
+    end
+
+    def respond_to_missing?(method_name, *args)
+      @transport.respond_to?(method_name) || super
+    end
+
+    def user_agent
+      user_agent = [
+        "elasticsearch-serverless-ruby/#{ElasticsearchServerless::VERSION}",
+        "elastic-transport-ruby/#{Elastic::Transport::VERSION}",
+        "RUBY_VERSION: #{RUBY_VERSION}"
+      ]
+      if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+        user_agent << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}"
+      end
+      user_agent.join("; ")
+    end
+  end
+end
+
+module Elastic
+  # If the version is X.X.X.pre/alpha/beta, use X.X.Xp for the meta-header:
+  def self.client_meta_version
+    regexp = /^([0-9]+\.[0-9]+\.[0-9]+)\.?([a-z0-9.-]+)?$/
+    match = ElasticsearchServerless::VERSION.match(regexp)
+    return "#{match[1]}p" if match[2]
+
+    ElasticsearchServerless::VERSION
+  end
+
+  ELASTICSEARCH_SERVICE_VERSION = [:esv, client_meta_version].freeze
+end