elastomer-client 3.2.3 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2120602479977d001a0c4b2cecaa0b270acd2b65f9b293168b24f46e94b5cc0d
-  data.tar.gz: 506fd065a16ea197d0bb7b1b8ca3a9f304d33881d934dcc681f3884ce7554c78
+  metadata.gz: 49da91bf2c259b9b77ed76d66fa001aa4192432225090bb62ff9d74f8173f8dc
+  data.tar.gz: 2d519500cced0a8783a9fd5b77853d935cc3b99f35e8be981e5e1e23b55d9632
 SHA512:
-  metadata.gz: 991d2089b80e8e9d708e3539bd7cf6bce95d540cdbf6e75290594cc994a79c549147b264237971edbfe49771ca93845cd626e99e3f076560735415281bf1b546
-  data.tar.gz: c151d7c2629bebd56c5134cc45864210e61757bf35b44d04099e25690b6d9cdbe7254b5fed6b1d85e948b407ca1aa2a192302a8278ac473fc1c997e0728ef224
+  metadata.gz: 2f0f879414271cf6f861bfcf256ec6af824a60c2603dbb48dc2297ecffae55f969e7947e8c9cfc0469239c15fe4b9754721279886def527eb89658a549f085fb
+  data.tar.gz: 42cd80d2c67d119767451b524543f73cc1af3ffda4088186cfac8daa99970849655c05ed5382e7ab689a71e1a5c8e4c6b620fbaf66a91693e4afad7e186900ff

data/.devcontainer/devcontainer.json

@@ -0,0 +1,46 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/universal
+{
+  "name": "github/elastomer-client",
+  "image": "mcr.microsoft.com/devcontainers/ruby:0-3-bullseye",
+  
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {},
+    "ghcr.io/meaningful-ooo/devcontainer-features/homebrew:2": {},
+    "ghcr.io/guiyomh/features/vim:0": {},
+    "ghcr.io/jungaretti/features/ripgrep:1": {}
+  },
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": ".devcontainer/postCreateCommand.sh",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "github.copilot",
+        "misogi.ruby-rubocop",
+        "mutantdino.resourcemonitor",
+        "rebornix.ruby",
+        "wingrunr21.vscode-ruby",
+        "eamodio.gitlens",
+        "miguel-savignano.ruby-symbols",
+        "KoichiSasada.vscode-rdbg"
+      ],
+      "settings": {
+        "files.watcherExclude": {
+          "**/vendor": true,
+          "**/.git": true,
+          "**/tmp": true
+        }
+      }
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

data/.devcontainer/postCreateCommand.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+script/bootstrap

data/.github/dependabot.yaml

@@ -0,0 +1,11 @@
+---
+version: 2
+updates:
+  - package-ecosystem: 'bundler'
+    directory: '/'
+    schedule:
+        interval: 'weekly'
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+        interval: 'weekly'

data/.github/workflows/main.yml

@@ -0,0 +1,45 @@
+name: CI tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2']
+        ES_VERSION: ['8.13.2']
+        include:
+          - ES_VERSION: '8.13.2'
+            ES_DOWNLOAD_URL: >-
+              https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-8.13.2-linux-x86_64.tar.gz
+    steps:
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - uses: actions/checkout@v4
+      - name: Cache Elasticsearch
+        id: cache-elasticsearch
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-elasticsearch
+        with:
+          path: ./elasticsearch-${{ matrix.ES_VERSION }}
+          key: ${{ env.cache-name }}-${{ matrix.ES_VERSION }}
+      - if: ${{ steps.cache-elasticsearch.outputs.cache-hit != 'true' }}
+        name: Download Elasticsearch
+        run: |
+          wget ${{ matrix.ES_DOWNLOAD_URL }}
+          tar -xzf elasticsearch-*.tar.gz
+      - if: ${{ matrix.ES_VERSION != '5.6.15' }}
+        name: Run Elasticsearch
+        run: './elasticsearch-${{ matrix.ES_VERSION }}/bin/elasticsearch -d -Expack.security.enabled=false'
+      - run: gem install bundler
+      - run: bundle install
+      - run: script/poll-for-es
+      - run: bundle exec rake test

data/.github/workflows/rubocop.yml

@@ -0,0 +1,15 @@
+name: Rubocop
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+      - run: bundle exec rubocop

