elasticsearch-api 1.0.6 → 1.0.7

data/lib/elasticsearch/api/actions/snapshot/restore.rb

@@ -39,7 +39,7 @@ module Elasticsearch
           repository = arguments.delete(:repository)
           snapshot   = arguments.delete(:snapshot)
 
-          method = 'POST'
+          method = HTTP_POST
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_restore' )
 
           params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/snapshot/status.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           repository = arguments.delete(:repository)
           snapshot   = arguments.delete(:snapshot)
 
-          method = 'GET'
+          method = HTTP_GET
 
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_status')
           params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb

@@ -20,7 +20,7 @@ module Elasticsearch
             :timeout ]
 
           repository = arguments.delete(:repository)
-          method = 'POST'
+          method = HTTP_POST
           path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), '_verify' )
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -33,7 +33,7 @@ module Elasticsearch
           :routing,
           :source ]
 
-        method = 'POST'
+        method = HTTP_POST
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_suggest' )
 
         params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/{termvector.rb → termvectors.rb}

@@ -4,7 +4,7 @@ module Elasticsearch
 
       # Return information and statistics about terms in the fields of a particular document
       #
-      # @example Get statistics for a specific document
+      # @example Get statistics for an indexed document
       #
       #     client.indices.create index: 'my_index',
       #                           body: {
@@ -22,12 +22,23 @@ module Elasticsearch
       #
       #     client.index index: 'my_index', type: 'my_type', id: '1', body: { text: 'Foo Bar Fox' }
       #
-      #     client.termvector index: 'my_index', type: 'my_type', id: '1'
+      #     client.termvectors index: 'my_index', type: 'my_type', id: '1'
+      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
+      #
+      #
+      # @example Get statistics for an arbitrary document
+      #
+      #     client.termvector index: 'my_index', type: 'my_type',
+      #                       body: {
+      #                         doc: {
+      #                           text: 'Foo Bar Fox'
+      #                         }
+      #                       }
       #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
       #
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [String] :id The document ID (*Required*)
+      # @option arguments [String] :id The document ID
       # @option arguments [Hash] :body The request definition
       # @option arguments [Boolean] :term_statistics Whether total term frequency and
       #                                              document frequency should be returned
@@ -46,10 +57,9 @@ module Elasticsearch
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html
       #
-      def termvector(arguments={})
+      def termvectors(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
         valid_params = [
           :term_statistics,
@@ -63,18 +73,25 @@ module Elasticsearch
           :routing,
           :parent ]
 
-        method = 'GET'
+        method = HTTP_GET
+        endpoint = arguments.delete(:endpoint) || '_termvectors'
 
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  arguments[:id],
-                                 '_termvector'
+                                 endpoint
 
         params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body
       end
+
+      # @deprecated Use the plural version, {#termvectors}
+      #
+      def termvector(arguments={})
+        termvectors(arguments.merge :endpoint => '_termvector')
+      end
     end
   end
 end

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

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

data/lib/elasticsearch/api/utils.rb

@@ -110,24 +110,45 @@ module Elasticsearch
       # @raise [ArgumentError] If the arguments Hash contains invalid keys
       #
       # @example Extract parameters
-      #   __validate_and_extract_params { :foo => 'qux' }, [:foo, :bar]
+      #   __validate_and_extract_params( { :foo => 'qux' }, [:foo, :bar] )
       #   # => { :foo => 'qux' }
       #
       # @example Raise an exception for invalid parameters
-      #   __validate_and_extract_params { :foo => 'qux', :bam => 'mux' }, [:foo, :bar]
+      #   __validate_and_extract_params( { :foo => 'qux', :bam => 'mux' }, [:foo, :bar] )
       #   # ArgumentError: "URL parameter 'bam' is not supported"
       #
+      # @example Skip validating parameters
+      #   __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar], { skip_parameter_validation: true } )
+      #   # => { :foo => "q", :bam => "m" }
+      #
+      # @example Skip validating parameters when the module setting is set
+      #   Elasticsearch::API.settings[:skip_parameter_validation] = true
+      #   __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar] )
+      #   # => { :foo => "q", :bam => "m" }
+      #
       # @api private
       #
-      def __validate_and_extract_params(arguments, valid_params=[])
+      def __validate_and_extract_params(arguments, params=[], options={})
+        if options[:skip_parameter_validation] || Elasticsearch::API.settings[:skip_parameter_validation]
+          arguments
+        else
+          __validate_params(arguments, params)
+          __extract_params(arguments, params)
+        end
+      end
+
+      def __validate_params(arguments, valid_params=[])
         arguments.each do |k,v|
           raise ArgumentError, "URL parameter '#{k}' is not supported" \
             unless COMMON_PARAMS.include?(k) || COMMON_QUERY_PARAMS.include?(k) || valid_params.include?(k)
         end
+      end
 
-        params = arguments.select { |k,v| COMMON_QUERY_PARAMS.include?(k) || valid_params.include?(k) }
-        params = Hash[params] unless params.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params
+      def __extract_params(arguments, params=[])
+        result = arguments.select { |k,v| COMMON_QUERY_PARAMS.include?(k) || params.include?(k) }
+        result = Hash[result] unless result.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+        result = Hash[result.map { |k,v| v.is_a?(Array) ? [k, __listify(v)] : [k,v]  }] # Listify Arrays
+        result
       end
 
       # Extracts the valid parts of the URL from the arguments

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "1.0.6"
+    VERSION = "1.0.7"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -14,7 +14,8 @@ require 'elasticsearch/extensions/test/startup_shutdown'
 require 'elasticsearch/extensions/test/profiling' unless JRUBY
 
 # Skip features
-SKIP_FEATURES = ENV['TEST_SKIP_FEATURES'] || ''
+skip_features = 'stash_in_path,requires_replica'
+SKIP_FEATURES = ENV.fetch('TEST_SKIP_FEATURES', skip_features)
 
 # Turn configuration
 ENV['ansi'] = 'false' if ENV['CI']
@@ -261,7 +262,7 @@ end
 include Elasticsearch::YamlTestSuite
 
 PATH    = Pathname(ENV['TEST_REST_API_SPEC'] || \
-          File.expand_path('../../../../support/elasticsearch/rest-api-spec/test', __FILE__))
+          File.expand_path('../../../../tmp/elasticsearch/rest-api-spec/test', __FILE__))
 suites  = Dir.glob(PATH.join('*')).map { |d| Pathname(d) }
 suites  = suites.select { |s| s.to_s =~ Regexp.new(ENV['FILTER']) } if ENV['FILTER']
 

