elasticsearch-api 7.4.0 → 7.5.0.pre.pre

data/utils/thor/generator/endpoint_specifics.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# 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
+
+module Elasticsearch
+  module API
+    # Handles specific exceptional parameters and code snippets that need to be
+    # included in the generated code. This module is included in SourceGenerator
+    # so its methods can be used from the ERB template (method.erb). This will
+    # potentially be refactored into different templates.
+    module EndpointSpecifics
+      # Endpoints that need Utils.__rescue_from_not_found
+      IGNORE_404 = %w[
+        exists
+        indices.exists
+        indices.exists_alias
+        indices.exists_template
+        indices.exists_type
+      ].freeze
+
+      # Endpoints that need Utils.__rescue_from_not_found if the ignore
+      # parameter is included
+      COMPLEX_IGNORE_404 = %w[
+        delete
+        get
+        indices.flush_synced
+        indices.delete_template
+        indices.delete
+        security.get_role
+        security.get_user
+        snapshot.status
+        snapshot.get
+        snapshot.get_repository
+        snapshot.delete_repository
+        snapshot.delete
+        update
+        watcher.delete_watch
+      ].freeze
+
+      # Endpoints that need params[:h] listified
+      H_PARAMS = %w[aliases allocation count health indices nodes pending_tasks
+                    recovery shards thread_pool].freeze
+
+      # Function that adds the listified h param code
+      def specific_params(namespace)
+        params = []
+        if H_PARAMS.include?(@method_name) && namespace == 'cat'
+          if @method_name == 'nodes'
+            params << 'params[:h] = Utils.__listify(params[:h], escape: false) if params[:h]'
+          else
+            params << 'params[:h] = Utils.__listify(params[:h]) if params[:h]'
+          end
+        end
+        params
+      end
+
+      def needs_ignore_404?(endpoint)
+        IGNORE_404.include? endpoint
+      end
+
+      def needs_complex_ignore_404?(endpoint)
+        COMPLEX_IGNORE_404.include? endpoint
+      end
+
+      def termvectors_path
+        <<~SRC
+          if _index && _type && _id
+            "\#{Utils.__listify(_index)}/\#{Utils.__listify(_type)}/\#{Utils.__listify(_id)}/\#{endpoint}"
+          elsif _index && _type
+            "\#{Utils.__listify(_index)}/\#{Utils.__listify(_type)}/\#{endpoint}"
+          elsif _index && _id
+            "\#{Utils.__listify(_index)}/\#{endpoint}/\#{Utils.__listify(_id)}"
+          else
+            "\#{Utils.__listify(_index)}/\#{endpoint}"
+          end
+        SRC
+      end
+
+      def ping_perform_request
+        <<~SRC
+          begin
+            perform_request(method, path, params, body).status == 200 ? true : false
+          rescue Exception => e
+            if e.class.to_s =~ /NotFound|ConnectionFailed/ || e.message =~ /Not\s*Found|404|ConnectionFailed/i
+              false
+            else
+              raise e
+            end
+          end
+        SRC
+      end
+
+      def indices_stats_params_registry
+        <<~SRC
+          ParamsRegistry.register(:stats_params, [
+            #{@spec['params'].keys.map { |k| ":#{k}" }.join(",\n")}
+          ].freeze)
+
+          ParamsRegistry.register(:stats_parts, [
+            #{@parts['metric']['options'].push('metric').map { |k| ":#{k}" }.join(",\n")}
+          ].freeze)
+        SRC
+      end
+
+      def msearch_body_helper
+        <<~SRC
+          case
+          when body.is_a?(Array) && body.any? { |d| d.has_key? :search }
+            payload = body.
+              inject([]) do |sum, item|
+                meta = item
+                data = meta.delete(:search)
+
+                sum << meta
+                sum << data
+                sum
+              end.
+              map { |item| Elasticsearch::API.serializer.dump(item) }
+            payload << "" unless payload.empty?
+            payload = payload.join("\n")
+          when body.is_a?(Array)
+            payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
+            payload << "" unless payload.empty?
+            payload = payload.join("\n")
+          else
+            payload = body
+          end
+        SRC
+      end
+
+      def msearch_template_body_helper
+        <<~SRC
+          case
+          when body.is_a?(Array)
+            payload = body.map { |d| d.is_a?(String) ? d : Elasticsearch::API.serializer.dump(d) }
+            payload << "" unless payload.empty?
+            payload = payload.join("\n")
+          else
+            payload = body
+          end
+        SRC
+      end
+
+      def bulk_body_helper
+        <<~SRC
+          if body.is_a? Array
+            payload = Utils.__bulkify(body)
+          else
+            payload = body
+          end
+        SRC
+      end
+    end
+  end
+end

