bunny 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b498f37cb4c91500ac5b66e0abeb8d650112b2e
-  data.tar.gz: 4edc1a872bc9806c64ab1d8307c9730af9edada0
+  metadata.gz: bddad506ff3cf646d188ee710760ba6264f892e2
+  data.tar.gz: 8633350680a481c8244acc6c847994e087f0d278
 SHA512:
-  metadata.gz: 76f472696876ab6912b0244a1c234bea819d1538d6483156eb7ba9f099eac7fcc2437320c1a1e7ccde887ba2a42fd871d5a472d7499b4744d44b9d2449f4fd98
-  data.tar.gz: 5f2d9d2743555ac1f147b0887b0e989741bbcc9b559ef5354dc929374bf6e4ab63ee9ef82c3f64a62244b43b23c2c3c209f9b828fff58c45099ef89f68f474a3
+  metadata.gz: c38e6e5ba79c33cd79bc2e8fea5c2be0a1f23dce82816e3962f22965f6e98ac51ff30aad75c6f59e8fc165629878dc00d83cf74fdba51deb4bbe7b0874f34bcb
+  data.tar.gz: ca7f75991cec9ffa875c5e8a8870cba2e94433d63fe253971b21c0b3201a555046b0a6e68a416248b8c4ccdded30dc2aed2ed8e875fcec6a0960c8c142b5a766

data/CONTRIBUTING.md

@@ -39,7 +39,8 @@ running a RabbitMQ server in a Docker container.
 
 #### Using a locally installed RabbitMQ server
 
