amqp-client 1.0.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f619f7aec324221f4c5dd66a10e5e30b1904a224d34702f94f9f75ac19f1c3
-  data.tar.gz: 4d3e3fc1234f44ab741b15b61156617a7f8f181ce5fdc2aacbbc4c07a787129e
+  metadata.gz: 191cd8053858a46d350a6c89db378058c9c602bde3eadc95ee4ae79b149fb0cf
+  data.tar.gz: c322ca75508f8a9566170fa473b562dfe4b4989dc6b1e2baa68408612fe47692
 SHA512:
-  metadata.gz: 6ade93665b42b3c64ebed869be2af64cde53b259a6f376483c8c4d7e9de6432e2453be88caddf58655c249ae0d531a924348eb97c92b0a6a21b13a3276e3019b
-  data.tar.gz: '0479fe0b0c6f120e4bf0c5b72b905d7946037f8b5e1d83f462c18c2df790c8ed67ff5e32be693deac570d7d82dc9411875f252384364feea3b6e8b85c6abd27d'
+  metadata.gz: 7c47bba0271dbd49b603127ac8749bfd85468ea7b0faa97d857eca585cde012094ace144b339a71d24fc4c90dace83f5e562669ae040ddb1eedd54b24eb6a876
+  data.tar.gz: 3ecb4641c83020063186fa1ac4413e6e42ae33ecb013eae3d2dcadfa1c30a3943ddf6320561ccb63917376ac23ac908c87f2d7e64abd7508c69c9f1030460e8e

data/.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0']
+        ruby: ['2.6', '2.7', '3.0', 'jruby', 'truffleruby']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -31,5 +31,5 @@ jobs:
         bundle install
         bundle exec rake
       env:
+        TESTOPTS: --exclude=/_tls$/
         AMQP_PORT: ${{ job.services.rabbitmq.ports[5672] }}
-

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
 
 Style/StringLiterals:
   Enabled: true

data/.rubocop_todo.yml

@@ -1,15 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-09-06 19:39:47 UTC using RuboCop version 1.19.1.
+# on 2021-10-15 13:44:24 UTC using RuboCop version 1.19.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 18
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 132
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/amqp/client/connection.rb'
+
+# Offense count: 32
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 179
+  Max: 175
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
@@ -22,27 +34,32 @@ Metrics/BlockLength:
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 400
+  Max: 497
 
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 44
+  Max: 46
 
