elasticsearch-api 8.9.0 → 8.11.0

data/utils/thor/generate_source.rb

@@ -23,7 +23,7 @@ require 'multi_json'
 require 'coderay'
 require 'pry'
 require_relative 'generator/files_helper'
-require_relative 'generator/endpoint_specifics'
+require_relative '../endpoint_spec'
 
 module Elasticsearch
   module API
@@ -62,45 +62,25 @@ module Elasticsearch
       private
 
       def generate_source
-        @output = FilesHelper.output_dir
-        cleanup_directory!
+        output = FilesHelper.output_dir
+        cleanup_directory!(output)
 
         FilesHelper.files.each do |filepath|
-          @path = Pathname(filepath)
-          @json = MultiJson.load(File.read(@path))
-          @spec = @json.values.first
-          say_status 'json', @path, :yellow
-
-          @spec['url'] ||= {}
-
-          @endpoint_name    = @json.keys.first
-          @full_namespace   = __full_namespace
-          @namespace_depth  = @full_namespace.size > 0 ? @full_namespace.size - 1 : 0
-          @module_namespace = @full_namespace[0, @namespace_depth]
+          @spec = EndpointSpec.new(filepath)
+          say_status 'json', @spec.path, :yellow
 
           # Don't generate code for internal APIs:
-          next if @module_namespace.flatten.first == '_internal'
-
-          @method_name      = @full_namespace.last
-          @parts            = __endpoint_parts
-          @params           = @spec['params'] || {}
-          @specific_params  = specific_params(@module_namespace.first) # See EndpointSpecifics
-          @http_method      = __http_method
-          @paths            = @spec['url']['paths'].map { |b| b['path'] }
-          # Using Ruby's safe operator on array:
-          @deprecation_note = @spec['url']['paths'].last&.[]('deprecated')
-          @http_path        = __http_path
-          @required_parts   = __required_parts
-
-          @path_to_file = @output.join(@module_namespace.join('/')).join("#{@method_name}.rb")
-          dir = @output.join(@module_namespace.join('/'))
+          next if @spec.module_namespace.flatten.first == '_internal'
+
+          path_to_file = output.join(@spec.module_namespace.join('/')).join("#{@spec.method_name}.rb")
+          dir = output.join(@spec.module_namespace.join('/'))
 
           empty_directory(dir, verbose: false)
 
           # Write the file with the ERB template:
-          template('templates/method.erb', @path_to_file, force: true)
+          template('templates/method.erb', path_to_file, force: true)
 
-          print_source_code(@path_to_file) if options[:verbose]
+          print_source_code(path_to_file) if options[:verbose]
 
           generate_tests if options[:tests]
 
@@ -137,122 +117,15 @@ module Elasticsearch
         match[1]
       end
 
-      def __full_namespace
-        names = @endpoint_name.split('.')
-        # Return an array to expand 'ccr', 'ilm', 'ml' and 'slm'
-        names.map do |name|
-          name
-            .gsub(/^ml$/, 'machine_learning')
-            .gsub(/^ilm$/, 'index_lifecycle_management')
-            .gsub(/^ccr/, 'cross_cluster_replication')
-            .gsub(/^slm/, 'snapshot_lifecycle_management')
-        end
-      end
-
       # Create the hierarchy of directories based on API namespaces
       #
-      def __create_directories(key, value)
+      def create_directories(key, value)
         return if value['documentation']
 
         empty_directory @output.join(key)
         create_directory_hierarchy * value.to_a.first
       end
 
