elasticsearch-api 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1554532d71fd5117adb7ac3122e6511562ca46b
-  data.tar.gz: afd742d0f2bda5ef8b46ded7bc55f1a2f3db27a1
+  metadata.gz: 25fb9700e6298b2c6a37cd1a114041689e9cbfd4
+  data.tar.gz: c04e61a9efce06dbecdec9f45681259dc3a26ff5
 SHA512:
-  metadata.gz: a46bcd15c661d6fff1d90eab4ec2d950b992f17e71e89515d9090d6166f6263b6d7a6df079ba78f634c162b03abb0c4881adc0bd2cd8ace5c0b77b1a5302e3af
-  data.tar.gz: 16b84a016789792774afa4cb84107b69ae4483ac31949c2efa0bd491041fe1bb81f34928fb9287b1e4afa9f35b9e67782d022c87e6887646ef040a775287bcb6
+  metadata.gz: 570c0084b961fccc4741ba790dc93edef6562027c531c3019535143c2e1161dcfbb064058eb55016afce2bced5a70126c7a24e062728ae5e44be8ff9d01bc661
+  data.tar.gz: bbe4bc6dd89766e037af5ac4ac38abd80f7df830caf3a75f221a5874266cc0275f6a6ba4e1028a1893a4788dd1a184043e1dca95f384686addf90aec3ee37750

data/README.md

@@ -155,6 +155,22 @@ mash.facets.tags.terms.first
 # => #<Hashie::Mash count=3 term="z">
 ```
 
+## Development
+
+To work on the code, clone and bootstrap the main repository first --
+please see instructions in the main [README](../README.md#development).
+
+To run tests, launch a testing cluster -- again, see instructions
+in the main [README](../README.md#development) -- and use the Rake tasks:
+
+```
+time rake test:unit
+time rake test:integration
+```
+
+Unit tests have to use Ruby 1.8 compatible syntax, integration tests
+can use Ruby 2.x syntax and features.
+
 ## License
 
 This software is licensed under the Apache 2 license, quoted below.

data/Rakefile

@@ -5,7 +5,7 @@ def __current__
 end
 
 def git_specs(command, options={})
-  sh "git --git-dir=#{__current__.join('../support/elasticsearch/.git')} --work-tree=#{__current__.join('../support/elasticsearch')} #{command}", options
+  sh "git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} #{command}", options
 end
 
 task(:default) { system "rake --tasks" }
@@ -44,7 +44,7 @@ namespace :test do
   task :integration do
     require 'elasticsearch'
 
-    branches = `git --git-dir=#{__current__.join('../support/elasticsearch/.git')} --work-tree=#{__current__.join('../support/elasticsearch')} branch --no-color`
+    branches = `git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} branch --no-color`
 
     current_branch = branches.
       split("\n").
@@ -98,7 +98,7 @@ namespace :test do
       end
 
       # Path to the API specs
-      ENV['TEST_REST_API_SPEC'] = __current__.join('../support/elasticsearch/rest-api-spec/test/').to_s
+      ENV['TEST_REST_API_SPEC'] = __current__.join('../tmp/elasticsearch/rest-api-spec/test/').to_s
 
       # Run the task
       args = [t.ruby_opts_string, t.run_code, t.file_list_string, t.option_list].join(' ')

data/elasticsearch-api.gemspec

@@ -48,7 +48,6 @@ Gem::Specification.new do |s|
   # Prevent unit test failures on Ruby 1.8
   if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
     s.add_development_dependency "test-unit", '~> 2'
-    s.add_development_dependency "activesupport", '~> 3'
     s.add_development_dependency "json"
   end
 
@@ -62,6 +61,10 @@ Gem::Specification.new do |s|
     s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
   end
 
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    s.add_development_dependency "test-unit", '~> 2'
+  end
+
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
   DESC

data/lib/elasticsearch/api.rb

@@ -25,6 +25,14 @@ module Elasticsearch
       :human                          # Return numeric values in human readable format
     ]
 
+    HTTP_GET          = 'GET'.freeze
+    HTTP_HEAD         = 'HEAD'.freeze
+    HTTP_POST         = 'POST'.freeze
+    HTTP_PUT          = 'PUT'.freeze
+    HTTP_DELETE       = 'DELETE'.freeze
+    UNDERSCORE_SEARCH = '_search'.freeze
+    UNDERSCORE_ALL    = '_all'.freeze
+
     # Auto-include all namespaces in the receiver
     #
     def self.included(base)
@@ -37,5 +45,16 @@ module Elasticsearch
                 Elasticsearch::API::Snapshot,
                 Elasticsearch::API::Cat
     end
+
+    module ClassMethods
+
+      # Access the module settings
+      #
+      def settings
+        @settings ||= {}
+      end
+    end
+
+    extend ClassMethods
   end
 end

data/lib/elasticsearch/api/actions/abort_benchmark.rb

@@ -15,7 +15,7 @@ module Elasticsearch
       def abort_benchmark(arguments={})
         valid_params = [
            ]
-        method = 'POST'
+        method = HTTP_POST
         path   = "_bench/abort/#{arguments[:name]}"
         params = {}
         body   = nil

data/lib/elasticsearch/api/actions/benchmark.rb

@@ -50,7 +50,7 @@ module Elasticsearch
       def benchmark(arguments={})
         valid_params = [
           :verbose ]
-        method = 'PUT'
+        method = HTTP_PUT
         path   = "_bench"
         params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]

data/lib/elasticsearch/api/actions/bulk.rb

@@ -65,7 +65,7 @@ module Elasticsearch
           :type,
           :timeout ]
 
-        method = 'POST'
+        method = HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(arguments[:type]), '_bulk'
 
         params = Utils.__validate_and_extract_params arguments, valid_params

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