data/utils/thor/generator/files_helper.rb

@@ -0,0 +1,37 @@
+require 'pathname'
+
+module Elasticsearch
+  module API
+    module FilesHelper
+      OSS_SRC_PATH   = '../../../../../tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/api/'.freeze
+      OSS_OUTPUT_DIR = '../../elasticsearch-api/lib/elasticsearch/api/actions'.freeze
+
+      XPACK_SRC_PATH   = '../../../../../tmp/elasticsearch/x-pack/plugin/src/test/resources/rest-api-spec/api'.freeze
+      XPACK_OUTPUT_DIR = '../../elasticsearch-xpack/lib/elasticsearch/xpack/api/actions'.freeze
+
+      # Path to directory with JSON API specs
+      def self.input_dir(xpack = false)
+        input_dir = if xpack
+                      File.expand_path(XPACK_SRC_PATH, __FILE__)
+                    else
+                      File.expand_path(OSS_SRC_PATH, __FILE__)
+                    end
+        Pathname(input_dir)
+      end
+
+      # Path to directory to copy generated files
+      def self.output_dir(xpack = false)
+        xpack ? Pathname(XPACK_OUTPUT_DIR) : Pathname(OSS_OUTPUT_DIR)
+      end
+
+      # Only get JSON files and remove hidden files
+      def self.files(xpack = false)
+        Dir.entries(input_dir(xpack).to_s).reject do |f|
+          f.start_with?('.') ||
+            f.start_with?('_') ||
+            File.extname(f) != '.json'
+        end
+      end
+    end
+  end
+end

data/utils/thor/lister.rb

@@ -9,16 +9,16 @@ require 'thor'
 require 'pathname'
 
 module Elasticsearch
-
   module API
-
     class Lister < Thor
       namespace 'api'
 
+      DEFAULT_PATH = '../../tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/api/'.freeze
+
       desc "list <PATH DIRECTORY WITH JSON SPEC FILES>", "List all the REST API endpoints from the JSON specification"
       method_option :verbose,  type: :boolean, default: false, desc: 'Output more information'
       method_option :format,   default: 'text', desc: 'Output format (text, json)'
-      def list(directory)
+      def list(directory = DEFAULT_PATH)
         input = Pathname(directory).join('*.json')
         apis = Dir[input.to_s].map do |f|
           File.basename(f, '.json')
@@ -40,6 +40,5 @@ module Elasticsearch
         end
       end
     end
-
   end
 end

data/utils/thor/templates/_documentation_top.erb

