elasticsearch-api 0.4.1 → 0.4.2

data/README.md

@@ -49,7 +49,7 @@ client = Elasticsearch::Client.new log: true
 client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
 # => {"ok"=>true, "_index"=>"myindex", ...}
 
-client.search body: { query: { match: { title: 'test' } } }
+client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
@@ -105,7 +105,7 @@ taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jb
 ```ruby
 require 'jbuilder'
 
-json = Jbuilder.encode do |json|
+query = Jbuilder.encode do |json|
   json.query do
     json.match do
       json.title do
@@ -116,7 +116,7 @@ json = Jbuilder.encode do |json|
   end
 end
 
-client.search index: 'myindex', body: json
+client.search index: 'myindex', body: query
 
 # 2013-06-25 09:56:05 +0200: GET http://localhost:9200/myindex/_search [status:200, request:0.015s, query:0.011s]
 # 2013-06-25 09:56:05 +0200: > {"query":{"match":{"title":{"query":"test 1","operator":"and"}}}}

data/Rakefile

@@ -43,17 +43,15 @@ namespace :test do
     desc "Start Elasticsearch nodes for tests"
     task :start do
       $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
-      require 'elasticsearch/transport'
-      require 'elasticsearch/transport/extensions/test_cluster'
-      Elasticsearch::TestCluster.start
+      require 'elasticsearch/extensions/test/cluster'
+      Elasticsearch::Extensions::Test::Cluster.start
     end
 
     desc "Stop Elasticsearch nodes for tests"
     task :stop do
       $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
-      require 'elasticsearch/transport'
-      require 'elasticsearch/transport/extensions/test_cluster'
-      Elasticsearch::TestCluster.stop
+      require 'elasticsearch/extensions/test/cluster'
+      Elasticsearch::Extensions::Test::Cluster.stop
     end
   end
 end

data/elasticsearch-api.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "elasticsearch"
   s.add_development_dependency "elasticsearch-transport"
+  s.add_development_dependency "elasticsearch-extensions"
 
   s.add_development_dependency "ansi"
   s.add_development_dependency "shoulda-context"
@@ -42,7 +43,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "jbuilder"
   s.add_development_dependency "jsonify"
   s.add_development_dependency "hashie"
-  s.add_development_dependency "escape_utils"
 
   # Prevent unit test failures on Ruby 1.8
   if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
   end
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "escape_utils"
     s.add_development_dependency "simplecov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof"

data/lib/elasticsearch/api.rb

@@ -16,6 +16,7 @@ module Elasticsearch
                       :body,                          # Request body
                       :node_id,                       # Cluster APIs
                       :name,                          # Template, warmer APIs
+                      :field,                         # Get field mapping
                       :pretty                         # Pretty-print the response
                     ]
 

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

@@ -33,13 +33,15 @@ module Elasticsearch
       #
       #     ]
       #
-      # @option arguments [String] :index Default index for items which don't provide one
-      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [String]      :index Default index for items which don't provide one
+      # @option arguments [String]      :type Default document type for items which don't provide one
       # @option arguments [Array<Hash>] :body An array of operations to perform, each operation is a Hash
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation (options: one, quorum, all)
+      # @option arguments [String]  :consistency Explicit write consistency setting for the operation
+      #                             (options: one, quorum, all)
       # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Explicitely set the replication type (options: sync, async)
-      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [String]  :replication Explicitely set the replication type (options: sync, async)
+      # @option arguments [String]  :type Default document type for items which don't provide one
+      # @option arguments [Time]    :timeout Explicit operation timeout
       #
       # @return [Hash] Deserialized Elasticsearch response
       #
@@ -50,7 +52,8 @@ module Elasticsearch
           :consistency,
           :refresh,
           :replication,
-          :type ]
+          :type,
+          :timeout ]
 
         method = 'POST'
         path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(arguments[:type]), '_bulk'

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

@@ -12,6 +12,10 @@ module Elasticsearch
       #
       #     client.count index: 'myindex'
       #
+      # @example Get the number of documents matching a specific query
+      #
+      #     index: 'my_index', body: { filtered: { filter: { terms: { foo: ['bar'] } } } }
+      #
       # @option arguments [List] :index A comma-separated list of indices to restrict the results
       # @option arguments [List] :type A comma-separated list of types to restrict the results
       # @option arguments [Hash] :body A query to restrict the results (optional)

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

@@ -51,7 +51,9 @@ module Elasticsearch
           :timeout ]
 
         method = 'DELETE'
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), '/_query' )
+        path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                 Utils.__listify(arguments[:type]),
+                                 '/_query'
 
         params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]

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

@@ -13,7 +13,7 @@ module Elasticsearch
         #
         #     client.indices.analyze text: 'The Quick Brown Jumping Fox', analyzer: 'snowball'
         #
-        # @example Analyze text "Quick Brown Jumping Fox" with the _snowball_ analyzer
+        # @example Analyze text "Quick Brown Jumping Fox" with a custom tokenizer and filter chain
         #
         #     client.indices.analyze text: 'The Quick Brown Jumping Fox',
         #                            tokenizer: 'whitespace',

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

@@ -25,6 +25,12 @@ module Elasticsearch
           body = nil
 
           perform_request(method, path, params, body).body
+
+        rescue Exception => e
+          # NOTE: Use exception name, not full class in Elasticsearch::Client to allow client plugability
+          if arguments[:ignore] == 404 && e.class.to_s =~ /NotFound/; false
+          else raise(e)
+          end
         end
       end
     end

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

@@ -0,0 +1,46 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return the mapping definition for specific field (or fields)
+        #
+        # @example Get mapping for a specific field across all indices
+        #
+        #     client.indices.get_field_mapping field: 'foo'
+        #
+        # @example Get mapping for a specific field in an index
+        #
+        #     client.indices.get_field_mapping index: 'foo', field: 'bar'
+        #
+        # @example Get mappings for multiple fields in an index
+        #
+        #     client.indices.get_field_mapping index: 'foo', field: ['bar', 'bam']
+        #
+        # @option arguments [List] :index A comma-separated list of index names
+        # @option arguments [List] :type  A comma-separated list of document types
+        # @option arguments [List] :field A comma-separated list of fields (*Required*)
+        # @option arguments [Boolean] :include_defaults Whether default mapping values should be returned as well
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html
+        #
+        def get_field_mapping(arguments={})
+          raise ArgumentError, "Required argument 'field' missing" unless arguments[:field]
+          valid_params = [ :include_defaults ]
+
+          method = 'GET'
+          path   = Utils.__pathify(
+                     Utils.__listify(arguments[:index]),
+                     Utils.__listify(arguments[:type]),
+                     '_mapping', 'field',
+                     Utils.__listify(arguments[:field])
+                   )
+          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/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "0.4.1"
+    VERSION = "0.4.2"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -4,16 +4,18 @@ require 'yaml'
 require 'pry'
 
 require 'elasticsearch'
-require 'elasticsearch/transport/extensions/test_cluster'
+require 'elasticsearch/extensions/test/cluster'
+require 'elasticsearch/extensions/test/startup_shutdown'
+require 'elasticsearch/extensions/test/profiling'
 
 # Launch test cluster
 #
-Elasticsearch::TestCluster.start if ENV['SERVER'] and not Elasticsearch::TestCluster.running?
+Elasticsearch::Extensions::Test::Cluster.start if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?
 
 # Register `at_exit` handler for server shutdown.
 # MUST be called before requiring `test/unit`.
 #
-at_exit { Elasticsearch::TestCluster.stop if ENV['SERVER'] }
+at_exit { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] }
 
 require 'logger'
 require 'ansi'
@@ -29,7 +31,17 @@ logger.formatter = proc do |severity, datetime, progname, msg|
   ANSI.ansi(severity[0] + ' ', color, :faint) + ANSI.ansi(msg, :white, :faint) + "\n"
 end
 
-$client = Elasticsearch::Client.new host: 'localhost:9250', logger: (ENV['QUIET'] ? nil : logger)
+# Set up the client for the test
+#
+# To set up your own client, just set the `$client` variable in a file, and then require it:
+#
+#     ruby -I lib:test -r ./tmp/my_special_client.rb test/integration/yaml_test_runner.rb
+#
+$client ||= Elasticsearch::Client.new host: "localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}",
+                                      logger: (ENV['QUIET'] ? nil : logger)
+
+# Store Elasticsearch version
+#
 $es_version = $client.info['version']['number']
 
 puts '-'*80, "Elasticsearch #{ANSI.ansi($es_version, :bold)}", '-'*80
@@ -211,6 +223,10 @@ suites.each do |suite|
       # Extract setup actions
       setup_actions = tests.select { |t| t['setup'] }.first['setup'] rescue []
 
+      # Skip all the tests when `skip` is part fo the `setup`
+      # TODO: Implement top-level `setup` expression
+      next if Runner.skip? setup_actions
+
       # Remove setup actions from tests
       tests = tests.reject { |t| t['setup'] }
 
@@ -230,6 +246,7 @@ suites.each do |suite|
           # --- Register test setup -------------------------------------------
           setup do
             actions.select { |a| a['setup'] }.first['setup'].each do |action|
+              next unless action['do']
               api, arguments = action['do'].to_a.first
               arguments      = Utils.symbolize_keys(arguments)
               Runner.perform_api_call((test.to_s + '___setup'), api, arguments)

data/test/test_helper.rb

@@ -24,6 +24,10 @@ require 'require-prof' if ENV["REQUIRE_PROF"]
 require 'elasticsearch/api'
 RequireProf.print_timing_infos if ENV["REQUIRE_PROF"]
 
+require 'elasticsearch/extensions/test/cluster'
+require 'elasticsearch/extensions/test/startup_shutdown'
+require 'elasticsearch/extensions/test/profiling'
+
 module Elasticsearch
   module Test
     class FakeClient

data/test/unit/count_test.rb

@@ -32,11 +32,11 @@ module Elasticsearch
         should "take the query" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'GET', method
-            assert_equal( {:query => {:match => {:foo => 'bar'}}}, body)
+            assert_equal( {:match => {:foo => 'bar'}}, body)
             true
           end.returns(FakeResponse.new)
 
-          subject.count :body => { :query => { :match => { :foo => 'bar' } } }
+          subject.count :body => { :match => { :foo => 'bar' } }
         end
 
       end

data/test/unit/delete_by_query_test.rb

@@ -25,6 +25,15 @@ module Elasticsearch
           subject.delete_by_query :index => 'foo', :body => { :term => {} }
         end
 
+        should "optionally take the :type argument" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/tweet,post/_query', url
+            true
+          end.returns(FakeResponse.new)
+
+          subject.delete_by_query :index => 'foo', :type => ['tweet', 'post'], :body => { :term => {} }
+        end
+
         should "pass the query in URL parameters" do
           subject.expects(:perform_request).with do |method, url, params, body|
             assert_equal 'foo/_query', url

data/test/unit/indices/delete_template_test.rb

@@ -28,6 +28,14 @@ module Elasticsearch
           subject.indices.delete_template :name => 'foo^bar'
         end
 
+        should "ignore 404s" do
+          subject.expects(:perform_request).raises(NotFound)
+
+          assert_nothing_raised do
+            assert ! subject.indices.delete_template(:name => 'foo^bar', :ignore => 404)
+          end
+        end
+
       end
 
     end

data/test/unit/indices/get_field_mapping_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class IndicesGetFieldMappingTest < ::Test::Unit::TestCase
+
+      context "Indices: Get field mapping" 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 '_mapping/field/foo', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.indices.get_field_mapping :field => 'foo'
+        end
+
+        should "perform request against an index" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/_mapping/field/bam', url
+            true
+          end.returns(FakeResponse.new)
+
+          subject.indices.get_field_mapping :index => 'foo', :field => 'bam'
+        end
+
+        should "perform request against an index and type" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'foo/bar/_mapping/field/bam', url
+            true
+          end.returns(FakeResponse.new)
+
+          subject.indices.get_field_mapping :index => 'foo', :type => 'bar', :field => 'bam'
+        end
+
+      end
+
+    end
+  end
+end

data/test/unit/utils_test.rb

@@ -31,7 +31,7 @@ module Elasticsearch
             CGI.expects(:escape).never
             EscapeUtils.expects(:escape_url)
             __escape('foo bar')
-          end
+          end unless RUBY_1_8
 
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-extensions
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ansi
   requirement: !ruby/object:Gem::Requirement
@@ -416,6 +432,7 @@ files:
 - lib/elasticsearch/api/actions/indices/flush.rb
 - lib/elasticsearch/api/actions/indices/get_alias.rb
 - lib/elasticsearch/api/actions/indices/get_aliases.rb
+- lib/elasticsearch/api/actions/indices/get_field_mapping.rb
 - lib/elasticsearch/api/actions/indices/get_mapping.rb
 - lib/elasticsearch/api/actions/indices/get_settings.rb
 - lib/elasticsearch/api/actions/indices/get_template.rb
@@ -487,6 +504,7 @@ files:
 - test/unit/indices/flush_test.rb
 - test/unit/indices/get_alias_test.rb
 - test/unit/indices/get_aliases_test.rb
+- test/unit/indices/get_field_mapping_test.rb
 - test/unit/indices/get_mapping_test.rb
 - test/unit/indices/get_settings_test.rb
 - test/unit/indices/get_template_test.rb
@@ -582,6 +600,7 @@ test_files:
 - test/unit/indices/flush_test.rb
 - test/unit/indices/get_alias_test.rb
 - test/unit/indices/get_aliases_test.rb
+- test/unit/indices/get_field_mapping_test.rb
 - test/unit/indices/get_mapping_test.rb
 - test/unit/indices/get_settings_test.rb
 - test/unit/indices/get_template_test.rb