bunny 1.0.7 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 644fb83ebe90f39169723ddefd72ec581e7e055f
-  data.tar.gz: f359455c828d498288f5a1ac5aa1a34d008e6982
+SHA256:
+  metadata.gz: 20682c9d4288b25e0aec7dcf5ad54276c7494faa45da1101eeedafa4f0f52abf
+  data.tar.gz: e88c87ecce0902f284a2bf54540c322afd3ac4c1fa625fb109d08d325a4faafa
 SHA512:
-  metadata.gz: 8ed7e1beffc8b2c86a509009664d9a648cd65afca1c4eebb2d049a157664135d53082a8032ce84373a505d2f964a042c117b46d16f106ee09ba6bbe71bbb0969
-  data.tar.gz: ef055f07569c758663bd0ed0507430d94062b5d4ab7bae8258bc475d9945f775df0b8f74463fbb2044bd63a9a785509a976b37e2fa58d51e89221116c4ff262c
+  metadata.gz: 8c5668062269ae3be5c160a410432e712b110fc30f9fb6ddcde0c6ce14ddccc5c60e2c298eb21ce4a0512b4564f20833e4556e3d4532fd26918b674b4163ccb7
+  data.tar.gz: e621b5fd31913bf21d48380f0f8e198075f74e7bcec9c97feb17f32ae206b28551b87dd52c83640e72465afce98e12e5e611db940561ea9edbd3ef281f97169e

data/README.md

@@ -1,19 +1,19 @@
 # Bunny, a Ruby RabbitMQ Client
 
-Bunny is a synchronous RabbitMQ client that focuses on ease of use. It
-is feature complete, supports all RabbitMQ 3.0 features and does not
+Bunny is a RabbitMQ client that focuses on ease of use. It
+is feature complete, supports all recent RabbitMQ features and does not
 have any heavyweight dependencies.
 
 
 ## I Know What RabbitMQ and Bunny are, How Do I Get Started?
 