@@ -0,0 +1,27 @@
+<%- if @spec['documentation']['description'] -%>
+  <%= '  '*(@namespace_depth+3) %># <%= @spec['documentation']['description'].gsub("\n", "\n#{'  '*(@namespace_depth+3)}# ") -%>
+<%- else %>
+  <%= '  '*(@namespace_depth+3) %># TODO: Description
+<%- end %>
+<%= '  '*(@namespace_depth+3) %>#
+<%- unless @parts.nil? || @parts.empty? %><%# URL parts -%>
+  <%- @parts.each do |name, info| -%>
+    <%= docs_helper(name, info) -%>
+  <%- end -%>
+<%- end -%><%# Body -%>
+<%# URL parameters -%>
+<%- @params.each do |name, info| -%>
+  <%= docs_helper(name, info) -%>
+<%- end %>
+<%= '  '*(@namespace_depth+3) + '# @option arguments [Hash] :body ' + (@spec['body']['description'] ? @spec['body']['description'].strip : 'TODO: Description') + (@spec['body']['required'] ? ' (*Required*)' : '') + "\n" if @spec['body'] -%>
+<% if @deprecation_note -%>
+  #
+  # *Deprecation notice*:
+  # <%=  @deprecation_note['description'] %>
+  # Deprecated since version <%=  @deprecation_note['version'] %>
+  #
+<% end -%>
+<%= '  '*(@namespace_depth+3) -%>#
+<%# Documentation link -%>
+<%=  '  '*(@namespace_depth+3) %># @see <%= @spec['documentation']['url'] ? @spec['documentation']['url'].gsub!(/\/(current|master)\//, '/7.5/') : "[TODO]" %>
+<%= '  '*(@namespace_depth+3) %>#

data/utils/thor/templates/_method_setup.erb

@@ -0,0 +1,35 @@
+<%- if @endpoint_name == 'indices.stats' %>
+  method = HTTP_GET
+  parts  = Utils.__extract_parts arguments, ParamsRegistry.get(:stats_parts)
+  path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
+  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:stats_params)
+  params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
+  params[:groups] = Utils.__listify(params[:groups], :escape => false) if params[:groups]
+<%- else %>
+  <%= '  '*(@namespace_depth+4) %>arguments = arguments.clone
+  <%- if @method_name == 'mtermvectors' -%>
+    ids = arguments.delete(:ids)
+  <%- end -%>
+  <%- if @method_name == 'search' -%>
+    arguments[:index] = UNDERSCORE_ALL if ! arguments[:index] && arguments[:type]
+  <%- end -%>
+  <%- @parts.each do |name, _| %>
+    <%- unless @method_name == 'get_field_mapping' && name == 'fields' %>
+      <%= '  '*(@namespace_depth+3) + "_#{name}" %> = arguments.delete(:<%=name %>)
+    <%- end -%>
+  <%- end -%>
+
+  <%= '  '*(@namespace_depth+4) %>method = <%= @http_method %>
+  <%- if @method_name == 'termvectors' %>
+    endpoint = arguments.delete(:endpoint) || '_termvectors'
+  <%- end -%>
+  <%= '  '*(@namespace_depth+4) %>path   = <%= @http_path %>
+  <%- unless @params.empty? -%>
+    <%= '  '*(@namespace_depth+4) %>params = <%= __utils %>.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+  <%- else -%>
+    <%= '  '*(@namespace_depth+4) %>params = {}
+  <%- end -%>
+  <%- @specific_params.each do |param| -%>
+    <%= param %>
+  <%- end -%>
+<%- end -%>

data/utils/thor/templates/_params_registry.erb

@@ -0,0 +1,12 @@
+<%- unless @params.empty? -%>
+  <%= '  '*(@namespace_depth+3) %># Register this action with its valid params when the module is loaded.
+  <%= '  '*(@namespace_depth+3) %>#
+  <%= '  '*(@namespace_depth+3) %># @since 6.2.0
+  <%- if @endpoint_name == 'indices.stats' -%>
+    <%= indices_stats_params_registry %>
+  <%- else -%>
+    <%= '  '*(@namespace_depth+3) %>ParamsRegistry.register(:<%= @method_name %>, [
+    <%= '  '*(@namespace_depth+4) %><%= @params.keys.map { |k| ":#{k}" }.join(",\n#{'  '*(@namespace_depth+4)}") %>
+    <%= '  '*(@namespace_depth+3) %>].freeze)
+  <%- end -%>
+<%- end -%>

data/utils/thor/templates/_perform_request.erb