data/test/unit/api_test.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class APITest < ::Test::Unit::TestCase
+
+      context "The API module" do
+
+        should "access the settings" do
+          assert_not_nil Elasticsearch::API.settings
+        end
+
+        should "allow to set settings" do
+          assert_nothing_raised { Elasticsearch::API.settings[:foo] = 'bar' }
+          assert_equal 'bar', Elasticsearch::API.settings[:foo]
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/cat/segments_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class CatSegmentsTest < ::Test::Unit::TestCase
+
+      context "Cat: Segments" 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/segments', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.cat.segments
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/clear_scroll_test.rb

@@ -10,9 +10,9 @@ module Elasticsearch
         should "perform correct request" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'DELETE', method
-            assert_equal '_search/scroll/abc123', url
+            assert_equal '_search/scroll', url
             assert_equal Hash.new, params
-            assert_nil   body
+            assert_equal 'abc123', body
             true
           end.returns(FakeResponse.new)
 
@@ -22,9 +22,9 @@ module Elasticsearch
         should "listify scroll IDs" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'DELETE', method
-            assert_equal '_search/scroll/abc123,def456', url
+            assert_equal '_search/scroll', url
             assert_equal Hash.new, params
-            assert_nil   body
+            assert_equal 'abc123,def456', body
             true
           end.returns(FakeResponse.new)
 

data/test/unit/exists_document_test.rb

@@ -78,6 +78,11 @@ module Elasticsearch
           end
         end
 
+        should "be aliased as predicate method" do
+          assert_nothing_raised do
+            subject.exists?(:index => 'foo', :type => 'bar', :id => '1') == subject.exists(:index => 'foo', :type => 'bar', :id => '1')
+          end
+        end
       end
 
     end

data/test/unit/indices/delete_test.rb

@@ -47,6 +47,13 @@ module Elasticsearch
           subject.indices.delete :index => 'foo^bar'
         end
 
+        should "catch a NotFound exception with the ignore parameter" do
+          subject.expects(:perform_request).raises(NotFound)
+
+          assert_nothing_raised do
+            subject.indices.delete :index => 'foo', :ignore => 404
+          end
+        end
       end
 
     end

data/test/unit/indices/exists_alias_test.rb

@@ -61,6 +61,11 @@ module Elasticsearch
           end
         end
 
+        should "be aliased as predicate method" do
+          assert_nothing_raised do
+            subject.indices.exists_alias?(:name => 'foo') == subject.indices.exists_alias(:name => 'foo')
+          end
+        end
       end
 
     end

data/test/unit/indices/exists_test.rb

@@ -59,6 +59,11 @@ module Elasticsearch
           end
         end
 
+        should "be aliased as predicate method" do
+          assert_nothing_raised do
+            subject.indices.exists?(:index => 'foo') == subject.indices.exists(:index => 'foo')
+          end
+        end
       end
 
     end

