bunny 0.6.3.rc2 → 0.7

data/lib/bunny/subscription08.rb

@@ -1,5 +1,7 @@
+# encoding: utf-8
+
 module Bunny
-	
+
 =begin rdoc
 
 === DESCRIPTION:
@@ -27,10 +29,10 @@ processing. If error occurs, _Bunny_::_ProtocolError_ is raised.
 
 ==== OPERATION:
 
-Passes a hash of message information to the block, if one has been supplied. The hash contains 
+Passes a hash of message information to the block, if one has been supplied. The hash contains
 :header, :payload and :delivery_details. The structure of the data is as follows -
 
-:header has instance variables - 
+:header has instance variables -
   @klass
   @size
   @weight
@@ -45,7 +47,7 @@ Passes a hash of message information to the block, if one has been supplied. The
   :consumer_tag
   :delivery_tag
   :redelivered
-  :exchange 
+  :exchange
   :routing_key
 
 If the :timeout option is specified then Qrack::ClientTimeout is raised if method times out
@@ -58,28 +60,27 @@ my_queue.subscribe(:timeout => 5) {|msg| puts msg[:payload]}
 my_queue.subscribe(:message_max => 10, :ack => true) {|msg| puts msg[:payload]}
 
 =end
-	
-	class Subscription < Qrack::Subscription
-
-	
-		def setup_consumer
-			client.send_frame(
-				Qrack::Protocol::Basic::Consume.new({ :queue => queue.name,
-																					 		:consumer_tag => consumer_tag,
-																					 		:no_ack => !ack,
-																							:exclusive => exclusive,
-																					 		:nowait => false }.merge(@opts))
-												)
-
-			method = client.next_method
-			
-			client.check_response(method,	Qrack::Protocol::Basic::ConsumeOk,
-				"Error subscribing to queue #{queue.name}")
-		
-			@consumer_tag = method.consumer_tag
-		
-		end
-	
-	end
-	
-end
+
+  class Subscription < Bunny::Consumer
+
+    def setup_consumer
+      subscription_options = {
+        :queue => queue.name,
+        :consumer_tag => consumer_tag,
+        :no_ack => !ack,
+        :exclusive => exclusive,
+        :nowait => false
+      }.merge(@opts)
+
+      client.send_frame(Qrack::Protocol::Basic::Consume.new(subscription_options))
+
+      method = client.next_method
+
+      client.check_response(method, Qrack::Protocol::Basic::ConsumeOk, "Error subscribing to queue #{queue.name}")
+
+      @consumer_tag = method.consumer_tag
+    end
+
+  end
+
+end

data/lib/bunny/subscription09.rb

@@ -1,85 +1,86 @@
-module Bunny
-	
-=begin rdoc
-
-=== DESCRIPTION:
-
-Asks the server to start a "consumer", which is a transient request for messages from a specific
-queue. Consumers last as long as the channel they were created on, or until the client cancels them
-with an _unsubscribe_. Every time a message reaches the queue it is passed to the _blk_ for
-processing. If error occurs, _Bunny_::_ProtocolError_ is raised.
-
-==== OPTIONS:
-* <tt>:consumer_tag => '_tag_'</tt> - Specifies the identifier for the consumer. The consumer tag is
-  local to a connection, so two clients can use the same consumer tags. If this option is not
-  specified a server generated name is used.
-* <tt>:ack => false (_default_) or true</tt> - If set to _false_, the server does not expect an
-  acknowledgement message from the client. If set to _true_, the server expects an acknowledgement
-  message from the client and will re-queue the message if it does not receive one within a time specified
-  by the server.
-* <tt>:exclusive => true or false (_default_)</tt> - Request exclusive consumer access, meaning
-  only this consumer can access the queue.
-* <tt>:nowait => true or false (_default_)</tt> - Ignored by Bunny, always _false_.
-* <tt>:timeout => number of seconds - The subscribe loop will continue to wait for
-  messages until terminated (Ctrl-C or kill command) or this timeout interval is reached.
-* <tt>:message_max => max number messages to process</tt> - When the required number of messages
-  is processed subscribe loop is exited.
-
-==== OPERATION:
-
-Passes a hash of message information to the block, if one has been supplied. The hash contains 
-:header, :payload and :delivery_details. The structure of the data is as follows -
-
-:header has instance variables - 
-  @klass
-  @size
-  @weight
-  @properties is a hash containing -
-    :content_type
-    :delivery_mode
-    :priority
-
-:payload contains the message contents
+# encoding: utf-8
 
