esse 0.2.0 → 0.2.3

data/lib/esse/repository/object_document_mapper.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Esse
+  # Delegates all the methods to the index ODM by prepending the type name.
+  #
+  # @see ObjectDocumentMapper
+  class Repository
+    module ClassMethods
+      # Convert ruby object to json. Arguments will be same of passed through the
+      # collection. It's allowed a block or a class with the `to_h` instance method.
+      # Example with block
+      #   document do |model, **context|
+      #     {
+      #       id: model.id,
+      #       admin: context[:is_admin],
+      #     }
+      #   end
+      # Example with document class
+      #   document UserDocument
+      def document(klass = nil, &block)
+        if @document_proc
+          raise ArgumentError, format('Document for %p already defined', repo_name)
+        end
+
+        if block
+          @document_proc = ->(model, **kwargs) { coerce_to_document(block.call(model, **kwargs)) }
+        elsif klass.is_a?(Class) && klass <= Esse::Document
+          @document_proc = ->(model, **kwargs) { klass.new(model, **kwargs) }
+        elsif klass.is_a?(Class) && klass.instance_methods.include?(:to_h)
+          @document_proc = ->(model, **kwargs) { coerce_to_document(klass.new(model, **kwargs).to_h) }
+        elsif klass.is_a?(Class) && klass.instance_methods.include?(:as_json) # backward compatibility
+          @document_proc = ->(model, **kwargs) { coerce_to_document(klass.new(model, **kwargs).as_json) }
+        elsif klass.is_a?(Class) && klass.instance_methods.include?(:call)
+          @document_proc = ->(model, **kwargs) { coerce_to_document(klass.new(model, **kwargs).call) }
+        else
+          msg = format("%<arg>p is not a valid document. The document should inherit from Esse::Document or respond to `to_h'", arg: klass)
+          raise ArgumentError, msg
+        end
+      end
+
+      def coerce_to_document(value)
+        case value
+        when Esse::Document
+          value
+        when Hash
+          Esse::HashDocument.new(value)
+        when NilClass, FalseClass
+          Esse::NullDocument.new
+        else
+          raise ArgumentError, format('%<arg>p is not a valid document. The document should be a hash or an instance of Esse::Document', arg: value)
+        end
+      end
+
+      # Convert ruby object to json by using the document of the given document type.
+      # @param [Object] model The ruby object
+      # @param [Hash] kwargs The context
+      # @return [Esse::Document] The serialized document
+      def serialize(model, **kwargs)
+        if @document_proc.nil?
+          raise NotImplementedError, format('there is no %<t>p document defined for the %<k>p index', t: repo_name, k: index.to_s)
+        end
+
+        @document_proc.call(model, **kwargs)
+      end
+
+      # Used to define the source of data. A block is required. And its
+      # content should yield an array of each object that should be serialized.
+      # The list of arguments will be passed throught the document method.
+      #
+      # Example:
+      #   collection AdminStore
+      #   collection do |**conditions, &block|
+      #     User.where(conditions).find_in_batches(batch_size: 5000) do |batch|
+      #       block.call(batch, conditions)
+      #     end
+      #   end
+      #
+      # @param [String] name The identification of the collection.
+      # @param [Class] klass The class of the collection. (Optional when block is passed)
+      # @param [Proc] block The block that will be used to iterate over the collection. (Optional when using a class)
+      # @return [void]
+      def collection(collection_klass = nil, **_, &block)
+        if collection_klass.nil? && block.nil?
+          raise ArgumentError, 'a document type, followed by a collection class or block that stream the data ' \
+                              'is required to define the collection'
+        end
+
+        if block.nil? && collection_klass.is_a?(Class) && !collection_klass.include?(Enumerable)
+          msg = '%<arg>p is not a valid collection class.' \
+                ' Collections should implement the Enumerable interface.'
+          raise ArgumentError, format(msg, arg: collection_klass)
+        end
+
+        @collection_proc = collection_klass || block
+      end
+
+      # Used to fetch all batch of data defined on the collection model.
+      # Arguments can be anything. They will just be passed through the block.
+      # Useful when the collection depends on scope or any other conditions
+      #
+      # Example:
+      #   each_batch(active: true) do |data, **_collection_opts|
+      #     puts data.size
+      #   end
+      #
+      # @todo Remove *args. It should only support keyword arguments
+      #
+      # @param [Hash] kwargs The context
+      # @param [Proc] block The block that will be used to iterate over the collection.
+      # @return [void]
+      def each_batch(*args, **kwargs, &block)
+        if @collection_proc.nil?
+          raise NotImplementedError, format('there is no %<t>p collection defined for the %<k>p index', t: repo_name, k: index.to_s)
+        end
+
+        case @collection_proc
+        when Class
+          @collection_proc.new(*args, **kwargs).each(&block)
+        else
+          @collection_proc.call(*args, **kwargs, &block)
+        end
+      rescue LocalJumpError
+        raise(SyntaxError, 'block must be explicitly declared in the collection definition')
+      end
+
+      # Wrap collection data into serialized batches
+      #
+      # @param [Hash] kwargs The context
+      # @return [Enumerator] The enumerator
+      # @yield [Array, **context] serialized collection and the optional context from the collection
+      def each_serialized_batch(**kwargs, &block)
+        each_batch(**kwargs) do |*args|
+          batch, collection_context = args
+          collection_context ||= {}
+          entries = [*batch].map { |entry| serialize(entry, **collection_context) }.compact
+          block.call(entries, **kwargs)
+        end
+      end
+
+      # Wrap collection data into serialized documents
+      #
+      # Example:
+      #    GeosIndex.documents(id: 1).first
+      #
+      # @return [Enumerator] All serialized entries
+      def documents(**kwargs)
+        Enumerator.new do |yielder|
+          each_serialized_batch(**kwargs) do |docs, **_collection_kargs|
+            docs.each { |document| yielder.yield(document) }
+          end
+        end
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/esse/repository.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Esse
+  # Type is actually deprecated. Elasticsearch today uses _doc instead of type
+  # And in upcoming release it will be totally removed.
+  # But I want to keep compatibility with old versions of es.
+  class Repository
+    class << self
+      # This methods will be defined using meta programming in the index respository definition
+      # @see Esse::Index::Type.repository
+      attr_reader :index
+    end
+    require_relative 'repository/actions'
+    require_relative 'repository/documents'
+    require_relative 'repository/object_document_mapper'
+  end
+end

