antbird 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af75afbbb6d09da0a80a3ef3c15c12eca61410975581dd6f26997fa3f70272d0
-  data.tar.gz: 5327fae6beaaecb226dea3ab8b04b3a88de6b47d3be77d23651f5c3840d4f26f
+  metadata.gz: b0f0ed1c7dabf81835ef85e0a5a105b19c233ade75532df0462228277f447e11
+  data.tar.gz: c56cf7841b8309571e54e03cb13ce006d9a17e04222ed5afda7921aa89c468a1
 SHA512:
-  metadata.gz: ac456d024f7ad570b8dc3243a65895c74706ae9453bcdea5e0a8a52c98dcd38e2b3ca0c9f34290ed9483613d8facf50971c3dbde5d816bc011c37c9854141e1a
-  data.tar.gz: 3266fefa55330b1a4180d16dfd54ac40b0bc91208b2253933d3648ed7bb7a02eab4eef49c41d173675a1c36932ca5b5391e3cb086df6df7b26f0a9ec1ad04467
+  metadata.gz: fee97bce77ff300cd14b51fd4de70214a7521bd5f58e19b1473a97612951a25ba7632287c8889263708b1566b8a963b172f060a9782379445458f83a46072dc6
+  data.tar.gz: 57fb63974675572ff7222a0a9af53f4c2b00258a7f0c6ec69647a09f1a68aba8120f05448bc4caa35ddb5232b9a389e21ecc4e0298aeab787ca4b11c284ac51b

data/.github/workflows/build-os.yml

@@ -0,0 +1,41 @@
+name: build-os
+
+on: [push]
+env:
+  ENGINE_NAME: opensearch
+  REST_API_SPEC_REPO: opensearch-project/OpenSearch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # https://github.com/opensearch-project/OpenSearch/releases
+        search_versions:
+        - 1.2.0
+        - 1.1.0
+        - 1.0.0
+    services:
+      opensearch:
+        image: opensearchproject/opensearch:${{matrix.search_versions}}
+        ports:
+          - 9200:9200
+        env:
+          discovery.type: single-node
+          plugins.security.disabled: true
+    steps:
+    - name: Configure sysctl limits
+      run: |
+        sudo swapoff -a
+        sudo sysctl -w vm.swappiness=1
+        sudo sysctl -w fs.file-max=262144
+        sudo sysctl -w vm.max_map_count=262144
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - name: Wait for OpenSearch
+      run: timeout 60 bash -c "until curl --silent --output /dev/null localhost:9200/_cat/health?h=st; do printf '.'; sleep 5; done; printf '\n'"
+    - run: bundle exec rspec

data/.github/workflows/build.yml

@@ -1,6 +1,9 @@
 name: build
 
 on: [push]
+env:
+  ENGINE_NAME: elasticsearch
+  REST_API_SPEC_REPO: elastic/elasticsearch
 
 jobs:
   build:
@@ -10,15 +13,15 @@ jobs:
       matrix:
         # 1. Run script/list_versions
         # 2. Check https://www.elastic.co/jp/support/eol
-        elasticsearch:
-        - 7.14.0
+        search_versions:
+        - 7.15.2
+        - 7.14.2
         - 7.13.4
         - 7.12.1
         - 7.11.2
         - 7.10.2
         - 7.9.3
         - 7.8.1
-        - 7.7.1
         - 6.8.18
     steps:
     # @see https://github.com/elastic/elastic-github-actions/tree/master/elasticsearch
@@ -31,13 +34,12 @@ jobs:
     - name: Runs Elasticsearch
       uses: elastic/elastic-github-actions/elasticsearch@master
       with:
-        stack-version: ${{matrix.elasticsearch}}
+        stack-version: ${{matrix.search_versions}}
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.7
         bundler-cache: true
-    - run: bundle install --jobs 4 --retry 3
     - name: Wait for elasticsearch
       run: timeout 60 bash -c "until curl --silent --output /dev/null localhost:9200/_cat/health?h=st; do printf '.'; sleep 5; done; printf '\n'"
     - run: bundle exec rspec

data/README.md