-# Offense count: 40
+# Offense count: 67
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 170
+  Max: 169
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 500
+  Max: 486
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 13
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 22
+  Max: 23

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+## [1.1.3] - 2021-11-04
+
+- Fixed: Reraise SystemcallError in connect so that reconnect works
+- Fixed: Keepalive support in OS X
+- Added: Make keepalive settings configurable (eg. amqp://?keepalive=60:10:3)
+
+## [1.1.2] - 2021-10-15
+
+- Added: Support for JRuby and TruffleRuby
+
+## [1.1.1] - 2021-09-15
+
+- Added: Examples in the documentation
+- Added: Faster Properties and Table encoding and decoding
+
+## [1.1.0] - 2021-09-08
+
+- Fixed: Due to a race condition publishers could get stuck waiting for publish confirms
+- Change: Message, ReturnMessage and Properties are now classes and not structs (for performance reasons)
+- Added: Ruby 2.6 support
+- Added: RBS signatures in sig/amqp-client.rbs
+
 ## [1.0.2] - 2021-09-07
 
 - Changed: Raise ConnectionClosed and ChannelClosed correctly (previous always ChannelClosed)

data/Gemfile

@@ -10,3 +10,7 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
+
+gem "yard", require: false
+
+gem "rubocop-minitest", require: false

data/README.md

@@ -1,58 +1,67 @@
 # AMQP::Client
 
-An AMQP 0-9-1 Ruby client, trying to keep things as simple as possible.
+A modern AMQP 0-9-1 Ruby client. Very fast (just as fast as the Java client, and >4x than other Ruby clients), fully thread-safe, blocking operations and straight-forward error handling.
 
-## Documentation
+It's small, only ~1800 lines of code, and without any dependencies. Other Ruby clients are about 4 times bigger. But without trading functionallity.
 
-[API reference](https://cloudamqp.github.io/amqp-client.rb/)
+It's safe by default, messages are published as persistent, and is waiting for confirmation from the broker. That can of course be disabled if performance is a priority.
 
-## Installation
+## Support
 
-Add this line to your application's Gemfile:
+The library is fully supported by [CloudAMQP](https://www.cloudamqp.com), the largest RabbitMQ hosting provider in the world. Open [an issue](https://github.com/cloudamqp/amqp-client.rb/issues) or [email our support](mailto:support@cloudamqp.com) if you have problems or questions.
 
-```ruby
-gem 'amqp-client'
-```
-
-And then execute:
+## Documentation
 
-    $ bundle install
+[API reference](https://cloudamqp.github.io/amqp-client.rb/)
 
-Or install it yourself as:
+## Usage
 
-    $ gem install amqp-client
+The client has two APIs.
 
-## Usage
+### Low level API
 
-Low level API
+This API matches the AMQP protocol very well, it can do everything the protocol allows, but requires some knowledge about the protocol, and doesn't handle reconnects.
 
 ```ruby
 require "amqp-client"
 
-c = AMQP::Client.new("amqp://guest:guest@localhost")
-conn = c.connect
+# Opens and establishes a connection
+conn = AMQP::Client.new("amqp://guest:guest@localhost").connect
+
+# Open a channel
 ch = conn.channel
+
+# Create a temporary queue
 q = ch.queue_declare
-ch.basic_publish "Hello World!", "", q[:queue_name]
-msg = ch.basic_get q[:queue_name]
+
+# Publish a message to said queue
+ch.basic_publish_confirm "Hello World!", "", q.queue_name, persistent: true
+
+# Poll the queue for a message
+msg = ch.basic_get(q.queue_name)
+
+# Print the message's body to STDOUT
 puts msg.body
 ```
 
-High level API, is an easier and safer API, that only deal with durable queues and persisted messages. All methods are blocking in the case of connection loss etc. It's also fully thread-safe. Don't expect it to have extreme throughput, but expect 100% delivery guarantees (messages might be delivered twice, in the unlikely event of connection loss between message publish and message confirmation by the broker).
+### High level API
+
+The library provides a high-level API that is a bit easier to get started with, and also handles reconnection automatically.
 
 ```ruby
-amqp = AMQP::Client.new("amqp://localhost")
-amqp.start
+# Start the client, it will connect and once connected it will reconnect if that connection is lost
+# Operation pending when the connection is lost will raise an exception (not timeout)
+amqp = AMQP::Client.new("amqp://localhost").start
 
 # Declares a durable queue
-q = amqp.queue("myqueue")
+myqueue = amqp.queue("myqueue")
 
 # Bind the queue to any exchange, with any binding key
-q.bind("amq.topic", "my.events.*")
+myqueue.bind("amq.topic", "my.events.*")
 
 # The message will be reprocessed if the client loses connection to the broker
 # between message arrival and when the message was supposed to be ack'ed.
-q.subscribe(prefetch: 20) do |msg|
+myqueue.subscribe(prefetch: 20) do |msg|
   process(JSON.parse(msg.body))
   msg.ack
 rescue
@@ -60,13 +69,39 @@ rescue
 end
 
 # Publish directly to the queue
-q.publish { foo: "bar" }.to_json, content_type: "application/json"
+myqueue.publish({ foo: "bar" }.to_json, content_type: "application/json")
 
 # Publish to any exchange
 amqp.publish("my message", "amq.topic", "topic.foo", headers: { foo: 'bar' })
 amqp.publish(Zlib.gzip("an event"), "amq.topic", "my.event", content_encoding: 'gzip')
 ```
 
+## Supported Ruby versions
+
+All maintained Ruby versions are supported.
+
+- 3.0
+- 2.7
+- 2.6
+- jruby
+- truffleruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amqp-client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install amqp-client
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -75,7 +110,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cloudamqp/amqp-client.rb
+Bug reports and pull requests are welcome on GitHub at [https://github.com/cloudamqp/amqp-client.rb](https://github.com/cloudamqp/amqp-client.rb/)
 
 ## License
 

data/Rakefile

@@ -11,6 +11,8 @@ end
 
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << "rubocop-minitest"
+end
 
 task default: %i[test rubocop]

data/amqp-client.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Work in progress"
   spec.homepage      = "https://github.com/cloudamqp/amqp-client.rb"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "#{spec.homepage}.git"

data/lib/amqp/client/channel.rb

@@ -215,6 +215,7 @@ module AMQP
         def queue_unbind(name, exchange, binding_key, arguments: {})
           write_bytes FrameBytes.queue_unbind(@id, name, exchange, binding_key, arguments)
           expect :queue_unbind_ok
+          nil
         end
 
         # @!endgroup
@@ -411,11 +412,10 @@ module AMQP
         def wait_for_confirms
           return true if @unconfirmed.empty?
 
-          case @unconfirmed_empty.pop
-          when true then true
-          when false then false
-          else raise Error::Closed.new(@id, *@closed)
-          end
+          ok = @unconfirmed_empty.pop
+          raise Error::Closed.new(@id, *@closed) if ok.nil?
+
+          ok
         end
 
         # Called by Connection when received ack/nack from broker
@@ -433,9 +433,8 @@ module AMQP
           end
           return unless @unconfirmed.empty?
 
-          @unconfirmed_empty.num_waiting.times do
-            @unconfirmed_empty << (ack_or_nack == :ack)
-          end
+          ok = ack_or_nack == :ack
+          @unconfirmed_empty.push(ok) until @unconfirmed_empty.num_waiting.zero?
         end
 
         # @!endgroup
@@ -474,12 +473,12 @@ module AMQP
 
         # @api private
         def message_returned(reply_code, reply_text, exchange, routing_key)
-          @next_msg = ReturnMessage.new(reply_code, reply_text, exchange, routing_key, nil, "")
+          @next_msg = ReturnMessage.new(reply_code, reply_text, exchange, routing_key)
         end
 
         # @api private
         def message_delivered(consumer_tag, delivery_tag, redelivered, exchange, routing_key)
-          @next_msg = Message.new(self, delivery_tag, exchange, routing_key, nil, "", redelivered, consumer_tag)
+          @next_msg = Message.new(self, consumer_tag, delivery_tag, exchange, routing_key, redelivered)
         end
 
         # @api private
@@ -510,6 +509,7 @@ module AMQP
         # @api private
         def close_consumer(tag)
           @consumers.fetch(tag).close
+          nil
         end
 
         private
@@ -528,6 +528,7 @@ module AMQP
             Thread.pass until (consumer = @consumers[next_msg.consumer_tag])
             consumer.push next_msg
           end
+          nil
         ensure
           @next_msg = @next_body = @next_body_size = nil
         end