elastomer-client 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eee472ee555f628e95e3dd97d76ead36bc509e41
-  data.tar.gz: a56d61d1c97b089af9170a1e662b835b6c6def50
+  metadata.gz: 20de9fda77111f1c5d50ccbbb63dd8b3316f7149
+  data.tar.gz: 97b970b60153c6069c44d866b00c08ba0542ae24
 SHA512:
-  metadata.gz: 62ec42794c0799c52152e5b2ce6962b241c6dde67d46d402466957c5582c8b2ffd0b4cde9ddbdd355c71516f87bc60fba59f470b735b7dfb28c34731a2e35c7f
-  data.tar.gz: 837d5438ca92b8d4b7296a2086504fffb51b01daa39003fbbb2b9d2b5407ddb30a76846fdaf53c552c6a6148b0a57270ca37735275b02dde809579d7cce07c9e
+  metadata.gz: 25dd4d57d43c60e279eaec42708d0ba8f12ad3d085baa64d9b68c489e31f5f152e54b5663fad14afe1c459245e7ca9237082fe41d834a8126be3c09f3d311899
+  data.tar.gz: 751eeeb151a1e582903b84f6383de2f7ff47f39db86afeb582fed185775b6881b915ddaf80c3326930f988bf21d558eb3f66dae82f26b018d4b9c641b64d6b50

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.6.0 (2015-09-11)
+- Support all URL parameters when using `Client.#scroll`
+- BREAKING: Moved some `Scroller` reader methods into `Scroller.opts`
+
+## 0.5.1 (2015-04-03)
+- Add response body to notification payload
+
 ## 0.5.0 (2015-01-21)
 - BREAKING: rename action.available notification to action.ping
 - Index Component

data/Rakefile

@@ -3,7 +3,7 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-    t.pattern = "test/**/*_test.rb"
+    t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task :default => :test

data/lib/elastomer/client/cluster.rb

@@ -84,6 +84,15 @@ module Elastomer
         response.body
       end
 
+      # Returns `true` if there items in the pending task list. Returns `false`
+      # if the pending task list is empty. Returns `nil` if the response body
+      # does not contain the "tasks" field.
+      def pending_tasks?
+        hash = pending_tasks
+        return nil unless hash.key? "tasks"
+        hash["tasks"].length > 0
+      end
+
       # Cluster wide settings that have been modified via the update API.
       #
       # params - Parameters Hash

data/lib/elastomer/client/scroller.rb

@@ -101,6 +101,13 @@ module Elastomer
       response.body
     end
 
+    DEFAULT_OPTS = {
+      :index => nil,
+      :type => nil,
+      :scroll => '5m',
+      :size => 50,
+    }.freeze
+
     class Scroller
       # Create a new scroller that can be used to iterate over all the documents
       # returned by the `query`. The Scroller supports both the 'scan' and the
@@ -128,19 +135,14 @@ module Elastomer
       #
       def initialize( client, query, opts = {} )
         @client = client
-        @query  = query
 
-        @index       = opts.fetch(:index, nil)
-        @type        = opts.fetch(:type, nil)
-        @scroll      = opts.fetch(:scroll, '5m')
-        @size        = opts.fetch(:size, 50)
-        @search_type = opts.fetch(:search_type, nil)
+        @opts = DEFAULT_OPTS.merge({ :body => query }).merge(opts)
 
         @scroll_id = nil
         @offset = 0
       end
 
-      attr_reader :client, :query, :index, :type, :scroll, :size, :search_type, :scroll_id
+      attr_reader :client, :query, :scroll_id
 
       # Iterate over all the search results from the scan query.
       #
@@ -203,33 +205,19 @@ module Elastomer
       # Returns the response body as a Hash.
       def do_scroll
         if scroll_id.nil?
-          body = client.start_scroll(scroll_opts)
+          body = client.start_scroll(@opts)
           if body['hits']['hits'].empty?
             @scroll_id = body['_scroll_id']
             return do_scroll
           end
         else
-          body = client.continue_scroll(scroll_id, scroll)
+          body = client.continue_scroll(scroll_id, @opts[:scroll])
         end
 
         @scroll_id = body['_scroll_id']
         body
       end
 
-      # Internal: Returns the options Hash that should be passed to the initial
-      # `Client#start_scroll` method call.
-      def scroll_opts
-        hash = {
-          :scroll => scroll,
-          :size   => size,
-          :index  => index,
-          :type   => type,
-          :body   => query
-        }
-        hash[:search_type] = search_type unless search_type.nil?
-        hash
-      end
-
     end  # Scroller
   end  # Client
 end  # Elastomer

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 
   def self.version
     VERSION

data/script/cibuild

@@ -12,11 +12,6 @@ PATH="$(pwd)/bin:$(pwd)/script:/usr/share/rbenv/shims:$PATH"
 git log -n 1 || true
 echo
 
-# Create a snapshot dir and make it world writable
-export SNAPSHOT_DIR=/tmp/elastomer-client-snapshot-test
-mkdir -p $SNAPSHOT_DIR
-chmod a+rw $SNAPSHOT_DIR
-
 result=0
 
 export RBENV_VERSION="2.1.1-github"

data/script/test

@@ -2,5 +2,5 @@
 set -e
 cd "$(dirname "$0")/.."
 
-fn=${1:-"test/**/*_test.rb"}
+fn=${1:-"test/**/*_test.rb test/*_test.rb"}
 bundle exec testrb -Itest $fn $@