@@ -1,6 +1,6 @@
 # Antbird
 
-Nearly auto-generated Elasticsearch client
+Nearly auto-generated Elasticsearch/OpenSearch client
 
 [![Build Status](https://github.com/fukayatsu/antbird/workflows/build/badge.svg)](https://github.com/fukayatsu/antbird/actions)
 
@@ -113,9 +113,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/fukayatsu/antbird. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-### How to support newer version of Elasticsearch
+### How to support newer version of Elasticsearch/OpenSearch
 
-1. Add Elasticsearch version to `jobs.build.strategy.matrix.elasticsearch` on `.github/workflows/build.yml`
+1. Add Elasticsearch version to `jobs.build.strategy.matrix.search_versions` on `.github/workflows/build.yml` / `.github/workflows/build-os.yml`
     - Only one line for `x.y.*` version
 1. `script/generate_api_methods`
     - Set `GITHUB_TOKEN=***` env for GitHub API Limit

data/lib/antbird/client.rb

@@ -8,6 +8,7 @@ module Antbird
       scope: {},
       url: "http://localhost:9200",
       version: nil,
+      distribution: nil,
       read_timeout: 5,
       open_timeout: 2,
       adapter: ::Faraday.default_adapter,
@@ -19,12 +20,16 @@ module Antbird
       @block        = block
       @url          = url
 
-      @scope     = scope.transform_keys(&:to_sym)
-      @version   = version
+      @scope        = scope.transform_keys(&:to_sym)
+
+      if version
+        @version      = version
+        @distribution = distribution
+      end
 
       @api_specs = {}
     end
-    attr_reader :scope, :url, :version
+    attr_reader :scope, :url, :distribution
     attr_reader :read_timeout, :open_timeout, :adapter
     attr_reader :api_specs, :last_request
 
@@ -33,6 +38,7 @@ module Antbird
         scope: new_scope,
         url: url,
         version: version,
+        distribution: distribution,
         read_timeout: read_timeout,
         open_timeout: open_timeout
       )
@@ -190,6 +196,35 @@ module Antbird
       end
     end
 
+    def elasticsearch?
+      !opensearch?
+    end
+
+    def opensearch?
+      ensure_version_and_distribution
+
+      distribution == 'opensearch'
+    end
+
+    def elasticsearch_v7_0_compatible?
+      return true if opensearch?
+
+      elasticsearch? && Gem::Version.new(version) >= Gem::Version.new('7.0.0')
+    end
+
+    def elasticsearch_v7_6_compatible?
+      return true if opensearch?
+
+      elasticsearch? && Gem::Version.new(version) >= Gem::Version.new('7.6.0')
+    end
+
+    def version
+      return @version if @version
+
+      ensure_version_and_distribution
+      @version
+    end
+
     private
 
     # NOTE: stable sort
@@ -221,17 +256,35 @@ module Antbird
       end
     end
 
-    def fetch_version
-      connection.get('/').body.dig('version', 'number')
+    def ensure_version_and_distribution
+      return if @version
+
+      response = connection.get('/')
+      if response.status == 401
+        raise Antbird::Client::RequestError.new(response)
+      end
+
+      version_hash = response.body.dig('version')
+      @version = version_hash['number']
+      @distribution = version_hash['distribution']
+    end
+
+    def class_version
+      version.split('.')[0, 2].join('_')
     end
 
     def ensure_api_spec_loaded
       return if api_specs_loaded?
 
-      @version ||= fetch_version
-      class_version = @version.split('.')[0, 2].join('_')
-      require "antbird/rest_api/rest_api_v#{class_version}"
-      extend Antbird::RestApi.const_get "RestApiV#{class_version}"
+      ensure_version_and_distribution
+
+      if opensearch?
+        require "antbird/rest_api/rest_api_opensearch_v#{class_version}"
+        extend Antbird::RestApi.const_get "RestApiOpensearchV#{class_version}"
+      else
+        require "antbird/rest_api/rest_api_v#{class_version}"
+        extend Antbird::RestApi.const_get "RestApiV#{class_version}"
+      end
 
       @api_specs_loaded = true
     end