fake_sqs 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae5e043b856cd439056c369baeb1fdc3d12e7787
-  data.tar.gz: f4b4aedf522f93fa1e71a2ace2a1df482b310e90
+  metadata.gz: 04b7e156149ca16643c8fde1933bca20aea7434b
+  data.tar.gz: be9d4103aa2987ddbb43839c15f3ef85955b8e18
 SHA512:
-  metadata.gz: aa51a2e3bcde55667e86206db9d49043448618e07960ecbaa1a441287e7198137333e58bb62ee3ddfad11e4dc8a600d9d960456cb2a72c185d5d9fb7506ded42
-  data.tar.gz: edfb298a28ae9f4089b6d60e8deb36b3eed64e728284a08cfdce4520804e6a298fe810ab43f7aa1e689c7d97e20190e247aefbc49f11ecea27326a20af3ffe9e
+  metadata.gz: 4ffeacbcc77e857c5c125d90c3eaafdb4bbc068c4f8fc8b11d705d4f3c0e0fa26ef82bd5427cd882ef02e317375b8f35bcdb8399aa3c8bd88aa27763c28e7a89
+  data.tar.gz: 2a8dc5a14fbb7317e7ae6d44e9f79983568a3d204b74359d0cc2932dadd283b9a5ee79008ecb5dc1e649b596afc5ca4d658455cb6e508a420142a706a44e0983

data/README.md

@@ -18,17 +18,16 @@ Done so far are:
 * Receive messages (and in batch)
 * Deleting messages (and in batch)
 * Changing queue attributes (but not all, and no validation)
+* Setting visibility timeouts for messages
 
 Certain bits are left off on purpose, to make it easier to work with, such as:
 
 * No checking on access keys or signatures
 * No 60 second delay between deleting a queue and recreating it.
-* No visibility timeouts (see below about special hooks)
 
 Other parts are just not done yet:
 
 * Permissions
-* Changing message visibility
 * Error handling
 
 So, actually, just the basics are implemented at this point.

data/lib/fake_sqs.rb

@@ -1,5 +1,6 @@
 require 'fake_sqs/api'
 require 'fake_sqs/catch_errors'
+require 'fake_sqs/collection_view'
 require 'fake_sqs/error_response'
 require 'fake_sqs/message'
 require 'fake_sqs/queue'

data/lib/fake_sqs/actions/change_message_visibility.rb

@@ -0,0 +1,21 @@
+module FakeSQS
+  module Actions
+    class ChangeMessageVisibility
+
+      def initialize(options = {})
+        @server    = options.fetch(:server)
+        @queues    = options.fetch(:queues)
+        @responder = options.fetch(:responder)
+      end
+
+      def call(queue, params)
+        visibility = params.fetch("VisibilityTimeout")
+        receipt = params.fetch("ReceiptHandle")
+
+        @queues.get(queue).change_message_visibility( receipt, visibility.to_i )
+        @responder.call :ChangeMessageVisibility
+      end
+
+    end
+  end
+end

data/lib/fake_sqs/api.rb

@@ -1,3 +1,4 @@
+require 'fake_sqs/actions/change_message_visibility'
 require 'fake_sqs/actions/create_queue'
 require 'fake_sqs/actions/delete_queue'
 require 'fake_sqs/actions/list_queues'
@@ -21,6 +22,13 @@ module FakeSQS
     def initialize(options = {})
       @queues    = options.fetch(:queues)
       @options   = options
+      @run_timer = true
+      @timer     = Thread.new do
+        while @run_timer
+          queues.timeout_messages!
+          sleep(5)
+        end
+      end
     end
 
     def call(action, *args)
@@ -44,5 +52,9 @@ module FakeSQS
       queues.expire
     end
 
+    def stop
+      @run_timer = false
+    end
+
   end
 end

data/lib/fake_sqs/collection_view.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+
+module FakeSQS
+  class CollectionView
+    include Enumerable
+    extend Forwardable
+    def_delegators :@original, :[], :each, :empty?, :size, :length
+
+    UnmodifiableObjectError = Class.new(StandardError)
+
+    def initialize( original )
+      @original = original
+    end
+
+    def []=(key_or_index,value)
+      raise UnmodifiableObjectError.new("This is a collection view and can not be modified - #{key_or_index} => #{value}")
+    end
+
+  end
+end

