elasticsearch 7.1.0 → 8.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89c5a9a719fabbe7d5bd4c1e1c98ae686e7da2552689213fafc49d4ade5a8c62
-  data.tar.gz: 06ac4a280af9bd879e62bf8d244d046b2b5238631427487198fa9fd0fa4e9ca7
+  metadata.gz: 01703b098a99215d5b9b9591ed0e978843b55314b9dfa2d8fcf4abeebbd7dd1e
+  data.tar.gz: 907bf243f4dbc446d962b4055e80a08688b2a28c0fe3a087c8c4e8b648600380
 SHA512:
-  metadata.gz: 793d00f82d71ec2b909d48cccd51993a53a5c937584fd5c1ee8c083754fcd712fe19a002bbd09113de5577a082947885528319b972b304dec6dcbc4a876b6324
-  data.tar.gz: 19d977143f99755f022b04afd534951c303767b5e7d7436b12e17412aabc9e5150d33eaa41af77f3fa9de117d305f7d1dfce3dd43e9e9f801efcb4d0c20fca3a
+  metadata.gz: 0c1f8db8b41885f95e07b12e28f7d402c2695cb2497d0e1de348918c0f0ca7740731dfad4770bd3319e9df2c216b23e00e73ba4ca51e5be2686ee86f4b3b4889
+  data.tar.gz: 4e770597919914ff503d30c3a81bfa38d0361d626eb04e75a7168728baf402ea479bc7a84febde17abf1e7ca85f0a6efdafde429f2d28755966e2ddb06383334

data/.gitignore

@@ -1,19 +1,6 @@
-# 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.
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
 
 *.gem
 *.rbc

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -6,7 +8,7 @@
 # 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
+#   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
@@ -20,14 +22,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch.gemspec
 gemspec
 