data/.gitignore

@@ -3,7 +3,6 @@
 /vendor/gems
 /.bundle
 /.rbenv-version
-/.ruby-version
 /vendor/cache/*.gem
 /coverage
 Gemfile.lock
@@ -11,3 +10,4 @@ Gemfile.lock
 tags
 .byebug_history
 *.swp
+/tmp

data/.rubocop.yml

@@ -12,72 +12,20 @@
 #
 # If you disable a check, document why.
 
-AllCops:
-  DisabledByDefault: true
-
-StringLiterals:
-  EnforcedStyle: double_quotes
-  Severity: error
-
-HashSyntax:
-  EnforcedStyle: hash_rockets
-  Severity: error
-
-AlignHash:
-  SupportedLastArgumentHashStyles: always_ignore
-
-AlignParameters:
-  Enabled: false # This is usually true, but we often want to roll back to
-                 # the start of a line.
+inherit_gem:
+  rubocop-github:
+  - config/default.yml # generic Ruby rules and cops
 
-Attr:
-  Enabled: false # We have no styleguide guidance here, and it seems to be
-                 # in frequent use.
+require:
+- rubocop-minitest
+- rubocop-performance
+- rubocop-rake
 
-ClassAndModuleChildren:
-  Enabled: false # module X<\n>module Y is just as good as module X::Y.
-
-Documentation:
-  Exclude:
-    - !ruby/regexp /test\/*.rb/
-
-ClassLength:
+AllCops:
+  NewCops: enable
   Exclude:
-    - !ruby/regexp /test\/*.rb/
-
-PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%w': '{}'
-
-LineLength:
-  Max: 79
-  Severity: warning
-
-MultilineTernaryOperator:
-  Severity: error
-
-UnreachableCode:
-  Severity: error
-
-AndOr:
-  Severity: error
-
-EndAlignment:
-  Severity: error
-
-IndentationWidth:
-  Severity: error
-
-MethodLength:
-  CountComments: false  # count full line comments?
-  Max: 20
-  Severity: error
-
-Alias:
-  Enabled: false # We have no guidance on alias vs alias_method
-
-RedundantSelf:
-  Enabled: false # Sometimes a self.field is a bit more clear
+    - 'lib/elastomer_client/client/rest_api_spec/api_spec_*.rb' # Exclude generated ApiSpec files
+    - 'vendor/**/*'
 