-Run the following command from the base directory of the gem:
+It is possible to start a local RabbitMQ node from the repository root. It is not necessarily
+optimal but can be a good starting point but is a useful example:
 
 ```
 RABBITMQ_NODENAME=bunny RABBITMQ_CONFIG_FILE=./spec/config/rabbitmq RABBITMQ_ENABLED_PLUGINS_FILE=./spec/config/enabled_plugins rabbitmq-server
@@ -51,10 +52,17 @@ these. TLS (x509 PEM) certificates include a hostname-specific fields,
 the tests allow for expecting hostname overriding using the `BUNNY_RABBITMQ_HOSTNAME`
 environment variables (default value is `127.0.0.1`).
 
-Server, CA and client certificates can be found under `spec/tls`.
-The location can be overridden via the `BUNNY_CERTIFICATE_DIR` environment variable.
+By default there's a set of CA, server, and client certificates pre-generated at `spec/tls`. Since x509 certificates
+contain a hardcoded CN and your hostname is unlikely to match it,
+the location can be overridden via the `BUNNY_CERTIFICATE_DIR` environment variable.
 It is supposed to target [tls-gen](https://github.com/michaelklishin/tls-gen)'s basic profile
-output (result) directory on the host where specs are to be executed.
+output (result) directory on the host where specs are to be executed. Combine it with `BUNNY_RABBITMQ_HOSTNAME`
+when running TLS connection tests:
+
+```
+BUNNY_CERTIFICATE_DIR="/path/to/tls-gen/basic/result" BUNNY_RABBITMQ_HOSTNAME="mayflower" bundle exec rspec
+
+```
 
 Next up you'll need to prepare your node for the specs (just once):
 
@@ -104,8 +112,8 @@ Make sure you have those two installed and then run integration tests:
 
 It is possible to run all tests:
 
-    bundle exec rspec -c
+    bundle exec rspec
 
 It is possible to run only integration and regression tests but exclude unit and stress tests:
 
-    CI=true bundle exec rspec -c spec/higher_level_api/ spec/lower_level_api spec/issues && bundle exec rspec -c spec/higher_level_api/integration/connection_recovery_spec.rb
+    CI=true bundle exec rspec spec/higher_level_api/ spec/lower_level_api spec/issues spec/higher_level_api/integration/connection_recovery_spec.rb

data/ChangeLog.md

@@ -1,19 +1,18 @@
-## Changes between Bunny 2.8.1 and 2.8.2 (unreleased)
+## Changes between Bunny 2.8.0 and 2.9.0 (Jan 8th, 2018)
 
-No changes yet.
+### Ruby 2.2 Requirement
 
+Bunny now requires Ruby 2.2.
 
 
-## Changes between Bunny 2.8.0 and 2.8.1 (Jan 9th, 2018)
+### Support for Additional URI Query Parameters
 
-### amq-protocol Dependency
+GitHub issue: [#534](https://github.com/ruby-amqp/bunny/pull/534).
 
-This version depends on amq-protocol `2.2.x`.
+Contributed by Andrew Babichev.
 
-GitHub issue: [#538](https://github.com/ruby-amqp/bunny/issues/538).
 
-
-## Changes between Bunny 2.7.0 and 2.8.0 (Dec 18th, 2017)
+## Changes between Bunny 2.7.0 and 2.8.0 (Dec 18th, 2018)
 
 This release has **minor breaking public API changes**.
 
@@ -32,7 +31,7 @@ A JRuby 9K compatibility issue was corrected by Marian Posăceanu.
 Note that JRuby users are recommended to use [March Hare](http://rubymarchhare.info/), a JRuby-oriented client, instead
 of Bunny.
 
-GitHub issue: [bunny#529](https://github.com/ruby-amqp/bunny/pull/529)
+GitHub issue: [#529](https://github.com/ruby-amqp/bunny/pull/529)
 
 ### Connection Exceptions are Logged as Warning with Automatic Recovery
 
@@ -41,7 +40,7 @@ and not errors.
 
 Contributed by Merten Falk.
 
-GitHub issue: [bunny#531](https://github.com/ruby-amqp/bunny/pull/531)
+GitHub issue: [#531](https://github.com/ruby-amqp/bunny/pull/531)
 
 ### Server Heartbeat Value as a String
 
@@ -50,7 +49,7 @@ a symbol. This makes it easier to load settings from YAML files.
 
 Contributed by Tyrone Wilson.
 
-GitHub issue: [bunny#524](https://github.com/ruby-amqp/bunny/pull/524)
+GitHub issue: [#524](https://github.com/ruby-amqp/bunny/pull/524)
 
 
 ## Changes between Bunny 2.7.0 and 2.7.1 (Sep 25th, 2017)

data/Gemfile

@@ -33,7 +33,7 @@ end
 
 group :test do
   gem "rspec", "~> 3.5.0"
-  gem "rabbitmq_http_api_client", "~> 1.9.1"
+  gem "rabbitmq_http_api_client", "~> 1.9.1", require: "rabbitmq/http/client"
 end
 
 gemspec
@@ -43,11 +43,11 @@ gemspec
 def custom_gem(name, options = Hash.new)
   local_path = File.expand_path("../vendor/#{name}", __FILE__)
   if File.exist?(local_path)
-    # puts "Using #{name} from #{local_path}..."
+    puts "Using #{name} from #{local_path}..."
     gem name, options.merge(:path => local_path).delete_if { |key, _| [:git, :branch].include?(key) }
   else
     gem name, options
   end
 end
 
-custom_gem "amq-protocol", "~> 2.2.0"
+custom_gem "amq-protocol", git: "https://github.com/ruby-amqp/amq-protocol", branch: "master"

data/README.md

@@ -88,7 +88,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.7.2"
+gem "bunny", ">= 2.8.0"
 ```
 
 

data/bunny.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.summary = "Popular easy to use Ruby client for RabbitMQ"
   s.description = "Easy to use, feature complete Ruby client for RabbitMQ 3.3 and later versions."
   s.license = "MIT"
