bunny 0.2.0 → 0.3.0

data/lib/bunny/transport/frame.rb

@@ -0,0 +1,62 @@
+module Bunny
+	module Transport #:nodoc: all
+	  class Frame
+	    def initialize payload = nil, channel = 0
+	      @channel, @payload = channel, payload
+	    end
+	    attr_accessor :channel, :payload
+
+	    def id
+	      self.class::ID
+	    end
+    
+	    def to_binary
+	      buf = Transport::Buffer.new
+	      buf.write :octet, id
+	      buf.write :short, channel
+	      buf.write :longstr, payload
+	      buf.write :octet, Transport::Frame::FOOTER
+	      buf.rewind
+	      buf
+	    end
+
+	    def to_s
+	      to_binary.to_s
+	    end
+
+	    def == frame
+	      [ :id, :channel, :payload ].inject(true) do |eql, field|
+	        eql and __send__(field) == frame.__send__(field)
+	      end
+	    end
+    
+	    class Method
+	      def initialize payload = nil, channel = 0
+	        super
+	        unless @payload.is_a? Protocol::Class::Method or @payload.nil?
+	          @payload = Protocol.parse(@payload)
+	        end
+	      end
+	    end
+
+	    class Header
+	      def initialize payload = nil, channel = 0
+	        super
+	        unless @payload.is_a? Protocol::Header or @payload.nil?
+	          @payload = Protocol::Header.new(@payload)
+	        end
+	      end
+	    end
+
+	    class Body; end
+
+	    def self.parse buf
+	      buf = Transport::Buffer.new(buf) unless buf.is_a? Transport::Buffer
+	      buf.extract do
+	        id, channel, payload, footer = buf.read(:octet, :short, :longstr, :octet)
+	        Transport::Frame.types[id].new(payload, channel) if footer == Transport::Frame::FOOTER
+	      end
+	    end
+	  end
+	end
+end

data/spec/bunny_spec.rb

@@ -11,12 +11,12 @@ require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib bunny]))
 describe Bunny do
 	
 	before(:each) do
-    @b = Bunny.new
+    @b = Bunny::Client.new
 		@b.start
 	end
 	
   it "should connect to an AMQP server" do
-    @b.status.should == 'CONNECTED'
+    @b.status.should == :connected
   end
 
 	it "should be able to create an exchange" do

data/spec/exchange_spec.rb

@@ -11,12 +11,12 @@ require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib bunny]))
 describe Bunny::Exchange do
 	
 	before(:each) do
-    @b = Bunny.new
+    @b = Bunny::Client.new
 		@b.start
 	end
 		
 	it "should raise an error if instantiated as non-existent type" do
-		lambda { @b.exchange('bogus_ex', :type => :bogus) }.should raise_error(API::ProtocolError)
+		lambda { @b.exchange('bogus_ex', :type => :bogus) }.should raise_error(Bunny::ProtocolError)
 	end
 	
 	it "should allow a default direct exchange to be instantiated by specifying :type" do
@@ -105,7 +105,7 @@ describe Bunny::Exchange do
 	it "should be able to be deleted" do
 		exch = @b.exchange('direct_exchange')
 		res = exch.delete
-		res.should == 'EXCHANGE DELETED'
+		res.should == :delete_ok
 		@b.exchanges.has_key?('direct_exchange').should be false
 	end
 	

data/spec/queue_spec.rb

@@ -11,7 +11,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib bunny]))
 describe Bunny::Queue do
 	
 	before(:each) do
-    @b = Bunny.new
+    @b = Bunny::Client.new
 		@b.start
 	end
 	
@@ -22,25 +22,25 @@ describe Bunny::Queue do
 	it "should ignore the :nowait option when binding to an exchange" do
 		exch = @b.exchange('direct_exch')
 		q = @b.queue('test0')
-		q.bind(exch, :nowait => true).should == 'BIND SUCCEEDED'
+		q.bind(exch, :nowait => true).should == :bind_ok
 	end
 	
 	it "should be able to bind to an exchange" do
 		exch = @b.exchange('direct_exch')
 		q = @b.queue('test1')
