[API] [1.0] Changed the namespace for cluster.nodes_* APIs to nodes

Due to changes in Elasticsearch 1.0 API, the client "namespaces" have been changed to reflect the change in URLs: `_cluster/nodes` => `_nodes` Thus, instead of: client.cluster.nodes_info the new API is: client.nodes.info Related: * elastic/elasticsearch#4055 * elastic/elasticsearch#4336 * elastic/elasticsearch#4769
elastic · Jan 29, 2014 · 560647b · 560647b
1 parent 8801997
commit 560647b
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 38 deletions.
diff --git a/elasticsearch-api/lib/elasticsearch/api.rb b/elasticsearch-api/lib/elasticsearch/api.rb
@@ -27,6 +27,7 @@ def self.included(base)
                 Elasticsearch::API::Common,
                 Elasticsearch::API::Actions,
                 Elasticsearch::API::Cluster,
+                Elasticsearch::API::Nodes,
                 Elasticsearch::API::Indices
     end
   end

diff --git a/...h/api/actions/cluster/node_hot_threads.rb → ...icsearch/api/actions/nodes/hot_threads.rb b/...h/api/actions/cluster/node_hot_threads.rb → ...icsearch/api/actions/nodes/hot_threads.rb
@@ -1,6 +1,6 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Returns information about the hottest threads in the cluster or on a specific node as a String.
@@ -11,7 +11,7 @@ module Actions
         #
         # @example Return 10 hottest threads
         #
-        #     client.cluster.node_hot_threads threads: 10
+        #     client.nodes.hot_threads threads: 10
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
         #                                   use `_local` to return information from the node you're connecting to,