data/test/client/index_test.rb

@@ -127,6 +127,10 @@ describe Elastomer::Client::Index do
   end
 
   it 'updates document mappings' do
+    unless es_version_supports_update_mapping_with__all_disabled?
+      skip "Mapping Update API is broken in this ES version."
+    end
+
     @index.create(
       :mappings => {
         :doco => {
@@ -154,6 +158,10 @@ describe Elastomer::Client::Index do
   end
 
   it 'updates document mappings with .put_mapping' do
+    unless es_version_supports_update_mapping_with__all_disabled?
+      skip "Mapping Update API is broken in this ES version."
+    end
+
     @index.create(
       :mappings => {
         :doco => {

data/test/client/repository_test.rb

@@ -5,6 +5,10 @@ describe Elastomer::Client::Repository do
   if es_version_1_x?
 
     before do
+      if !run_snapshot_tests?
+        skip "To enable snapshot tests, add a path.repo setting to your elasticsearch.yml file."
+      end
+
       @name = 'elastomer-repository-test'
       @repo = $client.repository(@name)
     end

data/test/client/scroller_test.rb

@@ -83,6 +83,16 @@ describe Elastomer::Client::Scroller do
     assert_equal expected, tweets
   end
 
+  it 'propagates URL query strings' do
+    scan = @index.scan(nil, { :q => 'author:pea53 || title:17' })
+
+    counts = {'tweet' => 0, 'book' => 0}
+    scan.each_document { |h| counts[h['_type']] += 1 }
+
+    assert_equal 50, counts['tweet']
+    assert_equal 1, counts['book']
+  end
+
   def populate!
     h = @index.bulk do |b|
       50.times { |num|

data/test/client/snapshot_test.rb

@@ -4,13 +4,17 @@ require File.expand_path('../../test_helper', __FILE__)
 describe Elastomer::Client::Snapshot do
   if es_version_1_x?
     before do
+      if !run_snapshot_tests?
+        skip "To enable snapshot tests, add a path.repo setting to your elasticsearch.yml file."
+      end
+
       @index_name = 'elastomer-snapshot-test-index'
       @index = $client.index(@index_name)
       @name = 'elastomer-test'
     end
 
     after do
-      @index.delete if @index.exists?
+      @index.delete if @index && @index.exists?
     end
 
     it 'determines if a snapshot exists' do
@@ -99,7 +103,7 @@ describe Elastomer::Client::Snapshot do
       end
 
       after do
-        @restored_index.delete if @restored_index.exists?
+        @restored_index.delete if @restored_index && @restored_index.exists?
       end
 
       it 'restores snapshots with options' do

data/test/test_helper.rb

@@ -11,8 +11,6 @@ if ENV['COVERAGE'] == 'true'
   end
 end
 
-ENV['SNAPSHOT_DIR'] ||= '/tmp/elastomer-client-snapshot-test'
-
 require 'minitest/spec'
 require 'minitest/autorun'
 
@@ -92,12 +90,12 @@ def es_version_1_x?
 end
 
 # Elasticsearch 1.4 changed the response body for interacting with index
-# alaises. If an index does not contain any aliases, then an "alises" key is no
-# longer returned in the resopsne.
+# aliases. If an index does not contain any aliases, then an "aliases" key is no
+# longer returned in the response.
 #
-# Reeturns `true` if the response contains an "alises" key.
+# Returns `true` if the response contains an "aliases" key.
 def es_version_always_returns_aliases?
-  $client.semantic_version <= '1.4.0' ||
+  $client.semantic_version <  '1.4.0' ||
   $client.semantic_version >= '1.4.3'
 end
 
@@ -113,8 +111,40 @@ def es_version_supports_gateway_snapshots?
   $client.semantic_version <= '1.2.0'
 end
 
+# Elasticsearch 1.4.0 had a bug in its handling of the Mapping API where it
+# would not accept an Update request if the index had been created with the
+# _all field set to disabled. This bug was fixed in 1.4.1.
+#
+# See: https://github.com/elastic/elasticsearch/pull/8426
+def es_version_supports_update_mapping_with__all_disabled?
+  $client.semantic_version != '1.4.0'
+end
+
+# Elasticsearch 1.6 requires the repo.path setting when creating
+# FS repositories.
+def es_version_requires_repo_path?
+  $client.semantic_version >= '1.6.0'
+end
+
+def run_snapshot_tests?
+  unless defined? $run_snapshot_tests
+    begin
+      create_repo("elastomer-client-snapshot-test")
+      $run_snapshot_tests = true
+    rescue Elastomer::Client::Error => e
+      puts "Could not create a snapshot repo. Snapshot tests will be disabled."
+      puts "To enable snapshot tests, add a path.repo setting to your elasticsearch.yml file."
+      $run_snapshot_tests = false
+    ensure
+      delete_repo("elastomer-client-snapshot-test")
+    end
+  end
+  $run_snapshot_tests
+end
+
 def create_repo(name, settings = {})
-  default_settings = {:type => 'fs', :settings => {:location => ENV['SNAPSHOT_DIR']}}
+  location = File.join(*[ENV['SNAPSHOT_DIR'], name].compact)
+  default_settings = {:type => 'fs', :settings => {:location => location}}
   $client.repository(name).create(default_settings.merge(settings))
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Elasticsearch