elasticsearch-api 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62247808bb72f7ae656b190ea047eeb8a93160f2
-  data.tar.gz: 0ab2745690ffc9e0e5243b050ade10dea4fec177
+  metadata.gz: 8c84503f7051b6272a5d1bcd9010d84b1b3fcf6c
+  data.tar.gz: 715eb2f3af37710770a9247872f8c55c23d5d144
 SHA512:
-  metadata.gz: 04845dd1ec5918fdd884ced7eed2772f15e3e73b56462d8e4859964e55a099af166dd9cf7df5715141aa69a286fbdb91bbe7360f4133d60b9f38953e86e0c1b5
-  data.tar.gz: 4e0f8f9f1e1d4853d48acc0f583af99b8d84693af566e18eb8f775fc0e3b0b1e731964a54bf40391d9d5b24f784a093f25efc5be593bfb637a70722530893130
+  metadata.gz: 9fdf7d52c842acc1f962601abf18277fce30051b7efd87233881d77d09d39647a0ec0f70e3d623cedf277166bc24e6720b9496a44a5ecc8abc92ead6e3c8b021
+  data.tar.gz: 2641055eac4b624a1422298da436b5f1e3d62c69becd67b67c9dcac9ee532159ce9c7a59d1cdcafe9a2186a9f9f4392b93c3b7116aa9781262986dc2727891f1

data/lib/elasticsearch/api.rb

@@ -22,7 +22,8 @@ module Elasticsearch
     COMMON_QUERY_PARAMS = [
       :format,                        # Search, Cat, ...
       :pretty,                        # Pretty-print the response
-      :human                          # Return numeric values in human readable format
+      :human,                         # Return numeric values in human readable format
+      :filter_path                    # Filter the JSON response
     ]
 
     HTTP_GET          = 'GET'.freeze

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

@@ -47,7 +47,7 @@ module Elasticsearch
           path   = "_cat/nodes"
 
           params = Utils.__validate_and_extract_params arguments, valid_params
-          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          params[:h] = Utils.__listify(params[:h], :escape => false) if params[:h]
 
           body   = nil
 

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

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
+        # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html
+        #
+        def flush_synced(arguments={})
+          valid_params = [
+             ]
+          method = HTTP_POST
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush/synced'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          if Array(arguments[:ignore]).include?(404)
+            Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
+          else
+            perform_request(method, path, params, body).body
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -76,6 +76,8 @@ module Elasticsearch
       # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation
       #                                      as part of a hit
       # @option arguments [List] :fields A comma-separated list of fields to return as part of a hit
+      # @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data
+      #                                            representation of a field for each hit
       # @option arguments [Number] :from Starting offset (default: 0)
       # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
       #                                            (options: none, missing)
@@ -120,6 +122,7 @@ module Elasticsearch
           :default_operator,
           :df,
           :explain,
+          :fielddata_fields,
           :fields,
           :from,
           :ignore_indices,
@@ -152,9 +155,14 @@ module Elasticsearch
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
 
         params = Utils.__validate_and_extract_params arguments, valid_params
+
         body   = arguments[:body]
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+        params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields]) if params[:fielddata_fields]
+
+        # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
+        params[:filter_path] =  defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
 
         perform_request(method, path, params, body).body
       end

data/lib/elasticsearch/api/utils.rb

@@ -28,13 +28,18 @@ module Elasticsearch
       # @example Escape values
       #     __listify('foo','bar^bam') # => 'foo,bar%5Ebam'
       #
+      # @example Do not escape the values
+      #     __listify('foo','bar^bam', escape: false) # => 'foo,bar^bam'
+      #
       # @api private
       def __listify(*list)
+        options = list.last.is_a?(Hash) ? list.pop : {}
+
         Array(list).flatten.
           map { |e| e.respond_to?(:split) ? e.split(',') : e }.
           flatten.
           compact.
-          map { |e| __escape(e) }.
+          map { |e| options[:escape] == false ? e : __escape(e) }.
           join(',')
       end
 
@@ -133,7 +138,7 @@ module Elasticsearch
           arguments
         else
           __validate_params(arguments, params)
-          __extract_params(arguments, params)
+          __extract_params(arguments, params, options.merge(:escape => false))
         end
       end
 
@@ -144,10 +149,10 @@ module Elasticsearch
         end
       end
 
-      def __extract_params(arguments, params=[])
+      def __extract_params(arguments, params=[], options={})
         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 = Hash[result.map { |k,v| v.is_a?(Array) ? [k, __listify(v, options)] : [k,v]  }] # Listify Arrays
         result
       end
 
@@ -168,9 +173,6 @@ module Elasticsearch
       # @api private
       #
       def __extract_parts(arguments, valid_parts=[])
-        # require 'pry'; binding.pry;
-        # parts  = arguments.keys.select { |a| valid_parts.include?(a) }.map { |a| a.to_s }.sort
-
         parts = Hash[arguments.select { |k,v| valid_parts.include?(k) }]
         parts = parts.reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v  }
 

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "1.0.12"
+    VERSION = "1.0.13"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -23,12 +23,14 @@ Turn.config.format = :pretty
 
 # Launch test cluster
 #
-Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?
+if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running?
+  Elasticsearch::Extensions::Test::Cluster.start(nodes: 1, es_params: "-D es.repositories.url.allowed_urls=http://snapshot.test*")
+end
 
 # Register `at_exit` handler for server shutdown.
 # MUST be called before requiring `test/unit`.
 #
-at_exit { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] }
+at_exit { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] and Elasticsearch::Extensions::Test::Cluster.running? }
 
 class String
   # Reset the `ansi` method on CI
@@ -128,6 +130,7 @@ end
 
 module Elasticsearch
   module YamlTestSuite