-		q.bind(exch).should == 'BIND SUCCEEDED'
+		q.bind(exch).should == :bind_ok
 	end
 	
 	it "should ignore the :nowait option when unbinding from an exchange" do
 		exch = @b.exchange('direct_exch')
 		q = @b.queue('test0')
-		q.unbind(exch, :nowait => true).should == 'UNBIND SUCCEEDED'
+		q.unbind(exch, :nowait => true).should == :unbind_ok
 	end
 	
 	it "should be able to unbind from an exchange" do
 		exch = @b.exchange('direct_exch')
 		q = @b.queue('test1')
-		q.unbind(exch).should == 'UNBIND SUCCEEDED'
+		q.unbind(exch).should == :unbind_ok
 	end
 
 	it "should be able to publish a message" do
@@ -49,12 +49,13 @@ describe Bunny::Queue do
 		q.message_count.should == 1
 	end
 	
-	it "should be able to pop a message complete with header" do
+	it "should be able to pop a message complete with header and delivery details" do
 		q = @b.queue('test1')
 		msg = q.pop(:header => true)
 		msg.should be_an_instance_of Hash
-		msg[:header].should be_an_instance_of Protocol::Header
+		msg[:header].should be_an_instance_of Bunny::Protocol::Header
 		msg[:payload].should == 'This is a test message'
+		msg[:delivery_details].should be_an_instance_of Hash
 		q.message_count.should == 0
 	end
 
@@ -71,13 +72,13 @@ describe Bunny::Queue do
 		q.publish('This is another test message')
 		q.pop
 		msg = q.pop
-		msg.should == 'QUEUE EMPTY'
+		msg.should == :queue_empty
 	end
 
 	it "should be able to be deleted" do
 		q = @b.queue('test1')
 		res = q.delete
-		res.should == 'QUEUE DELETED'
+		res.should == :delete_ok
 		@b.queues.has_key?('test1').should be false
 	end
 	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bunny
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Duncan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-01 00:00:00 +01:00
+date: 2009-05-10 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -19,38 +19,38 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
+- LICENSE
+- README
 - Rakefile
-- README.markdown
-- lib/api_messages.rb
-- lib/bunny.rb
-- lib/engineroom/buffer.rb
-- lib/engineroom/frame.rb
-- lib/engineroom/protocol.rb
-- lib/engineroom/spec.rb
-- lib/bunny/exchange.rb
-- lib/bunny/header.rb
-- lib/bunny/queue.rb
-- lib/bunny/client.rb
+- bunny.gemspec
 - examples/simple.rb
-- examples/simple_fanout.rb
+- examples/simple_ack.rb
 - examples/simple_consumer.rb
+- examples/simple_fanout.rb
 - examples/simple_publisher.rb
-- examples/simple_ack.rb
 - examples/simple_topic.rb
+- ext/amqp-0.8.json
+- ext/codegen.rb
+- lib/bunny.rb
+- lib/bunny/client.rb
+- lib/bunny/exchange.rb
+- lib/bunny/protocol/protocol.rb
+- lib/bunny/protocol/spec.rb
+- lib/bunny/queue.rb
+- lib/bunny/transport/buffer.rb
+- lib/bunny/transport/frame.rb
 - spec/bunny_spec.rb
 - spec/exchange_spec.rb
 - spec/queue_spec.rb
-- protocol/amqp-0.8.json
-- protocol/codegen.rb
 has_rdoc: true
 homepage: http://github.com/celldee/bunny
 post_install_message: 
 rdoc_options: 
-- --inline-source
-- --charset=UTF-8
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -71,6 +71,6 @@ rubyforge_project: bunny-amqp
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Another synchronous Ruby AMQP client
+summary: A synchronous Ruby AMQP client that enables interaction with AMQP-compliant brokers/servers.
 test_files: []
 

data/README.markdown

