elastomer-client 0.3.3 → 0.4.0

data/lib/elastomer/client/index.rb

@@ -150,10 +150,11 @@ module Elastomer
       end
 
       # Return the aliases associated with this index.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
       #
       # params - Parameters Hash
       #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
+      #
       # Returns the response body as a Hash
       def get_aliases( params = {} )
         response = client.get '/{index}/_aliases', update_params(:action => 'index.get_aliases')
@@ -161,6 +162,63 @@ module Elastomer
       end
       alias :aliases :get_aliases
 
+      # Return the named aliases associated with this index.
+      #
+      # name   - Name of the alias to look up
+      # params - Parameters Hash
+      #   :ignore_unavailable - What to do is an specified index name doesn’t
+      #                         exist. If set to `true` then those indices are ignored.
+      #
+      # Examples
+      #
+      #   index.get_alias("*")       # returns all aliases for the current index
+      #   index.get_alias("issue*")  # returns all aliases starting with "issue"
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
+      #
+      # Returns the response body as a Hash
+      def get_alias( name, params = {} )
+        response = client.get '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.get_alias')
+        response.body
+      end
+
+      # Add a single alias to this index.
+      #
+      # name   - Name of the alias to add to the index
+      # params - Parameters Hash
+      #   :routing - optional routing that can be associated with an alias
+      #   :filter  - optional filter that can be associated with an alias
+      #
+      # Examples
+      #
+      #   index.add_alias("foo", :routing => "foo")
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
+      #
+      # Returns the response body as a Hash
+      def add_alias( name, params = {} )
+        response = client.put '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.add_alias')
+        response.body
+      end
+
+      # Delete an alias from this index.
+      #
+      # name   - Name of the alias to delete from the index
+      # params - Parameters Hash
+      #
+      # Examples
+      #
+      #   index.delete_alias("foo")
+      #   index.delete_alias(["foo", "bar"])
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
+      #
+      # Returns the response body as a Hash
+      def delete_alias( name, params = {} )
+        response = client.delete '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.delete_alias')
+        response.body
+      end
+
       # Performs the analysis process on a text and return the tokens breakdown of the text.
       # See http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
       #

data/lib/elastomer/client/nodes.rb

@@ -26,32 +26,59 @@ module Elastomer
 
       attr_reader :client, :node_id
 
-      # Retrieve one or more (or all) of the cluster nodes information.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
+      # Retrieve one or more (or all) of the cluster nodes information. By
+      # default all information is returned from all ndoes. You can select the
+      # information to be returned by passing in the `:info` from the list of
+      # "settings", "os", "process", "jvm", "thread_pool", "network",
+      # "transport", "http" and "plugins".
       #
       # params - Parameters Hash
+      #   :node_id - a single node ID or Array of node IDs
+      #   :info    - a single information attribute or an Array
+      #
+      # Examples
+      #
+      #   info(:info => "_all")
+      #   info(:info => "os")
+      #   info(:info => %w[os jvm process])
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-info.html
       #
       # Returns the response as a Hash
       def info( params = {} )
-        response = client.get '/_nodes{/node_id}', update_params(params, :action => 'nodes.info')
+        response = client.get '/_nodes{/node_id}{/info}', update_params(params, :action => 'nodes.info')
         response.body
       end
 
-      # Retrieve one or more (or all) of the cluster nodes statistics.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/
+      # Retrieve one or more (or all) of the cluster nodes statistics. For 1.x
+      # stats filtering, use the :stats parameter key.
       #
       # params - Parameters Hash
+      #   :node_id - a single node ID or Array of node IDs
+      #   :stats   - a single stats value or an Array of stats values
+      #
+      # Examples
+      #
+      #   stats(:stats => "thread_pool")
+      #   stats(:stats => %w[os process])
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html
       #
       # Returns the response as a Hash
       def stats( params = {} )
-        response = client.get '/_nodes{/node_id}/stats', update_params(params, :action => 'nodes.stats')
+        response = client.get '/_nodes{/node_id}/stats{/stats}', update_params(params, :action => 'nodes.stats')
         response.body
       end
 
       # Get the current hot threads on each node in the cluster.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
       #
       # params - Parameters Hash
+      #   :node_id  - a single node ID or Array of node IDs
+      #   :threads  - number of hot threads to provide
+      #   :interval - sampling interval [default is 500ms]
+      #   :type     - the type to sample: "cpu", "wait", or "block"
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html
       #
       # Returns the response as a Hash
       def hot_threads( params = {} )
@@ -59,10 +86,13 @@ module Elastomer
         response.body
       end
 