data/test/unit/indices/exists_type_test.rb

@@ -61,6 +61,11 @@ module Elasticsearch
           end
         end
 
+        should "be aliased as predicate method" do
+          assert_nothing_raised do
+            subject.indices.exists_type?(:index => 'foo', :type => 'bar') == subject.indices.exists_type(:index => 'foo', :type => 'bar')
+          end
+        end
       end
 
     end

data/test/unit/indices/put_alias_test.rb

@@ -34,6 +34,15 @@ module Elasticsearch
           subject.indices.put_alias :index => 'foo', :name => 'bar', :body => { :filter => 'foo' }
         end
 
+        should "Listify indices" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo,bar/_alias/bar%2Fbam', url
+            true
+          end.returns(FakeResponse.new)
+
+          subject.indices.put_alias :index => ['foo', 'bar'], :name => 'bar/bam', :body => {}
+        end
+
         should "URL-escape the parts" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'foo%5Ebar/_alias/bar%2Fbam', url

data/test/unit/nodes/info_test.rb

@@ -59,6 +59,15 @@ module Elasticsearch
           subject.nodes.info :format => 'yaml'
         end
 
+        should "encode metrics" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal '_nodes/http,network', url
+            assert_nil   params[:metric]
+            true
+          end.returns(FakeResponse.new)
+
+          subject.nodes.info :metric => ['http', 'network']
+        end
       end
 
     end

data/test/unit/scroll_test.rb

@@ -11,8 +11,7 @@ module Elasticsearch
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'GET', method
             assert_equal '_search/scroll', url
-            assert_equal 'cXVlcn...', params[:scroll_id]
-            assert_nil   body
+            assert_equal 'cXVlcn...', body
             true
           end.returns(FakeResponse.new)
 

data/test/unit/{termvector_test.rb → termvectors_test.rb}

@@ -2,39 +2,42 @@ require 'test_helper'
 
 module Elasticsearch
   module Test
-    class TermvectorTest < ::Test::Unit::TestCase
+    class TermvectorsTest < ::Test::Unit::TestCase
 
-      context "Termvector" do
+      context "Termvectors" do
         subject { FakeClient.new }
 
         should "require the :index argument" do
           assert_raise ArgumentError do
-            subject.termvector :type => 'bar', :id => '1'
+            subject.termvectors :type => 'bar', :id => '1'
           end
         end
 
         should "require the :type argument" do
           assert_raise ArgumentError do
-            subject.termvector :index => 'foo', :id => '1'
-          end
-        end
-
-        should "require the :id argument" do
-          assert_raise ArgumentError do
-            subject.termvector :index => 'foo', :type => 'bar'
+            subject.termvectors :index => 'foo', :id => '1'
           end
         end
 
         should "perform correct request" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'GET', method
-            assert_equal 'foo/bar/123/_termvector', url
+            assert_equal 'foo/bar/123/_termvectors', url
             assert_equal Hash.new, params
             assert_equal Hash.new, body
             true
           end.returns(FakeResponse.new)
 
-          subject.termvector :index => 'foo', :type => 'bar', :id => '123', :body => {}
+          subject.termvectors :index => 'foo', :type => 'bar', :id => '123', :body => {}
+        end
+
+        should "be aliased to singular for older versions" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/bar/123/_termvector', url
+            true
+          end.returns(FakeResponse.new)
+
+          subject.termvector :index => 'foo', :type => 'bar', :id => '123'
         end
 
       end

data/test/unit/utils_test.rb

@@ -141,6 +141,9 @@ module Elasticsearch
         end
 
         context "__validate_and_extract_params" do
+          teardown do
+            Elasticsearch::API.settings.clear
+          end
 
           should "extract valid params from a Hash" do
             assert_equal( {:foo => 'qux'},
@@ -164,6 +167,25 @@ module Elasticsearch
                           __validate_and_extract_params( { :format => 'yaml' } ) )
           end
 
+          should "not validate parameters when the option is set" do
+            assert_nothing_raised do
+              result = __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar], { :skip_parameter_validation => true } )
+              assert_equal( { :foo => 'q', :bam => 'm' }, result )
+            end
+          end
+
+          should "not validate parameters when the module setting is set" do
+            assert_nothing_raised do
+              Elasticsearch::API.settings[:skip_parameter_validation] = true
+              result = __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar] )
+              assert_equal( { :foo => 'q', :bam => 'm' }, result )
+            end
+          end
+
+          should "listify Arrays" do
+            result = __validate_and_extract_params( { :foo => ['a', 'b'] }, [:foo] )
+            assert_equal( { :foo => 'a,b'}, result )
+          end
         end
 
         context "__extract_parts" do