elastomer-client 3.2.3 → 6.2.0

data/script/generate-rest-api-spec

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # Usage:
 #
 #   script/generate-rest-api-spec <elasticsearch-version>
@@ -12,19 +14,22 @@ require "rubygems"
 require "bundler/setup"
 
 $LOAD_PATH.unshift "lib"
-require "elastomer/client"
+require "elastomer_client/client"
+require "elastomer_client/version_support"
 
 class RestApiSpecGenerator
   WORKING_DIR = "vendor/elasticsearch"
 
   attr_reader :version, :short_version, :class_version
 
-  def initialize(version = "5.6")
+  def initialize(version = "8.13")
     @version = version
 
-    sliced = @version.split(".").slice(0,2)
+    sliced = @version.split(".").slice(0, 2)
     @short_version = sliced.join(".")
     @class_version = sliced.join("_")
+
+    @version_support = ElastomerClient::VersionSupport.new(version)
   end
 
   # Setup the working directory and generate the Ruby API spec for the
@@ -32,7 +37,7 @@ class RestApiSpecGenerator
   def run
     setup
     File.open(ruby_spec_filename, "w") do |fd|
-      fd.puts ERB.new(DATA.read, 0, "-").result(binding)
+      fd.puts ERB.new(DATA.read, trim_mode: "-").result(binding)
     end
   ensure
     reset
@@ -40,18 +45,18 @@ class RestApiSpecGenerator
 
   # The name of the Ruby API spec file for this particular Elasticsearch version.
   def ruby_spec_filename
-    "lib/elastomer/client/rest_api_spec/api_spec_v#{class_version}.rb"
+    "lib/elastomer_client/client/rest_api_spec/api_spec_v#{class_version}.rb"
   end
 
   # Returns true if the elasticserach working directory exists.
   def working_dir_exists?
-    File.directory?(WORKING_DIR) && File.exists?(WORKING_DIR)
+    File.directory?(WORKING_DIR) && File.exist?(WORKING_DIR)
   end
 
   # Iterate over each of the REST API specs yield the name and the descriptor
   # hash for that particular API spec.
   def each_api
-    Dir.glob("#{WORKING_DIR}/rest-api-spec/src/main/resources/rest-api-spec/api/*.json").each do |filename|
+    Dir.glob("#{WORKING_DIR}/rest-api-spec/src/main/resources/rest-api-spec/api/*.json").sort.each do |filename|
       next if filename =~ /\/_common\.json\Z/
 
       hash = MultiJson.load(File.read(filename))
@@ -65,12 +70,61 @@ class RestApiSpecGenerator
   # value pairs.
   def each_common
     filename = "#{WORKING_DIR}/rest-api-spec/src/main/resources/rest-api-spec/api/_common.json"
-    if File.exists? filename
+    if File.exist? filename
       hash = MultiJson.load(File.read(filename))
-      hash["params"].each {|k,v| yield(k,v)}
+      hash["params"].each { |k, v| yield(k, v) }
+    end
+  end
+
+  def generate_documentation(data)
+    if @version_support.es_version_8_plus?
+      data["documentation"]["url"].to_s
+    else
+      data["documentation"].to_s
+    end
+  end
+
+  def generate_methods(data)
+    if @version_support.es_version_8_plus?
+      data["url"]["paths"].map { |h| h["methods"] }.flatten.uniq
+    else
+      Array(data["methods"]).to_s
+    end
+  end
+
+  def generate_path(url)
+    if @version_support.es_version_8_plus?
+      url["paths"].map { |h| h["path"] }.flatten.uniq.first
+    else
+      url["path"]
     end
   end
 
+  def generate_paths(url)
+    if @version_support.es_version_8_plus?
+      url["paths"].map { |h| h["path"] }.flatten.uniq
+    else
+      Array(url["paths"]).to_s
+    end
+  end
+
+  def generate_parts(url)
+    if @version_support.es_version_8_plus?
+      url["paths"].map { |h| h["parts"] }.compact.reduce({}, :merge)
+    else
+      url["parts"]
+    end
+  end
+
+  def generate_params(data)
+    if @version_support.es_version_8_plus?
+      data["params"]
+    else
+      data["url"]["params"]
+    end
+  end
+
+
   # Perform a sparse checkout of the elasticsearch git repository and then check
   # out the branch corresponding to the ES version passed to this script.
   def setup
@@ -82,23 +136,23 @@ class RestApiSpecGenerator
         git remote add -f origin https://github.com/elastic/elasticsearch.git &&
         git config core.sparsecheckout true &&
         echo /rest-api-spec/src/main/resources/rest-api-spec/api/ >> .git/info/sparse-checkout &&
-        git pull origin master
+        git pull origin main
       SH
     end
 
     system <<-SH
       cd #{WORKING_DIR} &&
-      git pull origin master &&
+      git pull origin main &&
       git checkout -q origin/#{short_version}
     SH
   end
 
-  # Reset the elasticsearch working directory back to the master branch of the
+  # Reset the elasticsearch working directory back to the main branch of the
   # git repository.
   def reset
     system <<-SH
       cd #{WORKING_DIR} &&
-      git checkout master
+      git checkout main
     SH
   end
 end
@@ -110,27 +164,28 @@ __END__
 # Date: <%= Time.now.strftime("%Y-%m-%d") %>
 # ES version: <%= version %>
 
