amq-protocol 2.2.0 → 2.3.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d8c34cb05958c71cc0a6ec3c52b24bfb6939dd4
-  data.tar.gz: 62b732a3fbae0803d246e4bf67a9666222004c5a
+  metadata.gz: 56aef8400f27c7f5169e7a0ba5bc9cda78d104a7
+  data.tar.gz: 7845fbe53e26130c9d7193831242e35a969fe78f
 SHA512:
-  metadata.gz: 70d31ca38bb0208b3c8246e19dd43bcc4a5ddd9fc57cfc5b410cc8e942c823031c3a31f52732909170ce6352e0a85dbac2daf7ede84ecc85ca968482ad9cdadb
-  data.tar.gz: cf2d8b74629d4e457a79ca52027831c37bd77ae6dc05130edac2fcc2ec8f8aea38f69533394b8c17060cfb4c1738ba16d0b2d0b97ec58fe67d080eaeb30a4f63
+  metadata.gz: 1afaca3d78941a1362a86a4959689aaf6e731e2c2eebe62342cce7bfc820e6063f71125b8cf0fec1cadb4751f15cc4bc0c1adb48570d54ace1598006caa632d4
+  data.tar.gz: 24c3f1e94cf8bbba16ad7976d2a0e7257a1200193359de72027452f2ae798ddcaca9237170aed3698e360196dd77569d32521f0396d9aa00838d010abd59b921

data/.rspec

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

data/ChangeLog.md

@@ -1,4 +1,10 @@
-## Changes between 2.1.0 and 2.2.0 (unreleased)
+## Changes between 2.2.0 and 2.3.0 (unreleased)
+
+No changes yet.
+
+
+
+## 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,12 @@ group :development do
 end
 
 group :test do
-  gem "rspec", ">= 3.4.0"
+  gem "rspec", ">= 3.5.0"
   gem "rspec-its"
   gem "effin_utf8"
+  gem "simplecov"
+end
+
+group :development, :test do
+  gem "byebug"
 end

data/lib/amq/protocol/version.rb

@@ -1,5 +1,5 @@
 module AMQ
   module Protocol
-    VERSION = "2.2.0"
+    VERSION = "2.3.0.rc1"
   end # Protocol
 end # AMQ

data/lib/amq/settings.rb

@@ -14,24 +14,32 @@ module AMQ
       # @see AMQ::Client::Settings.configure
       def self.default
         @default ||= {
-          # server
-          :host  => "127.0.0.1",
-          :port  => AMQ::Protocol::DEFAULT_PORT,
+          # TCP/IP connection parameters
+          host: "127.0.0.1",
+          port: AMQ::Protocol::DEFAULT_PORT,
+          auth_mechanism: [],
 
-          # login
-          :user  => "guest",
-          :pass  => "guest",
-          :vhost => "/",
+          # authentication parameters
+          user: "guest",
+          pass: "guest",
+          vhost: "/",
 
-          # ssl
-          :ssl => false,
+          # client connection parameters
+          frame_max: (128 * 1024),
+          heartbeat: nil,
+          connection_timeout: nil,
+          channel_max: nil,
 
-          :frame_max => (128 * 1024),
-          :heartbeat => 0
-        }
+          # ssl parameters
+          ssl: false,
+          verify: false,
+          fail_if_no_peer_cert: false,
+          cacertfile: nil,
+          certfile: nil,
+          keyfile: nil
+        }.freeze
       end
 
-
       # Merges given configuration parameters with defaults and returns
       # the result.
       #
@@ -43,9 +51,18 @@ module AMQ
       # @option settings [String] :user ("guest") Username to use for authentication.
       # @option settings [String] :pass ("guest") Password to use for authentication.
       # @option settings [String] :ssl (false) Should be use TLS (SSL) for connection?
-      # @option settings [String] :timeout (nil) Connection timeout.
-      # @option settings [String] :broker (nil) Broker name (use if you intend to use broker-specific features).
       # @option settings [Fixnum] :frame_max (131072) Maximum frame size to use. If broker cannot support frames this large, broker's maximum value will be used instead.
+      # @option settings [Integer] :heartbeat (nil) Heartbeat timeout value in seconds to negotiate with the server.
+      # @option settings [Integer] :connection_timeout (nil) Time in milliseconds to wait while establishing a TCP connection to the server before giving up.
+      # @option settings [Fixnum] :channel_max (nil) Maximum number of channels to permit on this connection.
+      # @option settings [Array] :auth_mechanism ([]) SASL authentication mechanisms to consider when negotiating a mechanism with the server. This parameter can be specified multiple times to specify multiple mechanisms, e.g. `?auth_mechanism=plain&auth_mechanism=amqplain`.
+      # @option settings [Boolean] :verify (false) Controls peer verification mode.
+      # @option settings [Boolean] :fail_if_no_peer_cert (false) When set to true, TLS connection will be rejected if client fails to provide a certificate.
+      # @option settings [String] :cacertfile (nil) Certificate Authority (CA) certificate file path.
+      # @option settings [String] :certfile (nil) Server certificate file path.
+      # @option settings [String] :keyfile (nil) Server private key file path.
+      #
+      # @option settings [String] :broker (nil) Broker name (use if you intend to use broker-specific features).
       #
       # @return [Hash] Merged configuration parameters.
       def self.configure(settings = nil)

data/lib/amq/uri.rb

@@ -6,30 +6,95 @@ require "uri"
 module AMQ
   class URI
     # @private
-    AMQP_PORTS = {"amqp" => 5672, "amqps" => 5671}.freeze
+    AMQP_DEFAULT_PORTS = {
+      "amqp" => 5672,
+      "amqps" => 5671
+    }.freeze
 
+    private_constant :AMQP_DEFAULT_PORTS
+
+    DEFAULTS = {
+      heartbeat: nil,
+      connection_timeout: nil,
+      channel_max: nil,
+      auth_mechanism: [],
+      verify: false,
+      fail_if_no_peer_cert: false,
+      cacertfile: nil,
+      certfile: nil,
+      keyfile: nil
+    }.freeze
 
     def self.parse(connection_string)
       uri = ::URI.parse(connection_string)
       raise ArgumentError.new("Connection URI must use amqp or amqps schema (example: amqp://bus.megacorp.internal:5766), learn more at http://bit.ly/ks8MXK") unless %w{amqp amqps}.include?(uri.scheme)
 
-      opts = {}
+      opts = DEFAULTS.dup
 
       opts[:scheme] = uri.scheme
       opts[:user]   = ::CGI::unescape(uri.user) if uri.user
       opts[:pass]   = ::CGI::unescape(uri.password) if uri.password
       opts[:host]   = uri.host if uri.host
-      opts[:port]   = uri.port || AMQP_PORTS[uri.scheme]
-      opts[:ssl]    = uri.scheme.to_s.downcase =~ /amqps/i
+      opts[:port]   = uri.port || AMQP_DEFAULT_PORTS[uri.scheme]
+      opts[:ssl]    = uri.scheme.to_s.downcase =~ /amqps/i # TODO: rename to tls
       if uri.path =~ %r{^/(.*)}
         raise ArgumentError.new("#{uri} has multiple-segment path; please percent-encode any slashes in the vhost name (e.g. /production => %2Fproduction). Learn more at http://bit.ly/amqp-gem-and-connection-uris") if $1.index('/')
         opts[:vhost] = ::CGI::unescape($1)
       end
 
+      if uri.query
+        query_params = CGI::parse(uri.query)
+
+        normalized_query_params = Hash[query_params.map { |param, value| [param, value.one? ? value.first : value] }]
+
+        opts[:heartbeat] = normalized_query_params["heartbeat"].to_i
+        opts[:connection_timeout] = normalized_query_params["connection_timeout"].to_i
+        opts[:channel_max] = normalized_query_params["channel_max"].to_i
+        opts[:auth_mechanism] = normalized_query_params["auth_mechanism"]
+
+        %w(cacertfile certfile keyfile).each do |tls_option|
+          if normalized_query_params[tls_option] && uri.scheme == "amqp"
+            raise ArgumentError.new("The option '#{tls_option}' can only be used in URIs that use amqps schema")
+          else
+            opts[tls_option.to_sym] = normalized_query_params[tls_option]
+          end
+        end
+
+        %w(verify fail_if_no_peer_cert).each do |tls_option|
+          if normalized_query_params[tls_option] && uri.scheme == "amqp"
+            raise ArgumentError.new("The option '#{tls_option}' can only be used in URIs that use amqps schema")
+          else
+            opts[tls_option.to_sym] = as_boolean(normalized_query_params[tls_option])
+          end
+        end
+      end
+
       opts
     end
+
     def self.parse_amqp_url(s)
       parse(s)
     end
+
+    #
+    # Implementation
+    #
+
+    # Normalizes values returned by CGI.parse.
+    # @private
+    def self.as_boolean(val)
+      case val
+      when true    then true
+      when false   then false
+      when 1       then true
+      when 0       then false
+      when "true"  then true
+      when "false" then false
+      else
+        !!val
+      end
+    end
+
+    private_class_method :as_boolean
   end
 end

data/spec/amq/bit_set_spec.rb

@@ -1,12 +1,7 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
 require "amq/bit_set"
 
-
 # extracted from amqp gem. MK.
-describe AMQ::BitSet do
+RSpec.describe AMQ::BitSet do
 
   #
   # Environment

data/spec/amq/int_allocator_spec.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
-require 'spec_helper'
 require "amq/int_allocator"
 
-describe AMQ::IntAllocator do
+RSpec.describe AMQ::IntAllocator do
 
   #
   # Environment

data/spec/amq/pack_spec.rb

@@ -1,76 +1,68 @@
 # encoding: binary
 
-require File.expand_path('../../spec_helper', __FILE__)
-
-
-module AMQ
-  describe Pack do
-    context "16-bit big-endian packing / unpacking" do
-      let(:examples_16bit) {
-        {
-            0x068D => "\x06\x8D" # 1677
-        }
+RSpec.describe AMQ::Pack do
+  context "16-bit big-endian packing / unpacking" do
+    let(:examples_16bit) {
+      {
+          0x068D => "\x06\x8D" # 1677
       }
+    }
 
-      it "unpacks signed integers from a string to a number" do
-        examples_16bit.each do |key, value|
-          expect(described_class.unpack_int16_big_endian(value)[0]).to eq(key)
-        end
+    it "unpacks signed integers from a string to a number" do
+      examples_16bit.each do |key, value|
+        expect(described_class.unpack_int16_big_endian(value)[0]).to eq(key)
       end
     end
+  end
 
-
-
-    context "64-bit big-endian packing / unpacking" do
-      let(:examples) {
-        {
-          0x0000000000000000 => "\x00\x00\x00\x00\x00\x00\x00\x00",
-          0x000000000000000A => "\x00\x00\x00\x00\x00\x00\x00\x0A",
-          0x00000000000000A0 => "\x00\x00\x00\x00\x00\x00\x00\xA0",
-          0x000000000000B0A0 => "\x00\x00\x00\x00\x00\x00\xB0\xA0",
-          0x00000000000CB0AD => "\x00\x00\x00\x00\x00\x0C\xB0\xAD",
-          0x8BADF00DDEFEC8ED => "\x8B\xAD\xF0\x0D\xDE\xFE\xC8\xED",
-          0x0D15EA5EFEE1DEAD => "\x0D\x15\xEA\x5E\xFE\xE1\xDE\xAD",
-          0xDEADBEEFDEADBABE => "\xDE\xAD\xBE\xEF\xDE\xAD\xBA\xBE"
-        }
+  context "64-bit big-endian packing / unpacking" do
+    let(:examples) {
+      {
+        0x0000000000000000 => "\x00\x00\x00\x00\x00\x00\x00\x00",
+        0x000000000000000A => "\x00\x00\x00\x00\x00\x00\x00\x0A",
+        0x00000000000000A0 => "\x00\x00\x00\x00\x00\x00\x00\xA0",
+        0x000000000000B0A0 => "\x00\x00\x00\x00\x00\x00\xB0\xA0",
+        0x00000000000CB0AD => "\x00\x00\x00\x00\x00\x0C\xB0\xAD",
+        0x8BADF00DDEFEC8ED => "\x8B\xAD\xF0\x0D\xDE\xFE\xC8\xED",
+        0x0D15EA5EFEE1DEAD => "\x0D\x15\xEA\x5E\xFE\xE1\xDE\xAD",
+        0xDEADBEEFDEADBABE => "\xDE\xAD\xBE\xEF\xDE\xAD\xBA\xBE"
       }
+    }
 
-      it "packs integers into big-endian string" do
-        examples.each do |key, value|
-          expect(described_class.pack_uint64_big_endian(key)).to eq(value)
-        end
+    it "packs integers into big-endian string" do
+      examples.each do |key, value|
+        expect(described_class.pack_uint64_big_endian(key)).to eq(value)
       end
+    end
 
-      it "should unpack string representation into integer" do
-        examples.each do |key, value|
-          expect(described_class.unpack_uint64_big_endian(value)[0]).to eq(key)
-        end
+    it "should unpack string representation into integer" do
+      examples.each do |key, value|
+        expect(described_class.unpack_uint64_big_endian(value)[0]).to eq(key)
       end
+    end
 
-      if RUBY_VERSION < '1.9'
-        describe "with utf encoding" do
-          before do
-            $KCODE = 'u'
-          end
+    if RUBY_VERSION < '1.9'
+      describe "with utf encoding" do
+        before do
+          $KCODE = 'u'
+        end
 
-          after do
-            $KCODE = 'NONE'
-          end
+        after do
+          $KCODE = 'NONE'
+        end
 
-          it "packs integers into big-endian string" do
-            examples.each do |key, value|
-              expect(described_class.pack_uint64_big_endian(key)).to eq(value)
-            end
+        it "packs integers into big-endian string" do
+          examples.each do |key, value|
+            expect(described_class.pack_uint64_big_endian(key)).to eq(value)
           end
+        end
 
-          it "should unpack string representation into integer" do
-            examples.each do |key, value|
-              expect(described_class.unpack_uint64_big_endian(value)[0]).to eq(key)
-            end
+        it "should unpack string representation into integer" do
+          examples.each do |key, value|
+            expect(described_class.unpack_uint64_big_endian(value)[0]).to eq(key)
           end
         end
       end
-
     end
   end
 end

data/spec/amq/protocol/basic_spec.rb

@@ -1,42 +1,39 @@
 # encoding: binary
 
-require File.expand_path('../../../spec_helper', __FILE__)
-
-
 module AMQ
   module Protocol
-    describe Basic do
+    RSpec.describe AMQ::Protocol::Basic do
       describe '.encode_timestamp' do
         it 'encodes the timestamp as a 64 byte big endian integer' do
           expect(Basic.encode_timestamp(12345).last).to eq("\x00\x00\x00\x00\x00\x0009")
         end
       end
-      
+
       # describe '.decode_timestamp' do
       #   it 'decodes the timestamp from a 64 byte big endian integer and returns a Time object' do
       #     expect(Basic.decode_timestamp("\x00\x00\x00\x00\x00\x0009")).to eq(Time.at(12345))
       #   end
       # end
-      
+
       describe '.encode_headers' do
         it 'encodes the headers as a table' do
           expect(Basic.encode_headers(:hello => 'world').last).to eq("\x00\x00\x00\x10\x05helloS\x00\x00\x00\x05world")
         end
       end
-      
+
       # describe '.decode_headers' do
       #   it 'decodes the headers from a table' do
       #     expect(Basic.decode_headers("\x00\x00\x00\x10\x05helloS\x00\x00\x00\x05world")).to eq({'hello' => 'world'})
       #   end
       # end
-      
+
       describe '.encode_properties' do
         it 'packs the parameters into a byte array using the other encode_* methods' do
           result = Basic.encode_properties(10, {:priority => 0, :delivery_mode => 2, :content_type => 'application/octet-stream'})
           expect(result).to eq("\x00<\x00\x00\x00\x00\x00\x00\x00\x00\x00\x0a\x98\x00\x18application/octet-stream\x02\x00")
         end
       end
-      
+
       describe '.decode_properties' do
         it 'unpacks the properties from a byte array using the decode_* methods' do
           result = Basic.decode_properties("\x98@\x18application/octet-stream\x02\x00\x00\x00\x00\x00\x00\x00\x00{")
@@ -48,7 +45,7 @@ module AMQ
           expect(result).to eq({:priority => 0, :delivery_mode => 2, :content_type => 'application/octet-stream', :timestamp => Time.at(123), :headers => {'hello' => 'world'}})
         end
       end
-      
+
       %w(content_type content_encoding correlation_id reply_to expiration message_id type user_id app_id cluster_id).each do |method|
         describe ".encode_#{method}" do
           it 'encodes the parameter as a Pascal string' do
@@ -63,7 +60,7 @@ module AMQ
         #   end
         # end
       end
-      
+
       %w(delivery_mode priority).each do |method|
         describe ".encode_#{method}" do
           it 'encodes the parameter as a char' do
@@ -78,9 +75,9 @@ module AMQ
         # end
       end
     end
-    
+
     class Basic
-      describe Qos do
+      RSpec.describe Qos do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -94,12 +91,12 @@ module AMQ
         end
       end
 
-      # describe QosOk do
+      # RSpec.describe QosOk do
       #   describe '.decode' do
       #   end
       # end
 
-      describe Consume do
+      RSpec.describe Consume do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -116,18 +113,18 @@ module AMQ
           end
         end
       end
-      
-      describe ConsumeOk do
+
+      RSpec.describe ConsumeOk do
         describe '.decode' do
           subject do
             ConsumeOk.decode("\x03foo")
           end
-          
+
           its(:consumer_tag) { should eq('foo') }
         end
       end
 
-      describe Cancel do
+      RSpec.describe Cancel do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -138,27 +135,27 @@ module AMQ
             expect(method_frame.channel).to eq(1)
           end
         end
-        
+
         describe '.decode' do
           subject do
-            CancelOk.decode("\x03foo\x01")            
+            CancelOk.decode("\x03foo\x01")
           end
 
           its(:consumer_tag) { should eq('foo') }
         end
       end
 
-      describe CancelOk do
+      RSpec.describe CancelOk do
         describe '.decode' do
           subject do
             CancelOk.decode("\x03foo")
           end
-          
+
           its(:consumer_tag) { should eq('foo') }
         end
       end
 
-      describe Publish do
+      RSpec.describe Publish do
         describe '.encode' do
           it 'encodes the parameters into a list of MethodFrames' do
             channel = 1
@@ -181,12 +178,12 @@ module AMQ
         end
       end
 
-      describe Return do
+      RSpec.describe Return do
         describe '.decode' do
           subject do
             Return.decode("\x019\fNO_CONSUMERS\namq.fanout\x00")
           end
-          
+
           its(:reply_code) { should eq(313) }
           its(:reply_text) { should eq('NO_CONSUMERS') }
           its(:exchange) { should eq('amq.fanout') }
@@ -194,12 +191,12 @@ module AMQ
         end
       end
 
-      describe Deliver do
+      RSpec.describe Deliver do
         describe '.decode' do
           subject do
             Deliver.decode("\e-1300560114000-445586772970\x00\x00\x00\x00\x00\x00\x00c\x00\namq.fanout\x00")
           end
-          
+
           its(:consumer_tag) { should eq('-1300560114000-445586772970') }
           its(:delivery_tag) { should eq(99) }
           its(:redelivered) { should eq(false) }
@@ -207,8 +204,8 @@ module AMQ
           its(:routing_key) { should eq('') }
         end
       end
-      
-      describe Get do
+
+      RSpec.describe Get do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -220,13 +217,13 @@ module AMQ
           end
         end
       end
-      
-      describe GetOk do
+
+      RSpec.describe GetOk do
         describe '.decode' do
           subject do
             GetOk.decode("\x00\x00\x00\x00\x00\x00\x00\x06\x00\namq.fanout\x00\x00\x00\x00^")
           end
-          
+
           its(:delivery_tag) { should eq(6) }
           its(:redelivered) { should eq(false) }
           its(:exchange) { should eq('amq.fanout') }
@@ -234,18 +231,18 @@ module AMQ
           its(:message_count) { should eq(94) }
         end
       end
-      
-      describe GetEmpty do
+
+      RSpec.describe GetEmpty do
         describe '.decode' do
           subject do
             GetEmpty.decode("\x03foo")
           end
-          
+
           its(:cluster_id) { should eq('foo') }
         end
       end
 
-      describe Ack do
+      RSpec.describe Ack do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -257,8 +254,8 @@ module AMQ
           end
         end
       end
-      
-      describe Reject do
+
+      RSpec.describe Reject do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -270,8 +267,8 @@ module AMQ
           end
         end
       end
-      
-      describe RecoverAsync do
+
+      RSpec.describe RecoverAsync do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -282,8 +279,8 @@ module AMQ
           end
         end
       end
-      
-      describe Recover do
+
+      RSpec.describe Recover do
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1
@@ -295,22 +292,22 @@ module AMQ
         end
       end
 
-      # describe RecoverOk do
+      # RSpec.describe RecoverOk do
       #   describe '.decode' do
       #   end
       # end
-      
-      describe Nack do
+
+      RSpec.describe Nack do
         describe '.decode' do
           subject do
             Nack.decode("\x00\x00\x00\x00\x00\x00\x00\x09\x03")
           end
-          
+
           its(:delivery_tag) { should eq(9) }
           its(:multiple) { should eq(true) }
           its(:requeue) { should eq(true) }
         end
-        
+
         describe '.encode' do
           it 'encodes the parameters into a MethodFrame' do
             channel = 1