-:delivery details is a hash containing -
-  :consumer_tag
-  :delivery_tag
-  :redelivered
-  :exchange 
-  :routing_key
-
-If the :timeout option is specified then Qrack::ClientTimeout is raised if method times out
-waiting to receive the next message from the queue.
-
-==== EXAMPLES
-
-my_queue.subscribe(:timeout => 5) {|msg| puts msg[:payload]}
-
-my_queue.subscribe(:message_max => 10, :ack => true) {|msg| puts msg[:payload]}
-
-=end
-	
-	class Subscription09 < Qrack::Subscription
-	
-		def setup_consumer
-			client.send_frame(
-				Qrack::Protocol09::Basic::Consume.new({ :deprecated_ticket => 0,
-																			 					:queue => queue.name,
-																	 		 					:consumer_tag => consumer_tag,
-																	 		 					:no_ack => !ack,
-																								:exclusive => exclusive,
-																	 		 					:nowait => false}.merge(@opts))
-												)
-
-			method = client.next_method
-
-			client.check_response(method,	Qrack::Protocol09::Basic::ConsumeOk,
-				"Error subscribing to queue #{queue.name}")
+module Bunny
 
-			@consumer_tag = method.consumer_tag
-		
-		end
-	
-	end
-	
-end
+  # Asks the server to start a "consumer", which is a transient request for messages from a specific
+  # queue. Consumers last as long as the channel they were created on, or until the client cancels them
+  # with an @unsubscribe@. Every time a message reaches the queue it is passed to the @blk@ for
+  # processing. If error occurs, {Bunny::ProtocolError} is raised.
+  #
+  # @option opts [String] :consumer_tag
+  #   Specifies the identifier for the consumer. The consumer tag is
+  #   local to a connection, so two clients can use the same consumer tags.
+  #   If this option is not specified a server generated name is used.
+  #
+  # @option opts [Boolean] :ack (false)
+  #   If set to @false@, the server does not expect an acknowledgement message
+  #   from the client. If set to @true, the server expects an acknowledgement
+  #   message from the client and will re-queue the message if it does not
+  #   receive one within a time specified by the server.
+  #
+  # @option opts [Boolean] :exclusive (false)
+  #   Request exclusive consumer access, meaning only this consumer can access the queue.
+  #
+  # @option opts [Boolean] :nowait (false)
+  #   Ignored by Bunny, always @false@.
+  #
+  # @option opts [Numeric] :timeout
+  #   The subscribe loop will continue to wait for messages
+  #   until terminated (Ctrl-C or kill command) or this timeout interval is reached.
+  #
+  # @option opts [Integer] :message_max
+  #   When the required number of messages is processed subscribe loop is exited.
+  #
+  # h2. Operation
+  #
+  # Passes a hash of message information to the block, if one has been supplied. The hash contains
+  # :header, :payload and :delivery_details. The structure of the data is as follows -
+  #
+  # :header has instance variables -
+  #   @klass
+  #   @size
+  #   @weight
+  #   @properties is a hash containing -
+  #     :content_type
+  #     :delivery_mode
+  #     :priority
+  #
+  # :payload contains the message contents
+  #
+  # :delivery details is a hash containing -
+  #   :consumer_tag
+  #   :delivery_tag
+  #   :redelivered
+  #   :exchange
+  #   :routing_key
+  #
+  # If the :timeout option is specified then Qrack::ClientTimeout is raised if method times out
+  # waiting to receive the next message from the queue.
+  #
+  # @example
+  #   my_queue.subscribe(timeout: 5) { |msg| puts msg[:payload] }
+  #   my_queue.subscribe(message_max: 10, ack: true) { |msg| puts msg[:payload] }
+  class Subscription09 < Bunny::Consumer
+
+    def setup_consumer
+      subscription_options = {
+        :deprecated_ticket => 0,
+        :queue => queue.name,
+        :consumer_tag => consumer_tag,
+        :no_ack => !ack,
+        :exclusive => exclusive,
+        :nowait => false
+      }.merge(@opts)
+
+      client.send_frame(Qrack::Protocol09::Basic::Consume.new(subscription_options))
+
+      method = client.next_method
+
+      client.check_response(method, Qrack::Protocol09::Basic::ConsumeOk, "Error subscribing to queue #{queue.name}")
+
+      @consumer_tag = method.consumer_tag
+    end
+
+  end
+
+end

