SQS 0.1.3 → 0.1.4

data/CHANGELOG

@@ -1,3 +1,26 @@
+0.1.4
+2007-06-12
+* Upped the API version to 2007-05-01
+* Queue#force_delete is deprecated.  Please use Queue#delete!.  Queue#force_delete
+is not guaranteed to be available after SQS v0.1.4
+* Added Queue#get_queue_attributes and Queue#set_queue_attributes, and syntactic sugar
+Queue#approximate_number_of_messages, Queue#visibility_timeout, and Queue#visibility_timeout=
+Note that these three sugar methods aren't really methods, but are handled in Queue#method_missing
+Note that these changes do not change the invocation of visibility_timeout or visibility_timeout=
+* Added Queue#empty?, which calls self.peek, not self.approximate_number_of_messages, which should
+mean that the result is accurate.
+* Looks like Amazon fixed
+http://developer.amazonwebservices.com/connect/thread.jspa?threadID=15364&tstart=0
+* Added a small test for SQS.call_web_service
+* Added a test to check for valid queue names
+* Test messages up to 6000 bytes in length--this will require further work, since it's erroring out on my machine, before I even get to the supported 8K message size.
+* Added Queue#each_message
+NOTE that Queue#each_message is an infinite loop!  You must either break out of it, or delete each
+message as it comes.
+* NOTE
+http://developer.amazonwebservices.com/connect/thread.jspa?threadID=15618&tstart=0
+Is unresolved
+
 0.1.3
 2007-04-25
 * Missed one "include REXML."

data/lib/sqs.rb

@@ -135,7 +135,7 @@ class SQS
 
 
   def self.api_version
-    '2006-04-01'
+    '2007-05-01'
   end
 
   def self.signature_version
@@ -193,8 +193,12 @@ class SQS
       retries = self.retry_attempts
     end
 
-    if !params[:queue].nil? && params[:queue].respond_to?( :url )
-      url = params[:queue].url
+    if !params[:queue].nil?
+      if params[:queue].respond_to?( :url )
+        url = params[:queue].url
+      else
+        url = params[:queue].to_s
+      end
       params.delete( :queue )
     else
       url = "#{self.url_for_query}"
@@ -248,6 +252,7 @@ module REXML
     def message_body( type=:peek ) ; self.node_text( "/#{type.to_s.capitalize}MessageResponse/Message/MessageBody" ) ; end
 
     def messages( type=:receive ) ; self.nodes( "/#{type.to_s.capitalize}MessageResponse#{ type == :send ? '' : '/Message'}" ) ; end
+    def attributed_values( type=:get ) ; self.nodes( "/#{type.to_s.capitalize}QueueAttributesResponse#{ type == :send ? '' : '/AttributedValue'}" ) ; end
 
     def visibility_timeout( type=:get ) ; self.node_text( "/#{type.to_s.capitalize}VisibilityTimeoutResponse/VisibilityTimeout" ).to_i ; end
 
@@ -269,6 +274,9 @@ module REXML
     def message_id ; self.node_text( "MessageId" ) ; end
     def message_body ; self.node_text( "MessageBody" ) ; end
 
+    def attribute ; self.node_text( "Attribute" ) ; end
+    def value ; self.node_text( "Value" ) ; end
+
     def id( type=:message ) ; self.node_text( type == :grantee ? "ID" : "Id" ) ; end
     def display_name ; self.node_text( "DisplayName" ) ; end
     def permission ; self.node_text( "Permission" ) ; end

data/lib/sqs/queue.rb

@@ -5,15 +5,14 @@ require 'rexml/document'
 
 class SQS::Queue
   private
-  @attributes = {}
   @@acceptable_schemes = ['https', 'http']
 
   public
-  attr_accessor :url
+  attr_accessor :url, :attributes
   def initialize( options={} )
     self.url = options.is_a?( Hash ) ? options[:url] : options
     bad_url = false
-
+    self.attributes = {}
     begin
       u = URI.parse( self.url )
       bad_url = !@@acceptable_schemes.include?( u.scheme ) || u.host.to_s.empty? || u.path.to_s.empty?
@@ -23,6 +22,22 @@ class SQS::Queue
     raise "'#{self.url}' does not seem to be a parseable URL. (Please provide all parts of the URL.)" if bad_url
   end
 
