amq-protocol 2.2.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d8c34cb05958c71cc0a6ec3c52b24bfb6939dd4
-  data.tar.gz: 62b732a3fbae0803d246e4bf67a9666222004c5a
+SHA256:
+  metadata.gz: c3952d1aea112b833a87bc1dc5f4a48b30b3203cc6916ea94e6489a233e4f07e
+  data.tar.gz: a9c2c60ac42dfbf18fcfc9c91ab146c5db2501c51ab96047129f0d3e17c6d51d
 SHA512:
-  metadata.gz: 70d31ca38bb0208b3c8246e19dd43bcc4a5ddd9fc57cfc5b410cc8e942c823031c3a31f52732909170ce6352e0a85dbac2daf7ede84ecc85ca968482ad9cdadb
-  data.tar.gz: cf2d8b74629d4e457a79ca52027831c37bd77ae6dc05130edac2fcc2ec8f8aea38f69533394b8c17060cfb4c1738ba16d0b2d0b97ec58fe67d080eaeb30a4f63
+  metadata.gz: 2e20cc9579e2fd2d6750d0ca1201786ab73635a21d5783ef2f14a115dbcfe524b3561abd7a835c0f925c638c5164f72139a717b0c43b1303470295d3fa06494c
+  data.tar.gz: da6ecba234868b2a2bd5035cb1df2f5687e8b58e886f64bd1b99530419767ce53f30c6f89ec11395e91d163fbe5ee2e1a54dd3686735d6a51bf936b85f93bda0

data/.rspec

@@ -1,3 +1 @@
---colour
---format
-progress
+--require spec_helper

data/.travis.yml

@@ -1,14 +1,14 @@
+dist: bionic
 language: ruby
 bundler_args: --without development
 cache: bundler
 script: "bundle exec rspec spec"
 rvm:
-  - "2.4.0"
-  - "2.3.3"
-  - "2.2"
-  - "2.1"
-  - "2.0"
   - ruby-head
+  - "2.6.3"
+  - "2.5.5"
+  - "2.4.5"
+  - "2.3.8"
 notifications:
   recipients:
     - michael@rabbitmq.com

data/ChangeLog.md

