[API] Adds shutdown endpoints

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api.rb

@@ -73,7 +73,8 @@ def self.included(base)
                 Elasticsearch::API::Cat,
                 Elasticsearch::API::Remote,
                 Elasticsearch::API::DanglingIndices,
-                Elasticsearch::API::Features
+                Elasticsearch::API::Features,
+                Elasticsearch::API::Shutdown
     end
 
     # The serializer class

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/delete_node.rb

@@ -0,0 +1,52 @@
+# 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
+  module API
+    module Shutdown
+      module Actions
+        # Removes a node from the shutdown list
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id The node id of node to be removed from the shutdown state
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def delete_node(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/get_node.rb

@@ -0,0 +1,54 @@
+# 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
+  module API
+    module Shutdown
+      module Actions
+        # Retrieve status of a node or nodes that are currently marked as shutting down
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id Which node for which to retrieve the shutdown status
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def get_node(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+                   else
+                     "_nodes/shutdown"
+                   end
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/params_registry.rb

@@ -0,0 +1,60 @@
+# 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
+  module API
+    module Shutdown
+      module Actions
+        module ParamsRegistry
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.1.1
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.1.1
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.1.1
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/actions/shutdown/put_node.rb

@@ -0,0 +1,54 @@
+# 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
+  module API
+    module Shutdown
+      module Actions
+        # Adds a node to be shut down
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :node_id The node id of node to be shut down
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body The shutdown type definition to register (*Required*)
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/current
+        #
+        def put_node(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
+          params = {}
+
+          body = arguments[:body]
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

elasticsearch-api/lib/elasticsearch/api/namespace/shutdown.rb

@@ -0,0 +1,37 @@
+# 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
+  module API
+    module Shutdown
+      module Actions; end
+
+      # Client for the "shutdown" namespace (includes the {Shutdown::Actions} methods)
+      #
+      class ShutdownClient
+        include Common::Client, Common::Client::Base, Shutdown::Actions
+      end
+
+      # Proxy method for {ShutdownClient}, available in the receiving object
+      #
+      def shutdown
+        @shutdown ||= ShutdownClient.new(self)
+      end
+
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/shutdown/delete_node_spec.rb

@@ -0,0 +1,44 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.shutdown#delete_node' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_nodes/id/shutdown',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.delete_node(node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.delete_node
+    }.to raise_exception(ArgumentError)
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/shutdown/get_node_spec.rb

@@ -0,0 +1,46 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.shutdown#get_node' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when id is provided' do
+    let(:url) { '_nodes/id/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node(node_id: 'id')).to eq({})
+    end
+  end
+
+  context 'when no id is provided' do
+    let(:url) { '_nodes/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node).to eq({})
+    end
+  end
+end