@@ -50,7 +50,7 @@ module Elasticsearch
 
           name = arguments.delete(:name)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
 

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

@@ -52,7 +52,7 @@ module Elasticsearch
 
           node_id = arguments.delete(:node_id)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
 

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

@@ -46,7 +46,7 @@ module Elasticsearch
 
           index = arguments.delete(:index)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/count', Utils.__listify(index)
 

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

@@ -36,7 +36,7 @@ module Elasticsearch
 
           fields = arguments.delete(:fields)
 
-          method = 'GET'
+          method = HTTP_GET
           path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -37,7 +37,7 @@ module Elasticsearch
             :ts,
             :v ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat/health"
           params = Utils.__validate_and_extract_params arguments, valid_params
           params[:h] = Utils.__listify(params[:h]) if params[:h]

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

@@ -12,7 +12,7 @@ module Elasticsearch
         def help(arguments={})
           valid_params = [
             :help ]
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -60,7 +60,7 @@ module Elasticsearch
 
           index = arguments.delete(:index)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/indices', Utils.__listify(index)
 

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

@@ -35,7 +35,7 @@ module Elasticsearch
             :help,
             :v ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat/master"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -43,7 +43,7 @@ module Elasticsearch
             :help,
             :v ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat/nodes"
 
           params = Utils.__validate_and_extract_params arguments, valid_params

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

@@ -35,7 +35,7 @@ module Elasticsearch
             :help,
             :v ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, valid_params
           params[:h] = Utils.__listify(params[:h]) if params[:h]

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

@@ -56,7 +56,7 @@ module Elasticsearch
 
           index = arguments.delete(:index)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/recovery', Utils.__listify(index)
 

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

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display information about the segments in the shards of an index
+        #
+        # @example Display information for all indices
+        #
+        #     puts client.cat.segments
+        #
+        # @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
+        # @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-segments.html
+        #
+        def segments(arguments={})
+          valid_params = [
+            :h,
+            :help,
+            :v ]
+          method = 'GET'
+          path   = "_cat/segments"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -55,7 +55,7 @@ module Elasticsearch
 
           index = arguments.delete(:index)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify '_cat/shards', Utils.__listify(index)
 

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

@@ -42,7 +42,7 @@ module Elasticsearch
             :help,
             :v ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cat/thread_pool"
           params = Utils.__validate_and_extract_params arguments, valid_params
           params[:h] = Utils.__listify(params[:h]) if params[:h]

data/lib/elasticsearch/api/actions/clear_scroll.rb

@@ -12,10 +12,19 @@ module Elasticsearch
       def clear_scroll(arguments={})
         raise ArgumentError, "Required argument 'scroll_id' missing" unless arguments[:scroll_id]
 
-        method = 'DELETE'
-        path   = Utils.__pathify '_search/scroll', Utils.__listify(arguments[:scroll_id])
+        scroll_id = arguments.delete(:scroll_id)
+
+        scroll_ids = case scroll_id
+          when Array
+            scroll_id.join(',')
+          else
+            scroll_id
+        end
+
+        method = HTTP_DELETE
+        path   = Utils.__pathify '_search/scroll'
         params = {}
-        body   = nil
+        body   = scroll_ids
 
         perform_request(method, path, params, body).body
       end

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -18,7 +18,7 @@ module Elasticsearch
             :flat_settings
           ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cluster/settings"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -40,7 +40,7 @@ module Elasticsearch
             :wait_for_relocating_shards,
             :wait_for_status ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cluster/health"
 
           params = Utils.__validate_and_extract_params arguments, valid_params

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

@@ -20,7 +20,7 @@ module Elasticsearch
           valid_params = [
             :local,
             :master_timeout ]
-          method = 'GET'
+          method = HTTP_GET
           path   = "/_cluster/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -17,7 +17,7 @@ module Elasticsearch
         def put_settings(arguments={})
           valid_params = [ :flat_settings ]
 
-          method = 'PUT'
+          method = HTTP_PUT
           path   = "_cluster/settings"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body] || {}

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -32,7 +32,7 @@ module Elasticsearch
         def reroute(arguments={})
           valid_params = [ :dry_run, :explain, :metric, :master_timeout, :timeout ]
 
-          method = 'POST'
+          method = HTTP_POST
           path   = "_cluster/reroute"
 
           params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -19,6 +19,10 @@ module Elasticsearch
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
         #                                    (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression for inidices
+        #                                              (options: open, closed)
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
         #
@@ -32,9 +36,11 @@ module Elasticsearch
             :index_templates,
             :local,
             :master_timeout,
-            :flat_settings ]
+            :flat_settings,
+            :expand_wildcards,
+            :ignore_unavailable ]
 
-          method = 'GET'
+          method = HTTP_GET
           path   = "_cluster/state"
 
           path   = Utils.__pathify '_cluster/state',

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

@@ -45,7 +45,7 @@ module Elasticsearch
           :routing,
           :source ]
 
-        method = 'GET'
+        method = HTTP_GET
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
 
         params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/count_percolate.rb

@@ -62,7 +62,7 @@ module Elasticsearch
           :version,
           :version_type ]
 
-        method = 'GET'
+        method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  arguments[:id],

data/lib/elasticsearch/api/actions/delete.rb

@@ -43,7 +43,7 @@ module Elasticsearch
           :version,
           :version_type ]
 
-        method = 'DELETE'
+        method = HTTP_DELETE
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  Utils.__escape(arguments[:id])

data/lib/elasticsearch/api/actions/delete_by_query.rb

@@ -60,7 +60,7 @@ module Elasticsearch
           :source,
           :timeout ]
 
-        method = 'DELETE'
+        method = HTTP_DELETE
         path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                  Utils.__listify(arguments[:type]),
                                  '/_query'