@@ -1,4 +1,40 @@
-## Changes between 2.1.0 and 2.2.0 (unreleased)
+## Changes between 2.3.2 and 2.3.3 (unreleased)
+
+No changes yet.
+
+## Changes between 2.3.1 and 2.3.2 (July 10th, 2020)
+
+### Safer Encoding Handling When Serialising Message Properties and Headers
+
+Contributed by @bbascarevic-tti.
+
+GitHub issue: [ruby-amqp/amq-protocol#76](https://github.com/ruby-amqp/amq-protocol/issues/76)
+
+
+## Changes between 2.3.0 and 2.3.1 (April 8th, 2020)
+
+### Support for connection.update-secret
+
+Used together with the `rabbitmq-auth-backend-oauth2` plugin.
+
+### Squashed a gemspec Warning
+
+GitHub issue: [ruby-amqp/amq-protocol#75](https://github.com/ruby-amqp/amq-protocol/issues/75).
+
+
+
+## Changes between 2.2.0 and 2.3.0 (Jan 8th, 2018)
+
+### Support for Additional URI Query Parameters
+
+GitHub issue: [#67](https://github.com/ruby-amqp/amq-protocol/issues/67), [#68](https://github.com/ruby-amqp/amq-protocol/issues/68), [#69](https://github.com/ruby-amqp/amq-protocol/issues/69).
+
+Contributed by Andrew Babichev.
+
+
+
+
+## Changes between 2.1.0 and 2.2.0 (May 11th, 2017)
 
 ### Timestamps are Encoded as 64-bit Unsigned Integers
 

data/Gemfile

@@ -10,7 +10,11 @@ group :development do
 end
 
 group :test do
-  gem "rspec", ">= 3.4.0"
+  gem "rspec", ">= 3.8.0"
   gem "rspec-its"
-  gem "effin_utf8"
+  gem "simplecov"
+end
+
+group :development, :test do
+  gem "byebug"
 end

data/README.md

@@ -1,16 +1,17 @@
-# What is amq-protocol.
+# What is amq-protocol
 
 amq-protocol is an AMQP 0.9.1 serialization library for Ruby. It is not an
-AMQP client: amq-protocol only handles serialization and deserialization.
+AMQP 0-9-1 client such as [Bunny](http://rubybunny.info): amq-protocol only handles serialization and deserialization.
 
-If you want to write your own AMQP client, this gem will handle all the serialization
+If you want to write your own AMQP 0-9-1 client, this gem will handle all the serialization
 needs for you, including RabbitMQ extensions to AMQP 0.9.1.
 
 
 ## Supported Ruby Versions
 
-amq-protocol `1.9.2` was the last version to support Ruby 1.8 and 1.9.
-amq-protocol `2.0.0` and later only supports Ruby 2.0+.
+ * amq-protocol `2.3.0` only supports Ruby 2.2+.
+ * amq-protocol `2.0.0` through `2.2.0` and later supports Ruby 2.0+.
+ * amq-protocol `1.9.2` was the last version to support Ruby 1.8 and 1.9.
 
 
 ## Installation
@@ -46,7 +47,7 @@ amq-protocol is maintained by [Michael Klishin](https://github.com/michaelklishi
 
 ## CI Status
 
-[![Build Status](https://secure.travis-ci.org/ruby-amqp/amq-protocol.png)](https://travis-ci.org/ruby-amqp/amq-protocol)
+[![Build Status](https://secure.travis-ci.org/ruby-amqp/amq-protocol.svg)](https://travis-ci.org/ruby-amqp/amq-protocol)
 
 
 ## Issues

data/amq-protocol.gemspec

@@ -17,13 +17,11 @@ Gem::Specification.new do |s|
   DESC
   s.email = ["michael.s.klishin@gmail.com"]
   s.licenses    = ["MIT"]
-  s.required_ruby_version = Gem::Requirement.new(">= 2.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2")
 
   # files
   s.files = `git ls-files`.split("\n").reject { |file| file =~ /^vendor\// }
   s.require_paths = ["lib"]
 
   s.extra_rdoc_files = ["README.md"] + Dir.glob("doc/*")
-
-  s.rubyforge_project = "amq-protocol"
 end

data/lib/amq/protocol/client.rb

@@ -251,7 +251,7 @@ module AMQ
         end
 
         # @return
-        # ['client_properties = nil', "mechanism = 'PLAIN'", 'response = nil', "locale = 'en_US'"]
+        # [u'client_properties = nil', u"mechanism = u'PLAIN'", u'response = nil', u"locale = u'en_US'"]
         def self.encode(client_properties, mechanism, response, locale)
           channel = 0
           buffer = @packed_indexes.dup
@@ -307,7 +307,7 @@ module AMQ
         end
 
         # @return
-        # ['response = nil']
+        # [u'response = nil']
         def self.encode(response)
           channel = 0
           buffer = @packed_indexes.dup
@@ -362,7 +362,7 @@ module AMQ
         end
 
         # @return
-        # ['channel_max = false', 'frame_max = false', 'heartbeat = false']
+        # [u'channel_max = false', u'frame_max = false', u'heartbeat = false']
         def self.encode(channel_max, frame_max, heartbeat)
           channel = 0
           buffer = @packed_indexes.dup
@@ -386,7 +386,7 @@ module AMQ
         end
 
         # @return
-        # ["virtual_host = '/'", 'capabilities = EMPTY_STRING', 'insist = false']
+        # [u"virtual_host = u'/'", u'capabilities = EMPTY_STRING', u'insist = false']
         def self.encode(virtual_host)
           capabilities = EMPTY_STRING
           insist = false
@@ -467,7 +467,7 @@ module AMQ
         end
 
         # @return
-        # ['reply_code = nil', 'reply_text = EMPTY_STRING', 'class_id = nil', 'method_id = nil']
+        # [u'reply_code = nil', u'reply_text = EMPTY_STRING', u'class_id = nil', u'method_id = nil']
         def self.encode(reply_code, reply_text, class_id, method_id)
           channel = 0
           buffer = @packed_indexes.dup
@@ -536,7 +536,7 @@ module AMQ
         end
 
         # @return
-        # ['reason = EMPTY_STRING']
+        # [u'reason = EMPTY_STRING']
         def self.encode(reason)
           channel = 0
           buffer = @packed_indexes.dup
@@ -576,6 +576,79 @@ module AMQ
 
       end
 
+      class UpdateSecret < Protocol::Method
+        @name = "connection.update-secret"
+        @method_id = 70
+        @index = 0x000A0046 # 10, 70, 655430
+        @packed_indexes = [10, 70].pack(PACK_UINT16_X2).freeze
+
+        # @return
+        def self.decode(data)
+          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
+          length = data[offset, 4].unpack(PACK_UINT32).first
+          offset += 4
+          new_secret = data[offset, length]
+          offset += length
+          length = data[offset, 1].unpack(PACK_CHAR).first
+          offset += 1
+          reason = data[offset, length]
+          offset += length
+          self.new(new_secret, reason)
+        end
+
+        attr_reader :new_secret, :reason
+        def initialize(new_secret, reason)
+          @new_secret = new_secret
+          @reason = reason
+        end
+
+        def self.has_content?
+          false
+        end
+
+        # @return
+        # [u'new_secret = nil', u'reason = nil']
+        def self.encode(new_secret, reason)
+          channel = 0
+          buffer = @packed_indexes.dup
+          buffer << [new_secret.to_s.bytesize].pack(PACK_UINT32)
+          buffer << new_secret.to_s
+          buffer << reason.to_s.bytesize.chr
+          buffer << reason.to_s
+          MethodFrame.new(buffer, channel)
+        end
+
+      end
+
+      class UpdateSecretOk < Protocol::Method
+        @name = "connection.update-secret-ok"
+        @method_id = 71
+        @index = 0x000A0047 # 10, 71, 655431
+        @packed_indexes = [10, 71].pack(PACK_UINT16_X2).freeze
+
+        # @return
+        def self.decode(data)
+          offset = offset = 0 # self-assigning offset to eliminate "assigned but unused variable" warning even if offset is not used in this method
+          self.new()
+        end
+
+        def initialize()
+        end
+
+        def self.has_content?
+          false
+        end
+
+        # @return
+        # []
+        def self.encode()
+          channel = 0
+          buffer = @packed_indexes.dup
+          MethodFrame.new(buffer, channel)
+        end
+
+      end
+
     end
 
     class Channel < Protocol::Class
@@ -596,7 +669,7 @@ module AMQ
         end
 
         # @return
-        # ['out_of_band = EMPTY_STRING']
+        # [u'out_of_band = EMPTY_STRING']
         def self.encode(channel, out_of_band)
           buffer = @packed_indexes.dup
           buffer << out_of_band.to_s.bytesize.chr
@@ -659,7 +732,7 @@ module AMQ
         end
 
         # @return
-        # ['active = nil']
+        # [u'active = nil']
         def self.encode(channel, active)
           buffer = @packed_indexes.dup
           bit_buffer = 0
@@ -695,7 +768,7 @@ module AMQ
         end
 
         # @return
-        # ['active = nil']
+        # [u'active = nil']
         def self.encode(channel, active)
           buffer = @packed_indexes.dup
           bit_buffer = 0
@@ -741,7 +814,7 @@ module AMQ
         end
 
         # @return
-        # ['reply_code = nil', 'reply_text = EMPTY_STRING', 'class_id = nil', 'method_id = nil']
+        # [u'reply_code = nil', u'reply_text = EMPTY_STRING', u'class_id = nil', u'method_id = nil']
         def self.encode(channel, reply_code, reply_text, class_id, method_id)
           buffer = @packed_indexes.dup
           buffer << [reply_code].pack(PACK_UINT16)
@@ -802,7 +875,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'exchange = nil', "type = 'direct'", 'passive = false', 'durable = false', 'auto_delete = false', 'internal = false', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'exchange = nil', u"type = u'direct'", u'passive = false', u'durable = false', u'auto_delete = false', u'internal = false', u'nowait = false', u'arguments = {}']
         def self.encode(channel, exchange, type, passive, durable, auto_delete, internal, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -858,7 +931,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'exchange = nil', 'if_unused = false', 'nowait = false']
+        # [u'ticket = 0', u'exchange = nil', u'if_unused = false', u'nowait = false']
         def self.encode(channel, exchange, if_unused, nowait)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -908,7 +981,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'destination = nil', 'source = nil', 'routing_key = EMPTY_STRING', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'destination = nil', u'source = nil', u'routing_key = EMPTY_STRING', u'nowait = false', u'arguments = {}']
         def self.encode(channel, destination, source, routing_key, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -962,7 +1035,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'destination = nil', 'source = nil', 'routing_key = EMPTY_STRING', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'destination = nil', u'source = nil', u'routing_key = EMPTY_STRING', u'nowait = false', u'arguments = {}']
         def self.encode(channel, destination, source, routing_key, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1024,7 +1097,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'passive = false', 'durable = false', 'exclusive = false', 'auto_delete = false', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'passive = false', u'durable = false', u'exclusive = false', u'auto_delete = false', u'nowait = false', u'arguments = {}']
         def self.encode(channel, queue, passive, durable, exclusive, auto_delete, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1090,7 +1163,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'exchange = nil', 'routing_key = EMPTY_STRING', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'exchange = nil', u'routing_key = EMPTY_STRING', u'nowait = false', u'arguments = {}']
         def self.encode(channel, queue, exchange, routing_key, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1144,7 +1217,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'nowait = false']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'nowait = false']
         def self.encode(channel, queue, nowait)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1197,7 +1270,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'if_unused = false', 'if_empty = false', 'nowait = false']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'if_unused = false', u'if_empty = false', u'nowait = false']
         def self.encode(channel, queue, if_unused, if_empty, nowait)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1252,7 +1325,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'exchange = nil', 'routing_key = EMPTY_STRING', 'arguments = {}']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'exchange = nil', u'routing_key = EMPTY_STRING', u'arguments = {}']
         def self.encode(channel, queue, exchange, routing_key, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1540,7 +1613,7 @@ module AMQ
         end
 
         # @return
-        # ['prefetch_size = false', 'prefetch_count = false', 'global = false']
+        # [u'prefetch_size = false', u'prefetch_count = false', u'global = false']
         def self.encode(channel, prefetch_size, prefetch_count, global)
           buffer = @packed_indexes.dup
           buffer << [prefetch_size].pack(PACK_UINT32)
@@ -1587,7 +1660,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'consumer_tag = EMPTY_STRING', 'no_local = false', 'no_ack = false', 'exclusive = false', 'nowait = false', 'arguments = {}']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'consumer_tag = EMPTY_STRING', u'no_local = false', u'no_ack = false', u'exclusive = false', u'nowait = false', u'arguments = {}']
         def self.encode(channel, queue, consumer_tag, no_local, no_ack, exclusive, nowait, arguments)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1666,7 +1739,7 @@ module AMQ
         end
 
         # @return
-        # ['consumer_tag = nil', 'nowait = false']
+        # [u'consumer_tag = nil', u'nowait = false']
         def self.encode(channel, consumer_tag, nowait)
           buffer = @packed_indexes.dup
           buffer << consumer_tag.to_s.bytesize.chr
@@ -1719,7 +1792,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'exchange = EMPTY_STRING', 'routing_key = EMPTY_STRING', 'mandatory = false', 'immediate = false', 'user_headers = nil', 'payload = ""', 'frame_size = nil']
+        # [u'ticket = 0', u'exchange = EMPTY_STRING', u'routing_key = EMPTY_STRING', u'mandatory = false', u'immediate = false', 'user_headers = nil', 'payload = ""', 'frame_size = nil']
         def self.encode(channel, payload, user_headers, exchange, routing_key, mandatory, immediate, frame_size)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1843,7 +1916,7 @@ module AMQ
         end
 
         # @return
-        # ['ticket = 0', 'queue = EMPTY_STRING', 'no_ack = false']
+        # [u'ticket = 0', u'queue = EMPTY_STRING', u'no_ack = false']
         def self.encode(channel, queue, no_ack)
           ticket = 0
           buffer = @packed_indexes.dup
@@ -1957,7 +2030,7 @@ module AMQ
         end
 
         # @return
-        # ['delivery_tag = false', 'multiple = false']
+        # [u'delivery_tag = false', u'multiple = false']
         def self.encode(channel, delivery_tag, multiple)
           buffer = @packed_indexes.dup
           buffer << AMQ::Pack.pack_uint64_big_endian(delivery_tag)
@@ -1981,7 +2054,7 @@ module AMQ
         end
 
         # @return
-        # ['delivery_tag = nil', 'requeue = true']
+        # [u'delivery_tag = nil', u'requeue = true']
         def self.encode(channel, delivery_tag, requeue)
           buffer = @packed_indexes.dup
           buffer << AMQ::Pack.pack_uint64_big_endian(delivery_tag)
@@ -2005,7 +2078,7 @@ module AMQ
         end
 
         # @return
-        # ['requeue = false']
+        # [u'requeue = false']
         def self.encode(channel, requeue)
           buffer = @packed_indexes.dup
           bit_buffer = 0
@@ -2028,7 +2101,7 @@ module AMQ
         end
 
         # @return
-        # ['requeue = false']
+        # [u'requeue = false']
         def self.encode(channel, requeue)
           buffer = @packed_indexes.dup
           bit_buffer = 0
@@ -2091,7 +2164,7 @@ module AMQ
         end
 
         # @return
-        # ['delivery_tag = false', 'multiple = false', 'requeue = true']
+        # [u'delivery_tag = false', u'multiple = false', u'requeue = true']
         def self.encode(channel, delivery_tag, multiple, requeue)
           buffer = @packed_indexes.dup
           buffer << AMQ::Pack.pack_uint64_big_endian(delivery_tag)
@@ -2271,7 +2344,7 @@ module AMQ
         end
 
         # @return
-        # ['nowait = false']
+        # [u'nowait = false']
         def self.encode(channel, nowait)
           buffer = @packed_indexes.dup
           bit_buffer = 0