data/lib/bunny/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Bunny
+  VERSION = "0.7"
+end

data/lib/qrack/amq-client-url.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+################################################################
+#                  DO NOT EDIT THIS FILE !                     #
+# The file comes from https://github.com/ruby-amqp/amq-client, #
+# it's located in lib/amq/client/settings.rb, so if you want   #
+# to make some changes, please do them in the amq-client repo. #
+################################################################
+
+# TODO: When we start to work on porting Bunny on AMQ Client,
+# this file will become obsolete.
+
+require "uri"
+
+module AMQ
+  module Client
+    # @see AMQ::Client::Settings.configure
+    module Settings
+      # @private
+      AMQP_PORTS = {"amqp" => 5672, "amqps" => 5671}.freeze
+
+      # @private
+      AMQPS = "amqps".freeze
+
+      # Default connection settings used by AMQ clients
+      #
+      # @see AMQ::Client::Settings.configure
+      def self.default
+        @default ||= {
+          # server
+          :host  => "127.0.0.1",
+          :port  => AMQ::Protocol::DEFAULT_PORT,
+
+          # login
+          :user  => "guest",
+          :pass  => "guest",
+          :vhost => "/",
+
+          # connection timeout
+          :timeout => nil,
+
+          # logging
+          :logging => false,
+
+          # ssl
+          :ssl => false,
+
+          # broker
+          # if you want to load broker-specific extensions
+          :broker => nil,
+
+          :frame_max => 131072
+        }
+      end
+
+
+      def self.client_properties
+        @client_properties ||= {
+          :platform    => ::RUBY_DESCRIPTION,
+          :product     => "AMQ Client",
+          :information => "http://github.com/ruby-amqp/amq-client",
+          :version     => AMQ::Client::VERSION
+        }
+      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
+      #
+      #   AMQ::Client::Settings.parse_amqp_url("amqp://dev.rabbitmq.com")            # => vhost is nil, so default (/) will be used
+      #   AMQ::Client::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/")           # => vhost is an empty string
+      #   AMQ::Client::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/%2Fvault")   # => vhost is /vault
+      #   AMQ::Client::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/production") # => vhost is production
+      #   AMQ::Client::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/a.b.c")      # => vhost is a.b.c
+      #   AMQ::Client::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://bit.ly/ks8MXK") 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 || AMQ::Client::Settings::AMQP_PORTS[uri.scheme]
+        opts[:ssl]    = uri.scheme == AMQ::Client::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://bit.ly/amqp-gem-and-connection-uris") if $1.index('/')
+          opts[:vhost] = URI.unescape($1)
+        end
+
+        opts
+      end
+    end
+  end
+end

data/lib/qrack/channel.rb

@@ -1,18 +1,20 @@
+# encoding: utf-8
+
 module Qrack
-	# Channel ancestor class
-	class Channel
-		
-		attr_accessor :number, :active, :frame_buffer
-		attr_reader :client
-		
-		def initialize(client)
-			@frame_buffer = []
-			@client = client
-			@number = client.channels.size
-			@active = false
-			client.channels[@number] = self
-		end
-		
-	end
-	
-end
+  # Channel ancestor class
+  class Channel
+
+    attr_accessor :number, :active, :frame_buffer
+    attr_reader :client
+
+    def initialize(client)
+      @frame_buffer = []
+      @client = client
+      @number = client.channels.size
+      @active = false
+      client.channels[@number] = self
+    end
+
+  end
+
+end