bunny 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0c99fb0a3faf8edcc73da84f74ce724e77b71a1
-  data.tar.gz: 4c50a4aa3b4b6bb70ae4f9f8d4305914c24e9f1b
+  metadata.gz: a03370c05bd0085362a6eb7776c5f8bac7baa228
+  data.tar.gz: f23f3d9759ac91de7a9f43a17ca4681aa9da9192
 SHA512:
-  metadata.gz: 717ee6c9d892e4d930464b2122ffbd2059420553c4b3f3ec670d6b66331d9885feeac96eb0edf7f2da1fcf11ef77bc05e3b2beacfbb7f96a19a7e780b2fb3ea5
-  data.tar.gz: 3b24edbe00fbbb46a20592bb5cc28bc5f00fa6fb05180a5b91405f2534c9c4a8d8e3b0b9ab12e1f6213a501f3cc2cab374e00a3bc3a31ba79281efa7e9e0a8d1
+  metadata.gz: 1beba2d8994c8d8a977a19085d62dc4afe5d319bf5768aad48b145636fe0217b6a7e3dacb5f2a0b0161609d291c4a6fc9bc5856dfbfbbe741f28eea5416d8ca0
+  data.tar.gz: 3639354508b8bb3b0e637372a6c4b6295a7422d15b09354604c3c00af7db55a70d866d39170b4fac4f06ae1b82f7658749152e6b99d90f77db18e1dabb96f105

data/ChangeLog.md

@@ -55,6 +55,14 @@ Since `basic.qos`'s `prefetch_count` field is of type `short` in the protocol,
 Bunny must enforce its maximum allowed value to `2^16 - 1` to avoid
 confusing issues due to overflow.
 
+### Per-Consumer and Per-Channel Prefetch
+
+Recent RabbitMQ versions support `basic.qos` `global` flag, controlling whether
+`prefetch` applies per-consumer or per-channel. Bunny `Channel#prefetch` now
+allows flag to be set as optional parameter, with the same default behaviour as
+before (per-consumer).
+
+Contributed by tiredpixel.
 
 
 ## Changes between Bunny 1.6.0 and 1.7.0

data/README.md

@@ -194,10 +194,14 @@ contributing failing test cases.
 
 ### Running the Specs
 
-The cleanest way to get the specs running is by starting a clean rabbitmq server
-node on your machine specifically for the bunny specs.
+The specs require RabbitMQ to be running locally with a specific set of vhosts
+and users. RabbitMQ can be provisioned and started any that's convenient to you
+as long as it has a suitable TLS keys configuration and management plugin enabled.
+Make sure you have a recent version of RabbitMQ (> `3.5.3`).
 
-Make sure you have a recent version of RabbitMQ (> 3.4) and run the following command
+You can also start a clean RabbitMQ server
+node on your machine specifically for the bunny specs.
+To do so, run the following command
 from the base directory of the gem:
 
 ```
@@ -206,16 +210,16 @@ RABBITMQ_NODENAME=bunny RABBITMQ_CONFIG_FILE=./spec/config/rabbitmq RABBITMQ_ENA
 
 The specs use the RabbitMQ management plugin and require a TLS port to be available. The config files in the spec/config directory enable these.
 
-Next up you'll need to prepare your node for the specs (Only once):
+Next up you'll need to prepare your node for the specs (just once):
 
 ```
 RABBITMQ_NODENAME=bunny ./bin/ci/before_build
 ```
 
-And then run the specs:
+And then run the core integration suite:
 
 ```