+  def method_missing( symbol, *args )
+    #method_missing intercepts .attribute and .attribute= calls
+    method_name = symbol.to_s
+
+    if method_name =~ /(.*)=$/
+      attribute_name = $1.capitalize.gsub( /_([^_])/ ) { |m| $1.capitalize }.to_sym
+      raise NoMethodError, "#{self.class.name}.#{method_name} takes one parameter" unless args.size == 1
+      self.set_queue_attributes( attribute_name => args[0] )
+    else
+      attribute_name = method_name.capitalize.gsub( /_([^_])/ ) { |m| $1.capitalize }.to_sym
+      self.get_queue_attributes( true ) if args[0] || @attributes.empty?
+      raise NoMethodError, "This #{self.class.name} does not respond to #{method_name}" unless @attributes[attribute_name]
+      @attributes[attribute_name]
+    end
+  end
+
   def ==( other_queue )
     self.url == other_queue.url
   rescue
@@ -33,28 +48,37 @@ class SQS::Queue
     "#{self.class.to_s} '#{self.name}' (#{self.url})"
   end
 
-  def delete
-    doc = SQS.call_web_service( :Action => 'DeleteQueue', :queue => self )
+  def delete( options=nil )
+    force = options.is_a?( Hash ) && options[:force]
+    doc = SQS.call_web_service( :Action => 'DeleteQueue', :ForceDeletion => force, :queue => self )
     true
   rescue Exception => e
     raise e
   end
 
+  def delete!
+    delete( :force => true )
+  end
   def force_delete
-    begin
-      self.delete
-    rescue
-      while m = self.receive_message
-        m.delete if m.respond_to?( :delete )
-      end
-      populated = 2
-      while populated > 0
-        begin
-          self.delete
-          populated = 0
-        rescue
-          populated -= 1
-        end
+    warn "Queue#force_delete is deprecated.  Please use Queue#delete!."
+    delete!
+  end
+
+
+  def send_message( m )
+    doc = SQS.call_web_service( :Action => 'SendMessage', :queue => self, :MessageBody => m.to_s )
+    m = SQS::Message.new( :id => doc.message_id, :queue => self )
+  rescue Exception => e
+    raise e
+  end
+
+  def get_queue_attributes( force=false )
+    if force || @attributes.empty?
+      params = { :Action => 'GetQueueAttributes', :queue => self, :Attribute => 'All' }
+      doc = SQS.call_web_service( params )
+
+      doc.attributed_values.each do |v|
+        @attributes[ v.attribute.to_sym ] = (v.value == v.value.to_i.to_s ? v.value.to_i : v.value )
       end
     end
     true
@@ -62,14 +86,25 @@ class SQS::Queue
     raise e
   end
 
-
-  def send_message( m )
-    doc = SQS.call_web_service( :Action => 'SendMessage', :queue => self, :MessageBody => m.to_s )
-    m = SQS::Message.new( :id => doc.message_id, :queue => self )
+  def set_queue_attributes( atts={} )
+    @attributes = {} unless @attributes
+    params = { :Action => 'SetQueueAttributes', :queue => self.url }
+    atts.each do |k,v|
+      params[:Attribute] = k
+      params[:Value] = v
+      doc = SQS.call_web_service( params )
+      @attributes[k] = v
+    end
+    true
   rescue Exception => e
     raise e
   end
 
+  def empty?
+    self.peek_message.nil?
+  end
+
+
   def peek_message
     # returns the first element of what peek_messages returns
     m = self.peek_messages( :count => 1 ).first
@@ -103,19 +138,6 @@ class SQS::Queue
     raise e
   end
 
-  def visibility_timeout=( timeout )
-    doc = SQS.call_web_service( :Action => 'SetVisibilityTimeout', :queue => self, :VisibilityTimeout => timeout.to_i )
-    true
-  rescue Exception => e
-    raise e
-  end
-  def visibility_timeout
-    doc = SQS.call_web_service( :Action => 'GetVisibilityTimeout', :queue => self )
-    doc.visibility_timeout.to_i
-  rescue Exception => e
-    raise e
-  end
-
 
 
   def add_grant( options={} )
@@ -170,6 +192,15 @@ class SQS::Queue
     end
   end
 
+  def each_message( &block )
+    # This is an infinite loop.
+    # You must either break out of it
+    # Or delete each message!
+    while m = self.peek_message
+      block.call( m )
+    end
+  end
+
   def name
     # return everything after the last slash
     self.url =~ /([^\/]*)$/ ? $1 : ''

data/test/unit/sqs_grant_test.rb