data/lib/fake_sqs/error_responses.yml

@@ -16,6 +16,7 @@ InvalidSecurity: 403
 InvalidSecurityToken: 400
 MalformedVersion: 400
 MessageTooLong: 400
+MessageNotInflight: 400
 MissingClientTokenId: 403
 MissingCredentials: 401
 MissingParameter: 400
@@ -25,6 +26,7 @@ NotAuthorizedToUseVersion: 401
 QueueDeletedRecently: 400
 QueueNameExists: 400
 ReadCountOutOfRange: 400
+ReceiptHandleIsInvalid: 400
 RequestExpired: 400
 RequestThrottled: 403
 ServiceUnavailable: 503

data/lib/fake_sqs/message.rb

@@ -4,6 +4,7 @@ module FakeSQS
   class Message
 
     attr_reader :body, :id, :md5
+    attr_accessor :visibility_timeout
 
     def initialize(options = {})
       @body = options.fetch("MessageBody")
@@ -11,6 +12,18 @@ module FakeSQS
       @md5 = options.fetch("MD5") { Digest::MD5.hexdigest(@body) }
     end
 
+    def expire!
+      self.visibility_timeout = nil
+    end
+
+    def expired?( limit = Time.now )
+      self.visibility_timeout.nil? || self.visibility_timeout < limit
+    end
+
+    def expire_at(seconds)
+      self.visibility_timeout = Time.now + seconds
+    end
+
     def attributes
       {
         "MessageBody" => body,

data/lib/fake_sqs/queue.rb

@@ -1,12 +1,17 @@
 require 'securerandom'
+require 'fake_sqs/collection_view'
 
 module FakeSQS
 
+  MessageNotInflight = Class.new(RuntimeError)
   ReadCountOutOfRange = Class.new(RuntimeError)
+  ReceiptHandleIsInvalid = Class.new(RuntimeError)
 
   class Queue
 
-    attr_reader :name, :messages, :message_factory, :messages_in_flight, :arn, :queue_attributes
+    VISIBILITY_TIMEOUT = 30
+
+    attr_reader :name, :message_factory, :arn, :queue_attributes
 
     def initialize(options = {})
       @message_factory = options.fetch(:message_factory)
@@ -14,14 +19,15 @@ module FakeSQS
       @name = options.fetch("QueueName")
       @arn = options.fetch("Arn") { "arn:aws:sqs:us-east-1:#{SecureRandom.hex}:#{@name}" }
       @queue_attributes = options.fetch("Attributes") { {} }
+      @lock = Monitor.new
       reset
     end
 
     def to_yaml
       {
-        "QueueName"        => name,
-        "Arn"              => arn,
-        "Attributes"       => queue_attributes,
+        "QueueName" => name,
+        "Arn" => arn,
+        "Attributes" => queue_attributes,
       }
     end
 
@@ -32,15 +38,17 @@ module FakeSQS
     def attributes
       queue_attributes.merge(
         "QueueArn" => arn,
-        "ApproximateNumberOfMessages" => messages.size,
-        "ApproximateNumberOfMessagesNotVisible" => messages_in_flight.size,
+        "ApproximateNumberOfMessages" => @messages.size,
+        "ApproximateNumberOfMessagesNotVisible" => @messages_in_flight.size,
       )
     end
 
     def send_message(options = {})
-      message = message_factory.new(options)
-      messages << message
-      message
+      with_lock do
+        message = message_factory.new(options)
+        @messages << message
+        message
+      end
     end
 
     def receive_message(options = {})
@@ -48,34 +56,99 @@ module FakeSQS
 
       fail ReadCountOutOfRange, amount if amount > 10
 
-      return {} if messages.empty?
+      return {} if @messages.empty?
 
       result = {}
 
-      actual_amount = amount > size ? size : amount
+      with_lock do
+        actual_amount = amount > size ? size : amount
 
-      actual_amount.times do
-        message = messages.delete_at(rand(size))
-        receipt = generate_receipt
-        messages_in_flight[receipt] = message
-        result[receipt] = message
+        actual_amount.times do
+          message = @messages.delete_at(rand(size))
+          message.expire_at(default_visibility_timeout)
+          receipt = generate_receipt
+          @messages_in_flight[receipt] = message
+          result[receipt] = message
+        end
       end
 
       result
     end
 
+    def default_visibility_timeout
+      if value = attributes['VisibilityTimeout']
+        value.to_i
+      else
+        VISIBILITY_TIMEOUT
+      end
+    end
+
+    def timeout_messages!
+      with_lock do
+        expired = @messages_in_flight.inject({}) do |memo,(receipt,message)|
+          if message.expired?
+            memo[receipt] = message
+          end
+          memo
+        end
+        expired.each do |receipt,message|
+          message.expire!
+          @messages << message
+          delete_message(receipt)
+        end
+      end
+    end
+
+    def change_message_visibility(receipt, visibility)
+      with_lock do
+        message = @messages_in_flight[receipt]
+        raise MessageNotInflight unless message
+
+        if visibility == 0
+          message.expire!
+          @messages << message
+          delete_message(receipt)
+        else
+          message.expire_at(visibility)
+        end
+
+      end
+    end
+
     def delete_message(receipt)
-      messages_in_flight.delete(receipt)
+      with_lock do
+        @messages_in_flight.delete(receipt)
+      end
     end
 
     def reset
-      @messages = []
-      @messages_in_flight = {}
+      with_lock do
+        @messages = []
+        @messages_view = FakeSQS::CollectionView.new(@messages)
+        reset_messages_in_flight
+      end
     end
 
     def expire
-      @messages += messages_in_flight.values
-      @messages_in_flight = {}
+      with_lock do
+        @messages += @messages_in_flight.values
+        reset_messages_in_flight
+      end
+    end
+
+    def reset_messages_in_flight
+      with_lock do
+        @messages_in_flight = {}
+        @messages_in_flight_view = FakeSQS::CollectionView.new(@messages_in_flight)
+      end
+    end
+
+    def messages
+      @messages_view
+    end
+
+    def messages_in_flight
+      @messages_in_flight_view
     end
 
     def size
@@ -86,5 +159,11 @@ module FakeSQS
       SecureRandom.hex
     end
 
+    def with_lock
+      @lock.synchronize do
+        yield
+      end
+    end
+
   end
 end

data/lib/fake_sqs/queues.rb

@@ -60,6 +60,12 @@ module FakeSQS
       database.reset
     end
 
+    def timeout_messages!
+      transaction do
+        database.each { |name,queue| queue.timeout_messages! }
+      end
+    end
+
     def expire
       transaction do
         database.each { |name, queue| queue.expire }

data/lib/fake_sqs/version.rb

@@ -1,3 +1,3 @@
 module FakeSQS
-  VERSION = "0.0.11"
+  VERSION = "0.1.0"
 end

data/lib/fake_sqs/web_interface.rb

@@ -30,6 +30,7 @@ module FakeSQS
     end
 
     post "/" do
+      params['logger'] = logger
       if params['QueueUrl']
         queue = URI.parse(params['QueueUrl']).path.gsub(/\//, '')
         return settings.api.call(action, queue, params) unless queue.empty?

data/spec/acceptance/message_actions_spec.rb

@@ -56,6 +56,46 @@ describe "Actions for Messages", :sqs do
     messages.map(&:body).should match_array bodies
   end
 
+  specify "set message timeout to 0" do
+    body = 'some-sample-message'
+    queue.send_message(body)
+    message = queue.receive_message
+    message.body.should == body
+    message.visibility_timeout = 0
+
+    same_message = queue.receive_message
+    same_message.body.should == body
+  end
+
+  specify 'set message timeout and wait for message to come' do
+
+    body = 'some-sample-message'
+    queue.send_message(body)
+    message = queue.receive_message
+    message.body.should == body
+    message.visibility_timeout = 3
+
+    nothing = queue.receive_message
+    nothing.should be_nil
+
+    sleep(10)
+
+    same_message = queue.receive_message
+    same_message.body.should == body
+  end
+
+  specify 'should fail if trying to update the visibility_timeout for a message that is not in flight' do
+    body = 'some-sample-message'
+    queue.send_message(body)
+    message = queue.receive_message
+    message.body.should == body
+    message.visibility_timeout = 0
+
+    expect do
+      message.visibility_timeout = 30
+    end.to raise_error(AWS::SQS::Errors::MessageNotInflight)
+  end
+
   def let_messages_in_flight_expire
     $fake_sqs.expire
   end

data/spec/unit/collection_view_spec.rb

@@ -0,0 +1,41 @@
+require 'fake_sqs/collection_view'
+
+describe FakeSQS::CollectionView do
+
+  def wrap(collection)
+    FakeSQS::CollectionView.new(collection)
+  end
+
+  it 'should correctly wrap an array' do
+    array = %w{one two three four}
+    view = wrap(array)
+    view[0].should == 'one'
+    view[1].should == 'two'
+    view[2].should == 'three'
+    view[3].should == 'four'
+  end
+
+  it 'should correctly wrap a hash' do
+    hash = { :one => 1, :two => 2, :three => 3 }
+    view = wrap(hash)
+    view[:one].should == 1
+    view[:two].should == 2
+    view[:three].should == 3
+  end
+
+  it 'should respond to empty correctly' do
+    wrap([]).should be_empty
+    wrap({'one' => 1}).should_not be_empty
+  end
+
+  it 'should be enumerable' do
+    result = wrap([1, 2, 3]).map { |i| i * i }
+    result.should == [1, 4, 9]
+  end
+
+  it 'should respond to size/length' do
+    wrap([1, 2, 3]).size.should == 3
+    wrap([]).length.should == 0
+  end
+
+end

data/spec/unit/message_spec.rb

@@ -29,6 +29,37 @@ describe FakeSQS::Message do
 
   end
 
+  describe 'visibility_timeout' do
+
+    let :message do
+      create_message
+    end
+
+    it 'should default to nil' do
+      message.visibility_timeout.should be_nil
+    end
+
+    it 'should be expired when it is nil' do
+      message.should be_expired
+    end
+
+    it 'should be expired if set to a previous time' do
+      message.visibility_timeout = Time.now - 1
+      message.should be_expired
+    end
+
+    it 'should not be expired at a future date' do
+      message.visibility_timeout = Time.now + 1
+      message.should_not be_expired
+    end
+
+    it 'should not be expired when set to expire at a future date' do
+      message.expire_at(5)
+      message.visibility_timeout.should be >=(Time.now + 4)
+    end
+
+  end
+
   def create_message(options = {})
     FakeSQS::Message.new({"MessageBody" => "test"}.merge(options))
   end

data/spec/unit/queue_spec.rb

@@ -1,15 +1,11 @@
 require 'fake_sqs/queue'
+require 'fake_sqs/message'
 
 describe FakeSQS::Queue do
 
   class MessageFactory
-
-    def initialize
-      @count = 0
-    end
-
     def new(options = {})
-      @count += 1
+      FakeSQS::Message.new({'MessageBody' => 'sample-body'}.merge(options))
     end
   end
 

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: fake_sqs
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: verbose_hash_fetch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides a fake SQS server that you can run locally to test against
@@ -144,9 +144,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE.txt
 - README.md
@@ -154,6 +154,7 @@ files:
 - bin/fake_sqs
 - fake_sqs.gemspec
 - lib/fake_sqs.rb
+- lib/fake_sqs/actions/change_message_visibility.rb
 - lib/fake_sqs/actions/create_queue.rb
 - lib/fake_sqs/actions/delete_message.rb
 - lib/fake_sqs/actions/delete_message_batch.rb
@@ -167,6 +168,7 @@ files:
 - lib/fake_sqs/actions/set_queue_attributes.rb
 - lib/fake_sqs/api.rb
 - lib/fake_sqs/catch_errors.rb
+- lib/fake_sqs/collection_view.rb
 - lib/fake_sqs/daemonize.rb
 - lib/fake_sqs/error_response.rb
 - lib/fake_sqs/error_responses.yml
@@ -187,6 +189,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
 - spec/unit/catch_errors_spec.rb
+- spec/unit/collection_view_spec.rb
 - spec/unit/error_response_spec.rb
 - spec/unit/message_spec.rb
 - spec/unit/queue_factory_spec.rb
@@ -204,17 +207,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Provides a fake SQS server that you can run locally to test against
@@ -224,6 +227,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
 - spec/unit/catch_errors_spec.rb
+- spec/unit/collection_view_spec.rb
 - spec/unit/error_response_spec.rb
 - spec/unit/message_spec.rb
 - spec/unit/queue_factory_spec.rb