elastomer-client 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 739a7083a0d3f2499f70d7940e067caf82584f63
-  data.tar.gz: 97f9ba36db36aa1da06f9648962b9f80d76e5e1b
+  metadata.gz: ee5ef212d2d3fefeef8794a4b25901237a989ded
+  data.tar.gz: 3434bb50acbebd5cf4a8d98a2bff8e2fe8863dd8
 SHA512:
-  metadata.gz: c914b6adc53461678ee18f84b83856e241f2af4de326514c191c5898a53580e91f947cc74bcad6f95d9b3e71093e017efc815e5d1992b07b5d03e3856e7f24df
-  data.tar.gz: 5d43ee3e85f1ba7a18ec0772d7a9b0935070549f1484c3aa5a8941d611963dbb265ec7034629633f50582821849152df3d8e7e79dd0e1c72ac5bb87b3a7185ea
+  metadata.gz: 92a3b002a675a1937360c01670df306e91af406b7bed2402f08094bf4e077d81cee56f961287ea38b702c5f0f0d994d77a4a55efe34261d47e9b5bf62d4e49f7
+  data.tar.gz: '02297cdcb7c4305b2d9e5e20edb7ac9247ba4f0daae03feec88c09621257d57adc5b482e9ea405cc01f7a515486898eb21f97dcb747d853fb2700ab585f93e94'

data/lib/elastomer/client.rb

@@ -33,11 +33,14 @@ module Elastomer
     #   :max_retries      - the maximum number of request retires (defaults to 0)
     #   :retry_delay      - delay in seconds between retries (defaults to 0.075)
     #   :strict_params    - set to `true` to raise exceptions when invalid request params are used
+    #   :es_version       - set to the Elasticsearch version (example: "5.6.6") to avoid an HTTP request to get the version.
+    #   :compress_body    - set to true to enable request body compression (default: false)
+    #   :compression      - The compression level (0-9) when request body compression is enabled (default: Zlib::DEFAULT_COMPRESSION)
     #
     def initialize(host: "localhost", port: 9200, url: nil,
                    read_timeout: 5, open_timeout: 2, max_retries: 0, retry_delay: 0.075,
                    opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE,
-                   strict_params: false)
+                   strict_params: false, es_version: nil, compress_body: false, compression: Zlib::DEFAULT_COMPRESSION)
 
       @url = url || "http://#{host}:#{port}"
 
@@ -53,12 +56,18 @@ module Elastomer
       @opaque_id        = opaque_id
       @max_request_size = max_request_size
       @strict_params    = strict_params
+      @es_version       = es_version
+      @compress_body    = compress_body
+      @compression      = compression
     end
 
     attr_reader :host, :port, :url
     attr_reader :read_timeout, :open_timeout
     attr_reader :max_retries, :retry_delay, :max_request_size
     attr_reader :strict_params
+    attr_reader :es_version
+    attr_reader :compress_body
+    attr_reader :compression
     alias :strict_params? :strict_params
 
     # Returns a duplicate of this Client connection configured in the exact same
@@ -84,6 +93,8 @@ module Elastomer
 
     # Returns the version String of the attached Elasticsearch instance.
     def version
+      return es_version unless es_version.nil?
+
       @version ||= begin
         response = get "/"
         response.body.dig("version", "number")
@@ -120,6 +131,7 @@ module Elastomer
         conn.request(:encode_json)
         conn.request(:opaque_id) if @opaque_id
         conn.request(:limit_size, max_request_size: max_request_size) if max_request_size
+        conn.request(:elastomer_compress, compression: compression) if compress_body
 
         if @adapter.is_a?(Array)
           conn.adapter(*@adapter)

data/lib/elastomer/middleware/compress.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require "stringio"
+
+module Elastomer
+  module Middleware
+    # Request middleware that compresses request bodies with GZip for supported
+    # versions of Elasticsearch.
+    #
+    # It will only compress when there is a request body that is a String. This
+    # middleware should be inserted after JSON serialization.
+    class Compress < Faraday::Middleware
+      CONTENT_ENCODING = "Content-Encoding"
+      GZIP = "gzip"
+      # An Ethernet packet can hold 1500 bytes. No point in compressing anything smaller than that (plus some wiggle room).
+      MIN_BYTES_FOR_COMPRESSION = 1400
+
+      attr_reader :compression
+
+      # options - The Hash of "keyword" arguments.
+      #           :compression - the compression level (0-9, default Zlib::DEFAULT_COMPRESSION)
+      def initialize(app, options = {})
+        super(app)
+        @compression = options[:compression] || Zlib::DEFAULT_COMPRESSION
+      end
+
+      def call(env)
+        if body = env[:body]
+          if body.is_a?(String) && body.bytesize > MIN_BYTES_FOR_COMPRESSION
+            output = StringIO.new
+            output.set_encoding("BINARY")
+            gz = Zlib::GzipWriter.new(output, compression, Zlib::DEFAULT_STRATEGY)
+            gz.write(env[:body])
+            gz.close
+            env[:body] = output.string
+            env[:request_headers][CONTENT_ENCODING] = GZIP
+          end
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(elastomer_compress: ::Elastomer::Middleware::Compress)

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "3.1.2"
+  VERSION = "3.1.3"
 
   def self.version
     VERSION

data/lib/elastomer/version_support.rb

@@ -161,6 +161,11 @@ module Elastomer
       end
     end
 
+    # ES 5.X supports GZip-compressed request bodies, but ES 2.4 doesn't?
+    def supports_gzip?
+      es_version_5_x?
+    end
+
     private
 
     # Internal: Helper to reject arguments that shouldn't be passed because

data/test/client_test.rb

@@ -171,6 +171,15 @@ describe Elastomer::Client do
       assert_match(/[\d\.]+/, $client.version)
     end
 
+    it "does not make an HTTP request for version if it is provided at create time" do
+      request = stub_request(:get, "#{$client.url}/")
+
+      client = Elastomer::Client.new $client_params.merge(es_version: "5.6.6")
+      assert_equal "5.6.6", client.version
+
+      assert_not_requested request
+    end
+
     it "gets semantic version" do
       version_string = $client.version
       assert_equal Semantic::Version.new(version_string), $client.semantic_version

data/test/test_helper.rb

@@ -43,6 +43,17 @@ raise "No server available at #{$client.url}" unless $client.available?
 
 puts "Elasticsearch version is #{$client.version}"
 
+# COMPATIBILITY
+# Returns true if the Elasticsearch cluster defaults to supporting compression.
+def supports_compressed_bodies_by_default?
+  $client.version_support.es_version_5_x?
+end
+
+# Now that we have the version, re-create the client with compression if supported.
+if supports_compressed_bodies_by_default?
+  $client = Elastomer::Client.new $client_params.merge(compress_body: true)
+end
+
 # remove any lingering test indices from the cluster
 MiniTest.after_run do
   $client.cluster.indices.keys.each do |name|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -275,6 +275,7 @@ files:
 - lib/elastomer/client/template.rb
 - lib/elastomer/client/warmer.rb
 - lib/elastomer/core_ext/time.rb
+- lib/elastomer/middleware/compress.rb
 - lib/elastomer/middleware/encode_json.rb
 - lib/elastomer/middleware/limit_size.rb
 - lib/elastomer/middleware/opaque_id.rb