@@ -10,7 +10,7 @@ class SQS_GrantTest < Test::Unit::TestCase
     @q = SQS.create_queue( @queue_prefix ) unless SQStest.skip_live_tests?
   end
   def teardown
-    SQS.list_queues( @queue_prefix ).each { |q| q.force_delete } unless SQStest.skip_live_tests?
+    SQS.list_queues( @queue_prefix ).each { |q| q.delete! } unless SQStest.skip_live_tests?
     print SQS.counter if SQStest.print_counter?
   end
 

data/test/unit/sqs_message_test.rb

@@ -11,7 +11,7 @@ class SQS_MessageTest < Test::Unit::TestCase
     @q = SQS.create_queue( @queue_prefix ) unless SQStest.skip_live_tests?
   end
   def teardown
-    SQS.list_queues( @queue_prefix ).each { |q| q.force_delete } unless SQStest.skip_live_tests?
+    SQS.list_queues( @queue_prefix ).each { |q| q.delete! } unless SQStest.skip_live_tests?
     print SQS.counter if SQStest.print_counter?
   end
 

data/test/unit/sqs_queue_test.rb

@@ -13,11 +13,11 @@ class SQS_QueueTest < Test::Unit::TestCase
   end
   
   def setup
-    @queue_prefix = 'testQUEUE'
+    @queue_prefix = 'test_queue_'
     @q = SQStest.skip_live_tests? ? SQS::Queue.new( 'http://nowhere.com/nothing' ) : SQS.create_queue( @queue_prefix )
   end
   def teardown
-    SQS.list_queues( @queue_prefix ).each { |q| q.force_delete } unless SQStest.skip_live_tests?
+    SQS.list_queues( @queue_prefix ).each { |q| q.delete! } unless SQStest.skip_live_tests?
     print SQS.counter if SQStest.print_counter?
   end
 
@@ -37,6 +37,53 @@ class SQS_QueueTest < Test::Unit::TestCase
       assert_raises RuntimeError do
         q2.delete
       end
+
+      q = SQS.create_queue :name => "#{@queue_prefix}test_delete"
+      q.send_message( 'A' )
+      q.send_message( 'B' )
+      assert_raises RuntimeError do
+        q.delete
+      end
+      assert_nothing_raised do
+        q.delete( :force => true )
+      end
+    end
+    
+    def test_delete!
+      @q.send_message( 'A' )
+      @q.send_message( 'B' )
+      assert_raises RuntimeError do
+        @q.delete
+      end
+      assert_nothing_raised do
+        @q.delete!
+      end
+      
+      assert_raises RuntimeError do
+        q = SQS.get_queue( @queue_prefix )
+      end
+    end
+
+    def test_force_delete
+      (1..10).to_a.each do |i|
+        @q.send_message( "I am receiving message ##{i}" )
+      end
+    
+      sleep 5
+    
+      assert_raises RuntimeError do
+        @q.delete
+      end
+    
+      assert_nothing_raised do
+        @q.force_delete
+      end
+      
+      sleep 5
+    
+      assert_raises RuntimeError do
+        q = SQS.get_queue( @queue_prefix )
+      end
     end
 
     def test_exist
@@ -64,6 +111,102 @@ class SQS_QueueTest < Test::Unit::TestCase
       assert m.is_a?( SQS::Message )
       assert_equal @q, m.queue
     end
