elasticsearch-api 1.0.0.rc1 → 1.0.0.rc2

data/Gemfile

@@ -3,10 +3,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-api.gemspec
 gemspec
 
-if File.exists? File.expand_path("../../elasticsearch-extensions", __FILE__)
-  gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => true
+if File.exists? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
+  gem 'elasticsearch', :path => File.expand_path("../../elasticsearch", __FILE__), :require => false
 end
 
 if File.exists? File.expand_path("../../elasticsearch-transport", __FILE__)
   gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => true
 end
+
+if File.exists? File.expand_path("../../elasticsearch-extensions", __FILE__)
+  gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => false
+end

data/README.md

@@ -54,17 +54,18 @@ require 'elasticsearch'
 client = Elasticsearch::Client.new log: true
 
 client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
-# => {"ok"=>true, "_index"=>"myindex", ...}
+# => {"_index"=>"myindex", ... "created"=>true}
 
 client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
-Full documentation is available at <http://rubydoc.info/gems/elasticsearch-api>.
+Full documentation and examples are included as RDoc annotations in the source code
+and available online at <http://rubydoc.info/gems/elasticsearch-api>.
 
 ### Usage with a custom client
 
-When you want to mix the library into you own client, it must conform to a following _contract_:
+When you want to mix the library into your own client, it must conform to a following _contract_:
 
 * It responds to a `perform_request(method, path, params, body)` method,
 * the method returns an object with `status`, `body` and `headers` methods.

data/lib/elasticsearch/api/actions/cat/count.rb

@@ -17,9 +17,13 @@ module Elasticsearch
         #
         #     puts client.cat.count index: ['index-a', 'index-b']
         #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.count v: true
+        #
         # @example Return the information as Ruby objects
         #
-        #     client.cat.allocation format: 'json'
+        #     client.cat.count format: 'json'
         #
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument

data/lib/elasticsearch/api/actions/cat/health.rb

@@ -9,6 +9,14 @@ module Elasticsearch
         #
         #     puts client.cat.health
         #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.health v: true
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.health format: 'json'
+        #
         # @option arguments [Boolean] :ts Whether to display timestamp information
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
         # @option arguments [Boolean] :v Display column headers as part of the output

data/lib/elasticsearch/api/actions/cat/master.rb

@@ -9,6 +9,14 @@ module Elasticsearch
         #
         #     puts client.cat.master
         #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.master v: true
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.master format: 'json'
+        #
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
         # @option arguments [Boolean] :v Display column headers as part of the output
         # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'

data/lib/elasticsearch/api/actions/cat/nodes.rb

@@ -3,13 +3,35 @@ module Elasticsearch
     module Cat
       module Actions
 
-        # TODO: Description
+        # Display information about cluster topology and nodes statistics
         #
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @example Display basic information about nodes in the cluster (host, node name, memory usage, master, etc.)
+        #
+        #     puts client.cat.nodes
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.nodes v: true
+        #
+        # @example Display only specific columns in the output (see the `help` parameter)
+        #
+        #     puts client.cat.nodes h: %w(name version jdk disk.avail heap.percent load merges.total_time), v: true
+        #
+        # @example Display only specific columns in the output, using the short names
+        #
+        #     puts client.cat.nodes h: 'n,v,j,d,hp,l,mtt', v: true
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.nodes format: 'json'
+        #
+        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+        # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [List] :h Comma-separated list of column names to display
-        # @option arguments [Boolean] :help Return help information
-        # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html
         #
@@ -25,7 +47,6 @@ module Elasticsearch
           path   = "_cat/nodes"
 
           params = Utils.__validate_and_extract_params arguments, valid_params
-
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
           body   = nil

data/lib/elasticsearch/api/actions/cat/pending_tasks.rb

@@ -9,6 +9,14 @@ module Elasticsearch
         #
         #     puts client.cat.pending_tasks
         #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.pending_tasks v: true
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.pending_tasks format: 'json'
+        #
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
         # @option arguments [Boolean] :v Display column headers as part of the output
         # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
@@ -30,6 +38,7 @@ module Elasticsearch
           method = 'GET'
           path   = "_cat/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
           body   = nil
 
           perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/cat/thread_pool.rb

@@ -0,0 +1,56 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display thread pool statistics across nodes (use the `help` parameter to display a list
+        # of avaialable thread pools)
+        #
+        # @example Display information about all thread pools across nodes
+        #
+        #     puts client.cat.thread_pool
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.thread_pool v: true
+        #
+        # @example Display information about the indexing thread pool
+        #
+        #     puts client.cat.thread_pool h: %w(h ip index.active index.size index.queue index.rejected), v: true
+        #
+        # @example Display information about the indexing and search threads, using the short names
+        #
+        #     puts client.cat.thread_pool h: 'host,ia,is,iq,ir,sa,ss,sq,sr', v: true
+        #
+        # @option arguments [Boolean] :full_id Display the complete node ID
+        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+        # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html
+        #
+        def thread_pool(arguments={})
+          valid_params = [
+            :full_id,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          method = 'GET'
+          path   = "_cat/thread_pool"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "1.0.0.rc1"
+    VERSION = "1.0.0.rc2"
   end
 end

data/test/unit/cat/thread_pool_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class CatThreadPoolTest < ::Test::Unit::TestCase
+
+      context "Cat: Thread pool" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'GET', method
+            assert_equal '_cat/thread_pool', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.cat.thread_pool
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -410,6 +410,7 @@ files:
 - lib/elasticsearch/api/actions/cat/pending_tasks.rb
 - lib/elasticsearch/api/actions/cat/recovery.rb
 - lib/elasticsearch/api/actions/cat/shards.rb
+- lib/elasticsearch/api/actions/cat/thread_pool.rb
 - lib/elasticsearch/api/actions/clear_scroll.rb
 - lib/elasticsearch/api/actions/cluster/get_settings.rb
 - lib/elasticsearch/api/actions/cluster/health.rb
@@ -508,6 +509,7 @@ files:
 - test/unit/cat/pending_tasks_test.rb
 - test/unit/cat/recovery_test.rb
 - test/unit/cat/shards_test.rb
+- test/unit/cat/thread_pool_test.rb
 - test/unit/clear_scroll_test.rb
 - test/unit/client_test.rb
 - test/unit/cluster/get_settings_test.rb
@@ -629,6 +631,7 @@ test_files:
 - test/unit/cat/pending_tasks_test.rb
 - test/unit/cat/recovery_test.rb
 - test/unit/cat/shards_test.rb
+- test/unit/cat/thread_pool_test.rb
 - test/unit/clear_scroll_test.rb
 - test/unit/client_test.rb
 - test/unit/cluster/get_settings_test.rb