elasticsearch-api 0.4.0 → 0.4.1

data/README.md

@@ -36,6 +36,8 @@ or install it from a source code checkout:
 The library is designed as a group of standalone Ruby modules, which can be mixed into a class
 providing connection to Elasticsearch -- an Elasticsearch client.
 
+### Usage with the `elasticsearch` gem
+
 **When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package,
 the library modules have been already included**, so you just call the API methods:
 
@@ -51,6 +53,10 @@ client.search body: { query: { match: { title: 'test' } } }
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
+Full documentation is available 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_:
 
 * It responds to a `perform_request(method, path, params, body)` method,
@@ -90,7 +96,7 @@ p client.index index: 'myindex', type: 'mytype', id: 'custom', body: { title: "I
 # => "{"ok":true, ... }"
 ```
 
-## Using JSON Builders
+### Using JSON Builders
 
 Instead of passing the `:body` argument as a Ruby _Hash_, you can pass it as a _String_, potentially
 taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jbuilder) or
@@ -118,7 +124,7 @@ client.search index: 'myindex', body: json
 # => {"took"=>21, ..., "hits"=>{"total"=>1, "hits"=>[{ "_source"=>{"title"=>"Test 1", ...}}]}}
 ```
 
-## Using Hash Wrappers
+### Using Hash Wrappers
 
 For a more comfortable access to response properties, you may wrap it in one of the _Hash_ "object access"
 wrappers, such as [`Hashie::Mash`](https://github.com/intridea/hashie):

data/Rakefile

@@ -8,7 +8,19 @@ task :test    => 'test:unit'
 
 require 'rake/testtask'
 namespace :test do
+  task :ci_reporter do
+    ENV['CI_REPORTS'] ||= 'tmp/reports'
+    if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+      require 'ci/reporter/rake/test_unit'
+      Rake::Task['ci:setup:testunit'].invoke
+    else
+      require 'ci/reporter/rake/minitest'
+      Rake::Task['ci:setup:minitest'].invoke
+    end
+  end
+
   Rake::TestTask.new(:unit) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/unit/**/*_test.rb"]
     # test.verbose = true
@@ -16,13 +28,15 @@ namespace :test do
   end
 
   Rake::TestTask.new(:integration) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/integration/yaml_test_runner.rb", "test/integration/**/*_test.rb"]
   end
 
   Rake::TestTask.new(:all) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb", "test/integration/yaml_test_runner.rb"]
   end
 
   namespace :server do

data/elasticsearch-api.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "> 1"
   s.add_development_dependency "rake"
 
+  s.add_development_dependency "elasticsearch"
   s.add_development_dependency "elasticsearch-transport"
 
   s.add_development_dependency "ansi"
@@ -33,16 +34,27 @@ Gem::Specification.new do |s|
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
   s.add_development_dependency "ruby-prof"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "ci_reporter"
 
+  # Gems for testing integrations
   s.add_development_dependency "multi_json"
   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'
+    s.add_development_dependency "test-unit", '~> 2'
+    s.add_development_dependency "activesupport", '~> 3'
+  end
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
     s.add_development_dependency "simplecov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof"
+    s.add_development_dependency "coveralls"
   end
 
   s.description = <<-DESC.gsub(/^    /, '')

data/lib/elasticsearch/api.rb

@@ -1,3 +1,4 @@
+require "cgi"
 require "multi_json"
 
 require "elasticsearch/api/version"
@@ -9,6 +10,14 @@ Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require
 
 module Elasticsearch
   module API
+    COMMON_PARAMS = [
+                      :ignore,                        # Client specific parameters
+                      :index, :type, :id,             # :index/:type/:id
+                      :body,                          # Request body
+                      :node_id,                       # Cluster APIs
+                      :name,                          # Template, warmer APIs
+                      :pretty                         # Pretty-print the response
+                    ]
 
     # Auto-include all namespaces in the receiver
     #

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

@@ -46,16 +46,16 @@ module Elasticsearch
       # @see http://elasticsearch.org/guide/reference/api/bulk/
       #
       def bulk(arguments={})
+        valid_params = [
+          :consistency,
+          :refresh,
+          :replication,
+          :type ]
+
         method = 'POST'
-        path   = [arguments[:index], arguments[:type], '_bulk'].compact.join('/')
-        params = arguments.select do |k,v|
-          [ :consistency,
-            :refresh,
-            :replication,
-            :type ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(arguments[:type]), '_bulk'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         if body.is_a? Array

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

@@ -26,20 +26,20 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
         #
         def health(arguments={})
+          valid_params = [
+            :level,
+            :local,
+            :master_timeout,
+            :timeout,
+            :wait_for_active_shards,
+            :wait_for_nodes,
+            :wait_for_relocating_shards,
+            :wait_for_status ]
+
           method = 'GET'
           path   = "_cluster/health"
-          params = arguments.select do |k,v|
-            [ :level,
-              :local,
-              :master_timeout,
-              :timeout,
-              :wait_for_active_shards,
-              :wait_for_nodes,
-              :wait_for_relocating_shards,
-              :wait_for_status ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 
           perform_request(method, path, params, body).body

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

@@ -26,16 +26,16 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
         def node_hot_threads(arguments={})
+          valid_params = [
+            :interval,
+            :snapshots,
+            :threads,
+            :type ]
+
           method = 'GET'
-          path   = "_cluster/nodes/#{arguments[:node_id]}/hot_threads".squeeze('/')
-          params = arguments.select do |k,v|
-            [ :interval,
-              :snapshots,
-              :threads,
-              :type ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+          path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), 'hot_threads'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 
           perform_request(method, path, params, body).body

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

@@ -32,23 +32,23 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
         def node_info(arguments={})
+          valid_params = [
+            :all,
+            :clear,
+            :http,
+            :jvm,
+            :network,
+            :os,
+            :plugin,
+            :process,
+            :settings,
+            :thread_pool,
+            :transport ]
+
           method = 'GET'
-          path   = Utils.__pathify( '_cluster/nodes', Utils.__listify(arguments[:node_id]) )
-          params = arguments.select do |k,v|
-            [ :all,
-              :clear,
-              :http,
-              :jvm,
-              :network,
-              :os,
-              :plugin,
-              :process,
-              :settings,
-              :thread_pool,
-              :transport ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+          path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id])
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 
           perform_request(method, path, params, body).body

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

@@ -18,14 +18,14 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
         def node_shutdown(arguments={})
+          valid_params = [
+            :delay,
+            :exit ]
+
           method = 'POST'
-          path   = Utils.__pathify( '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown' )
-          params = arguments.select do |k,v|
-            [ :delay,
-              :exit ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+          path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           perform_request(method, path, params, body).body

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

@@ -31,12 +31,26 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/
         #
         def node_stats(arguments={})
+          valid_params = [
+            :all,
+            :clear,
+            :fields,
+            :fs,
+            :http,
+            :indices,
+            :jvm,
+            :network,
+            :os,
+            :process,
+            :thread_pool,
+            :transport ]
+
           method = 'GET'
 
           case
             # Field data metric for the `indices` metric family
             when arguments[:indices] && arguments[:metric] == 'fielddata'
-              path   = Utils.__pathify( '_nodes', Utils.__listify(arguments[:node_id]), 'stats/indices/fielddata' )
+              path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'stats/indices/fielddata'
               params = { :fields => Utils.__listify(arguments[:fields]) }
 
             # `indices` metric family incl. a metric
@@ -47,23 +61,7 @@ module Elasticsearch
             else
               path   = Utils.__pathify( '_nodes', Utils.__listify(arguments[:node_id]), 'stats' )
 
-              params = arguments.select do |k,v|
-                [ :all,
-                  :clear,
-                  :fields,
-                  :fs,
-                  :http,
-                  :indices,
-                  :jvm,
-                  :network,
-                  :os,
-                  :process,
-                  :thread_pool,
-                  :transport ].include?(k)
-              end
-              # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-              params = Hash[params] unless params.is_a?(Hash)
-
+              params = Utils.__validate_and_extract_params arguments, valid_params
               params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
           end
 

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

@@ -26,14 +26,12 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
         #
         def reroute(arguments={})
+          valid_params = [ :dry_run, :filter_metadata ]
+
           method = 'POST'
           path   = "_cluster/reroute"
-          params = arguments.select do |k,v|
-            [ :dry_run,
-              :filter_metadata ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body] || {}
 
           perform_request(method, path, params, body).body

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

@@ -23,20 +23,20 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
         #
         def state(arguments={})
+          valid_params = [
+            :filter_blocks,
+            :filter_index_templates,
+            :filter_indices,
+            :filter_metadata,
+            :filter_nodes,
+            :filter_routing_table,
+            :local,
+            :master_timeout ]
+
           method = 'GET'
           path   = "_cluster/state"
-          params = arguments.select do |k,v|
-            [ :filter_blocks,
-              :filter_index_templates,
-              :filter_indices,
-              :filter_metadata,
-              :filter_nodes,
-              :filter_routing_table,
-              :local,
-              :master_timeout ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 
           perform_request(method, path, params, body).body

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

@@ -26,17 +26,17 @@ module Elasticsearch
       # @see http://elasticsearch.org/guide/reference/api/count/
       #
       def count(arguments={})
+        valid_params = [
+          :ignore_indices,
+          :min_score,
+          :preference,
+          :routing,
+          :source ]
+
         method = 'GET'
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_count' )
-        params = arguments.select do |k,v|
-          [ :ignore_indices,
-            :min_score,
-            :preference,
-            :routing,
-            :source ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body

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

@@ -32,20 +32,23 @@ module Elasticsearch
         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 = [
+          :consistency,
+          :parent,
+          :refresh,
+          :replication,
+          :routing,
+          :timeout,
+          :version,
+          :version_type ]
+
         method = 'DELETE'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id] )
-        params = arguments.select do |k,v|
-          [ :consistency,
-            :parent,
-            :refresh,
-            :replication,
-            :routing,
-            :timeout,
-            :version,
-            :version_type ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id])
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = nil
 
         perform_request(method, path, params, body).body