@@ -1,126 +0,0 @@
-# Bunny: A synchronous Ruby AMQP client
-
-Google Group: [http://groups.google.com/group/bunny-amqp](http://groups.google.com/group/bunny-amqp)
-
-Mailing List: [http://rubyforge.org/mailman/listinfo/bunny-amqp-devel](http://rubyforge.org/mailman/listinfo/bunny-amqp-devel)
-
-Rubyforge: [http://rubyforge.org/projects/bunny-amqp](http://rubyforge.org/projects/bunny-amqp)
-
-Twitter: [http://twitter.com/bunny_amqp](https://twitter.com/bunny_amqp)
-
-## Announcements
-
-Bunny v0.2.0 is now available. The highlights are -
-
-* Code has been re-organised enabling Bunny to play nicely with [amqp](http://github.com/tmm1/amqp) (thanks [Dan](http://github.com/danielsdeleo))
-* When instantiating a default exchange (one beginning with ‘amq.’) the type will be inferred from the name.
-* Fixed Queue#subscribe and included Queue#unsubscribe method. See examples/simple_consumer.rb for details
-
-## About
-
-*Bunny* is an [AMQP](http://www.amqp.org) (Advanced Message Queuing Protocol) client, written in Ruby, that is intended to allow you to interact with AMQP-compliant message brokers/servers such as [RabbitMQ](http://www.rabbitmq.com) in a synchronous fashion.
-
-It is based on a great deal of fabulous code from [amqp](http://github.com/tmm1/amqp) by Aman Gupta and [Carrot](http://github.com/famoseagle/carrot) by Amos Elliston.
-
-You can use *Bunny* to -
-
-* Create and delete exchanges
-* Create and delete queues
-* Publish and consume messages
- 
-*Bunny* is known to work with RabbitMQ version 1.5.4 and version 0-8 of the AMQP specification. If you want to try to use it with other AMQP message brokers/servers please let me know how you get on.
- 
-## Quick Start
-
-    require 'bunny'
-
-    b = Bunny.new(:logging => true)
-
-    # start a communication session with the amqp server
-    b.start
-
-    # declare a queue
-    q = b.queue('test1')
-
-    # publish a message to the queue
-    q.publish('Hello everybody!')
-
-    # get message from the queue
-    msg = q.pop
-
-    puts 'This is the message: ' + msg + "\n\n"
-
-    # close the connection
-    b.close
-
-## Bunny methods
-
-These are the Bunny methods that you will probably want to use -
-
-### Create a Bunny instance
-Bunny#new({_options_})
-
-### Start a communication session with the target server
-Bunny#start
-
-### Stop a communication session with the target server
-Bunny#stop
-
-### Create a Queue
-Bunny#queue(_**name**_, {_options_})
-
-### Create an Exchange
-Bunny#exchange(_**name**_, {_options_})
-
-### Return connection status ('CONNECTED' or 'NOT CONNECTED')
-Bunny#status               
-
-### Publish a message to an exchange
-Exchange#publish(_**data**_, {_options_})
-
-### Delete an exchange from the target server
-Exchange#delete({_options_})
-
-### Bind a queue to an exchange
-Queue#bind(_**exchange**_, {_options_})
-
-### Unbind a queue from an exchange
-Queue#unbind(_**exchange**_, {_options_})
-
-### Publish a message to a queue
-Queue#publish(_**data**_, {_options_})
-
-### Pop a message off of a queue
-Queue#pop({_options_})
-
-### Subscribe to a queue
-Queue#subscribe({_options_}, &blk)
-
-### Unsubscribe from a queue
-Queue#unsubscribe({_options_})
-
-### Return queue message count
-Queue#message_count
-
-### Return queue consumer count
-Queue#consumer_count
-
-### Return queue status (hash {:message count, :consumer_count})
-Queue#status
-
-### Delete a queue from the target server
-Queue#delete({_options_})
-
-### Acknowledge receipt of a message
-Queue#ack
-
-## Acknowledgements
-
-This project has borrowed heavily from the following two projects and owes their respective creators and collaborators a whole lot of gratitude:
-
-1. **amqp** by *tmm1* [http://github.com/tmm1/amqp/tree/master](http://github.com/tmm1/amqp/tree/master)
-2. **carrot** by *famoseagle* [http://github.com/famoseagle/carrot/tree/master](http://github.com/famoseagle/carrot/tree/master)
-
-## LICENSE
-
-Copyright (c) 2009 Chris Duncan; Published under The MIT License, see License

data/lib/api_messages.rb

@@ -1,18 +0,0 @@
-module API
-	# return messages
-	CONNECTED = 'CONNECTED'
-	NOT_CONNECTED = 'NOT CONNECTED'
-	QUEUE_EMPTY = 'QUEUE EMPTY'
-	QUEUE_DELETED = 'QUEUE DELETED'
-	EXCHANGE_DELETED = 'EXCHANGE DELETED'
-	BIND_SUCCEEDED = 'BIND SUCCEEDED'
-	UNBIND_SUCCEEDED = 'UNBIND SUCCEEDED'
-
-	# specific error definitions
-	class ProtocolError < StandardError; end
-	class ServerDownError < StandardError; end
-	class BufferOverflowError < StandardError; end
-  class InvalidTypeError < StandardError; end
-	class ConnectionError < StandardError; end
-	class MessageError < StandardError; end
-end

data/lib/bunny/header.rb

@@ -1,30 +0,0 @@
-module API
-	class Header
-	
-		attr_reader :client
-	
-	  def initialize(client, header_obj)
-	    @client = client
-	    @header = header_obj
-	  end
-
-	  # Acknowledges the receipt of this message with the server.
-	  def ack
-	    client.send(Protocol::Basic::Ack.new(:delivery_tag => properties[:delivery_tag]))
-	  end
-
-	  # Reject this message (XXX currently unimplemented in rabbitmq)
-	  # * :requeue => true | false (default false)
-	  def reject(opts = {})
-	    client.send(Protocol::Basic::Reject.new(opts.merge(:delivery_tag => properties[:delivery_tag])))
-	  end
-
-	  def method_missing(meth, *args, &blk)
-	    @header.send(meth, *args, &blk)
-	  end
-
-	  def inspect
-	    @header.inspect
-	  end
-	end
-end

data/lib/engineroom/buffer.rb

@@ -1,274 +0,0 @@
-if [].map.respond_to? :with_index
-  class Array #:nodoc:
-    def enum_with_index
-      each.with_index
-    end
-  end
-else
-  require 'enumerator'
-end
-
-module Transport
-  class Buffer #:nodoc: all
-    
-    def initialize data = ''
-      @data = data
-      @pos = 0
-    end
-
-    attr_reader :pos
-    
-    def data
-      @data.clone
-    end
-    alias :contents :data
-    alias :to_s :data
-
-    def << data
-      @data << data.to_s
-      self
-    end
-    
-    def length
-      @data.length
-    end
-    
-    def empty?
-      pos == length
-    end
-    
-    def rewind
-      @pos = 0
-    end
-    
-    def read_properties *types
-      types.shift if types.first == :properties
-      
-      i = 0
-      values = []
-
-      while props = read(:short)
-        (0..14).each do |n|
-          # no more property types
-          break unless types[i]
-          
-          # if flag is set
-          if props & (1<<(15-n)) != 0
-            if types[i] == :bit
-              # bit values exist in flags only
-              values << true
-            else
-              # save type name for later reading
-              values << types[i]
-            end
-          else
-            # property not set or is false bit
-            values << (types[i] == :bit ? false : nil)
-          end
-
-          i+=1
-        end
-
-        # bit(0) == 0 means no more property flags
-        break unless props & 1 == 1
-      end
-
-      values.map do |value|
-        value.is_a?(Symbol) ? read(value) : value
-      end
-    end
-
-    def read *types
-      if types.first == :properties
-        return read_properties(*types)
-      end
-
-      values = types.map do |type|
-        case type
-        when :octet
-          _read(1, 'C')
-        when :short
-          _read(2, 'n')
-        when :long
-          _read(4, 'N')
-        when :longlong
-          upper, lower = _read(8, 'NN')
-          upper << 32 | lower
-        when :shortstr
-          _read read(:octet)
-        when :longstr
-          _read read(:long)
-        when :timestamp
-          Time.at read(:longlong)
-        when :table
-          t = Hash.new
-
-          table = Buffer.new(read(:longstr))
-          until table.empty?
-            key, type = table.read(:shortstr, :octet)
-            key = key.intern
-            t[key] ||= case type
-                       when 83 # 'S'
-                         table.read(:longstr)
-                       when 73 # 'I'
-                         table.read(:long)
-                       when 68 # 'D'
-                         exp = table.read(:octet)
-                         num = table.read(:long)
-                         num / 10.0**exp
-                       when 84 # 'T'
-                         table.read(:timestamp)
-                       when 70 # 'F'
-                         table.read(:table)
-                       end
-          end
-
-          t
-        when :bit
-          if (@bits ||= []).empty?
-            val = read(:octet)
-            @bits = (0..7).map{|i| (val & 1<<i) != 0 }
-          end
-
-          @bits.shift
-        else
-          raise API::InvalidTypeError, "Cannot read data of type #{type}"
-        end
-      end
-      
-      types.size == 1 ? values.first : values
-    end
-    
-    def write type, data
-      case type
-      when :octet
-        _write(data, 'C')
-      when :short
-        _write(data, 'n')
-      when :long
-        _write(data, 'N')
-      when :longlong
-        lower =  data & 0xffffffff
-        upper = (data & ~0xffffffff) >> 32
-        _write([upper, lower], 'NN')
-      when :shortstr
-        data = (data || '').to_s
-        _write([data.length, data], 'Ca*')
-      when :longstr
-        if data.is_a? Hash
-          write(:table, data)
-        else
-          data = (data || '').to_s
-          _write([data.length, data], 'Na*')
-        end
-      when :timestamp
-        write(:longlong, data.to_i)
-      when :table
-        data ||= {}
-        write :longstr, (data.inject(Buffer.new) do |table, (key, value)|
-                          table.write(:shortstr, key.to_s)
-
-                          case value
-                          when String
-                            table.write(:octet, 83) # 'S'
-                            table.write(:longstr, value.to_s)
-                          when Fixnum
-                            table.write(:octet, 73) # 'I'
-                            table.write(:long, value)
-                          when Float
-                            table.write(:octet, 68) # 'D'
-                            # XXX there's gotta be a better way to do this..
-                            exp = value.to_s.split('.').last.length
-                            num = value * 10**exp
-                            table.write(:octet, exp)
-                            table.write(:long, num)
-                          when Time
-                            table.write(:octet, 84) # 'T'
-                            table.write(:timestamp, value)
-                          when Hash
-                            table.write(:octet, 70) # 'F'
-                            table.write(:table, value)
-                          end
-
-                          table
-                        end)
-      when :bit
-        [*data].to_enum(:each_slice, 8).each{|bits|
-          write(:octet, bits.enum_with_index.inject(0){ |byte, (bit, i)|
-            byte |= 1<<i if bit
-            byte
-           })
-         }
-      when :properties
-        values = []
-        data.enum_with_index.inject(0) do |short, ((type, value), i)|
-          n = i % 15
-          last = i+1 == data.size
-
-          if (n == 0 and i != 0) or last
-            if data.size > i+1
-              short |= 1<<0
-            elsif last and value
-              values << [type,value]
-              short |= 1<<(15-n)
-            end
-
-            write(:short, short)
-            short = 0
-          end
-
-          if value and !last
-            values << [type,value] 
-            short |= 1<<(15-n)
-          end
-
-          short
-        end
-        
-        values.each do |type, value|
-          write(type, value) unless type == :bit
-        end
-      else
-        raise API::InvalidTypeError, "Cannot write data of type #{type}"
-      end
-      
-      self
-    end
-
-    def extract
-      begin
-        cur_data, cur_pos = @data.clone, @pos
-        yield self
-      rescue API::BufferOverflowError
-        @data, @pos = cur_data, cur_pos
-        nil
-      end
-    end
-
-    def _read(size, pack = nil)
-      if @data.is_a?(API::Client)
-        raw = @data.read(size)
-        return raw if raw.nil? or pack.nil? 
-        return raw.unpack(pack).first
-      end
-
-      if @pos + size > length
-        raise API::BufferOverflowError
-      else
-        data = @data[@pos,size]
-        @data[@pos,size] = ''
-        if pack
-          data = data.unpack(pack)
-          data = data.pop if data.size == 1
-        end
-        data
-      end
-    end
-    
-    def _write data, pack = nil
-      data = [*data].pack(pack) if pack
-      @data[@pos,0] = data
-      @pos += data.length
-    end
-  end
-end