elasticsearch-api 6.8.0 → 7.10.0

data/utils/thor/templates/_documentation_top.erb

@@ -0,0 +1,39 @@
+<%- if @spec['documentation']['description'] -%>
+  <%= '  '*(@namespace_depth+3) %># <%= @spec['documentation']['description'].gsub("\n", "\n#{'  '*(@namespace_depth+3)}# ") -%>
+<%- else %>
+  <%= '  '*(@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| -%>
+    <%= 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)) -%>
+<%- end -%>
+# @option arguments [Hash] :headers Custom HTTP headers
+<%- if @spec['body'] -%>
+  <%- if @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"
+    -%>
+  <%- end -%>
+<%- end -%>
+<% 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)\//, "/#{Elasticsearch::API::FilesHelper.gem_version}/") : "[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,38 @@
+<%-
+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) %>
+  headers.merge!("Content-Type" => "application/x-ndjson")
+  <%= '  '*(@namespace_depth+4) %>perform_request(method, path, params, payload, headers).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, headers).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, headers).body }
+    else
+      perform_request(method, path, params, body, headers).body
+    end
+  <%- else -%>
+      perform_request(method, path, params, body, headers).body
+  <%- end -%>
+<%- end -%>
+<%= '  '*(@namespace_depth+3) %>end

data/utils/thor/templates/method.erb

@@ -0,0 +1,73 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+<%- if @current_api == :xpack -%>
+  <%= '  '*(@namespace_depth) %>module XPack
+<%- end %>
+<%= '  '*(@namespace_depth) %>module API
+<%- @module_namespace.each_with_index do |name, i| -%>
+  <%= '  '*i %>module <%= module_name_helper(name) %>
+<%- 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 -%>
+    headers = arguments.delete(:headers) || {}
+    <%- # 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

data/utils/thor/templates/{ruby/test.erb → test.erb}

@@ -1,3 +1,7 @@
+# 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
+
 require 'test_helper'
 
 module Elasticsearch

data/utils/thor/templates/{ruby/test_helper.rb → test_helper.rb}

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
 
 require 'rubygems' if RUBY_1_8
@@ -7,7 +24,6 @@ require 'simplecov' and SimpleCov.start { add_filter "/test|test_/" } if ENV["CO
 require 'test/unit'
 require 'shoulda-context'
 require 'mocha/setup'
-require 'turn' unless ENV["TM_FILEPATH"] || ENV["NOTURN"] || RUBY_1_8
 
 require 'require-prof' if ENV["REQUIRE_PROF"]
 Dir[ File.expand_path('../../lib/elasticsearch/api/**/*.rb', __FILE__) ].each do |f|