+    
+    def test_send_big_message
+      message = ''
+      6000.times do
+        message << 'x'
+      end
+      assert @q.send_message( message )
+      #Note that this is as big as I can reliably get right now
+      #Need to do some debugging, because I keep getting EOFErrors
+      #when I submit a message of size 7867 (roughly) or above
+      #
+      #Also, the Amazon API allows you to post a body to a URL
+      # with query parameters in it, to send a message up to 256K
+      # in length.  Something to consider.
+    end
+
+    def test_get_and_set_queue_attributes
+      assert @q.attributes.empty?
+      assert @q.get_queue_attributes
+      assert !@q.attributes.empty?
+      assert_equal 0, @q.attributes[:ApproximateNumberOfMessages]
+      assert_equal 30, @q.attributes[:VisibilityTimeout]
+      
+      assert @q.set_queue_attributes( :VisibilityTimeout => 400 )
+      assert_equal 400, @q.attributes[:VisibilityTimeout]
+      assert_equal 0, @q.attributes[:ApproximateNumberOfMessages]
+      assert_nothing_raised do
+        @q.get_queue_attributes( true )
+      end
+      assert_equal 400, @q.attributes[:VisibilityTimeout]
+      assert_equal 0, @q.attributes[:ApproximateNumberOfMessages]
+
+
+      assert_nothing_raised do
+        # This should ultimately raise an error, but does not as of 2007-06-12
+        # See http://developer.amazonwebservices.com/connect/thread.jspa?threadID=15618&tstart=0
+        @q.set_queue_attributes( :SHOULDBEANERROR => 'crazy!' )
+      end
+    end
+    
+    
+    def test_no_such_method
+      assert_raises NoMethodError do
+        @q.no_such_method
+      end
+    end
+
+    def test_approximate_number_of_messages
+      assert_nothing_raised do
+        @q.approximate_number_of_messages
+      end
+      assert_equal 0, @q.approximate_number_of_messages
+      
+      1.upto( 25 ) do |i|
+        @q.send_message( "sending message #{i}" )
+      end
+
+      assert_equal 0, @q.approximate_number_of_messages
+      assert_in_delta 25, @q.approximate_number_of_messages( true ), 3
+    end
+
+
+    def test_visibility_timeout
+      assert_nothing_raised do
+        @q.visibility_timeout
+      end
+      assert_equal 30, @q.visibility_timeout
+      
+      assert_nothing_raised do
+        @q.visibility_timeout = 500
+      end
+      
+      # Update happens in situ
+      assert_equal 500, @q.visibility_timeout
+      assert_equal 500, @q.visibility_timeout( true )
+    end
+
+    def test_empty?
+      assert @q.empty?
+      
+      @q.send_message( 'no longer empty' )
+      sleep 2
+      assert !@q.empty?
+
+      @q.send_message( 'no longer empty again' )
+
+      assert !@q.empty?
+      
+      messages = @q.receive_messages
+      messages.each do |m|
+        m.delete
+      end
+      
+      assert @q.empty?
+    end
+
 
     def test_peek_message
       @q.send_message( 'I am receiving a message from beyond' )
@@ -152,27 +295,6 @@ class SQS_QueueTest < Test::Unit::TestCase
       assert messages.size > 0 && messages.size < 12, "Weird array size: #{messages.size}"
     end
 
-    def test_force_delete
-      (1..10).to_a.each do |i|
-        @q.send_message( "I am receiving message ##{i}" )
-      end
-
-      sleep 5
-
-      assert_raises RuntimeError do
-        @q.delete
-      end
-
-      assert_nothing_raised do
-        @q.force_delete
-      end
-      
-      sleep 5
-
-      assert_raises RuntimeError do
-        q = SQS.get_queue( @queue_prefix )
-      end
-    end
 
     class DUMMY
       def self.email
@@ -269,6 +391,23 @@ class SQS_QueueTest < Test::Unit::TestCase
       end
     end
 
+
+    def test_each_message
+      assert_respond_to @q, :each_message
+      1.upto( 10 ) do |i|
+        @q.send_message( "message #{i}" )
+      end
+      
+      i = 0
+      @q.each_message do |m|
+        i += 1
+        assert_equal SQS::Message, m.class
+        m.delete
+      end
+      assert_equal 10, i
+    end
+
+
     def test_each_grant
       assert_respond_to @q, :each_grant
       @q.add_grant( :email => SQStest.other_aws_account[:email], :permission => :receive)
@@ -278,7 +417,6 @@ class SQS_QueueTest < Test::Unit::TestCase
     end
 
     def test_get_visiblity_timeout
-      assert_respond_to @q, :visibility_timeout
       assert_equal SQS::Queue.default_visibility_timeout, @q.visibility_timeout
       assert_kind_of Integer, @q.visibility_timeout
 
@@ -288,12 +426,14 @@ class SQS_QueueTest < Test::Unit::TestCase
     end
 
     def test_set_visiblity_timeout
-      assert_respond_to @q, :visibility_timeout=
       assert( @q.visibility_timeout = 456 )
       assert_equal 456, @q.visibility_timeout
 
-      assert_nothing_raised RuntimeError do
+      assert_raises RuntimeError do
         @q.visibility_timeout = nil
+      end
+
+      assert_nothing_raised do
         @q.visibility_timeout = 0
       end
 
@@ -304,10 +444,26 @@ class SQS_QueueTest < Test::Unit::TestCase
         @q.visibility_timeout = 86401
       end
 
-      assert_raises NoMethodError do
+      assert_raises RuntimeError do
         @q.visibility_timeout = Object
       end
     end