-  s.required_ruby_version = Gem::Requirement.new(">= 2.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2")
 
   # Sorted alphabetically.
   s.authors = [
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.email = ["michael.s.klishin@gmail.com"]
 
   # Dependencies
-  s.add_dependency "amq-protocol", "~> 2.2.0"
+  s.add_dependency "amq-protocol", ">= 2.2.0"
 
   # Files.
   s.has_rdoc = true

data/docker-compose.yml

@@ -5,6 +5,8 @@ services:
     container_name: bunny_rabbitmq
     environment:
       RABBITMQ_NODENAME: bunny
+      # see CONTRIBUTING.md
+      BUNNY_RABBITMQ_HOSTNAME: mercurio
       # link to spec specific configuration
       RABBITMQ_CONFIG_FILE: /spec/config/rabbitmq
       RABBITMQ_ENABLED_PLUGINS_FILE: /spec/config/enabled_plugins

data/docker/docker-entrypoint.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 server=rabbitmq-server
 ctl=rabbitmqctl
-delay=3
+delay=5
 
 echo "[Configuration] $(eval cat $RABBITMQ_CONFIG_FILE.config)"
 

data/lib/bunny/session.rb

@@ -464,7 +464,7 @@ module Bunny
     # @param [String] uri amqp or amqps URI to parse
     # @return [Hash] Parsed URI as a hash
     def self.parse_uri(uri)
-      AMQ::Settings.parse_amqp_url(uri)
+      AMQ::Settings.configure(uri)
     end
 
     # Checks if a queue with given name exists.
@@ -742,7 +742,7 @@ module Bunny
     rescue HostListDepleted
       reset_address_index
       retry
-    rescue TCPConnectionFailedForAllHosts, TCPConnectionFailed, AMQ::Protocol::EmptyResponseError, SystemCallError => e
+    rescue TCPConnectionFailedForAllHosts, TCPConnectionFailed, AMQ::Protocol::EmptyResponseError, SystemCallError, Timeout::Error => e
       @logger.warn "TCP connection failed, reconnecting in #{@network_recovery_interval} seconds"
       if should_retry_recovery?
         decrement_recovery_attemp_counter!

data/lib/bunny/transport.rb

@@ -26,7 +26,7 @@ module Bunny
     DEFAULT_WRITE_TIMEOUT = 30.0
 
     attr_reader :session, :host, :port, :socket, :connect_timeout, :read_timeout, :write_timeout, :disconnect_timeout
-    attr_reader :tls_context
+    attr_reader :tls_context, :verify_peer, :tls_ca_certificates, :tls_certificate_path, :tls_key_path
 
     attr_writer :read_timeout
 
@@ -298,17 +298,21 @@ module Bunny
     protected
 
     def tls_enabled?(opts)
-      return opts[:tls] unless opts[:tls].nil?
-      return opts[:ssl] unless opts[:ssl].nil?
+      return !!opts[:tls] unless opts[:tls].nil?
+      return !!opts[:ssl] unless opts[:ssl].nil?
       (opts[:port] == AMQ::Protocol::TLS_PORT) || false
     end
 
+    def tls_ca_certificates_paths_from(opts)
+      Array(opts[:cacertfile] || opts[:tls_ca_certificates] || opts[:ssl_ca_certificates])
+    end
+
     def tls_certificate_path_from(opts)
-      opts[:tls_cert] || opts[:ssl_cert] || opts[:tls_cert_path] || opts[:ssl_cert_path] || opts[:tls_certificate_path] || opts[:ssl_certificate_path]
+      opts[:certfile] || opts[:tls_cert] || opts[:ssl_cert] || opts[:tls_cert_path] || opts[:ssl_cert_path] || opts[:tls_certificate_path] || opts[:ssl_certificate_path]
     end
 
     def tls_key_path_from(opts)
-      opts[:tls_key] || opts[:ssl_key] || opts[:tls_key_path] || opts[:ssl_key_path]
+      opts[:keyfile] || opts[:tls_key] || opts[:ssl_key] || opts[:tls_key_path] || opts[:ssl_key_path]
     end
 
     def tls_certificate_from(opts)
@@ -337,7 +341,7 @@ module Bunny
     end
 
     def prepare_tls_context(opts)
-      if (opts[:verify_ssl] || opts[:verify_peer]).nil?
+      if (opts[:verify_ssl] || opts[:verify_peer] || opts[:verify]).nil?
         opts[:verify_peer] = true
       end
 
@@ -349,12 +353,23 @@ module Bunny
       @tls_key               = tls_key_from(opts)
       @tls_certificate_store = opts[:tls_certificate_store]
 
-      @tls_ca_certificates   = opts.fetch(:tls_ca_certificates, default_tls_certificates)
-      @verify_peer           = (opts[:verify_ssl] || opts[:verify_peer])
+      @tls_ca_certificates   = tls_ca_certificates_paths_from(opts) || default_tls_certificates
+      @verify_peer           = as_boolean(opts[:verify_ssl] || opts[:verify_peer] || opts[:verify])
 
       @tls_context = initialize_tls_context(OpenSSL::SSL::SSLContext.new, opts)
     end
 
+    def as_boolean(val)
+      case val
+      when true    then true
+      when false   then false
+      when "true"  then true
+      when "false" then false
+      else
+        !!val
+      end
+    end
+
     def wrap_in_tls_socket(socket)
       raise ArgumentError, "cannot wrap nil into TLS socket, @tls_context is nil. This is a Bunny bug." unless socket
       raise "cannot wrap a socket into TLS socket, @tls_context is nil. This is a Bunny bug." unless @tls_context

data/lib/bunny/version.rb

@@ -2,5 +2,5 @@
 
 module Bunny
   # @return [String] Version of the library
-  VERSION = "2.8.1"
+  VERSION = "2.9.0"
 end

data/spec/higher_level_api/integration/connection_spec.rb

@@ -1,5 +1,9 @@
 require "spec_helper"
 
+def local_hostname
+  ENV.fetch("BUNNY_RABBITMQ_HOSTNAME", "127.0.0.1")
+end
+
 describe Bunny::Session do
   let(:port)     { AMQ::Protocol::DEFAULT_PORT }
   let(:username) { "guest" }
@@ -319,9 +323,9 @@ describe Bunny::Session do
           password: "bunny_password",
           vhost: "bunny_testbed",
           ssl:                 true,
-          ssl_cert:            "spec/tls/client_cert.pem",
+          ssl_cert:            "spec/tls/client_certificate.pem",
           ssl_key:             "spec/tls/client_key.pem",
-          ssl_ca_certificates: ["./spec/tls/cacert.pem"])
+          ssl_ca_certificates: ["./spec/tls/ca_certificate.pem"])
       end
 
       it "uses TLS port" do