-module Elastomer::Client::RestApiSpec
+module ElastomerClient::Client::RestApiSpec
   class ApiSpecV<%= class_version %> < ApiSpec
     def initialize
       @rest_apis = {
-<% each_api do |name,data| -%>
+      <%- each_api do |name,data| -%>
+        <%- url = data["url"] -%>
         "<%= name %>" => RestApi.new(
-          documentation: "<%= data["documentation"].to_s %>",
-          methods: <%= Array(data["methods"]).to_s %>,
+          documentation: "<%= generate_documentation(data) %>",
+          methods: <%= generate_methods(data) %>,
           body: <%= data["body"] ? data["body"].to_s : "nil" %>,
-<% url = data["url"] -%>
           url: {
-            path: "<%= url["path"] %>",
-            paths: <%= Array(url["paths"]).to_s %>,
-<% if (parts = url["parts"]) && !parts.empty? -%>
+            path: "<%= generate_path(url) %>",
+            paths: <%= generate_paths(url) %>,
+<% if (parts = generate_parts(url)) && !parts.empty? -%>
             parts: {
 <% parts.each do |k,v| -%>
               "<%= k %>" => <%= v.to_s %>,
 <% end -%>
             },
 <% end -%>
-<% if (params = url["params"]) && !params.empty? -%>
+<% params = generate_params(data) -%>
+<% if !params.nil? && !params.empty? -%>
             params: {
 <% params.each do |k,v| -%>
               "<%= k %>" => <%= v.to_s %>,

data/test/assertions.rb

@@ -1,76 +1,69 @@
+# frozen_string_literal: true
+
 module Minitest::Assertions
-  #COMPATIBILITY
-  # ES 1.0 replaced the 'ok' attribute with a 'created' attribute
-  # in index responses. Check for either one so we are compatible
-  # with 0.90 and 1.0.
+  # COMPATIBILITY
+  # ES8+ response uses "result" instead of "created"
   def assert_created(response)
-    assert response["created"] || response["ok"], "document was not created"
+    assert $client.version_support.es_version_8_plus? ? response["result"] == "created" : response["created"], "document was not created"
   end
 
-  #COMPATIBILITY
-  # ES 1.0 replaced the 'ok' attribute with an 'acknowledged' attribute
-  # in many responses. Check for either one so we are compatible
-  # with 0.90 and 1.0.
   def assert_acknowledged(response)
-    assert response["acknowledged"] || response["ok"], "document was not acknowledged"
+    assert response["acknowledged"], "document was not acknowledged"
   end
 
-  #COMPATIBILITY
-  # ES 1.0 replaced the 'exists' attribute with a 'found' attribute in the
-  # get document response. Check for either one so we are compatible
-  # with 0.90 and 1.0.
   def assert_found(response)
-    assert response["found"] || response["exists"], "document was not found"
+    assert response["found"], "document was not found"
   end
 
   def refute_found(response)
     refute response["found"] || response["exists"], "document was unexpectedly found"
   end
 
-  #COMPATIBILITY
-  # ES 1.0 replaced the 'ok' attribute in the bulk response item with a
-  # 'status' attribute. Here we check for either one for compatibility
-  # with 0.90 and 1.0.
-  def assert_bulk_index(item, message="bulk index did not succeed")
-    ok     = item["index"]["ok"]
+  def assert_bulk_index(item, message = "bulk index did not succeed")
     status = item["index"]["status"]
-    assert ok == true || status == 201, message
+
+    assert_equal(201, status, message)
   end
 
-  def assert_bulk_create(item, message="bulk create did not succeed")
-    ok     = item["create"]["ok"]
+  def assert_bulk_create(item, message = "bulk create did not succeed")
     status = item["create"]["status"]
-    assert ok == true || status == 201, message
+
+    assert_equal(201, status, message)
   end
 
-  def assert_bulk_delete(item, message="bulk delete did not succeed")
-    ok     = item["delete"]["ok"]
+  def assert_bulk_delete(item, message = "bulk delete did not succeed")
     status = item["delete"]["status"]
-    assert ok == true || status == 200, message
+
+    assert_equal(200, status, message)
   end
 
-  #COMPATIBILITY
-  # ES 1.0 nests mappings in a "mappings" element under the index name, e.g.
-  # mapping["test-index"]["mappings"]["doco"]
-  # ES 0.90 doesn't have the "mappings" element:
-  # mapping["test-index"]["doco"]
-  def assert_mapping_exists(response, type, message="mapping expected to exist, but doesn't")
+  # COMPATIBILITY
+  # ES8+ no longer supports types
+  def assert_mapping_exists(response, type, message = "mapping expected to exist, but doesn't")
     mapping =
-      if response.has_key?("mappings")
-        response["mappings"][type]
+      if $client.version_support.es_version_8_plus?
+        response["mappings"]
       else
-        response[type]
+        response["mappings"][type]
       end
+
     refute_nil mapping, message
   end
 
-  def assert_property_exists(response, type, property, message="property expected to exist, but doesn't")
+  # COMPATIBILITY
+  # ES8+ no longer supports types
+  def assert_property_exists(response, type, property, message = "property expected to exist, but doesn't")
     mapping =
       if response.has_key?("mappings")
-        response["mappings"][type]
+        if $client.version_support.es_version_8_plus?
+          response["mappings"]
+        else
+          response["mappings"][type]
+        end
       else
         response[type]
       end
+
     assert mapping["properties"].has_key?(property), message
   end
 end