+    
+    
+    def test_legal_names
+      assert !SQS.create_queue( '' )
+      assert_raises RuntimeError do
+        SQS.create_queue( '81characterslongxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' )
+      end
+      assert q = SQS.create_queue( '80characterslongxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' )
+      q.delete
+      
+      acceptable_names = [ '-', '_', '0', 's' ]
+      acceptable_names.each do |name|
+        assert q = SQS.create_queue( name )
+        q.delete
+      end
+    end
   end
 
   def test_default_visibility_timeout
@@ -319,13 +475,15 @@ class SQS_QueueTest < Test::Unit::TestCase
 
   def test_new
     assert_nothing_raised do
-      q1 = SQS::Queue.new :url => 'http://www.slappy.com/', :a => 'a', 'b' => :b
+      q1 = SQS::Queue.new( :url => 'http://www.slappy.com/', :a => 'a', 'b' => :b )
     end
-    q1 = SQS::Queue.new :url => 'http://www.slappy.com/', :a => 'a', 'b' => :b
+    q1 = SQS::Queue.new( :url => 'http://www.slappy.com/', :a => 'a', 'b' => :b )
     assert_equal 'http://www.slappy.com/', q1.url
+    assert_equal( {}, q1.attributes )
 
     q2 = SQS::Queue.new 'http://www.slappy.com/'
     assert_equal 'http://www.slappy.com/', q2.url
+    assert_equal( {}, q2.attributes )
 
     assert_raises NameError do
       q.a

data/test/unit/sqs_test.rb

@@ -22,7 +22,7 @@ class SQSTest < Test::Unit::TestCase
     @q = SQS.create_queue( @queue_prefix ) unless SQStest.skip_live_tests?
   end
   def teardown
-    SQS.list_queues( @queue_prefix ).each { |q| q.force_delete } unless SQStest.skip_live_tests?
+    SQS.list_queues( @queue_prefix ).each { |q| q.delete! } unless SQStest.skip_live_tests?
     print SQS.counter if SQStest.print_counter?
   end
 
@@ -83,6 +83,17 @@ class SQSTest < Test::Unit::TestCase
       assert_kind_of( SQS::Queue, q )
     end
 
+    def test_call_web_service
+      assert_raises RuntimeError do
+        SQS.call_web_service( :Something => 'for nothing' )
+      end
+
+      x = nil
+      assert_nothing_raised do
+        x = SQS.call_web_service( :Action => 'ListQueues' )
+      end
+      assert_equal REXML::Document, x.class
+    end
   end
 
   def test_counter
@@ -146,7 +157,7 @@ class SQSTest < Test::Unit::TestCase
 
   def test_api_version
     assert_respond_to SQS, :api_version
-    assert_equal '2006-04-01', SQS.api_version
+    assert_equal '2007-05-01', SQS.api_version
   end
 
 
@@ -303,9 +314,18 @@ class SQSTest < Test::Unit::TestCase
 
     d = Document.new( "<?xml version='1.0'?><AddGrantResponse xmlns='http://access.amazonaws.com/doc/2006-01-01/'><ResponseStatus><StatusCode>Success</StatusCode></ResponseStatus></AddGrantResponse>" )
     assert_equal 'Success', d.status
+
+    d = Document.new( "<?xml version='1.0'?><GetQueueAttributesResponse xmlns='http://queue.amazonaws.com/doc/2007-05-01/'><AttributedValue><Attribute>VisibilityTimeout</Attribute><Value>30</Value></AttributedValue><AttributedValue><Attribute>ApproximateNumberOfMessages</Attribute><Value>0</Value></AttributedValue><ResponseStatus><StatusCode>Success</StatusCode><RequestId>00ae54e4-0dc9-4835-bc2e-36304ff40506</RequestId></ResponseStatus></GetQueueAttributesResponse>" )
+    assert d.attributed_values.is_a?( Array )
+    assert_equal 2, d.attributed_values.size
+#    d.attributed_values.each do |att|
+#      puts att
+#    end
+    assert_equal 'Success', d.status
     
   end
 
+
   def test_permissions
     assert_equal 'RECEIVEMESSAGE', SQS.permissions[:receive]
     assert_equal 'SENDMESSAGE', SQS.permissions[:send]

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: SQS
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2007-04-28 00:00:00 -07:00
+  version: 0.1.4
+date: 2007-06-12 00:00:00 -07:00
 summary: A Ruby interface to Amazon's Simple Queue Service
 require_paths: 
 - lib