-      # Shutdown one or more nodes in the cluster.
-      # See http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
+      # Shutdown one or more nodes in the cluster. There is also a
+      # Cluster#shutdown command for shutting down the entire cluseter.
       #
       # params - Parameters Hash
+      #   :node_id - a single node ID or Array of node IDs
+      #
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html
       #
       # Returns the response as a Hash
       def shutdown( params = {} )
@@ -82,6 +112,7 @@ module Elastomer
         h.update overrides unless overrides.nil?
         h
       end
-    end  # Nodes
-  end  # Client
-end  # Elastomer
+
+    end
+  end
+end

data/lib/elastomer/client/repository.rb

@@ -0,0 +1,127 @@
+module Elastomer
+  class Client
+
+    # Returns a Repository instance.
+    def repository(name = nil)
+      Repository.new(self, name)
+    end
+
+    class Repository
+      # Create a new index client for making API requests that pertain to
+      # the health and management individual indexes.
+      #
+      # client - Elastomer::Client used for HTTP requests to the server
+      # name   - The name of the index as a String or an Array of names
+      def initialize(client, name = nil)
+        @client = client
+        @name   = @client.assert_param_presence(name, 'repository name') unless name.nil?
+      end
+
+      attr_reader :client, :name
+
+      # Check for the existence of the repository.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # params - Parameters Hash
+      #
+      # Returns true if the repository exists
+      def exists?(params = {})
+        response = client.get '/_snapshot{/repository}', update_params(params, :action => 'repository.exists')
+        response.success?
+      rescue Elastomer::Client::Error => exception
+        if exception.message =~ /RepositoryMissingException/
+          false
+        else
+          raise exception
+        end
+      end
+      alias :exist? :exists?
+
+      # Create the repository.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # body   - The repository type and settings as a Hash or a JSON encoded String
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def create(body, params = {})
+        response = client.put '/_snapshot/{repository}', update_params(params, :body => body, :action => 'repository.create')
+        response.body
+      end
+
+      # Get repository type and settings.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def get(params = {})
+        response = client.get '/_snapshot{/repository}', update_params(params, :action => 'repository.get')
+        response.body
+      end
+
+      # Get status information on snapshots in progress.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def status(params = {})
+        response = client.get '/_snapshot{/repository}/_status', update_params(params, :action => 'repository.status')
+        response.body
+      end
+
+      # Update the repository.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # body   - The repository type and settings as a Hash or a JSON encoded String
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def update(body, params = {})
+        response = client.put '/_snapshot/{repository}', update_params(params, :body => body, :action => 'repository.update')
+        response.body
+      end
+
+      # Delete the repository.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_repositories
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def delete(params = {})
+        response = client.delete '/_snapshot/{repository}', update_params(params, :action => 'repository.delete')
+        response.body
+      end
+
+      # Provides access to snapshot API commands. These commands will be
+      # scoped to this repository and the given snapshot name.
+      #
+      # snapshot - The snapshot name as a String, or nil for all snapshots.
+      #
+      # Returns a Snapshot instance.
+      def snapshot(snapshot = nil)
+        client.snapshot(name, snapshot)
+      end
+      alias :snapshots :snapshot
+
+      # Internal: Add default parameters to the `params` Hash and then apply
+      # `overrides` to the params if any are given.
+      #
+      # params    - Parameters Hash
+      # overrides - Optional parameter overrides as a Hash
+      #
+      # Returns a new params Hash.
+      def update_params(params, overrides = nil)
+        h = defaults.update params
+        h.update overrides unless overrides.nil?
+        h
+      end
+
+      # Internal: Returns a Hash containing default parameters.
+      def defaults
+        { :repository => name }
+      end
+    end
+  end
+end

data/lib/elastomer/client/snapshot.rb

