elastomer-client 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7db106056a2ea4d14012e82621bc4c4073c85c15
-  data.tar.gz: ed047e4e19b8f45e7c553998cb0935ea59c1a94e
+  metadata.gz: 149f340281bffddc3fac2a8a783890725da2ee30
+  data.tar.gz: e25c7f445e3002c6c751fca4119e7abc6311885b
 SHA512:
-  metadata.gz: cb92e602580ce508195626093783510df3320ba20416cac7c879fcf80839ce87fbb64dd0af7c8f37b0a2775cf9f0c3d603a692251b8ab9c7c87bcfe867b955a4
-  data.tar.gz: 423da9494641de0a33a90dc26fdae67564469291a1120202015a5f9daecab22da06bbbf9c1e351a41a825b031563e90066ba9585b483d5c257ad3044c64ba449
+  metadata.gz: b738a0e0c1ee712fcdd2143996415b419203fc55c692e38d0ccc8c44caa0795f843e8da880a6ea4b4d346f65bdfbfcd6cd45c57db7d7fa00387c467cb0d3c36f
+  data.tar.gz: 3622c6b76c88e224f38587acd480f3bb2875abfe15e2a29ba7c00c1ea12c1166c1ef8522d93425e1a44b078f9a0d8515446a4682a4923787cb165a03c2f75228

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.0.1 (2017-12-20)
+- Fixed argument passing to `app_delete_by_query`
+- Explicitly close scroll search contexts when scroll is complete
+
 ## 3.0.0 (2017-12-15)
 - Fixed swapped args in {Client,Index}#multi\_percolate count calls using block API
 - Support for Elasticsearch 5.x

data/lib/elastomer/client/app_delete_by_query.rb

@@ -53,30 +53,6 @@ module Elastomer
 
     class AppDeleteByQuery
 
-      SEARCH_PARAMETERS = %i[
-        index
-        type
-        q
-        df
-        analyzer
-        analyze_wildcard
-        batched_reduce_size
-        default_operator
-        lenient
-        explain
-        _source
-        stored_fields
-        sort
-        track_scores
-        timeout
-        terminate_after
-        from
-        size
-        search_type
-        scroll
-      ].to_set.freeze
-
-
       # Create a new DeleteByQuery command for deleting documents matching a
       # query
       #
@@ -132,7 +108,8 @@ module Elastomer
       # Returns a Hash of statistics about the bulk operation
       def execute
         ops = Enumerator.new do |yielder|
-          @client.scan(@query, search_params).each_document do |hit|
+          scan = @client.scan(@query, search_params)
+          scan.each_document do |hit|
             yielder.yield([:delete, hit.select { |key, _| ["_index", "_type", "_id", "_routing"].include?(key) }])
           end
         end
@@ -144,15 +121,24 @@ module Elastomer
 
       # Internal: Remove parameters that are not valid for the _search endpoint
       def search_params
-        params = @params.merge(:_source => false)
-        params.select {|p, _| SEARCH_PARAMETERS.include? p}
+        return @search_params if defined?(@search_params)
+
+        @search_params = @params.merge(_source: false)
+        @search_params.delete(:action_count)
+        @search_params
       end
 
       # Internal: Remove parameters that are not valid for the _bulk endpoint
       def bulk_params
-        @params.clone.tap { |p| p.delete(:q) }
+        return @bulk_params if defined?(@bulk_params)
+
+        @bulk_params = @params.dup
+        return @bulk_params if @bulk_params.nil?
+
+        @bulk_params.delete(:q)
+        @bulk_params
       end
 
-    end  # AppDeleteByQuery
-  end  # Client
-end  # Elastomer
+    end
+  end
+end

data/lib/elastomer/client/scroller.rb

@@ -135,11 +135,11 @@ module Elastomer
       query.merge(:sort => [:_doc])
     end
 
-  DEFAULT_OPTS = {
-      :index => nil,
-      :type => nil,
-      :scroll => "5m",
-      :size => 50,
+    DEFAULT_OPTS = {
+      index:   nil,
+      type:    nil,
+      scroll:  "5m",
+      size:    50,
     }.freeze
 
     class Scroller
@@ -151,7 +151,7 @@ module Elastomer
       # and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-search-type.html#scan
       #
       # client - Elastomer::Client used for HTTP requests to the server
-      # query  - The query to scan as a Hash or a JSON encoded String
+      # query  - The query to scroll as a Hash or a JSON encoded String
       # opts   - Options Hash
       #   :index       - the name of the index to search
       #   :type        - the document type to search
@@ -194,7 +194,7 @@ module Elastomer
       #     hits['hits'].each { |document| ... }
       #   end
       #
-      # Returns this Scan instance.
+      # Returns this Scroller instance.
       def each
         loop do
           body = do_scroll
@@ -209,6 +209,8 @@ module Elastomer
         end
 
         self
+      ensure
+        clear!
       end
 
       # Iterate over each document from the scan query. This method is just a
@@ -227,11 +229,24 @@ module Elastomer
       #     document['_source']
       #   end
       #
-      # Returns this Scan instance.
+      # Returns this Scroller instance.
       def each_document( &block )
         each { |hits| hits["hits"].each(&block) }
       end
 
+      # Terminate the scroll query. This will remove the search context from the
+      # cluster and no further documents can be returned by this Scroller
+      # instance.
+      #
+      # Returns nil if the `scroll_id` is not valid; returns the reponse body if
+      # the `scroll_id` was cleared.
+      def clear!
+        return if scroll_id.nil?
+        client.clear_scroll(scroll_id)
+      rescue ::Elastomer::Client::IllegalArgument
+        nil
+      end
+
       # Internal: Perform the actual scroll requests. This method wil call out
       # to the `Client#start_scroll` and `Client#continue_scroll` methods while
       # keeping track of the `scroll_id` internally.

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 
   def self.version
     VERSION

data/lib/elastomer/version_support.rb

@@ -70,6 +70,17 @@ module Elastomer
       end
     end
 
+    # COMPATIBILITY: return a simple boolean value or legacy {"enabled": true/false}.
+    #
+    # https://www.elastic.co/guide/en/elasticsearch/reference/5.5/breaking_50_mapping_changes.html#_literal_norms_literal
+    def strict_boolean(b)
+      if es_version_2_x?
+        {enabled: b}
+      else
+        b
+      end 
+    end
+
     # Elasticsearch 2.0 changed some request formats in a non-backward-compatible
     # way. Some tests need to know what version is running to structure requests
     # as expected.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -317,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Elasticsearch