-IfUnlessModifier:
-  Enabled: false
+Metrics/MethodLength:
+  Max: 25

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,3 +1,79 @@
+## 6.2.1 (2024-12-10)
+- Add support for rethrottling reindex tasks
+
+## 6.2.0 (2024-11-06)
+- Add support for reindex API
+- Remove CI checks for ES 5.6.15
+
+## 6.1.1 (2024-06-05)
+- Unlock faraday_middleware version to allow 1.x
+
+## 6.1.0 (2024-04-09)
+- Replace `Faraday::Error::*` with `Faraday::*` error classes
+- Handle all `Faraday::Error` instead of `Faraday::Error::ClientError`
+- Unlock faraday version to allow 1.0.0
+- Bump the minimum version of faraday and faraday middleware
+
+## 6.0.3 (2024-04-05)
+- Add ES 8.13 REST API spec
+- Update CI and development versions from 8.7.0 to 8.13.0
+
+## 6.0.2 (2024-01-24)
+- Change Opaque ID error handling to not throw OpaqueIDError for 5xx responses
+
+## 6.0.1 (2024-01-09)
+- Move Opaque ID middleware to the end of the Faraday middleware chain
+
+## 6.0.0 (2023-12-08)
+- Remove default retry logic, requiring consumers to implement their own
+- Remove support for ES 7
+- Move to support only the latest Ruby version
+
+## 5.2.0 (2023-11-07)
+- Allow passing a Faraday connection configuration block to the client.
+
+## 5.1.0 (2023-09-29)
+- Remove logic extracting parameters from document in bulk requests. Parameters now must be sent separately from the document to be parsed correctly.
+
+## 5.0.5 (2023-08-08)
+- Replace usage of "found" field by "result" in tests for the delete API (#275)
+- Reduce the noise of the client during an inspect call by hiding connection info (#276)
+- Rename MiniTest to Minitest (#277)
+
+## 5.0.4 (2023-06-20)
+- Remove support for `timestamp` and `ttl` index parameters
+
+## 5.0.3 (2023-06-14)
+- Allow deprecated underscored parameters to work for Bulk API for versions ES 7+. 
+- Allow non-underscored parameters to work for Bulk API for version ES 5. 
+
+## 5.0.2 (2023-05-31)
+- Add ES 8.7 REST API spec
+- Remove deprecated `type` parameter from `search_shards` API 
+
+## 5.0.1 (2023-04-26)
+- Fix bug in bulk API preventing string `_id` from being removed if empty
+- Remove `_type` from document body during bulk requests for versions ES 7+
+
+## 5.0.0 (2023-04-17)
+- Rename Elastomer to ElastomerClient (and elastomer to elastomer_client)
+
+## 4.0.3 (2023-04-07)
+- Fix query values specified in path get removed when query values are specified with params (#261)
+- Add support for `update_by_query` (#263)
+
+## 4.0.2 (2023-03-03)
+- Fix ES 7+ handling of params like `routing` that were prefixed with an underscore in earlier versions
+
+## 4.0.1 (2023-02-10)
+- Fix a bug in the bulk API interface that prevents a version check from working correctly
+
+## 4.0.0 (2023-02-10)
+- Add ES 7 and ES 8 compatibility for existing functionality
+- Remove ES 2 support
+- Add support for newer Ruby versions (3.0, 3.1, 3.2)
+- Remove support for older Ruby versions (< 3.0)
+
 ## 3.2.3 (2020-02-26)
 - Fix warnings in Ruby 2.7 whan passing a Hash to a method that is expecting keyword arguments
 

data/Gemfile

@@ -1,5 +1,22 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
-gem "simplecov", :require => false, :group => :development, :platform => :ruby_19
+group :development do
+  gem "activesupport", ">= 7.0"
+  gem "bundler", "~> 2.0"
+  gem "debug", "~> 1.7"
+  gem "minitest", "~> 5.17"
+  gem "minitest-focus", "~> 1.3"
+  gem "rake"
+  gem "rubocop", "~> 1.63.0"
+  gem "rubocop-github", "~> 0.20.0"
+  gem "rubocop-minitest", "~> 0.35.0"
+  gem "rubocop-performance", "~> 1.21.0"
+  gem "rubocop-rake", "~> 0.6.0"
+  gem "simplecov", require: false
+  gem "spy", "~> 1.0"
+  gem "webmock", "~> 3.5"
+end

data/README.md

@@ -1,34 +1,23 @@
-# Elastomer Client [![Build Status](https://travis-ci.org/github/elastomer-client.svg?branch=master)](https://travis-ci.org/github/elastomer-client)
+# ElastomerClient [![CI build Workflow](https://github.com/github/elastomer-client/actions/workflows/main.yml/badge.svg)](https://github.com/github/elastomer-client/actions/workflows/main.yml)
 
 Making a stupid simple Elasticsearch client so your project can be smarter!
 
-## Getting Started
-
-Get started by cloning and running a few scripts:
-
-```
-$ git clone https://github.com/github/elastomer-client.git
-$ cd elastomer-client
-$ script/bootstrap
-$ bundle exec rake test
-```
-
 ## Client
 
 The client provides a one-to-one mapping to the Elasticsearch [API
 endpoints](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html).
 The API is decomposed into logical sections and accessed according to what you
 are trying to accomplish. Each logical section is represented as a [client
-class](lib/elastomer/client) and a top-level accessor is provided for each.
+class](lib/elastomer_client/client) and a top-level accessor is provided for each.
 
 #### Cluster
 
 API endpoints dealing with cluster level information and settings are found in
-the [Cluster](lib/elastomer/client/cluster.rb) class.
+the [Cluster](lib/elastomer_client/client/cluster.rb) class.
 
 ```ruby
-require 'elastomer/client'
-client = Elastomer::Client.new
+require 'elastomer_client/client'
+client = ElastomerClient::Client.new
 
 # the current health summary
 client.cluster.health
@@ -42,80 +31,150 @@ client.cluster.templates
 
 #### Index
 
-The methods in the [Index](lib/elastomer/client/index.rb) class deal with the
+The methods in the [Index](lib/elastomer_client/client/index.rb) class deal with the
 management of indexes in the cluster. This includes setting up type mappings
 and adjusting settings. The actual indexing and search of documents are
 handled by the Docs class (discussed next).
 
 ```ruby
-require 'elastomer/client'
-client = Elastomer::Client.new
+require 'elastomer_client/client'
+client = ElastomerClient::Client.new
 
-index = client.index('twitter')
+index = client.index('books')
 index.create(
   :settings => { 'index.number_of_shards' => 3 },
   :mappings => {
-    :tweet => {
-      :_source => { :enabled => true },
-      :_all    => { :enabled => false },
-      :properties => {
-        :author => { :type => 'string', :index => 'not_analyzed' },
-        :tweet  => { :type => 'string', :analyze => 'standard' }
-      }
+    :_source => { :enabled => true },
+    :properties => {
+      :author => { :type => 'keyword' },
+      :title  => { :type => 'text' }
     }
   }
 )
 
 index.exists?
 
-index.exists? :type => 'tweet'
-
 index.delete
 ```
 
 #### Docs
 
-The [Docs](lib/elastomer/client/docs.rb) class handles the indexing and
+The [Docs](lib/elastomer_client/client/docs.rb) class handles the indexing and
 searching of documents. Each instance is scoped to an index and optionally a
 document type.
 
 ```ruby
-require 'elastomer/client'
-client = Elastomer::Client.new
+require 'elastomer_client/client'
+client = ElastomerClient::Client.new
 
-docs = client.docs('twitter')
+docs = client.docs('books')
 
 docs.index({
   :_id    => 1,
-  :_type  => 'tweet',
-  :author => '@pea53',
-  :tweet  => 'announcing Elastomer, the stupid simple Elasticsearch client'
+  :author => 'Mark Twain',
+  :title  => 'The Adventures of Huckleberry Finn'
 })
 
-docs.search({:query => {:match_all => {}}}, :size => 0)
+docs.search({:query => {:match_all => {}}})
 ```
 
 #### Performance
 
-By default Elastomer uses Net::HTTP (via Faraday) to communicate with
+By default ElastomerClient uses Net::HTTP (via Faraday) to communicate with
 Elasticsearch. You may find that Excon performs better for your use. To enable
-Excon, add it to your bundle and then change your Elastomer initialization
+Excon, add it to your bundle and then change your ElastomerClient initialization
 thusly:
 
 ```ruby
-Elastomer::Client.new(url: YOUR_ES_URL, adapter: :excon)
+ElastomerClient::Client.new(url: YOUR_ES_URL, adapter: :excon)
+```
+
+#### Retries
+
+You can add retry logic to your Elastomer client connection using Faraday's Retry middleware. The `ElastomerClient::Client.new` method can accept a block, which you can use to customize the Faraday connection. Here's an example:
+
+```ruby
+retry_options = {
+  max: 2,
+  interval: 0.05,
+  methods: [:get]
+}
+
+ElastomerClient::Client.new do |connection|
+  connection.request :retry, retry_options
+end
+```
+
+## Compatibility
+
+This client is tested against:
+
+- Ruby version 3.2
+- Elasticsearch versions 5.6 and 8.13
+
+## Development
+
+Get started by cloning and running a few scripts:
+
+- [ElastomerClient ](#elastomerclient-)
+  - [Client](#client)
+      - [Cluster](#cluster)
+      - [Index](#index)
+      - [Docs](#docs)
+      - [Performance](#performance)
+  - [Compatibility](#compatibility)
+  - [Development](#development)
+    - [Bootstrap the project](#bootstrap-the-project)
+    - [Start an Elasticsearch server in Docker](#start-an-elasticsearch-server-in-docker)
+    - [Run tests against a version of Elasticsearch](#run-tests-against-a-version-of-elasticsearch)
+  - [Releasing](#releasing)
+
+### Bootstrap the project
+
+```
+script/bootstrap
+```
+
+### Start an Elasticsearch server in Docker
+
+To run ES 5 and ES 8:
+```
+docker compose --project-directory docker --profile all up
+```
+
+To run only ES 8:
+```
+docker compose --project-directory docker --profile es8 up
+```
+
+To run only ES 5:
+```
+docker compose --project-directory docker --profile es5 up
+```
+
+### Run tests against a version of Elasticsearch
+
+ES 8
+```
+ES_PORT=9208 rake test
+```
+
+ES 5
+```
+ES_PORT=9205 rake test
 ```
 
 ## Releasing
 
-1. Create a new branch from `master`
-2. Bump the version number in `lib/elastomer/version.rb`
-3. Update `CHANGELOG.md` with info about the new version
-4. Execute `bin/rake build`. This will place a new gem file in the `pkg/` folder.
-5. Run `gem install pkg/elastomer-client-{VERSION}.gem` to install the new gem locally
-6. Start an `irb` session, `require "elastomer/client"` and make sure things work as you expect
-7. Once everything is working as you expect, commit the version bump and open a PR
-8. Once you get approval and merge it to master, pull down a fresh copy of master and then...
-9. Run `rake release`
-10. If necessary, manually push the new version to rubygems.org
-11. 🕺 💃 🎉
+1. Create a new branch from `main`
+1. Bump the version number in `lib/elastomer/version.rb`
+1. Update `CHANGELOG.md` with info about the new version
+1. Commit your changes and tag the commit with a version number starting with the prefix "v" e.g. `v4.0.2`
+1. Execute `rake build`. This will place a new gem file in the `pkg/` folder.
+1. Run `gem install pkg/elastomer-client-{VERSION}.gem` to install the new gem locally
+1. Start an `irb` session, `require "elastomer/client"` and make sure things work as you expect
+1. Once everything is working as you expect, push both your commit and your tag, and open a pull request
+1. Request review from a maintainer and wait for the pull request to be approved. Once it is approved, you can merge it to `main` yourself. After that, pull down a fresh copy of `main` and then...
+1. [Optional] If you intend to release a new version to Rubygems, run `rake release`
+1. [Optional] If necessary, manually push the new version to rubygems.org
+1. 🕺 💃 🎉

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require "rake/testtask"
@@ -6,7 +8,7 @@ Rake::TestTask.new do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test
 
 namespace :actions do
   desc "list valid actions"

data/docker/compose.yaml

@@ -0,0 +1,71 @@
+version: "3"
+
+services:
+  elasticsearch8.13:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.13.2
+    container_name: es8.13
+    profiles: ["es8", "all"]
+    environment:
+      - cluster.name=elastomer8.13
+      - bootstrap.memory_lock=true
+      - discovery.type=single-node
+      - xpack.security.enabled=false
+      - xpack.watcher.enabled=false
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    mem_limit: 2g
+    cap_add:
+      - IPC_LOCK
+    volumes:
+      - esrepos8:/usr/share/elasticsearch/repos
+      - ./elasticsearch8plus.yml:/usr/share/elasticsearch/config/elasticsearch.yml
+    ports:
+      - 127.0.0.1:${ES_8_PORT:-9208}:9200
+  
+  elasticsearch5.6:
+    image: docker.elastic.co/elasticsearch/elasticsearch:5.6.4
+    container_name: es5.6
+    profiles: ["es5", "all"]
+    environment:
+      - cluster.name=elastomer5.6
+      - bootstrap.memory_lock=true
+      - discovery.type=single-node
+      - xpack.monitoring.enabled=false
+      - xpack.security.enabled=false
+      - xpack.watcher.enabled=false
+      - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536
+        hard: 65536
+    mem_limit: 1g
+    cap_add:
+      - IPC_LOCK
+    volumes:
+      - esrepos5:/usr/share/elasticsearch/repos
+      - ./elasticsearch.yml:/usr/share/elasticsearch/config/elasticsearch.yml
+    ports:
+      - 127.0.0.1:${ES_5_PORT:-9205}:9200
+
+volumes:
+  esrepos8:
+    driver: local
+    driver_opts:
+      device: tmpfs
+      type: tmpfs
+      o: size=100m,uid=102,gid=102
+  esrepos5:
+    driver: local
+    driver_opts:
+      device: tmpfs
+      type: tmpfs
+      o: size=100m,uid=102,gid=102

data/docker/elasticsearch8plus.yml

@@ -0,0 +1,13 @@
+cluster.name: "docker-cluster"
+
+network.host: 0.0.0.0
+
+path:
+  data: /usr/share/elasticsearch/data
+  logs: /usr/share/elasticsearch/logs
+  repo: /usr/share/elasticsearch/repos
+
+transport.port: 9300
+http.port: 9200
+http.max_content_length: 50mb
+ingest.geoip.downloader.enabled: false