@@ -0,0 +1,127 @@
+module Elastomer
+  class Client
+
+    # Provides access to snapshot API commands.
+    #
+    # repository - The name of the repository as a String
+    # name       - The name of the snapshot as a String
+    #
+    # Returns a Snapshot instance.
+    def snapshot(repository = nil, name = nil)
+      Snapshot.new self, repository, name
+    end
+
+    class Snapshot
+      # Create a new snapshot object for making API requests that pertain to
+      # creating, restoring, deleting, and retrieving snapshots.
+      #
+      # client     - Elastomer::Client used for HTTP requests to the server
+      # repository - The name of the repository as a String. Cannot be nil if
+      #              snapshot name is not nil.
+      # name       - The name of the snapshot as a String
+      def initialize(client, repository = nil, name = nil)
+        @client     = client
+        # don't allow nil repository if snapshot name is not nil
+        @repository = @client.assert_param_presence(repository, 'repository name') unless repository.nil? && name.nil?
+        @name       = @client.assert_param_presence(name, 'snapshot name') unless name.nil?
+      end
+
+      attr_reader :client, :repository, :name
+
+      # Check for the existence of the snapshot.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # params - Parameters Hash
+      #
+      # Returns true if the snapshot exists
+      def exists?(params = {})
+        response = client.get '/_snapshot/{repository}/{snapshot}', update_params(params, :action => 'snapshot.exists')
+        response.success?
+      rescue Elastomer::Client::Error => exception
+        if exception.message =~ /SnapshotMissingException/
+          false
+        else
+          raise exception
+        end
+      end
+      alias :exist? :exists?
+
+      # Create the snapshot.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # body   - The snapshot options as a Hash or a JSON encoded String
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def create(body = {}, params = {})
+        response = client.put '/_snapshot/{repository}/{snapshot}', update_params(params, :body => body, :action => 'snapshot.create')
+        response.body
+      end
+
+      # Get snapshot progress information.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def get(params = {})
+        # Set snapshot name or we'll get the repository instead
+        snapshot = name || '_all'
+        response = client.get '/_snapshot/{repository}/{snapshot}', update_params(params, :snapshot => snapshot, :action => 'snapshot.get')
+        response.body
+      end
+
+      # Get detailed snapshot status.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def status(params = {})
+        response = client.get '/_snapshot{/repository}{/snapshot}/_status', update_params(params, :action => 'snapshot.status')
+        response.body
+      end
+
+      # Restore the snapshot.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # body   - The restore options as a Hash or a JSON encoded String
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def restore(body = {}, params = {})
+        response = client.post '/_snapshot/{repository}/{snapshot}/_restore', update_params(params, :body => body, :action => 'snapshot.restore')
+        response.body
+      end
+
+      # Delete the snapshot.
+      # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-snapshots.html#_snapshot
+      #
+      # params - Parameters Hash
+      #
+      # Returns the response body as a Hash
+      def delete(params = {})
+        response = client.delete '/_snapshot/{repository}/{snapshot}', update_params(params, :action => 'snapshot.delete')
+        response.body
+      end
+
+      # Internal: Add default parameters to the `params` Hash and then apply
+      # `overrides` to the params if any are given.
+      #
+      # params    - Parameters Hash
+      # overrides - Optional parameter overrides as a Hash
+      #
+      # Returns a new params Hash.
+      def update_params( params, overrides = nil )
+        h = defaults.update params
+        h.update overrides unless overrides.nil?
+        h
+      end
+
+      # Internal: Returns a Hash containing default parameters.
+      def defaults
+        { :repository => repository, :snapshot => name }
+      end
+    end
+  end
+end

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 
   def self.version
     VERSION

data/test/client/cluster_test.rb

@@ -24,6 +24,22 @@ describe Elastomer::Client::Cluster do
     assert h.key?('cluster_name'), 'the cluster name is returned'
     assert h.key?('master_node'), 'the master node is returned'
     assert_instance_of Hash, h['nodes'], 'the node list is returned'
+    assert_instance_of Hash, h['metadata'], 'the metadata are returned'
+  end
+
+  if es_version_1_x?
+    it 'filters cluster state by metrics' do
+      h = @cluster.state(:metrics => 'nodes')
+      refute h.key('metadata'), 'expected only nodes state'
+      h = @cluster.state(:metrics => 'metadata')
+      refute h.key('nodes'), 'expected only metadata state'
+    end
+
+    it 'filters cluster state by indices' do
+      @index.create({}) unless @index.exists?
+      h = @cluster.state(:metrics => 'metadata', :indices => @name)
+      assert [@name], h['metadata']['indices'].keys
+    end
   end
 
   it 'gets the cluster settings' do
@@ -55,6 +71,23 @@ describe Elastomer::Client::Cluster do
     assert_equal "60", value
   end
 
+  it 'returns cluster stats' do
+    h = @cluster.stats
+    assert_equal %w[cluster_name indices nodes status timestamp], h.keys.sort
+  end
+
+  it 'returns a list of pending tasks' do
+    h = @cluster.pending_tasks
+    assert_equal %w[tasks], h.keys.sort
+    assert h['tasks'].is_a?(Array), "the tasks lists is always an Array even if empty"
+  end
+
+  it 'returns the list of indices in the cluster' do
+    @index.create({}) unless @index.exists?
+    indices = @cluster.indices
+    assert !indices.empty?, 'expected to see an index'
+  end
+
   it 'returns the list of nodes in the cluster' do
     nodes = @cluster.nodes
     assert !nodes.empty?, 'we have to have some nodes'