@@ -0,0 +1,37 @@
+<%-
+case @endpoint_name
+when 'mtermvectors'
+-%>
+  if ids
+    body = { :ids => ids }
+  else
+    body = arguments[:body]
+  end
+<%- when 'cluster.reroute', 'cluster.put_settings' %>
+  body = arguments[:body] || {}
+<%- when 'ml.find_file_structure' %>
+  body = <%= __utils %>.__bulkify(arguments.delete(:body))
+<%- else -%>
+  <%= '  '*(@namespace_depth+3) %>body   = <%= @spec['body'].nil? ? 'nil' : 'arguments[:body]' %>
+<%- end -%>
+<%- if ['bulk', 'msearch', 'msearch_template'].include? @method_name -%>
+  <%= self.send("#{@method_name}_body_helper".to_s) %>
+  <%= '  '*(@namespace_depth+4) %>perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+<%- elsif @method_name == 'ping' -%>
+  <%= ping_perform_request %>
+<%- else -%>
+  <%- if needs_ignore_404?(@endpoint_name) %>
+    <%= __utils %>.__rescue_from_not_found do
+      perform_request(method, path, params, body).status == 200 ? true : false
+    end
+  <%- elsif needs_complex_ignore_404?(@endpoint_name) -%>
+    if Array(arguments[:ignore]).include?(404)
+      <%= __utils %>.__rescue_from_not_found { perform_request(method, path, params, body).body }
+    else
+      perform_request(method, path, params, body).body
+    end
+  <%- else -%>
+      perform_request(method, path, params, body).body
+  <%- end -%>
+<%- end -%>
+<%= '  '*(@namespace_depth+3) %>end

data/utils/thor/templates/method.erb

@@ -0,0 +1,59 @@
+# 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
+
+module Elasticsearch
+<%- if @xpack -%>
+  <%= '  '*(@namespace_depth) %>module XPack
+<%- end %>
+<%= '  '*(@namespace_depth) %>module API
+<%- @module_namespace.each_with_index do |name, i| -%>
+  <%= '  '*i %>module <%= name.split("_").map(&:capitalize).join %>
+<%- end -%>
+<%= '  '*(@namespace_depth+2) %>module Actions
+<%= ERB.new(File.new("./thor/templates/_documentation_top.erb").read, trim_mode: '-').result(binding) -%>
+<%# Method definition -%>
+<%= '  '*(@namespace_depth+3) -%>def <%= @method_name %>(arguments={})
+<%- if @endpoint_name == 'create' -%>
+  <%= '  '*(@namespace_depth+3) %>if arguments[:id]
+  <%= '  '*(@namespace_depth+3) %>  index arguments.update op_type: 'create'
+  <%= '  '*(@namespace_depth+3) %>else
+  <%= '  '*(@namespace_depth+3) %>  index arguments
+  <%= '  '*(@namespace_depth+3) %>end
+  <%= '  '*(@namespace_depth+2) %>end
+<%- else -%>
+  <%- if @method_name == 'get_field_mapping' %>
+    _fields = arguments.delete(:field) || arguments.delete(:fields)
+    raise ArgumentError, "Required argument 'field' missing" unless _fields
+  <%- else -%>
+    <%- @required_parts.each do |required| %><%# Arguments -%>
+      <%= '  '*(@namespace_depth+3) + "raise ArgumentError, \"Required argument '#{required}' missing\" unless arguments[:#{required}]" + "\n" -%>
+    <%- end -%>
+    <%- end -%>
+    <%- # Method setup -%>
+    <%= ERB.new(File.new("./thor/templates/_method_setup.erb").read, trim_mode: '-').result(binding) %>
+    <%- # Perform request -%>
+    <%= ERB.new(File.new("./thor/templates/_perform_request.erb").read, trim_mode: '-').result(binding) %>
+<%- end -%>
+<%- if @method_name.match?(/^exists\S*/) -%>
+  alias_method :<%= @method_name %>?, :<%= @method_name %>
+<%- end -%>
+<%- if @method_name == 'termvectors' %>
+
+  # Deprecated: Use the plural version, {#termvectors}
+  #
+  def termvector(arguments={})
+    termvectors(arguments.merge endpoint: '_termvector')
+  end
+<%- end -%>
+<%# Params Registry Template -%>
+<%- unless @endpoint_name == 'create' -%>
+  <%= ERB.new(File.new("./thor/templates/_params_registry.erb").read, trim_mode: '-').result(binding) %>
+<%- end -%>
+
+<%- @namespace_depth.downto(1) do |i| -%>
+<%= '  '*(i-1) %>end
+<%- end if @namespace_depth > 0 -%>
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.5.0.pre.pre
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -334,7 +334,7 @@ dependencies:
         version: '2'
 description: 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
 
-  '
+'
 email:
 - karel.minarik@elasticsearch.org
 executables: []
@@ -390,6 +390,7 @@ files:
 - lib/elasticsearch/api/actions/create.rb
 - lib/elasticsearch/api/actions/delete.rb
 - lib/elasticsearch/api/actions/delete_by_query.rb
+- lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb
 - lib/elasticsearch/api/actions/delete_by_rethrottle.rb
 - lib/elasticsearch/api/actions/delete_script.rb
 - lib/elasticsearch/api/actions/exists.rb
@@ -422,6 +423,7 @@ files:
 - lib/elasticsearch/api/actions/indices/get_mapping.rb
 - lib/elasticsearch/api/actions/indices/get_settings.rb
 - lib/elasticsearch/api/actions/indices/get_template.rb
+- lib/elasticsearch/api/actions/indices/get_upgrade.rb
 - lib/elasticsearch/api/actions/indices/open.rb
 - lib/elasticsearch/api/actions/indices/params_registry.rb
 - lib/elasticsearch/api/actions/indices/put_alias.rb
@@ -471,6 +473,7 @@ files:
 - lib/elasticsearch/api/actions/search.rb
 - lib/elasticsearch/api/actions/search_shards.rb
 - lib/elasticsearch/api/actions/search_template.rb
+- lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb
 - lib/elasticsearch/api/actions/snapshot/create.rb
 - lib/elasticsearch/api/actions/snapshot/create_repository.rb
 - lib/elasticsearch/api/actions/snapshot/delete.rb
@@ -604,7 +607,7 @@ files:
 - spec/elasticsearch/api/actions/reindex_spec.rb
 - spec/elasticsearch/api/actions/remote/info_spec.rb
 - spec/elasticsearch/api/actions/render_search_template_spec.rb
-- spec/elasticsearch/api/actions/scoll_spec.rb
+- spec/elasticsearch/api/actions/scroll_spec.rb
 - spec/elasticsearch/api/actions/search_shards_spec.rb
 - spec/elasticsearch/api/actions/search_spec.rb
 - spec/elasticsearch/api/actions/search_template_spec.rb
@@ -633,12 +636,17 @@ files:
 - test/test_helper.rb
 - utils/Gemfile
 - utils/Thorfile
-- utils/thor/generate_api.rb
 - utils/thor/generate_source.rb
+- utils/thor/generator/endpoint_specifics.rb
+- utils/thor/generator/files_helper.rb
 - utils/thor/lister.rb
-- utils/thor/templates/ruby/method.erb
-- utils/thor/templates/ruby/test.erb
-- utils/thor/templates/ruby/test_helper.rb
+- utils/thor/templates/_documentation_top.erb
+- utils/thor/templates/_method_setup.erb
+- utils/thor/templates/_params_registry.erb
+- utils/thor/templates/_perform_request.erb
+- utils/thor/templates/method.erb
+- utils/thor/templates/test.erb
+- utils/thor/templates/test_helper.rb
 homepage: https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api
 licenses:
 - Apache-2.0
@@ -655,9 +663,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.6
 signing_key: 
@@ -768,7 +776,7 @@ test_files:
 - spec/elasticsearch/api/actions/reindex_spec.rb
 - spec/elasticsearch/api/actions/remote/info_spec.rb
 - spec/elasticsearch/api/actions/render_search_template_spec.rb
-- spec/elasticsearch/api/actions/scoll_spec.rb
+- spec/elasticsearch/api/actions/scroll_spec.rb
 - spec/elasticsearch/api/actions/search_shards_spec.rb
 - spec/elasticsearch/api/actions/search_spec.rb
 - spec/elasticsearch/api/actions/search_template_spec.rb