data/spec/higher_level_api/integration/tls_connection_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 unless ENV["CI"]
-  CERTIFICATE_DIR=ENV.fetch("BUNNY_CERTIFICATE_DIR", "./spec/tls")
+  CERTIFICATE_DIR = ENV.fetch("BUNNY_CERTIFICATE_DIR", "./spec/tls")
   puts "Will use certificates from #{CERTIFICATE_DIR}"
 
   shared_examples_for "successful TLS connection" do
@@ -40,14 +40,16 @@ unless ENV["CI"]
 
   context "initialized with :tls => true" do
     let(:subject) do
-      Bunny.new(:user     => "bunny_gem",
-        :password => "bunny_password",
-        :vhost    => "bunny_testbed",
-        :tls                   => true,
-        :verify_peer           => verify_peer,
-        :tls_cert              => "#{CERTIFICATE_DIR}/client_certificate.pem",
-        :tls_key               => "#{CERTIFICATE_DIR}/client_key.pem",
-        :tls_ca_certificates   => ["#{CERTIFICATE_DIR}/ca_certificate.pem"])
+      Bunny.new(
+        hostname:  local_hostname(),
+        user:     "bunny_gem",
+        password: "bunny_password",
+        vhost:    "bunny_testbed",
+        tls: true,
+        verify_peer: verify_peer,
+        tls_cert: "#{CERTIFICATE_DIR}/client_certificate.pem",
+        tls_key: "#{CERTIFICATE_DIR}/client_key.pem",
+        tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"])
     end
 
     context "peer verification is off" do
@@ -79,7 +81,9 @@ unless ENV["CI"]
 
   describe "TLS connection to RabbitMQ with client certificates" do
     let(:subject) do
-      c = Bunny.new(username: "bunny_gem",
+      c = Bunny.new(
+        hostname: local_hostname(),
+        username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
@@ -101,7 +105,9 @@ unless ENV["CI"]
 
   describe "TLS connection to RabbitMQ without client certificates" do
     let(:subject) do
-      c = Bunny.new(username: "bunny_gem",
+      c = Bunny.new(
+        hostname: local_hostname(),
+        username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
@@ -121,7 +127,7 @@ unless ENV["CI"]
 
   describe "TLS connection to RabbitMQ with a connection string" do
     let(:subject) do
-      c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname}/bunny_testbed",
+      c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname()}/bunny_testbed",
         tls_cert: "#{CERTIFICATE_DIR}/client_certificate.pem",
         tls_key: "#{CERTIFICATE_DIR}/client_key.pem",
         tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
@@ -135,12 +141,28 @@ unless ENV["CI"]
     end
 
     include_examples "successful TLS connection"
+
+    context "when URI contains query parameters" do
+      subject(:session) do
+        Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname()}/bunny_testbed?heartbeat=10&connection_timeout=100&channel_max=1000&verify=false&cacertfile=#{CERTIFICATE_DIR}/ca_certificate.pem&certfile=#{CERTIFICATE_DIR}/client_certificate.pem&keyfile=#{CERTIFICATE_DIR}/client_key.pem")
+      end
+
+      it "parses extra connection parameters" do
+        session.start
+
+        expect(session.uses_tls?).to eq(true)
+        expect(session.transport.verify_peer).to eq(false)
+        expect(session.transport.tls_ca_certificates).to eq(["#{CERTIFICATE_DIR}/ca_certificate.pem"])
+        expect(session.transport.tls_certificate_path).to eq("#{CERTIFICATE_DIR}/client_certificate.pem")
+        expect(session.transport.tls_key_path).to eq("#{CERTIFICATE_DIR}/client_key.pem")
+      end
+    end
   end
 
 
   describe "TLS connection to RabbitMQ with a connection string and w/o client certificate and key" do
     let(:subject) do
-      c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname}/bunny_testbed",
+      c = Bunny.new("amqps://bunny_gem:bunny_password@#{local_hostname()}/bunny_testbed",
         tls_ca_certificates: ["#{CERTIFICATE_DIR}/ca_certificate.pem"],
         verify_peer: verify_peer)
       c.start
@@ -177,7 +199,9 @@ unless ENV["CI"]
 
   describe "TLS connection to RabbitMQ with client certificates provided inline" do
     let(:subject) do
-      c = Bunny.new(username: "bunny_gem",
+      c = Bunny.new(
+        hostname: local_hostname(),
+        username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,
@@ -198,7 +222,9 @@ unless ENV["CI"]
 
   describe "TLS connection to RabbitMQ with tls_version TLSv1.1 specified" do
     let(:subject) do
-      c = Bunny.new(username: "bunny_gem",
+      c = Bunny.new(
+        hostname: local_hostname(),
+        username: "bunny_gem",
         password: "bunny_password",
         vhost: "bunny_testbed",
         tls: true,

data/spec/spec_helper.rb

@@ -3,15 +3,10 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
 require 'bundler'
-Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
 
-
-require "effin_utf8"
 require "bunny"
-require "rabbitmq/http/client"
-
 
-require "amq/protocol/version"
 puts "Using Ruby #{RUBY_VERSION}, amq-protocol #{AMQ::Protocol::VERSION}"
 
 module RabbitMQ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.8.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,20 +12,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
 description: Easy to use, feature complete Ruby client for RabbitMQ 3.3 and later
@@ -224,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="