data/lib/esse/search/query.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Esse
+  module Search
+    class Query
+      attr_reader :transport, :definition
+
+      # @param transport [Esse::Transport] The client proxy to use for the query
+      # @param indices [<Array<Esse::Index, String>] The class of the index to search or the index name
+      # @param definition [Hash] The options to pass to the search.
+      def initialize(transport, *indices, suffix: nil, **definition, &_block)
+        @transport = transport
+        @definition = definition
+        @definition[:index] = indices.map do |index|
+          if index.is_a?(Class) && index < Esse::Index
+            index.index_name(suffix: suffix)
+          elsif index.is_a?(String) || index.is_a?(Symbol)
+            [index, suffix].compact.join('_')
+          else
+            raise ArgumentError, format('Invalid index type: %<index>p. It should be a Esse::Index class or a String index name', index: index)
+          end
+        end.join(',')
+      end
+
+      def response
+        @response ||= execute_search_query!
+      end
+
+      def results
+        return paginated_results if respond_to?(:paginated_results, true)
+
+        response.hits
+      end
+
+      def scroll_hits(batch_size: 1_000, scroll: '1m')
+        response = execute_search_query!(size: batch_size, scroll: scroll)
+        scroll_id = nil
+        fetched = 0
+        total = response.total
+
+        loop do
+          fetched += response.hits.size
+          yield(response.hits) if response.hits.any?
+          break if fetched >= total
+          scroll_id = response.raw_response['scroll_id'] || response.raw_response['_scroll_id']
+          break unless scroll_id
+          response = execute_scroll_query(scroll: scroll, scroll_id: scroll_id)
+        end
+      ensure
+        begin
+          transport.clear_scroll(body: {scroll_id: scroll_id}) if scroll_id
+        rescue Esse::Transport::NotFoundError
+        end
+      end
+
+      private
+
+      def execute_search_query!(**execution_options)
+        resp, err = nil
+        Esse::Events.instrument('elasticsearch.execute_search_query') do |payload|
+          payload[:query] = self
+          begin
+            resp = Response.new(self, transport.search(**definition, **execution_options))
+          rescue => e
+            err = e
+          end
+          payload[:error] = err if err
+          payload[:response] = resp
+        end
+        raise err if err
+
+        resp
+      end
+
+      def execute_scroll_query(scroll:, scroll_id:)
+        resp, err = nil
+        Esse::Events.instrument('elasticsearch.execute_search_query') do |payload|
+          payload[:query] = self
+          begin
+            resp = Response.new(self, transport.scroll(scroll: scroll, body: { scroll_id: scroll_id }))
+          rescue => e
+            err = e
+          end
+          payload[:error] = err if err
+          payload[:response] = resp
+        end
+        raise err if err
+
+        resp
+      end
+
+      def reset!
+        @response = nil
+      end
+
+      def raw_limit_value
+        definition.dig(:body, :size) || definition.dig(:body, 'size') || definition.dig(:size) || definition.dig('size')
+      end
+
+      def raw_offset_value
+        definition.dig(:body, :from) || definition.dig(:body, 'from') || definition.dig(:from) || definition.dig('from')
+      end
+    end
+  end
+end

