bunny 2.16.1 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a05191f06bd28c3c4714a67c70a5097341f7d07961cb97df83ad5414a0e541
-  data.tar.gz: 3521b4979e62eb7a5d6c1f54cb5a17cbda33706f696288ec2c8a0ee0397c3ddf
+  metadata.gz: 3f3ba4a5565a42eace00f8789c1be953871d9dc57d42028a94a9dd70a586271e
+  data.tar.gz: c7d2fdf832b466a27c7ae884e6195729d31a6bf1cb6accde9818c2f72b46cdc6
 SHA512:
-  metadata.gz: 54314055b9f79e3c334d461f0a63f17fa50e7fe0b39fa71a9314b194db02a8416a057e66123f8b2d7d13353b69f018799a785dd59ea54eeea3d882ec8511b650
-  data.tar.gz: 9721730e57e5da633568b859f8df0feada37d4303b94f68e78d6a291d0d9d2e6409fa5a7fdcbb59ea5cb5a557c04e750ec7a1098496ab439bd2077b260ea4c3c
+  metadata.gz: 26a352492ca652429975e45ec36fad12ebfd3c94e66babb879afb0f09dcec0158affc820f8a29fd07a25d8db6ac9312fd31ebc5b1a3d4c315ecfeeb880a5a8f2
+  data.tar.gz: 393fa99fb87c7784eccd0f5019fe3668b39064e15935d85f4134c85aa6b138849d0026addb814f49d00f606b9157b78878863c875d2ad6480b17b3053dcb98fb

data/ChangeLog.md

@@ -1,8 +1,35 @@
-## Changes between Bunny 2.16.0 and 2.17.0 (undefined)
+## Changes between Bunny 2.17.x and 2.18.0 (in development)
 
 No changes yet.
 
 
+## Changes between Bunny 2.16.x and 2.17.0 (Sep 11th, 2020)
+
+### Easier to Specify a Client-Propvided Connection Name
+
+It is now easier to provide a client-provided (custom) connection
+name that will be displayed in the RabbitMQ management UI and mentioned in
+[server logs](https://www.rabbitmq.com/logging.html).
+
+Instead of
+
+``` ruby
+conn = Bunny.new(client_properties: {connection_name: 'app ABC #{rand}'})
+conn.start
+```
+
+a new top-level connection option now can be used:
+
+``` ruby
+conn = Bunny.new(connection_name: 'app ABC #{rand}')
+conn.start
+```
+
+Contributed by @brerx.
+
+GitHub issue: [ruby-amqp/bunny#600](https://github.com/ruby-amqp/bunny/pull/600)
+
+
 ## Changes between Bunny 2.15.0 and 2.16.0 (Aug 14th, 2020)
 
 ### Asynchronous Exception Delegate

data/README.md

@@ -43,12 +43,11 @@ Specific examples:
    Web applications that display that information in the real time.
 
 
-
 ## Supported Ruby Versions
 
 Modern Bunny versions support
 
- * CRuby 2.3 through 2.6 (inclusive)
+ * CRuby 2.3 through 2.7 (inclusive)
 
 Bunny works sufficiently well on JRuby but there are known
 JRuby bugs in versions prior to JRuby 9000 that cause high CPU burn. JRuby users should
@@ -71,10 +70,10 @@ a stable public API.
 Change logs per release series:
 
  * [master](https://github.com/ruby-amqp/bunny/blob/master/ChangeLog.md)
- * [2.14.x](https://github.com/ruby-amqp/bunny/blob/2.13.x-stable/ChangeLog.md)
+ * [2.16.x](https://github.com/ruby-amqp/bunny/blob/2.16.x-stable/ChangeLog.md)
+ * [2.15.x](https://github.com/ruby-amqp/bunny/blob/2.15.x-stable/ChangeLog.md)
+ * [2.14.x](https://github.com/ruby-amqp/bunny/blob/2.14.x-stable/ChangeLog.md)
  * [2.13.x](https://github.com/ruby-amqp/bunny/blob/2.13.x-stable/ChangeLog.md)
- * [2.12.x](https://github.com/ruby-amqp/bunny/blob/2.12.x-stable/ChangeLog.md)
- * [2.11.x](https://github.com/ruby-amqp/bunny/blob/2.11.x-stable/ChangeLog.md)
 
 
 
@@ -97,7 +96,7 @@ gem install bunny
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 2.14.1"
+gem "bunny", ">= 2.16.1"
 ```
 
 

data/lib/bunny/session.rb

@@ -89,6 +89,7 @@ module Bunny
     # @return [Integer] Timeout for blocking protocol operations (queue.declare, queue.bind, etc), in milliseconds. Default is 15000.
     attr_reader :continuation_timeout
     attr_reader :network_recovery_interval
+    attr_reader :connection_name
     attr_accessor :socket_configurator
 
     # @param [String, Hash] connection_string_or_opts Connection string or a hash of connection options
@@ -128,6 +129,7 @@ module Bunny
     #
     # @option optz [String] :auth_mechanism ("PLAIN") Authentication mechanism, PLAIN or EXTERNAL
     # @option optz [String] :locale ("PLAIN") Locale RabbitMQ should use
+    # @option optz [String] :connection_name (nil) Client-provided connection name, if any. Note that the value returned does not uniquely identify a connection and cannot be used as a connection identifier in HTTP API requests.
     #
     # @see http://rubybunny.info/articles/connecting.html Connecting to RabbitMQ guide
     # @see http://rubybunny.info/articles/tls.html TLS/SSL guide
@@ -198,7 +200,9 @@ module Bunny
       @client_heartbeat   = self.heartbeat_from(opts)
 
       client_props         = opts[:properties] || opts[:client_properties] || {}
+      @connection_name     = client_props[:connection_name] || opts[:connection_name]
       @client_properties   = DEFAULT_CLIENT_PROPERTIES.merge(client_props)
+                                                      .merge(connection_name: connection_name)
       @mechanism           = normalize_auth_mechanism(opts.fetch(:auth_mechanism, "PLAIN"))
       @credentials_encoder = credentials_encoder_for(@mechanism)
       @locale              = @opts.fetch(:locale, DEFAULT_LOCALE)

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/connection_spec.rb

@@ -560,4 +560,30 @@ describe Bunny::Session do
       described_class.new(logger: logger)
     end
   end
+
+  context "initialized with a custom connection name" do
+    it "uses provided connection name with default connection string" do
+      conn = Bunny.new(connection_name: 'test_name')
+
+      expect(conn.connection_name).to eq 'test_name'
+    end
+
+    it "uses provided connection name from client property hash" do
+      conn = Bunny.new(client_properties: {connection_name: 'cp/test_name'})
+
+      expect(conn.connection_name).to eq 'cp/test_name'
+    end
+
+    it "uses provided connection name with custom connection string" do
+      conn = Bunny.new('amqp://guest:guest@rabbitmq:5672', connection_name: 'test_name3')
+
+      expect(conn.connection_name).to eq 'test_name3'
+    end
+
+    it "uses provided connection name with hash options" do
+      conn = Bunny.new(user: 'user', password: 'p455w0rd', connection_name: 'test_name4')
+
+      expect(conn.connection_name).to eq 'test_name4'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.16.1
+  version: 2.17.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol