amqp 1.1.0.pre1 → 1.1.0.pre2

data/lib/amqp/settings.rb

@@ -0,0 +1,157 @@
+# encoding: utf-8
+
+require "amq/protocol/client"
+require "uri"
+
+module AMQP
+  # @see AMQP::Settings.configure
+  module Settings
+    # @private
+    AMQP_PORTS = {"amqp" => 5672, "amqps" => 5671}.freeze
+
+    # @private
+    AMQPS = "amqps".freeze
+
+    # Default connection settings used by AMQ clients
+    #
+    # @see AMQP::Settings.configure
+    def self.default
+      @default ||= {
+        # server
+        :host  => "127.0.0.1",
+        :port  => AMQ::Protocol::DEFAULT_PORT,
+
+        # login
+        :user           => "guest",
+        :pass           => "guest",
+        :auth_mechanism => "PLAIN",
+        :vhost          => "/",
+
+        # connection timeout
+        :timeout => nil,
+
+        # logging
+        :logging => false,
+
+        # ssl
+        :ssl => false,
+
+        :frame_max => 131072,
+        :heartbeat => 0
+      }
+    end
+
+    CLIENT_PROPERTIES = {
+      :platform    => ::RUBY_DESCRIPTION,
+      :product     => "amqp gem",
+      :information => "http://github.com/ruby-amqp/amqp",
+      :version     => AMQP::VERSION
+    }
+
+    def self.client_properties
+      @client_properties ||= CLIENT_PROPERTIES
+    end
+
+
+    # Merges given configuration parameters with defaults and returns
+    # the result.
+    #
+    # @param [Hash] Configuration parameters to use.
+    #
+    # @option settings [String] :host ("127.0.0.1") Hostname AMQ broker runs on.
+    # @option settings [String] :port (5672) Port AMQ broker listens on.
+    # @option settings [String] :vhost ("/") Virtual host to use.
+    # @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] :logging (false) Turns logging on or off.
+    # @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.
+    #
+    # @return [Hash] Merged configuration parameters.
+    def self.configure(settings = nil)
+      case settings
+      when Hash then
+        if username = settings.delete(:username)
+          settings[:user] ||= username
+        end
+
+        if password = settings.delete(:password)
+          settings[:pass] ||= password
+        end
+
+
+        self.default.merge(settings)
+      when String then
+        settings = self.parse_amqp_url(settings)
+        self.default.merge(settings)
+      when NilClass then
+        self.default
+      end
+    end
+
+    # Parses AMQP connection URI and returns its components as a hash.
+    #
+    # h2. vhost naming schemes
+    #
+    # It is convenient to be able to specify the AMQP connection
+    # parameters as a URI string, and various "amqp" URI schemes
+    # exist.  Unfortunately, there is no standard for these URIs, so
+    # while the schemes share the basic idea, they differ in some
+    # details.  This implementation aims to encourage URIs that work
+    # as widely as possible.
+    #
+    # The URI scheme should be "amqp", or "amqps" if SSL is required.
+    #
+    # The host, port, username and password are represented in the
+    # authority component of the URI in the same way as in http URIs.
+    #
+    # The vhost is obtained from the first segment of the path, with the
+    # leading slash removed.  The path should contain only a single
+    # segment (i.e, the only slash in it should be the leading one).
+    # If the vhost is to include slashes or other reserved URI
+    # characters, these should be percent-escaped.
+    #
+    # @example How vhost is parsed
+    #
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com")            # => vhost is nil, so default (/) will be used
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/")           # => vhost is an empty string
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/%2Fvault")   # => vhost is /vault
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/production") # => vhost is production
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/a.b.c")      # => vhost is a.b.c
+    #   AMQP::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/foo/bar")    # => ArgumentError
+    #
+    #
+    # @param [String] connection_string AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877.
+    # @return [Hash] Connection parameters (:username, :password, :vhost, :host, :port, :ssl)
+    #
+    # @raise [ArgumentError] When connection URI schema is not amqp or amqps, or the path contains multiple segments
+    #
+    # @see http://bit.ly/ks8MXK Connecting to The Broker documentation guide
+    # @api public
+    def self.parse_amqp_url(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://rubyamqp.info") unless %w{amqp amqps}.include?(uri.scheme)
+
+      opts = {}
+
+      opts[:scheme] = uri.scheme
+      opts[:user]   = URI.unescape(uri.user) if uri.user
+      opts[:pass]   = URI.unescape(uri.password) if uri.password
+      opts[:host]   = uri.host if uri.host
+      opts[:port]   = uri.port || AMQP::Settings::AMQP_PORTS[uri.scheme]
+      opts[:ssl]    = uri.scheme == AMQP::Settings::AMQPS
+      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://rubyamqp.info") if $1.index('/')
+        opts[:vhost] = URI.unescape($1)
+      end
+
+      opts
+    end
+
+    def self.parse_connection_uri(connection_string)
+      parse_amqp_url(connection_string)
+    end
+  end
+end

data/lib/amqp/version.rb

@@ -6,5 +6,5 @@ module AMQP
   #
   # @see AMQ::Protocol::VERSION
   # @return [String] AMQP gem version
-  VERSION = '1.1.0.pre1'
+  VERSION = '1.1.0.pre2'
 end

data/spec/integration/authentication_spec.rb

@@ -67,7 +67,7 @@ describe "Authentication attempt" do
       end # context
 
       context "and provided credentials ARE INCORRECT" do
-        default_timeout 10
+        default_timeout 5
 
         after(:all) { done }
 

data/spec/integration/extensions/rabbitmq/publisher_confirmations_spec.rb

@@ -29,21 +29,6 @@ describe "confirm.select" do
       end
     end
   end
-
-
-  context "with :nowait attribute set" do
-    it "results in NOT confirm.select-ok response" do
-      lambda do
-        @channel.confirm_select(:nowait => true) do
-          fail "Should never be called"
-        end
-      end.should raise_error(ArgumentError, /makes no sense/)
-
-      @channel.confirm_select(:nowait => true)
-
-      done(0.5)
-    end
-  end
 end
 
 

data/spec/integration/store_and_forward_spec.rb

@@ -51,7 +51,7 @@ describe "Store-and-forward routing" do
 
         @queue.purge
         @queue.subscribe(:ack => false) do |payload|
-          payload.should_not be_nil
+          payload.should be_instance_of(String)
           number_of_received_messages += 1
           payload.should == dispatched_data
         end # subscribe

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ require "evented-spec"
 require "effin_utf8"
 require "multi_json"
 
-puts "Using Ruby #{RUBY_VERSION}, amq-client #{AMQ::Client::VERSION} and amq-protocol #{AMQ::Protocol::VERSION}"
+puts "Using Ruby #{RUBY_VERSION} and amq-protocol #{AMQ::Protocol::VERSION}"
 
 
 amqp_config = File.dirname(__FILE__) + '/amqp.yml'

data/spec/unit/amqp/client_spec.rb

@@ -2,7 +2,9 @@
 
 require 'spec_helper'
 
-describe AMQP::Client do
+require "amqp/settings"
+
+describe AMQP::Settings do
 
   #
   # Examples

data/spec/unit/amqp/connection_spec.rb

@@ -3,53 +3,22 @@
 require 'spec_helper'
 require 'amqp'
 
-describe AMQP, 'class object' do
-
-  #
-  # Environment
-  #
-
-  subject { AMQP }
+describe AMQP do
 
   #
   # Examples
   #
 
-  its(:settings) do
-    # TODO: rewrite using key should eql value,
-    # it's not very wise to check frame_max etc.
-    should == {
-      :host      => "127.0.0.1",
-      :port      => 5672,
-      :user      => "guest",
-      :pass      => "guest",
-      :vhost     => "/",
-      :timeout   => nil,
-      :logging   => false,
-      :ssl       => false,
-      :broker    => nil,
-      :frame_max => 131072,
-      :heartbeat => 0,
-      :auth_mechanism => "PLAIN"
-    }
-  end
-
-  its(:client) { should == AMQP::Session }
-
-
-
-
-  describe 'logging' do
-    after(:all) do
-      AMQP.logging = false
-    end
-
-    it 'is silent by default' do
-      AMQP.logging.should be_false
-    end
-  end # .logging=
-
+  it "has default settings" do
+    s = AMQP.settings.dup
 
+    s[:host].should == "127.0.0.1"
+    s[:port].should == 5672
+    s[:user].should == "guest"
+    s[:pass].should == "guest"
+    s[:heartbeat].should == 0
+    s[:auth_mechanism].should == "PLAIN"
+  end
 
 
   describe '.start' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amqp
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre1
+  version: 1.1.0.pre2
 platform: ruby
 authors:
 - Aman Gupta
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -26,20 +26,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: amq-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0.pre1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0.pre1
 - !ruby/object:Gem::Dependency
   name: amq-protocol
   requirement: !ruby/object:Gem::Requirement
@@ -238,22 +224,32 @@ files:
 - examples/tls_certificates/testca/private/cakey.pem
 - examples/tls_certificates/testca/serial
 - examples/tls_certificates/testca/serial.old
+- lib/amq/protocol/get_response.rb
 - lib/amqp.rb
+- lib/amqp/auth_mechanism_adapter.rb
+- lib/amqp/auth_mechanism_adapter/external.rb
+- lib/amqp/auth_mechanism_adapter/plain.rb
 - lib/amqp/bit_set.rb
 - lib/amqp/broker.rb
+- lib/amqp/callbacks.rb
 - lib/amqp/channel.rb
-- lib/amqp/client.rb
 - lib/amqp/compatibility/ruby187_patchlevel_check.rb
-- lib/amqp/connection.rb
 - lib/amqp/consumer.rb
+- lib/amqp/consumer_tag_generator.rb
+- lib/amqp/deferrable.rb
+- lib/amqp/entity.rb
 - lib/amqp/exceptions.rb
 - lib/amqp/exchange.rb
 - lib/amqp/extensions/rabbitmq.rb
+- lib/amqp/framing/string/frame.rb
+- lib/amqp/handlers_registry.rb
 - lib/amqp/header.rb
 - lib/amqp/int_allocator.rb
 - lib/amqp/integration/rails.rb
+- lib/amqp/openable.rb
 - lib/amqp/queue.rb
 - lib/amqp/session.rb
+- lib/amqp/settings.rb
 - lib/amqp/utilities/event_loop_helper.rb
 - lib/amqp/utilities/server_type.rb
 - lib/amqp/version.rb
@@ -325,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: amqp
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Widely used, feature-rich asynchronous RabbitMQ client with batteries included

data/lib/amqp/client.rb

@@ -1,100 +0,0 @@
-# encoding: utf-8
-
-require 'amq/client/settings'
-require "amqp/session"
-
-module AMQP
-  # @private
-  module Client
-
-    # @private
-    AMQP_PORTS = Hash["amqp" => 5672, "amqps" => 5671].freeze
-    # @private
-    AMQPS      = "amqps".freeze
-
-
-    # {AMQP.connect} delegates to this method. There is no reason for applications or
-    # libraries to use this method directly.
-    #
-    #
-    # @note This method is not part of the public API and may be removed in the future without any warning.
-    # @see AMQP.start
-    # @see AMQP.connect
-    # @api plugin
-    #
-    # @see http://rubyamqp.info/articles/connecting_to_broker/ Connecting to The Broker documentation guide
-    def self.connect(connection_string_or_options = {}, options = {}, &block)
-      opts = case connection_string_or_options
-             when String then
-               parse_connection_uri(connection_string_or_options)
-             when Hash then
-               connection_string_or_options
-             else
-               Hash.new
-             end
-
-      connection = if block
-                     AMQP.client.connect(opts.merge(options), &block)
-                   else
-                     AMQP.client.connect(opts.merge(options))
-                   end
-
-      connection
-    end
-
-    # Parses AMQP connection URI and returns its components as a hash.
-    #
-    # h2. vhost naming schemes
-    #
-    # It is convenient to be able to specify the AMQP connection
-    # parameters as a URI string, and various "amqp" URI schemes
-    # exist.  Unfortunately, there is no standard for these URIs, so
-    # while the schemes share the basic idea, they differ in some
-    # details.  This implementation aims to encourage URIs that work
-    # as widely as possible.
-    #
-    # The URI scheme should be "amqp", or "amqps" if SSL is required.
-    #
-    # The host, port, username and password are represented in the
-    # authority component of the URI in the same way as in http URIs.
-    #
-    # The vhost is obtained from the first segment of the path, with the
-    # leading slash removed.  The path should contain only a single
-    # segment (i.e, the only slash in it should be the leading one).
-    # If the vhost is to include slashes or other reserved URI
-    # characters, these should be percent-escaped.
-    #
-    # @example How vhost is parsed
-    #
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com")            # => vhost is nil, so default (/) will be used
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/")           # => vhost is an empty string
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/%2Fvault")   # => vhost is /vault
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/production") # => vhost is production
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/a.b.c")      # => vhost is a.b.c
-    #   AMQP::Client.parse_connection_uri("amqp://dev.rabbitmq.com/foo/bar")    # => ArgumentError
-    #
-    #
-    # @param [String] connection_string AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877.
-    # @return [Hash] Connection parameters (:username, :password, :vhost, :host, :port, :ssl)
-    #
-    # @raise [ArgumentError] When connection URI schema is not amqp or amqps, or the path contains multiple segments
-    #
-    # @see http://rubyamqp.info/articles/connecting_to_broker/ Connecting to The Broker documentation guide
-    # @api public
-    def self.parse_connection_uri(connection_string)
-      AMQ::Client::Settings.parse_amqp_url(connection_string)
-    end
-  end # Client
-
-
-
-  # @private
-  def self.client
-    @client_implementation ||= AMQP::Session
-  end
-
-  # @private
-  def self.client=(value)
-    @client_implementation = value
-  end
-end # AMQP