data/lib/esse/search/response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Esse
+  module Search
+    class Response
+      include Enumerable
+      extend Forwardable
+
+      def_delegators :hits, :each, :size, :empty?
+      attr_reader :query, :raw_response, :options
+
+      # @param [Esse::Search::Query] query The search query
+      # @param [Hash] raw_response The raw response from Elasticsearch
+      # @param [Hash] options The options passed to the search
+      def initialize(query, raw_response, **options)
+        @query = query
+        @raw_response = raw_response
+        @options = options
+      end
+
+      def shards
+        raw_response['_shards']
+      end
+
+      def aggregations
+        raw_response['aggregations']
+      end
+
+      def suggestions
+        raw_response['suggest']
+      end
+
+      def hits
+        raw_response.dig('hits', 'hits') || []
+      end
+
+      def total
+        if raw_response.dig('hits', 'total').respond_to?(:keys)
+          raw_response.dig('hits', 'total', 'value')
+        else
+          raw_response.dig('hits', 'total')
+        end.to_i
+      end
+    end
+  end
+end

data/lib/esse/template_loader.rb

@@ -24,7 +24,7 @@ module Esse
       path = nil
       @directories.each do |dir|
         patterns.find do |pattern|
-          path = Dir[dir.join("#{pattern}.{#{@extensions.join(",")}}")].first
+          path = Dir[dir.join("#{pattern}.{#{@extensions.join(',')}}")].first
           break if path
         end
         break if path

data/lib/esse/transport/aliases.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Return a list of index aliases.
+      #
+      # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+      # @option [String] :index A comma-separated list of index names to filter aliases
+      # @option [String] :name A comma-separated list of alias names to return
+      # @raise [Esse::Transport::ServerError] in case of failure
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-get-alias.html
+      def aliases(**options)
+        coerce_exception { client.indices.get_alias(**options) }
+      end
+
+      # Updates index aliases.
+      #
+      # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+      # @option [Hash] :body The definition of `actions` to perform
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
+      def update_aliases(body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.update_aliases') do |payload|
+          payload[:request] = options
+          payload[:response] = coerce_exception { client.indices.update_aliases(**options, body: body) }
+        end
+      end
+    end
+
+    include InstanceMethods
+  end
+end

data/lib/esse/transport/documents.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Returns a document.
+      #
+      # @option [String] :id The document ID
+      # @option [String] :index The name of the index
+      # @option [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index.
+      # @option [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
+      # @option [Boolean] :refresh Refresh the shard containing the document before performing the operation
+      # @option [String] :routing Specific routing value
+      # @option [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option [Number] :version Explicit version number for concurrency control
+      # @option [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+      #
+      def get(id:, index:, **options)
+        Esse::Events.instrument('elasticsearch.get') do |payload|
+          payload[:request] = opts = options.merge(id: id, index: index)
+          payload[:response] = coerce_exception { client.get(**opts) }
+        end
+      end
+
+      # Returns information about whether a document exists in an index.
+      #
+      # @option [String] :id The document ID
+      # @option [String] :index The name of the index
+      # @option [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
+      # @option [Boolean] :refresh Refresh the shard containing the document before performing the operation
+      # @option [String] :routing Specific routing value
+      # @option [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option [Number] :version Explicit version number for concurrency control
+      # @option [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
+      #
+      def exist?(id:, index:, **options)
+        Esse::Events.instrument('elasticsearch.exist') do |payload|
+          payload[:request] = opts = options.merge(id: id, index: index)
+          payload[:response] = coerce_exception { client.exists(**opts) }
+        end
+      end
+
+      # Returns number of documents matching a query.
+      #
+      # @option [List] :index A comma-separated list of indices to restrict the results
+      # @option [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
+      # @option [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+      # @option [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option [Number] :min_score Include only documents with a specific `_score` value in the result
+      # @option [String] :preference Specify the node or shard the operation should be performed on (default: random)
+      # @option [List] :routing A comma-separated list of specific routing values
+      # @option [String] :q Query in the Lucene query string syntax
+      # @option [String] :analyzer The analyzer to use for the query string
+      # @option [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option [String] :df The field to use as default where no field prefix is given in the query string
+      # @option [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+      # @option [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early
+      # @option [Hash] :headers Custom HTTP headers
+      # @option [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
+      def count(index:, **options)
+        Esse::Events.instrument('elasticsearch.count') do |payload|
+          payload[:request] = opts = options.merge(index: index)
+          payload[:response] = coerce_exception { client.count(**opts) }
+        end
+      end
+
+      # Removes a document from the index.
+      #
+      # @option arguments [String] :id The document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [String] :refresh If `true` then refresh 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` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html
+      def delete(id:, index:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.delete') do |payload|
+          payload[:request] = opts = options.merge(id: id, index: index)
+          payload[:response] = coerce_exception { client.delete(**opts) }
+        end
+      end
+
+      # Updates a document with a script or partial document.
+      #
+      # @option [String] :id Document ID
+      # @option [String] :index The name of the index
+      # @option [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option [String] :lang The script language (default: painless)
+      # @option [String] :refresh If `true` then refresh 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` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
+      # @option [String] :routing Specific routing value
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
+      # @option [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+      # @option [Boolean] :require_alias When true, requires destination is an alias. Default is false
+      # @option [Hash] :headers Custom HTTP headers
+      # @option [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html
+      #
+      def update(id:, index:, body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.update') do |payload|
+          payload[:request] = opts = options.merge(id: id, index: index, body: body)
+          payload[:response] = coerce_exception { client.update(**opts) }
+        end
+      end
+
+      # Creates or updates a document in an index.
+      #
+      # @option [String] :id Document ID
+      # @option [String] :index The name of the index
+      # @option [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)
+      # @option [String] :refresh If `true` then refresh 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` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option [String] :routing Specific routing value
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [Number] :version Explicit version number for concurrency control
+      # @option [String] :version_type Specific version type (options: internal, external, external_gte)
+      # @option [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
+      # @option [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
+      # @option [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option [Boolean] :require_alias When true, requires destination to be an alias. Default is false
+      # @option [Hash] :headers Custom HTTP headers
+      # @option [Hash] :body The document (*Required*)
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html
+      def index(id:, index:, body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.index') do |payload|
+          payload[:request] = opts = options.merge(id: id, index: index, body: body)
+          payload[:response] = coerce_exception { client.index(**opts) }
+        end
+      end
+
+      # Allows to perform multiple index/update/delete operations in a single request.
+      #
+      # @option arguments [String] :index Default index for items which don't provide one
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [String] :refresh If `true` then refresh 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` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
+      # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
+      # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request
+      # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
+      # @option arguments [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
+      # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
+      def bulk(body:, **options)
+        throw_error_when_readonly!
+
+        Esse::Events.instrument('elasticsearch.bulk') do |payload|
+          payload[:request] = opts = options.merge(body: body)
+          payload[:response] = response = coerce_exception { client.bulk(**opts) }
+          yield(payload) if block_given? # Allow caller to add data to the payload of event
+          response
+        end
+      end
+    end
+
+    include InstanceMethods
+  end
+end

data/lib/esse/transport/health.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Esse
+  class Transport
+    module InstanceMethods
+      # Returns basic information about the health of the cluster.
+      #
+      # @option [List] :index Limit the information returned to a specific index
+      # @option [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
+      # @option [String] :level Specify the level of detail for returned information (options: cluster, indices, shards)
+      # @option [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+      # @option [Time] :master_timeout Explicit operation timeout for connection to master node
+      # @option [Time] :timeout Explicit operation timeout
+      # @option [String] :wait_for_active_shards Wait until the specified number of shards is active
+      # @option [String] :wait_for_nodes Wait until the specified number of nodes is available
+      # @option [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid)
+      # @option [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster
+      # @option [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster
+      # @option [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red)
+      # @option [Hash] :headers Custom HTTP headers
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html
+      def health(**options)
+        coerce_exception { client.cluster.health(**options) }
+      end
+    end
+
+    include InstanceMethods
+  end
+end