antbird 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0233525863b99bccb8734b00d5c92901924403113dd6bade6936ff566a00fa3a'
-  data.tar.gz: 00e9494e1a04c47adf6970bdc283a6854818186b112660c1830b9ada9370998c
+  metadata.gz: 3c8c8fecccb123dbea652666e8c3afe9c0bb82b05addd4c16184285fc8d883fa
+  data.tar.gz: 300f03046a12082dc0f7ee92dc0283f1228cdc6dc1975cfa965e56d7baf065db
 SHA512:
-  metadata.gz: '0191b07ce7917e9d57bf2b96e75e4f45d735e578209fe8e093bdf2bab43b08f76a61c6150cbae034e7a723c248571bf68b22cedd2def7962aab06f7ad353063f'
-  data.tar.gz: ede40233ca26abddba033fe7c52920e3c8aa7167d1ab5bc27aad3bd1f2fd01305b9ce7aacaf16132759b79cc4ddacc99a53d6bec3bd52ad46e358433f5dcc6ef
+  metadata.gz: e5e54fed3437d547f92bfead50aeab29612694a955d6ed3f762962eaa29a7bec0743027557c8f0d15c82f032f5f5f188e138eb1a58a53afdb893b4e9abfa09b6
+  data.tar.gz: 37595c88f4e1df53b79d3f859c9a551d9ebfd49fd005f6e75136c91b677c84def615f3022bbac99149da8f00ff1991884c9a18a9d43f50e476fbfe2875adec6a

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,32 +13,33 @@ jobs:
       matrix:
         # 1. Run script/list_versions
         # 2. Check https://www.elastic.co/jp/support/eol
-        elasticsearch:
-        - 7.9.2
+        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
-        - 7.6.2
-        - 7.5.2
-        - 7.4.2
-        - 7.3.2
-        - 7.2.1
-        - 7.1.1
-        - 6.8.12
-    services:
-      elasticsearch:
-        image: docker.elastic.co/elasticsearch/elasticsearch-oss:${{matrix.elasticsearch}}
-        ports:
-          - 9200:9200
-          - 9300:9300
-        env:
-          discovery.type: single-node
+        - 6.8.18
     steps:
+    # @see https://github.com/elastic/elastic-github-actions/tree/master/elasticsearch
+    - name: Configure sysctl limits for Elasticsearch
+      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
+    - name: Runs Elasticsearch
+      uses: elastic/elastic-github-actions/elasticsearch@master
+      with:
+        stack-version: ${{matrix.search_versions}}
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        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,20 +20,22 @@ module Antbird
       @block        = block
       @url          = url
 
-      @scope     = scope.transform_keys(&:to_sym)
-      @version   = version
+      @scope        = scope.transform_keys(&:to_sym)
+      @version      = version
+      @distribution = distribution
 
       @api_specs = {}
     end
-    attr_reader :scope, :url, :version
+    attr_reader :scope, :url, :version, :distribution
     attr_reader :read_timeout, :open_timeout, :adapter
-    attr_reader :api_specs
+    attr_reader :api_specs, :last_request
 
     def scoped(new_scope = {})
       Client.new(
         scope: new_scope,
         url: url,
         version: version,
+        distribution: distribution,
         read_timeout: read_timeout,
         open_timeout: open_timeout
       )
@@ -43,11 +46,13 @@ module Antbird
 
       body   = extract_body(params)
       scopes = extract_scopes(params)
+      forced_method = extract_method(params)
 
       # Greedy match
       api_path = nil
+      api_path_template = nil
       path_methods = nil
-      api_spec['url']['paths'].sort { |a, b| b.size <=> a.size }.each do |path|
+      sort_url_paths(api_spec['url']['paths']).each do |path|
         if path.is_a?(Hash)
           path_methods = path['methods']
           path = path['path']
@@ -57,19 +62,40 @@ module Antbird
           scopes[$1.to_sym] || @scope[$1.to_sym] || match
         end
 
-        break api_path = embeded unless embeded.include?('{')
+        unless embeded.include?('{')
+          api_path_template = path
+          api_path = embeded
+          break
+        end
       end
 
       unless api_path
         raise "API path not found: paths: #{api_spec['url']['paths']}, scope: #{@scope}"
       end
 
-      methods = (Array(path_methods) + Array(api_spec['methods'])).map(&:downcase).map(&:to_sym)
-      method = methods.include?(:post) ? :post : methods.first
+      methods = (path_methods || api_spec['methods']).map { |m| m.downcase.to_sym }
+      method =
+        if forced_method
+          forced_method
+        elsif methods.include?(:put)
+          :put
+        elsif methods.include?(:post)
+          :post
+        else
+          methods.first
+        end
 
       read_timeout = params.delete(:read_timeout)
       params.reject! { |_, v| v.nil? }
 
+      @last_request = {
+        method: method,
+        forced_method: forced_method,
+        api_path: api_path,
+        api_path_template: api_path_template,
+        params: params
+      }
+
       response =
         case method
         when :head
@@ -116,6 +142,10 @@ module Antbird
       response.body
     end
 
+    def extract_method(params)
+      params.delete(:method)&.to_sym
+    end
+
     def extract_scopes(params)
       scopes = {}
       [:index, :type, :id].each do |s|
@@ -163,8 +193,41 @@ module Antbird
       end
     end
 
+    def elasticsearch?
+      !opensearch?
+    end
+
+    def opensearch?
+      fetch_version
+      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
+
     private
 
+    # NOTE: stable sort
+    def sort_url_paths(url_paths)
+      i = 0
+      url_paths.sort_by do |path|
+        if path.is_a?(Hash)
+          [-path['path'].count('{'), (path['deprecated'] ? 1 : 0), i += 1]
+        else
+          [-path.count('{'), i += 1]
+        end
+      end
+    end
+
     def handle_errors!(response)
       if response.status >= 500
         raise ServerError, response
@@ -183,16 +246,25 @@ module Antbird
     end
 
     def fetch_version
-      connection.get('/').body.dig('version', 'number')
+      return if @version
+
+      version_hash = connection.get('/').body.dig('version')
+      @version ||= version_hash['number']
+      @distribution ||= version_hash['distribution']
     end
 
     def ensure_api_spec_loaded
       return if api_specs_loaded?
 
-      @version ||= fetch_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}"
+      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