@@ -25,7 +25,7 @@ module Actions
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
-        def node_hot_threads(arguments={})
+        def hot_threads(arguments={})
           valid_params = [
             :interval,
             :snapshots,

diff --git a/...icsearch/api/actions/cluster/node_info.rb → ...b/elasticsearch/api/actions/nodes/info.rb b/...icsearch/api/actions/cluster/node_info.rb → ...b/elasticsearch/api/actions/nodes/info.rb
@@ -1,6 +1,6 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Returns information about nodes in the cluster (cluster settings, JVM version, etc).
@@ -12,7 +12,7 @@ module Actions
         #
         # @example Return information about JVM
         #
-        #     client.cluster.node_info jvm: true
+        #     client.nodes.info jvm: true
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
         #                                   use `_local` to return information from the node you're connecting to, leave
@@ -31,7 +31,7 @@ module Actions
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
-        def node_info(arguments={})
+        def info(arguments={})
           valid_params = [
             :all,
             :clear,

diff --git a/...arch/api/actions/cluster/node_shutdown.rb → ...asticsearch/api/actions/nodes/shutdown.rb b/...arch/api/actions/cluster/node_shutdown.rb → ...asticsearch/api/actions/nodes/shutdown.rb
@@ -1,13 +1,13 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Shutdown one or all nodes
         #
         # @example Shut down node named _Bloke_
         #
-        #     client.cluster.node_shutdown node_id: 'Bloke'
+        #     client.nodes.shutdown node_id: 'Bloke'
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to perform the operation on; use
         #                                   `_local` to shutdown the node you're connected to, leave empty to
@@ -17,7 +17,7 @@ module Actions
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
-        def node_shutdown(arguments={})
+        def shutdown(arguments={})
           valid_params = [
             :delay,
             :exit ]

diff --git a/...csearch/api/actions/cluster/node_stats.rb → .../elasticsearch/api/actions/nodes/stats.rb b/...csearch/api/actions/cluster/node_stats.rb → .../elasticsearch/api/actions/nodes/stats.rb
@@ -1,17 +1,17 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Returns statistical information about nodes in the cluster.
         #
         # @example Return statistics about JVM
         #
-        #     client.cluster.node_stats metric: 'jvm'
+        #     client.nodes.stats metric: 'jvm'
         #
         # @example Return statistics about field data structures for all fields
         #
-        #     client.cluster.node_stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
+        #     client.nodes.stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
         #
         # @option arguments [List] :metric Limit the information returned to the specified metrics
         #                                  (options: _all, breaker, fs, http, indices, jvm, network,
@@ -40,7 +40,7 @@ module Actions
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
         #
-        def node_stats(arguments={})
+        def stats(arguments={})
           arguments = arguments.clone
 
           valid_params = [

diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/nodes.rb
@@ -0,0 +1,20 @@
+module Elasticsearch
+  module API
+    module Nodes
+      module Actions; end
+
+      # Client for the "nodes" namespace (includes the {Nodes::Actions} methods)
+      #
+      class NodesClient
+        include Common::Client, Common::Client::Base, Nodes::Actions
+      end
+
+      # Proxy method for {NodesClient}, available in the receiving object
+      #
+      def nodes
+        @nodes ||= NodesClient.new(self)
+      end
+
+    end
+  end
+end
diff --git a/...est/unit/cluster/node_hot_threads_test.rb → ...h-api/test/unit/nodes/hot_threads_test.rb b/...est/unit/cluster/node_hot_threads_test.rb → ...h-api/test/unit/nodes/hot_threads_test.rb
@@ -2,9 +2,9 @@
 
 module Elasticsearch
   module Test
-    class ClusterNodeHotThreadsTest < ::Test::Unit::TestCase
+    class NodesHotThreadsTest < ::Test::Unit::TestCase
 
-      context "Cluster: Node hot threads" do
+      context "Nodes: Hot Threads" do
         subject { FakeClient.new }
 
         should "perform correct request" do
@@ -16,7 +16,7 @@ class ClusterNodeHotThreadsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_hot_threads
+          subject.nodes.hot_threads
         end
 
         should "send :node_id correctly" do
@@ -25,7 +25,7 @@ class ClusterNodeHotThreadsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_hot_threads :node_id => 'foo'
+          subject.nodes.hot_threads :node_id => 'foo'
         end
 
         should "URL-escape the parts" do
@@ -34,7 +34,7 @@ class ClusterNodeHotThreadsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_hot_threads :node_id => 'foo^bar'
+          subject.nodes.hot_threads :node_id => 'foo^bar'
         end
 
       end

diff --git a/...h-api/test/unit/cluster/node_info_test.rb → ...icsearch-api/test/unit/nodes/info_test.rb b/...h-api/test/unit/cluster/node_info_test.rb → ...icsearch-api/test/unit/nodes/info_test.rb
@@ -2,9 +2,9 @@
 
 module Elasticsearch
   module Test
-    class ClusterNodeInfoTest < ::Test::Unit::TestCase
+    class NodesInfoTest < ::Test::Unit::TestCase
 
-      context "Cluster: Node info" do
+      context "Nodes: Info" do
         subject { FakeClient.new }
 
         should "perform correct request" do
@@ -16,7 +16,7 @@ class ClusterNodeInfoTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_info
+          subject.nodes.info
         end
 
         should "send :node_id correctly" do
@@ -25,7 +25,7 @@ class ClusterNodeInfoTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_info :node_id => 'foo'
+          subject.nodes.info :node_id => 'foo'
         end
 
         should "send multiple :node_id-s correctly" do
@@ -34,8 +34,8 @@ class ClusterNodeInfoTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new).twice
 
-          subject.cluster.node_info :node_id => 'A,B,C'
-          subject.cluster.node_info :node_id => ['A', 'B', 'C']
+          subject.nodes.info :node_id => 'A,B,C'
+          subject.nodes.info :node_id => ['A', 'B', 'C']
         end
 
       end

diff --git a/...i/test/unit/cluster/node_shutdown_test.rb → ...arch-api/test/unit/nodes/shutdown_test.rb b/...i/test/unit/cluster/node_shutdown_test.rb → ...arch-api/test/unit/nodes/shutdown_test.rb
@@ -2,9 +2,9 @@
 
 module Elasticsearch
   module Test
-    class ClusterNodeShutdownTest < ::Test::Unit::TestCase
+    class NodesShutdownTest < ::Test::Unit::TestCase
 
-      context "Cluster: Node shutdown" do
+      context "Nodes: Shutdown" do
         subject { FakeClient.new }
 
         should "perform correct request" do
@@ -16,7 +16,7 @@ class ClusterNodeShutdownTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_shutdown
+          subject.nodes.shutdown
         end
 
         should "send :node_id correctly" do
@@ -25,7 +25,7 @@ class ClusterNodeShutdownTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_shutdown :node_id => 'foo'
+          subject.nodes.shutdown :node_id => 'foo'
         end
 
         should "send multiple :node_id-s correctly" do
@@ -34,8 +34,8 @@ class ClusterNodeShutdownTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new).twice
 
-          subject.cluster.node_shutdown :node_id => 'A,B,C'
-          subject.cluster.node_shutdown :node_id => ['A', 'B', 'C']
+          subject.nodes.shutdown :node_id => 'A,B,C'
+          subject.nodes.shutdown :node_id => ['A', 'B', 'C']
         end
 
       end

diff --git a/...-api/test/unit/cluster/node_stats_test.rb → ...csearch-api/test/unit/nodes/stats_test.rb b/...-api/test/unit/cluster/node_stats_test.rb → ...csearch-api/test/unit/nodes/stats_test.rb
@@ -2,9 +2,9 @@
 
 module Elasticsearch
   module Test
-    class ClusterNodeStatsTest < ::Test::Unit::TestCase
+    class NodesStatsTest < ::Test::Unit::TestCase
 
-      context "Cluster: Node stats" do
+      context "Nodes: Stats" do
         subject { FakeClient.new }
 
         should "perform correct request" do
@@ -16,7 +16,7 @@ class ClusterNodeStatsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_stats
+          subject.nodes.stats
         end
 
         should "send :node_id correctly" do
@@ -25,7 +25,7 @@ class ClusterNodeStatsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_stats :node_id => 'foo'
+          subject.nodes.stats :node_id => 'foo'
         end
 
         should "get specific metric families" do
@@ -35,7 +35,7 @@ class ClusterNodeStatsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_stats :metric => [:http, :fs]
+          subject.nodes.stats :metric => [:http, :fs]
         end
 
         should "get specific metric for the indices family" do
@@ -44,7 +44,7 @@ class ClusterNodeStatsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new)
 
-          subject.cluster.node_stats :metric => :indices, :index_metric => 'filter_cache'
+          subject.nodes.stats :metric => :indices, :index_metric => 'filter_cache'
         end
 
         should "get fielddata statistics for the indices family" do
@@ -54,8 +54,8 @@ class ClusterNodeStatsTest < ::Test::Unit::TestCase
             true
           end.returns(FakeResponse.new).twice
 
-          subject.cluster.node_stats :metric => 'indices', :index_metric => 'fielddata', :fields => 'foo,bar'
-          subject.cluster.node_stats :metric => 'indices', :index_metric => 'fielddata', :fields => ['foo','bar']
+          subject.nodes.stats :metric => 'indices', :index_metric => 'fielddata', :fields => 'foo,bar'
+          subject.nodes.stats :metric => 'indices', :index_metric => 'fielddata', :fields => ['foo','bar']
         end
 
       end