-if File.exist? File.expand_path("../../elasticsearch-api/elasticsearch-api.gemspec", __FILE__)
-  gem 'elasticsearch-api', :path => File.expand_path("../../elasticsearch-api", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../elasticsearch-transport/elasticsearch-transport.gemspec", __FILE__)
-  gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => false
-end
-
-if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
-  gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => true
+if File.exist? File.expand_path('../elasticsearch-api/elasticsearch-api.gemspec', __dir__)
+  gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
 end

data/README.md

@@ -2,6 +2,29 @@
 
 The `elasticsearch` library provides a Ruby client and API for [Elasticsearch](http://elasticsearch.com).
 
+## Usage
+
+This gem is a wrapper for two separate libraries:
+
+* [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/), which provides a low-level Ruby client for connecting to [Elastic](http://elasticsearch.com) services.
+* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/main/elasticsearch-api), which provides a Ruby API for the Elasticsearch RESTful API.
+
+Install the `elasticsearch` package and use the API directly:
+
+```ruby
+require 'elasticsearch'
+
+client = Elasticsearch::Client.new(log: true)
+
+client.cluster.health
+
+client.transport.reload_connections!
+
+client.search(q: 'test')
+
+# etc.
+```
+
 Features overview:
 
 * Pluggable logging and tracing
@@ -14,24 +37,13 @@ Features overview:
 * Extensive documentation and examples
 * Emphasis on modularity and extendability of both the client and API libraries
 
-(For integration with Ruby models and Rails applications,
-see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
+(For integration with Ruby models and Rails applications, see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
 
 ## Compatibility
 
-The Elasticsearch client for Ruby is compatible with Ruby 1.9 and higher.
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
 
-The client's API is compatible with Elasticsearch's API versions from 0.90 till current,
-just use a release matching major version of Elasticsearch.
-
-| Ruby          |   | Elasticsearch |
-|:-------------:|:-:| :-----------: |
-| 0.90          | → | 0.90          |
-| 1.x           | → | 1.x           |
-| 2.x           | → | 2.x           |
-| 5.x           | → | 5.x           |
-| 6.x           | → | 6.x           |
-| master        | → | master        |
+Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.
 
 ## Installation
 
@@ -50,58 +62,68 @@ or install it from a source code checkout:
     bundle install
     rake install
 
-## Usage
+## Configuration
 
-This library is a wrapper for two separate libraries:
+* [Identifying running tasks with X-Opaque-Id](#identifying-running-tasks-with-x-opaque-id)
+* [Api Key Authentication](#api-key-authentication)
 
-* [`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport),
-  which provides a low-level Ruby client for connecting to an [Elasticsearch](http://elasticsearch.com) cluster
-* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api),
-  which provides a Ruby API for the Elasticsearch RESTful API
+### Identifying running tasks with X-Opaque-Id
 
-Install the `elasticsearch` package and use the API directly:
+The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example:
 
 ```ruby
-require 'elasticsearch'
+client = Elasticsearch::Client.new
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
+```
+The search request will include the following HTTP Header:
+```
+X-Opaque-Id: 123456
+```
 
-client = Elasticsearch::Client.new log: true
+You can also set a prefix for X-Opaque-Id when initializing the client. This will be prepended to the id you set before each request if you're using X-Opaque-Id. Example:
+```ruby
+client = Elastic::Transport::Client.new(opaque_id_prefix: 'eu-west1_')
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
+```
+The request will include the following HTTP Header:
+```
+X-Opaque-Id: eu-west1_123456
+```
 
-client.cluster.health
+### Api Key Authentication
 
-client.transport.reload_connections!
+You can use [**API Key authentication**](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html):
 
-client.search q: 'test'
+``` ruby
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  api_key: credentials
+)
+```
 
-# etc.
+Where credentials is either the base64 encoding of `id` and `api_key` joined by a colon or a hash with the `id` and `api_key`:
+
+``` ruby
+Elasticsearch::Client.new(
+  host: host,
+  transport_options: transport_options,
+  api_key: {id: 'my_id', api_key: 'my_api_key'}
+)
 ```
 
+## API and Transport
+
 Please refer to the specific library documentation for details:
 
 * **Transport**:
-   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/README.md)
-   [[Documentation]](http://rubydoc.info/gems/elasticsearch-transport/file/README.markdown)
+   [[README]](https://github.com/elastic/elastic-transport-ruby#elastic-transport)
+   [[Documentation]](https://rubydoc.info/github/elastic/elastic-transport-ruby/)
 
 * **API**:
-   [[README]](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-api/README.md)
-   [[Documentation]](http://rubydoc.info/gems/elasticsearch-api/file/README.markdown)
+   [[README]](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api#elasticsearchapi)
+   [[Documentation]](https://rubydoc.info/gems/elasticsearch-api)
 
 ## License
 
-This software is licensed under the Apache 2 license, quoted below.
-
-    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.
+This software is licensed under the [Apache 2 license](./LICENSE).

data/Rakefile

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -15,41 +15,35 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-desc "Run unit tests"
-task :test    => 'test:unit'
+task(:default) { system 'rake --tasks' }
+
+desc 'Run unit tests'
+task test: 'test:spec'
 
 # ----- Test tasks ------------------------------------------------------------
+require 'rspec/core/rake_task'
 
-require 'rake/testtask'
 namespace :test do
-
-  desc "Wait for Elasticsearch to be in a green state"
+  desc 'Wait for Elasticsearch to be in a green state'
   task :wait_for_green do
     sh '../scripts/wait-cluster.sh'
   end
 
-  Rake::TestTask.new(:unit) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**{,/*/**}/*_spec.rb'
   end
 
-  Rake::TestTask.new(:integration) do |test|
-    test.deps = [ :wait_for_green ]
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/integration/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**{,/*/**}/*_spec.rb'
   end
 
-  Rake::TestTask.new(:all) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+  desc 'Run unit and integration tests'
+  task :all do
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:integration'].invoke
   end
-
 end
 
 # ----- Documentation tasks ---------------------------------------------------

data/bin/elastic_ruby_console

@@ -1,30 +1,14 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift(File.expand_path('../../elasticsearch/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-transport/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-dsl/lib', __dir__))
 $LOAD_PATH.unshift(File.expand_path('../../elasticsearch-api/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-xpack/lib', __dir__))
-$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-extensions/lib', __dir__))
+$LOAD_PATH.unshift(File.expand_path('../../elasticsearch/lib/elasticsearch/helpers', __dir__))
 
 require 'elasticsearch'
-require 'elasticsearch-transport'
 require 'elasticsearch-api'
-
-gems_not_loaded = ['elasticsearch-dsl', 'elasticsearch/xpack', 'elasticsearch-extensions'].reject do |gem|
-  begin
-    (require gem) || true
-  rescue LoadError
-    false
-  end
-end
-
-unless gems_not_loaded.empty?
-  warn "The following gems were not loaded: [#{gems_not_loaded.join(', ')}]. Please install and require them explicitly."
-end
+require 'elasticsearch/helpers/bulk_helper'
 
 include Elasticsearch
-include Elasticsearch::DSL if defined?(Elasticsearch::DSL)
 
 begin
   require 'pry'

data/elasticsearch.gemspec

@@ -6,7 +6,7 @@
 # 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
+#   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
@@ -20,66 +20,44 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/version'
 
 Gem::Specification.new do |s|
-  s.name          = "elasticsearch"
+  s.name          = 'elasticsearch'
   s.version       = Elasticsearch::VERSION
-  s.authors       = ["Karel Minarik"]
-  s.email         = ["karel.minarik@elasticsearch.org"]
-  s.summary       = "Ruby integrations for Elasticsearch"
-  s.homepage      = "http://github.com/elasticsearch/elasticsearch-ruby"
-  s.license       = "Apache-2.0"
+  s.authors       = ['Karel Minarik', 'Emily Stolfo', 'Fernando Briano']
+  s.email         = ['clients-team@elastic.co']
+  s.summary       = 'Ruby integrations for Elasticsearch'
+  s.homepage      = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
+  s.license       = 'Apache-2.0'
+  s.metadata = {
+    'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html',
+    'changelog_uri' => 'https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/main',
+    'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-ruby/issues'
+  }
+  s.files = `git ls-files`.split($/)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.executables << 'elastic_ruby_console'
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.bindir = 'bin'
 
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.executables   << 'elastic_ruby_console'
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
-  s.bindir = "bin"
+  s.extra_rdoc_files  = ['README.md', 'LICENSE.txt']
+  s.rdoc_options      = ['--charset=UTF-8']
 
-  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
-  s.rdoc_options      = [ "--charset=UTF-8" ]
+  s.required_ruby_version = '>= 2.5'
 
-  s.required_ruby_version = '>= 1.9'
+  s.add_dependency 'elastic-transport', '~> 8'
+  s.add_dependency 'elasticsearch-api', '8.10.0'
 
-  s.add_dependency "elasticsearch-transport", '7.1.0'
-  s.add_dependency "elasticsearch-api",       '7.1.0'
-
-  s.add_development_dependency "bundler"
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "rake", "~> 11.1"
-  else
-    s.add_development_dependency "rake", "< 11.0"
-  end
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "elasticsearch-extensions"
-  end
-
-  s.add_development_dependency "ansi"
-  s.add_development_dependency "shoulda-context"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "pry"
-
-  # Prevent unit test failures on Ruby 1.8
-  if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
-    s.add_development_dependency "test-unit", '~> 2'
-    s.add_development_dependency "json", '~> 1.8'
-  end
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "minitest"
-    s.add_development_dependency "minitest-reporters"
-    s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-    s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
-    s.add_development_dependency "simplecov"
-    s.add_development_dependency "simplecov-rcov"
-    s.add_development_dependency "cane"
-  end
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
-    s.add_development_dependency "test-unit", '~> 2'
-  end
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'yard'
 
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby integrations for Elasticsearch (client, API, etc.)

data/lib/elasticsearch/helpers/bulk_helper.rb

@@ -0,0 +1,127 @@
+# 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 Elasticsearch
+  module Helpers
+    # Elasticsearch Client Helper for the Bulk API
+    #
+    # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html
+    #
+    class BulkHelper
+      attr_accessor :index
+
+      # Create a BulkHelper
+      #
+      # @param [Elasticsearch::Client] client Instance of Elasticsearch client to use.
+      # @param [String] index Index on which to perform the Bulk actions.
+      # @param [Hash] params Parameters to re-use in every bulk call
+      #
+      def initialize(client, index, params = {})
+        @client = client
+        @index = index
+        @params = params
+      end
+
+      # Index documents using the Bulk API.
+      #
+      # @param [Array<Hash>] docs The documents to be indexed.
+      # @param [Hash] params Parameters to use in the bulk ingestion. See the official Elastic documentation for Bulk API for parameters to send to the Bulk API.
+      # @option params [Integer] slice number of documents to send to the Bulk API for eatch batch of ingestion.
+      # @param block [Block] Optional block to run after ingesting a batch of documents.
+      # @yieldparam response [Elasticsearch::Transport::Response] The response object from calling the Bulk API.
+      # @yieldparam ingest_docs [Array<Hash>] The collection of documents sent in the bulk request.
+      #
+      def ingest(docs, params = {}, body = {}, &block)
+        ingest_docs = docs.map { |doc| { index: { _index: @index, data: doc} } }
+        if (slice = params.delete(:slice))
+          ingest_docs.each_slice(slice) { |items| ingest(items, params, &block) }
+        else
+          bulk_request(ingest_docs, params, &block)
+        end
+      end
+
+      # Delete documents using the Bulk API
+      #
+      # @param [Array] ids Array of id's for documents to delete.
+      # @param [Hash] params Parameters to send to bulk delete.
+      #
+      def delete(ids, params = {}, body = {})
+        delete_docs = ids.map { |id| { delete: { _index: @index, _id: id} } }
+        @client.bulk({ body: delete_docs }.merge(params.merge(@params)))
+      end
+
+      # Update documents using the Bulk API
+      #
+      # @param [Array<Hash>] docs (Required) The documents to be updated.
+      # @option params [Integer] slice number of documents to send to the Bulk API for eatch batch of updates.
+      # @param block [Block]  Optional block to run after ingesting a batch of documents.
+      #
+      # @yieldparam response [Elasticsearch::Transport::Response] The response object from calling the Bulk API.
+      # @yieldparam ingest_docs [Array<Hash>] The collection of documents sent in the bulk request.
+      #
+      def update(docs, params = {}, body = {}, &block)
+        ingest_docs = docs.map do |doc|
+          { update: { _index: @index, _id: doc.delete('id'), data: { doc: doc } } }
+        end
+        if (slice = params.delete(:slice))
+          ingest_docs.each_slice(slice) { |items| update(items, params, &block) }
+        else
+          bulk_request(ingest_docs, params, &block)
+        end
+      end
+
+      # Ingest data directly from a JSON file
+      #
+      # @param [String] file (Required) The file path.
+      # @param [Hash] params Parameters to use in the bulk ingestion.
+      # @option params [Integer] slice number of documents to send to the Bulk API for eatch batch of updates.
+      # @option params [Array|String] keys If the data needs to be digged from the JSON file, the
+      #                                      keys can be passed in  with this parameter to find it.
+      #
+      #                                      E.g.: If the data in the parsed JSON Hash is found in
+      #                                      +json_parsed['data']['items']+, keys would be passed
+      #                                      like this (as an Array):
+      #
+      #                                      +bulk_helper.ingest_json(file, { keys: ['data', 'items'] })+
+      #
+      #                                      or as a String:
+      #
+      #                                      +bulk_helper.ingest_json(file, { keys: 'data, items' })+
+      #
+      # @yieldparam response [Elasticsearch::Transport::Response] The response object from calling the Bulk API.
+      # @yieldparam ingest_docs [Array<Hash>] The collection of documents sent in the bulk request.
+      #
+      def ingest_json(file, params = {}, &block)
+        data = JSON.parse(File.read(file))
+        if (keys = params.delete(:keys))
+          keys = keys.split(',') if keys.is_a?(String)
+          data = data.dig(*keys)
+        end
+
+        ingest(data, params, &block)
+      end
+
+      private
+
+      def bulk_request(ingest_docs, params, &block)
+        response = @client.bulk({ body: ingest_docs }.merge(params.merge(@params)))
+        yield response, ingest_docs if block_given?
+        response
+      end
+    end
+  end
+end

data/lib/elasticsearch/helpers/scroll_helper.rb

@@ -0,0 +1,95 @@
+# 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 Elasticsearch
+  module Helpers
+    # Elasticsearch Client Helper for the Scroll API
+    #
+    # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/scroll-api.html
+    #
+    class ScrollHelper
+      include Enumerable
+
+      # Create a ScrollHelper
+      #
+      # @param [Elasticsearch::Client] client (Required) Instance of Elasticsearch client to use.
+      # @param [String] index (Required) Index on which to perform the Bulk actions.
+      # @param [Hash] body Body parameters to re-use in every scroll request
+      # @param [Time] scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      #
+      def initialize(client, index, body, scroll = '1m')
+        @index = index
+        @client = client
+        @scroll = scroll
+        @body = body
+      end
+
+      # Implementation of +each+ for Enumerable module inclusion
+      #
+      # @yieldparam document [Hash] yields a document found in the search hits.
+      #
+      def each(&block)
+        @docs = []
+        @scroll_id = nil
+        refresh_docs
+        for doc in @docs do
+          refresh_docs
+          yield doc
+        end
+        clear
+      end
+
+      # Results from a scroll.
+      # Can be called repeatedly (e.g. in a loop) to get the scroll pages.
+      #
+      def results
+        if @scroll_id
+          scroll_request
+        else
+          initial_search
+        end
+      rescue StandardError => e
+        raise e
+      end
+
+      # Clear Scroll and resets inner documents collection
+      #
+      def clear
+        @client.clear_scroll(body: { scroll_id: @scroll_id }) if @scroll_id
+        @docs = []
+      end
+
+      private
+
+      def refresh_docs
+        @docs ||= []
+        @docs << results
+        @docs.flatten!
+      end
+
+      def initial_search
+        response = @client.search(index: @index, scroll: @scroll, body: @body)
+        @scroll_id = response['_scroll_id']
+        response['hits']['hits']
+      end
+
+      def scroll_request
+        @client.scroll(body: {scroll: @scroll, scroll_id: @scroll_id})['hits']['hits']
+      end
+    end
+  end
+end