-[Right here](http://rubybunny.info/articles/getting_started.html)!
+[Right here](https://www.rabbitmq.com/getstarted.html)!
 
 
 ## What is Bunny Good For?
 
-One can use amqp gem to make Ruby applications interoperate with other
-applications (both Ruby and not). Complexity and size may vary from
+One can use Bunny to make Ruby applications interoperate with other
+applications (both built in Ruby and not). Complexity and size may vary from
 simple work queues to complex multi-stage data processing workflows that involve
 many applications built with all kinds of technologies.
 
@@ -43,56 +43,59 @@ Specific examples:
    Web applications that display that information in the real time.
 
 
-
 ## Supported Ruby Versions
 
-Bunny 0.9 and more recent versions support
+Modern Bunny versions support
 
- * CRuby 1.9.3, 1.9.2, 2.0.0, and 1.8.7
- * JRuby 1.7+
- * Rubinius 2.0+
+ * CRuby 3.2 through 3.4 (inclusive)
+ * [TruffleRuby](https://www.graalvm.org/ruby/)
 
+For environments that use TLS, Bunny expects Ruby installations to use a recent enough OpenSSL version that
+**includes support for [TLS 1.3](https://www.rabbitmq.com/docs/ssl#tls1.3)**.
 
-## Supported RabbitMQ Versions
+### JRuby
 
-Bunny `0.8.x` and later versions only support RabbitMQ 2.x and 3.x.
-Bunny `0.7.x` and earlier versions support RabbitMQ 1.x and 2.x.
+Bunny no longer supports JRuby.
 
+JRuby users should use [March Hare](http://rubymarchhare.info), which has a similar API
+and is built on top of the RabbitMQ Java client specifically for JRuby.
 
-## Project Maturity
 
-Bunny is a mature library (started in early 2009) library with
-a stable public API.
+## Supported RabbitMQ Versions
 
-Before version 0.9, **a lot** of functionality was missing.  Version
-0.9 can be considered to be "second birthday" for Bunny as it was
-rewritten from scratch with over a dozen of preview releases over the
-course of about a year.
+Modern Bunny releases target [currently community supported RabbitMQ release series](https://www.rabbitmq.com/release-information).
 
-We (the maintainers) made our best effort to keep the new version as
-backwards compatible as possible but within reason.
+The protocol implemented by Bunny was first introduced in RabbitMQ 2.0 and has evolved
+via extensions and with next to no breaking changes, so all key Bunny operations can be used with a wide range
+of RabbitMQ versions, accounting for the few potentially breaking changes they
+may introduce, e.g. the idempotency of `queue.delete` operations.
 
 
-## Installation & Bundler Dependency
+## Change Log
 
-### Most Recent Release
+[Change log](https://github.com/ruby-amqp/bunny/blob/main/ChangeLog.md).
 
-[![Gem Version](https://badge.fury.io/rb/bunny.png)](http://badge.fury.io/rb/bunny)
 
-### With Rubygems
+## Installation & Bundler Dependency
 
-To install Bunny with RubyGems:
+### Most Recent Release
 
-```
-gem install bunny
-```
+[![Gem Version](https://badge.fury.io/rb/bunny.svg)](http://badge.fury.io/rb/bunny)
 
 ### Bundler Dependency
 
 To use Bunny in a project managed with Bundler:
 
 ``` ruby
-gem "bunny", ">= 1.0.0.rc2"
+gem "bunny", ">= 2.23.0"
+```
+
+### With Rubygems
+
+To install Bunny with RubyGems:
+
+```
+gem install bunny
 ```
 
 
@@ -101,7 +104,7 @@ gem "bunny", ">= 1.0.0.rc2"
 Below is a small snippet that demonstrates how to publish
 and synchronously consume ("pull API") messages with Bunny.
 
-For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](http://rubybunny.info/articles/getting_started.html).
+For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](https://www.rabbitmq.com/tutorials/tutorial-one-ruby.html).
 
 ``` ruby
 require "bunny"
@@ -112,20 +115,31 @@ conn.start
 
 # open a channel
 ch = conn.create_channel
+ch.confirm_select
 
 # declare a queue
 q  = ch.queue("test1")
+q.subscribe(manual_ack: true) do |delivery_info, metadata, payload|
+  puts "This is the message: #{payload}"
+  # acknowledge the delivery so that RabbitMQ can mark it for deletion
+  ch.ack(delivery_info.delivery_tag)
+end
 
 # publish a message to the default exchange which then gets routed to this queue
 q.publish("Hello, everybody!")
 
-# fetch a message from the queue
-delivery_info, metadata, payload = q.pop
+# await confirmations from RabbitMQ, see
+# https://www.rabbitmq.com/publishers.html#data-safety for details
+ch.wait_for_confirms
 
-puts "This is the message: #{payload}"
+# give the above consumer some time consume the delivery and print out the message
+sleep 1
 
+puts "Done"
+
+ch.close
 # close the connection
-conn.stop
+conn.close
 ```
 
 
@@ -133,21 +147,33 @@ conn.stop
 
 ### Getting Started
 
-For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](http://rubybunny.info/articles/getting_started.html).
+For a 15 minute tutorial using more practical examples, see [Getting Started with RabbitMQ and Ruby using Bunny](https://github.com/ruby-amqp/bunny/blob/main/docs/guides/getting_started.md).
 
 ### Guides
 
-Other documentation guides are available at [rubybunny.info](http://rubybunny.info):
+Bunny documentation guides are [under `docs/guides` in this repository](https://github.com/ruby-amqp/bunny/tree/main/docs/guides):
 
- * [Queues and Consumers](http://rubybunny.info/articles/queues.html)
- * [Exchanges and Publishers](http://rubybunny.info/articles/exchanges.html)
+ * [Queues and Consumers](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/queues.md)
+ * [Exchanges and Publishers](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/exchanges.md)
  * [AMQP 0.9.1 Model Explained](http://www.rabbitmq.com/tutorials/amqp-concepts.html)
- * [Connecting to RabbitMQ](http://rubybunny.info/articles/connecting.html)
- * [Error Handling and Recovery](http://rubybunny.info/articles/error_handling.html)
- * [TLS/SSL Support](http://rubybunny.info/articles/tls.html)
- * [Bindings](http://rubybunny.info/articles/bindings.html)
- * [Using RabbitMQ Extensions with Bunny](http://rubybunny.info/articles/extensions.html)
- * [Durability and Related Matters](http://rubybunny.info/articles/durability.html)
+ * [Connecting to RabbitMQ](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/connecting.md)
+ * [Error Handling and Recovery](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/error_handling.md)
+ * [TLS/SSL Support](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/tls.md)
+ * [Bindings](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/bindings.md)
+ * [Using RabbitMQ Extensions with Bunny](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/extensions.md)
+ * [Durability and Related Matters](https://github.com/ruby-amqp/bunny/tree/main/docs/guides/durability.md)
+
+Some highly relevant RabbitMQ documentation guides:
+
+ * [Connections](https://www.rabbitmq.com/docs/connections)
+ * [Channels](https://www.rabbitmq.com/docs/channels)
+ * [Queues](https://www.rabbitmq.com/docs/queues)
+ * [Quorum queues](https://www.rabbitmq.com/docs/quorum-queues)
+ * [Streams](https://rabbitmq.com/docs/streams) (Bunny can perform basic operations on streams even though it does not implement the [RabbitMQ Stream protocol](https://github.com/rabbitmq/rabbitmq-server/blob/v4.0.x/deps/rabbitmq_stream/docs/PROTOCOL.adoc))
+ * [Publishers](https://www.rabbitmq.com/docs/publishers)
+ * [Consumers](https://www.rabbitmq.com/docs/consumers)
+ * Data safety: publisher and consumer [Confirmations](https://www.rabbitmq.com/docs/confirms)
+ * [Production Checklist](https://www.rabbitmq.com/docs/production-checklist)
 
 ### API Reference
 
@@ -158,62 +184,41 @@ Other documentation guides are available at [rubybunny.info](http://rubybunny.in
 
 ### Mailing List
 
-[Bunny has a mailing list](http://groups.google.com/group/ruby-amqp). We encourage you
-to also join the [rabbitmq-discuss](https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss) mailing list. Feel free to ask any questions that you may have.
-
+Please use [GitHub Discussions](https://github.com/ruby-amqp/bunny/discussions) for questions.
 
-### IRC
+GitHub issues should be used for specific, well understood, actionable
+maintainers and contributors can work on.
 
-For more immediate help, please join `#rabbitmq` on `irc.freenode.net`.
+We encourage you to keep an eye on [RabbitMQ Discussions](https://github.com/rabbitmq/rabbitmq-server/discussions),
+join the [RabbitMQ mailing list](https://groups.google.com/forum/#!forum/rabbitmq-users)
+and the [RabbitMQ Discord server](https://rabbitmq.com/discord).
 
 
-### News & Announcements on Twitter
-
-To subscribe for announcements of releases, important changes and so on, please follow [@rubyamqp](https://twitter.com/#!/rubyamqp) on Twitter.
-
-More detailed announcements can be found in the blogs
+### Reporting Issues
 
-* [RabbitMQ Ruby clients blog](http://blog.rubyrabbitmq.info)
-* [Bunny Blog](http://bunnyamqp.wordpress.com)
+If you find a bug you understand well, poor default, incorrect or unclear piece of documentation,
+or missing feature, please [file an
+issue](http://github.com/ruby-amqp/bunny/issues) on GitHub.
 
+Please use [Bunny's mailing list](http://groups.google.com/group/ruby-amqp) for questions,
+investigations, and discussions. GitHub issues should be used for specific, well understood, actionable
+maintainers and contributors can work on.
 
-### Reporting Issues
-
-If you find a bug, poor default, missing feature or find any part of
-the API inconvenient, please [file an
-issue](http://github.com/ruby-amqp/bunny/issues) on GitHub.  When
-filing an issue, please specify which Bunny and RabbitMQ versions you
-are using, provide recent RabbitMQ log file contents if possible, and
-try to explain what behavior you expected and why. Bonus points for
-contributing failing test cases.
+When filing an issue, please specify which Bunny and RabbitMQ versions you
+are using, provide recent RabbitMQ log file contents, full exception stack traces,
+and steps to reproduce (or failing test cases).
 
 
 ## Other Ruby RabbitMQ Clients
 
-Other widely used Ruby RabbitMQ clients are [March
-Hare](http://rubymarchhare.info) (JRuby-only) and [amqp
-gem](http://rubyamqp.info).  Both are mature libraries and require
-RabbitMQ 2.x or 3.x.
+The other widely used Ruby RabbitMQ client is [March Hare](http://rubymarchhare.info) (JRuby-only).
+It's a mature library that require RabbitMQ 3.3.x or later.
 
 
 ## Contributing
 
-First, clone the repository and run
-
-    bundle install --binstubs
-
-then set up RabbitMQ vhosts with
-
-    ./bin/ci/before_build.sh
-
-(if needed, set `RABBITMQCTL` env variable to point to `rabbitmqctl` you want to use)
-
-and then run tests with
-
-    CI=true ./bin/rspec -cfs spec
-
-After that create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request
-on GitHub.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information
+about running various test suites.
 
 
 ## License

data/lib/amq/protocol/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @private
 module AMQ
   # @private

data/lib/bunny/authentication/credentials_encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bunny
   # Contains credentials encoding implementations for various
   # authentication strategies.

data/lib/bunny/authentication/external_mechanism_encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bunny/authentication/credentials_encoder"
 
 module Bunny

data/lib/bunny/authentication/plain_mechanism_encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bunny/authentication/credentials_encoder"
 
 module Bunny