-      # Extract parts from each path
-      #
-      def __endpoint_parts
-        parts = @spec['url']['paths'].select do |a|
-          a.keys.include?('parts')
-        end.map do |path|
-          path&.[]('parts')
-        end
-        (parts.inject(&:merge) || [])
-      end
-
-      def __http_method
-        return '_id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST' if @endpoint_name == 'index'
-        return '_name ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST' if @method_name == 'create_service_token'
-        return post_and_get if @endpoint_name == 'count'
-
-        default_method = @spec['url']['paths'].map { |a| a['methods'] }.flatten.first
-        if @spec['body'] && default_method == 'GET'
-          # When default method is GET and body is required, we should always use POST
-          if @spec['body']['required']
-            'Elasticsearch::API::HTTP_POST'
-          else
-            post_and_get
-          end
-        else
-          "Elasticsearch::API::HTTP_#{default_method}"
-        end
-      end
-
-      def post_and_get
-        # the METHOD is defined after doing arguments.delete(:body), so we need to check for `body`
-        <<~SRC
-          if body
-            Elasticsearch::API::HTTP_POST
-          else
-            Elasticsearch::API::HTTP_GET
-          end
-        SRC
-      end
-
-      def __http_path
-        return "\"#{__parse_path(@paths.first)}\"" if @paths.size == 1
-
-        result = ''
-        anchor_string = []
-        @paths.sort { |a, b| b.length <=> a.length }.each_with_index do |path, i|
-          var_string = __extract_path_variables(path).map { |var| "_#{var}" }.join(' && ')
-          next if anchor_string.include? var_string
-
-          anchor_string << var_string
-          result += if i.zero?
-                      "if #{var_string}\n"
-                    elsif (i == @paths.size - 1) || var_string.empty?
-                      "else\n"
-                    else
-                      "elsif #{var_string}\n"
-                    end
-          result += "\"#{__parse_path(path)}\"\n"
-        end
-        result += 'end'
-        result
-      end
-
-      def __parse_path(path)
-        path.gsub(/^\//, '')
-          .gsub(/\/$/, '')
-          .gsub('{', "\#{Utils.__listify(_")
-          .gsub('}', ')}')
-      end
-
-      def __path_variables
-        @paths.map do |path|
-          __extract_path_variables(path)
-        end
-      end
-
-      # extract values that are in the {var} format:
-      def __extract_path_variables(path)
-        path.scan(/{(\w+)}/).flatten
-      end
-
-      # Find parts that are definitely required and should raise an error if
-      # they're not present
-      #
-      def __required_parts
-        required = []
-        return required if @endpoint_name == 'tasks.get'
-
-        required << 'body' if (@spec['body'] && @spec['body']['required'])
-        # Get required variables from paths:
-        req_variables = __path_variables.inject(:&) # find intersection
-        required << req_variables unless req_variables.empty?
-        required.flatten
-      end
-
       def docs_helper(name, info)
         info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings'
         info['type'] = 'Integer' if info['type'] == 'int' # Rename 'int' to 'Integer'
@@ -319,8 +192,8 @@ module Elasticsearch
         say_status('tree', lines.first + "\n" + lines[1, lines.size].map { |l| ' ' * 14 + l }.join("\n"))
       end
 
-      def cleanup_directory!
-        Dir["#{@output}/**/*.rb"].each do |file|
+      def cleanup_directory!(output)
+        Dir["#{output}/**/*.rb"].each do |file|
           # file = File.join(@output, f)
           File.delete(file) unless (['.', '..'].include? file) || Pathname(file).directory?
         end

data/utils/thor/templates/_body.erb

@@ -17,7 +17,7 @@
 # under the License.
 %>
 <%-
-case @endpoint_name
+case @spec.endpoint_name
 when 'mtermvectors'
 -%>
   body = if(ids = arguments.delete(:ids))
@@ -30,5 +30,5 @@ when 'mtermvectors'
 <%- when 'ml.find_file_structure' %>
   body = Utils.__bulkify(arguments.delete(:body))
 <%- else -%>
-  <%= '  '*(@namespace_depth+3) %>body   = <%= @spec['body'].nil? ? 'nil' : 'arguments.delete(:body)' %>
+  <%= '  '*(@spec.namespace_depth+3) %>body   = <%= @spec.body.nil? ? 'nil' : 'arguments.delete(:body)' %>
 <%- end -%>

data/utils/thor/templates/_documentation_top.erb

@@ -16,42 +16,42 @@
 # specific language governing permissions and limitations
 # under the License.
 %>
-<%- if @spec['documentation']['description'] -%>
-  <%= '  '*(@namespace_depth+3) %># <%= @spec['documentation']['description'].gsub("\n", "\n#{'  '*(@namespace_depth+3)}# ") -%>
+<%- if @spec.documentation['description'] -%>
+  <%= '  '*(@spec.namespace_depth+3) %># <%= @spec.documentation['description'] .gsub("\n", "\n#{'  '*(@spec.namespace_depth+3)}# ") -%>
 <%- else %>
-  <%= '  '*(@namespace_depth+3) %># TODO: Description
+  <%= '  '*(@spec.namespace_depth+3) %># TODO: Description
 <%- end %>
-<%= stability_doc_helper(@spec['stability']) -%>
-<%= '  '*(@namespace_depth+3) %>#
-<%- unless @parts.nil? || @parts.empty? %><%# URL parts -%>
-  <%- @parts.each do |name, info| -%>
+<%= stability_doc_helper(@spec.stability) -%>
+<%= '  '*(@spec.namespace_depth+3) %>#
+<%- unless @spec.path_parts.nil? || @spec.path_parts.empty? %><%# URL parts -%>
+  <%- @spec.path_parts.each do |name, info| -%>
     <%= docs_helper(name, info) -%>
   <%- end -%>
 <%- end -%><%# Body -%>
 <%# URL parameters -%>
-<%- @params.each do |name, info| -%>
-  <%= docs_helper(name, info) unless (!@parts.empty? && @parts.keys.include?(name)) -%>
+<%- @spec.params.each do |name, info| -%>
+  <%= docs_helper(name, info) unless (!@spec.path_parts.empty? && @spec.path_parts.keys.include?(name)) -%>
 <%- end -%>
 # @option arguments [Hash] :headers Custom HTTP headers
-<%- if @spec['body'] -%>
-  <%- if @method_name == 'bulk' -%>
-    <%= bulk_doc_helper(@spec['body']['description']) -%>
+<%- if @spec.body -%>
+  <%- if @spec.method_name == 'bulk' -%>
+    <%= bulk_doc_helper(@spec.body['description']) -%>
   <%- else -%>
-    <%= '  '*(@namespace_depth+1) +
-    '# @option arguments [Hash] :body ' + (@spec['body']['description'] ?
-                                           @spec['body']['description'].strip : 'TODO: Description') +
-                                           (@spec['body']['required'] ? ' (*Required*)' : '') + "\n"
+    <%= '  '*(@spec.namespace_depth+1) +
+    '# @option arguments [Hash] :body ' + (@spec.body['description'] ?
+                                           @spec.body['description'].strip : 'TODO: Description') +
+                                           (@spec.body['required'] ? ' (*Required*)' : '') + "\n"
     -%>
   <%- end -%>
 <%- end -%>
-<% if @deprecation_note -%>
+<% if @spec.deprecation_note -%>
   #
   # *Deprecation notice*:
-  # <%=  @deprecation_note['description'] %>
-  # Deprecated since version <%=  @deprecation_note['version'] %>
+  # <%=  @spec.deprecation_note['description'] %>
+  # Deprecated since version <%=  @spec.deprecation_note['version'] %>
   #
 <% end -%>
-<%= '  '*(@namespace_depth+3) -%>#
+<%= '  '*(@spec.namespace_depth+3) -%>#
 <%# Documentation link -%>
-<%=  '  '*(@namespace_depth+3) %># @see <%= @spec['documentation']['url'] ? Elasticsearch::API::FilesHelper.documentation_url(@spec['documentation']['url']) : "[TODO]" %>
-<%= '  '*(@namespace_depth+3) %>#
+<%=  '  '*(@spec.namespace_depth+3) %># @see <%= @spec.documentation['url'] ? Elasticsearch::API::FilesHelper.documentation_url(@spec.documentation['url']) : "[TODO]" %>
+<%= '  '*(@spec.namespace_depth+3) %>#

data/utils/thor/templates/_method_setup.erb

@@ -16,22 +16,22 @@
 # specific language governing permissions and limitations
 # under the License.
 %>
-<%- @parts.each do |name, _| %>
-  <%- unless @method_name == 'get_field_mapping' && name == 'fields' %>
-    <%= '  '*(@namespace_depth+3) + "_#{name}" %> = arguments.delete(:<%=name %>)
+<%- @spec.path_parts.each do |name, _| %>
+  <%- unless @spec.method_name == 'get_field_mapping' && name == 'fields' %>
+    <%= '  '*(@spec.namespace_depth+3) + "_#{name}" %> = arguments.delete(:<%=name %>)
   <%- end -%>
 <%- end -%>
 
-<%= '  '*(@namespace_depth+4) %>method = <%= @http_method %>
-<%- if @method_name == 'termvectors' %>
+<%= '  '*(@spec.namespace_depth+4) %>method = <%= @spec.http_method %>
+<%- if @spec.method_name == 'termvectors' %>
   endpoint = arguments.delete(:endpoint) || '_termvectors'
 <%- end -%>
-<%= '  '*(@namespace_depth+4) %>path   = <%= @http_path %>
-<%- if !@params.empty? || needs_ignore_404?(@endpoint_name) || needs_complex_ignore_404?(@endpoint_name)-%>
-  <%= '  '*(@namespace_depth+4) %>params = Utils.process_params(arguments)
+<%= '  '*(@spec.namespace_depth+4) %>path   = <%= @spec.http_path %>
+<%- if !@spec.params.empty? || needs_ignore_404?(@spec.endpoint_name) || needs_complex_ignore_404?(@spec.endpoint_name)-%>
+  <%= '  '*(@spec.namespace_depth+4) %>params = Utils.process_params(arguments)
 <%- else -%>
-  <%= '  '*(@namespace_depth+4) %>params = {}
+  <%= '  '*(@spec.namespace_depth+4) %>params = {}
 <%- end -%>
-<%- @specific_params.each do |param| -%>
+<%- @spec.specific_params.each do |param| -%>
   <%= param %>
 <%- end -%>

data/utils/thor/templates/_perform_request.erb

@@ -16,35 +16,35 @@
 # specific language governing permissions and limitations
 # under the License.
 %>
-<%- if ['bulk', 'msearch', 'msearch_template', 'find_structure'].include? @method_name -%>
-  <%= self.send("#{@method_name}_body_helper".to_s) %>
+<%- if ['bulk', 'msearch', 'msearch_template', 'find_structure'].include? @spec.method_name -%>
+  <%= self.send("#{@spec.method_name}_body_helper".to_s) %>
   headers.merge!("Content-Type" => "application/x-ndjson")
   Elasticsearch::API::Response.new(
-    perform_request(method, path, params, payload, headers)
+    perform_request(method, path, params, payload, headers, request_opts)
   )
-<%- elsif @method_name == 'ping' -%>
+<%- elsif @spec.method_name == 'ping' -%>
   <%= ping_perform_request %>
 <%- else -%>
-  <%- if needs_ignore_404?(@endpoint_name) %>
+  <%- if needs_ignore_404?(@spec.endpoint_name) %>
     Utils.__rescue_from_not_found do
-      perform_request(method, path, params, body, headers).status == 200 ? true : false
+      perform_request(method, path, params, body, headers, request_opts).status == 200 ? true : false
     end
-  <%- elsif needs_complex_ignore_404?(@endpoint_name) -%>
+  <%- elsif needs_complex_ignore_404?(@spec.endpoint_name) -%>
     if Array(arguments[:ignore]).include?(404)
     Utils.__rescue_from_not_found {
       Elasticsearch::API::Response.new(
-        perform_request(method, path, params, body, headers)
+        perform_request(method, path, params, body, headers, request_opts)
       )
     }
     else
     Elasticsearch::API::Response.new(
-      perform_request(method, path, params, body, headers)
+      perform_request(method, path, params, body, headers, request_opts)
     )
     end
   <%- else -%>
     Elasticsearch::API::Response.new(
-      perform_request(method, path, params, body, headers)
+      perform_request(method, path, params, body, headers, request_opts)
     )
   <%- end -%>
 <%- end -%>
-<%= '  '*(@namespace_depth+3) %>end
+<%= '  '*(@spec.namespace_depth+3) %>end

data/utils/thor/templates/method.erb

@@ -16,29 +16,38 @@
 # under the License.
 #
 module Elasticsearch
-<%= '  '*(@namespace_depth) %>module API
-<%- @module_namespace.each_with_index do |name, i| -%>
+<%= '  '*(@spec.namespace_depth) %>module API
+<%- @spec.module_namespace.each_with_index do |name, i| -%>
   <%= '  '*i %>module <%= module_name_helper(name) %>
 <%- end -%>
-<%= '  '*(@namespace_depth+2) %>module Actions
+<%= '  '*(@spec.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
+<%= '  '*(@spec.namespace_depth+3) -%>def <%= @spec.method_name %>(arguments = {})
+  request_opts = { endpoint: arguments[:endpoint] || "<%= @spec.endpoint_name %>" }
+<%- unless @spec.path_params.empty? %>
+  defined_params =<%=  @spec.path_params %>.inject({}) do |set_variables, variable|
+    set_variables[variable] = arguments[variable] if arguments.key?(variable)
+    set_variables
+  end
+  request_opts[:defined_params] = defined_params unless defined_params.empty?
+<%- end %>
+<%-    %>
+<%- if @spec.endpoint_name == 'create' -%>
+  <%= '  '*(@spec.namespace_depth+3) %>if arguments[:id]
+  <%= '  '*(@spec.namespace_depth+3) %>  index arguments.update op_type: 'create'
+  <%= '  '*(@spec.namespace_depth+3) %>else
+  <%= '  '*(@spec.namespace_depth+3) %>  index arguments
+  <%= '  '*(@spec.namespace_depth+3) %>end
+  <%= '  '*(@spec.namespace_depth+2) %>end
 <%- else -%>
-  <%- if @method_name == 'get_field_mapping' %>
+  <%- if @spec.method_name == 'get_field_mapping' %>
     arguments = arguments.clone
     _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" -%>
+    <%- @spec.required_parts.each do |required| %><%# Arguments -%>
+      <%= '  '*(@spec.namespace_depth+3) + "raise ArgumentError, \"Required argument '#{required}' missing\" unless arguments[:#{required}]" + "\n" -%>
     <%- end -%>
     arguments = arguments.clone
     <%- end -%>
@@ -50,10 +59,10 @@ module Elasticsearch
     <%- # 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 %>
+<%- if @spec.method_name.match?(/^exists\S*/) -%>
+  alias_method :<%= @spec.method_name %>?, :<%= @spec.method_name %>
 <%- end -%>
-<%- if @method_name == 'termvectors' %>
+<%- if @spec.method_name == 'termvectors' %>
 
   # Deprecated: Use the plural version, {#termvectors}
   #
@@ -62,9 +71,9 @@ module Elasticsearch
   end
 <%- end -%>
 
-<%- @namespace_depth.downto(1) do |i| -%>
+<%- @spec.namespace_depth.downto(1) do |i| -%>
 <%= '  '*(i-1) %>end
-<%- end if @namespace_depth > 0 -%>
+<%- end if @spec.namespace_depth > 0 -%>
     end
   end
 end