-RABBITMQ_NODENAME=bunny rspec
+RABBITMQ_NODENAME=bunny CI=true rspec
 ```
 
 ## Other Ruby RabbitMQ Clients

data/lib/bunny/channel.rb

@@ -156,6 +156,8 @@ module Bunny
 
     # @return [Integer] active basic.qos prefetch value
     attr_reader :prefetch_count
+    # @return [Integer] active basic.qos prefetch global mode
+    attr_reader :prefetch_global
 
     DEFAULT_CONTENT_TYPE = "application/octet-stream".freeze
     SHORTSTR_LIMIT = 255
@@ -429,11 +431,20 @@ module Bunny
     # have to acknowledge or reject one of the previously consumed messages
     #
     # @param [Integer] prefetch_count Prefetch (QoS setting) for this channel
+    # @param [Boolean] global
+    #   Whether to use global mode for prefetch:
+    #   - +false+: per-consumer
+    #   - +true+:  per-channel
+    #   Note that the default value (+false+) hasn't actually changed, but
+    #   previous documentation described that as meaning per-channel and
+    #   unsupported in RabbitMQ, whereas it now actually appears to mean
+    #   per-consumer and supported
+    #   (https://www.rabbitmq.com/consumer-prefetch.html).
     # @see http://rubybunny.info/articles/exchanges.html Exchanges and Publishing guide
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
     # @api public
-    def prefetch(count)
-      self.basic_qos(count, false)
+    def prefetch(count, global = false)
+      self.basic_qos(count, global)
     end
 
     # Flow control. When set to false, RabbitMQ will stop delivering messages on this
@@ -624,7 +635,15 @@ module Bunny
     #
     # @param [Integer] prefetch_count How many messages can consumers on this channel be given at a time
     #                                 (before they have to acknowledge or reject one of the earlier received messages)
-    # @param [Boolean] global (false) Ignored, as it is not supported by RabbitMQ
+    # @param [Boolean] global
+    #   Whether to use global mode for prefetch:
+    #   - +false+: per-consumer
+    #   - +true+:  per-channel
+    #   Note that the default value (+false+) hasn't actually changed, but
+    #   previous documentation described that as meaning per-channel and
+    #   unsupported in RabbitMQ, whereas it now actually appears to mean
+    #   per-consumer and supported
+    #   (https://www.rabbitmq.com/consumer-prefetch.html).
     # @return [AMQ::Protocol::Basic::QosOk] RabbitMQ response
     # @see Bunny::Channel#prefetch
     # @see http://rubybunny.info/articles/queues.html Queues and Consumers guide
@@ -641,7 +660,8 @@ module Bunny
       end
       raise_if_continuation_resulted_in_a_channel_error!
 
-      @prefetch_count = count
+      @prefetch_count  = count
+      @prefetch_global = global
 
       @last_basic_qos_ok
     end
@@ -1486,7 +1506,7 @@ module Bunny
     #
     # @api plugin
     def recover_prefetch_setting
-      basic_qos(@prefetch_count) if @prefetch_count
+      basic_qos(@prefetch_count, @prefetch_global) if @prefetch_count
     end
 
     # Recovers publisher confirms mode. Used by the Automatic Network Failure

data/lib/bunny/version.rb

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

data/spec/higher_level_api/integration/basic_qos_spec.rb

@@ -14,7 +14,20 @@ describe Bunny::Channel, "#prefetch" do
   context "with a positive integer < 65535" do
     it "sets that prefetch level via basic.qos" do
       ch = connection.create_channel
+      expect(ch.prefetch_count).not_to eq 10
+      expect(ch.prefetch_global).to be_nil
       expect(ch.prefetch(10)).to be_instance_of(AMQ::Protocol::Basic::QosOk)
+      expect(ch.prefetch_count).to eq 10
+      expect(ch.prefetch_global).to be false
+    end
+
+    it "sets that prefetch global via basic.qos" do
+      ch = connection.create_channel
+      expect(ch.prefetch_count).not_to eq 42
+      expect(ch.prefetch_global).to be_nil
+      expect(ch.prefetch(42, true)).to be_instance_of(AMQ::Protocol::Basic::QosOk)
+      expect(ch.prefetch_count).to eq 42
+      expect(ch.prefetch_global).to be true
     end
   end
 

data/spec/higher_level_api/integration/connection_recovery_spec.rb

@@ -172,6 +172,7 @@ unless ENV["CI"]
         ch = c.create_channel
         ch.prefetch(11)
         expect(ch.prefetch_count).to eq 11
+        expect(ch.prefetch_global).to be false
         close_all_connections!
         sleep 0.1
         expect(c).not_to be_open
@@ -179,9 +180,26 @@ unless ENV["CI"]
         wait_for_recovery
         expect(ch).to be_open
         expect(ch.prefetch_count).to eq 11
+        expect(ch.prefetch_global).to be false
       end
     end
 
+    it "recovers basic.qos prefetch global setting" do
+      with_open do |c|
+        ch = c.create_channel
+        ch.prefetch(42, true)
+        expect(ch.prefetch_count).to eq 42
+        expect(ch.prefetch_global).to be true
+        close_all_connections!
+        sleep 0.1
+        expect(c).not_to be_open
+
+        wait_for_recovery
+        expect(ch).to be_open
+        expect(ch.prefetch_count).to eq 42
+        expect(ch.prefetch_global).to be true
+      end
+    end
 
     it "recovers publisher confirms setting" do
       with_open do |c|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bunny
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Duncan
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amq-protocol
@@ -227,12 +227,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Popular easy to use Ruby client for RabbitMQ