+    $last_response = ''
     $results = {}
     $stash   = {}
 
@@ -180,7 +183,7 @@ module Elasticsearch
 
         $stderr.puts "ARGUMENTS: #{arguments.inspect}" if ENV['DEBUG']
 
-        $results[test.hash] = namespace.reduce($client) do |memo, current|
+        $last_response = namespace.reduce($client) do |memo, current|
           unless current == namespace.last
             memo = memo.send(current)
           else
@@ -188,12 +191,18 @@ module Elasticsearch
           end
           memo
         end
+
+        $results[test.hash] = $last_response
       end
 
-      def evaluate(test, property)
-        property.gsub(/\\\./, '_____').split('.').reduce($results[test.hash]) do |memo, attr|
+      def evaluate(test, property, response=nil)
+        response ||= $results[test.hash]
+        property.gsub(/\\\./, '_____').split('.').reduce(response) do |memo, attr|
           if memo
-            attr = attr.gsub(/_____/, '.') if attr
+            if attr
+              attr = attr.gsub(/_____/, '.')
+              attr = $stash[attr] if attr.start_with? '$'
+            end
             memo = memo.is_a?(Hash) ? memo[attr] : memo[attr.to_i]
           end
           memo
@@ -322,10 +331,18 @@ 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)
+              if action['do']
+                api, arguments = action['do'].to_a.first
+                arguments      = Utils.symbolize_keys(arguments)
+                Runner.perform_api_call((test.to_s + '___setup'), api, arguments)
+              end
+              if action['set']
+                stash = action['set']
+                property, variable = stash.to_a.first
+                result  = Runner.evaluate(test, property, $last_response)
+                $stderr.puts "STASH: '$#{variable}' => #{result.inspect}" if ENV['DEBUG']
+                Runner.set variable, result
+              end
             end
           end
 
@@ -386,8 +403,10 @@ suites.each do |suite|
 
                 when property = action['is_false']
                   result = Runner.evaluate(test, property)
-                  $stderr.puts "CHECK: Expected '#{property}' to be false, is: #{result.inspect}" if ENV['DEBUG']
-                  assert( !!! result, "Property '#{property}' should be false, is: #{result.inspect}")
+                  $stderr.puts "CHECK: Expected '#{property}' to be nil, false, 0 or empty string, is: #{result.inspect}" if ENV['DEBUG']
+                  assert_block "Property '#{property}' should be nil, false, 0 or empty string, but is: #{result.inspect}" do
+                    result.nil? || result == false || result == 0 || result == ''
+                  end
 
                 when a = action['match']
                   property, value = a.to_a.first

data/test/unit/indices/flush_synced_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class IndicesFlushSyncedTest < ::Test::Unit::TestCase
+
+      context "Indices: Flush synced" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'POST', method
+            assert_equal 'foo/_flush/synced', url
+            assert_equal Hash.new, params
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.indices.flush_synced :index => 'foo'
+        end
+
+        should "raise a NotFound exception" do
+          subject.expects(:perform_request).raises(NotFound)
+
+          assert_raise NotFound do
+            subject.indices.flush_synced :index => 'foo'
+          end
+        end
+
+        should "catch a NotFound exception with the ignore parameter" do
+          subject.expects(:perform_request).raises(NotFound)
+
+          assert_nothing_raised do
+            subject.indices.flush_synced :index => 'foo', :ignore => 404
+          end
+        end
+      end
+
+    end
+  end
+end

data/test/unit/utils_test.rb

@@ -61,6 +61,10 @@ module Elasticsearch
             assert_equal 'foo,bar%5Ebam', __listify(['foo', 'bar^bam'])
           end
 
+          should "not encode special characters when the :escape option is set" do
+            assert_equal 'foo,bar^bam', __listify(['foo', 'bar^bam'], :escape => false)
+          end
+
         end
 
         context "__pathify" do
@@ -186,6 +190,11 @@ module Elasticsearch
             result = __validate_and_extract_params( { :foo => ['a', 'b'] }, [:foo] )
             assert_equal( { :foo => 'a,b'}, result )
           end
+
+          should "not escape the parameters" do
+            result = __validate_and_extract_params( { :foo => ['a.*', 'b.*'] }, [:foo] )
+            assert_equal( { :foo => 'a.*,b.*'}, result )
+          end
         end
 
         context "__extract_parts" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -404,6 +404,7 @@ files:
 - lib/elasticsearch/api/actions/indices/exists_template.rb
 - lib/elasticsearch/api/actions/indices/exists_type.rb
 - lib/elasticsearch/api/actions/indices/flush.rb
+- lib/elasticsearch/api/actions/indices/flush_synced.rb
 - lib/elasticsearch/api/actions/indices/get.rb
 - lib/elasticsearch/api/actions/indices/get_alias.rb
 - lib/elasticsearch/api/actions/indices/get_aliases.rb
@@ -527,6 +528,7 @@ files:
 - test/unit/indices/exists_template_test.rb
 - test/unit/indices/exists_test.rb
 - test/unit/indices/exists_type_test.rb
+- test/unit/indices/flush_synced_test.rb
 - test/unit/indices/flush_test.rb
 - test/unit/indices/get_alias_test.rb
 - test/unit/indices/get_aliases_test.rb
@@ -679,6 +681,7 @@ test_files:
 - test/unit/indices/exists_template_test.rb
 - test/unit/indices/exists_test.rb
 - test/unit/indices/exists_type_test.rb
+- test/unit/indices/flush_synced_test.rb
 - test/unit/indices/flush_test.rb
 - test/unit/indices/get_alias_test.rb
 - test/unit/indices/get_aliases_test.rb