antbird 0.2.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e856fa219aa6977816eb17109225439b602a073ca0481b00bb2e474dcd757e0
-  data.tar.gz: 802baa6e45a28da47204e6e8fe47d9b9bb66ffd4d5a061e958d8ddc68008a96e
+  metadata.gz: 7f6be201e13340d8e4f7cf122049f745af8c9af0d4d6390601a3264bef077992
+  data.tar.gz: 7f1540e56bdc23db02b1300971550bdce93bb0ac426a0010d2fa4a9fc245e8f4
 SHA512:
-  metadata.gz: d6c020d3139d94edd7f4b354bf892f422e5fd6bfaab2250f05de237ca817c7f89397cd3f09628a63fcb7b64e46141062d460dea8525f0592048fcf448c0d3e9b
-  data.tar.gz: 8259edb19088e64d0c5d4cc751870710f801ab64fb4dbc91bfbe1083a4657ed56b0da3a34134209e69864f839cd2fdda5865e13c6e394422d68d6251fad94512
+  metadata.gz: 9d135caf322ed4ad9056883283062ffbf5f43073087b29befa60033273f95ac87dae3b0f2b21fac79eb15d1bf21fe23d3cf136acd89e5ac46c4f2add0bee7678
+  data.tar.gz: c8df3422cf55ffad4f18e4016e0ec972570c525f53250a48962d482d9ac7d45585cf0f2ad8357eb74e1b73dbf2309f2949bcc4ec8e3b016e7f71f07588295848

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,33 +13,33 @@ jobs:
       matrix:
         # 1. Run script/list_versions
         # 2. Check https://www.elastic.co/jp/support/eol
-        elasticsearch:
-        - 7.10.1
+        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.13
-    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,27 @@ 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
+      else
+        fetch_version_and_distribution
+      end
 
       @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 +51,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 +67,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 +147,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 +198,40 @@ module Antbird
       end
     end
 
+    def elasticsearch?
+      !opensearch?
+    end
+
+    def opensearch?
+      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
@@ -182,17 +249,26 @@ module Antbird
       end
     end
 
-    def fetch_version
-      connection.get('/').body.dig('version', 'number')
+    def fetch_version_and_distribution
+      version_hash = connection.get('/').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}"
+      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