lsqs 0.0.1

data/lib/lsqs/queue.rb

@@ -0,0 +1,176 @@
+module LSQS
+  class Queue
+    attr_accessor :name, :messages, :in_flight, :attributes, :monitor
+    
+    DEFAULT_TIMEOUT = 30
+    
+    def initialize(name, params = {})
+      @name       = name
+      @attributes = params.fetch('Attributes'){Hash.new}
+      @monitor    = Monitor.new
+      @messages   = []
+      @in_flight  = {}
+      @timeout    = true
+      
+      check_timeout
+    end
+    
+    ##
+    # Sets the default timeout of a queue. It takes the value from the
+    # attributes, if it is set, otherwise it uses the `DEFAULT_TIMEOUT`
+    # constant.
+    #
+    # @return [Fixnum]
+    #
+    def visibility_timeout
+      attributes['VisibilityTimeout'] || DEFAULT_TIMEOUT
+    end
+    
+    ##
+    # Creates a new message in the queue.
+    #
+    # @param [Hash] options
+    #
+    # @return [Message]
+    #
+    def create_message(options = {})
+      lock do
+        message = Message.new(options)
+        @messages << message
+        return message
+      end
+    end
+    
+    ##
+    # Gets a number of messages based on the MaxNumberOfMessages field.
+    #
+    # @param [Hash] options
+    #
+    # @return [Hash]
+    #
+    def get_messages(options = {})
+      number_of_messages = options.fetch('MaxNumberOfMessages'){1}.to_i
+
+      raise 'ReadCountOutOfRange' if number_of_messages > 10
+
+      result = {}
+
+      lock do
+        amount = number_of_messages > size ? size : number_of_messages
+
+        amount.times do
+          message             = messages.delete_at(rand(size))
+          message.expire_in(visibility_timeout)
+          receipt             = generate_receipt
+          @in_flight[receipt] = message
+          result[receipt]     = message
+        end
+      end
+
+      return result
+    end
+    
+    ##
+    # Deletes a message from the messages that are in-flight.
+    #
+    # @param [String] receipt
+    #
+    def delete_message(receipt)
+      lock do
+        in_flight.delete(receipt)
+      end
+    end
+    
+    ##
+    # Deletes all messages in queue and in flight.
+    #
+    def purge
+      lock do
+        @messages  = []
+        @in_flight = {}
+      end
+    end
+    
+    ##
+    # Returns the amount of messages in the queue.
+    #
+    # @return [Fixnum]
+    #
+    def size
+      messages.size
+    end
+    
+    ##
+    # Generates a hex receipt for the message
+    #
+    # @return [String]
+    #
+    def generate_receipt
+      SecureRandom.hex(16)
+    end
+    
+    ##
+    # Change the visibility of a message that is in flight. If visibility
+    # is set to 0, put back in the queue.
+    #
+    # @param [String] receipt
+    # @param [Fixnum] seconds
+    #
+    def change_message_visibility(receipt, seconds)
+      lock do
+        message = @in_flight[receipt]
+        raise 'MessageNotInflight' unless message
+
+        if seconds == 0
+          message.expire
+          @messages << message
+          delete_message(receipt)
+        else
+          message.expire_in(seconds)
+        end
+      end
+    end
+    
+    ##
+    # Checks if in-fligh messages need to be put back in the queue.
+    # 
+    def timeout_messages
+      lock do
+        in_flight.each do |key, message|
+          if message.expired?
+            message.expire
+            @messages << message
+            delete_message(key)
+          end
+        end
+      end
+    end
+    
+    protected
+    
+    ##
+    # Initializes a thread that checks every 5 seconds if messages need
+    # to be put back from flight to the message queue.
+    #
+    def check_timeout
+      Thread.new do
+        while @timeout
+          unless in_flight.empty?
+            timeout_messages
+          end
+          sleep(5)
+        end
+      end
+    end
+    
+    ##
+    # Locks a block, in order to ensure that there is no conflict if more than
+    # one processes try to access the object.
+    # 
+    def lock
+      @monitor.synchronize do
+        yield
+      end
+    end
+  end # Queue
+end # LSQS

data/lib/lsqs/queue_list.rb

@@ -0,0 +1,90 @@
+module LSQS
+  class QueueList
+    include MonitorMixin
+
+    attr_accessor :queues
+    
+    def initialize
+      super
+      @queues  = {}
+    end
+    
+    ##
+    # Purges the current queue list.
+    #
+    # @return [Hash]
+    #
+    def purge
+      @queues = {}
+    end
+    
+    ##
+    # Creates a new queue, if it doesn't exist already.
+    #
+    # @param [String] name
+    # @param [Hash] options
+    #
+    # @return [LSQS::Queue]
+    #
+    def create(name, options = {})
+      unless queues[name]
+        @queues[name] = Queue.new(name, options)
+      else
+        raise 'QueueNameExists'
+      end
+    end
+    
+    ##
+    # Returns the names of the existing queues.
+    #
+    # @param [Hash] options
+    #
+    # @return [Array]
+    #
+    def inspect(options = {})
+      if prefix = options['QueueNamePrefix']
+        queues.select { |name, queue| name.start_with?(prefix) }.values.map(&:name)
+      else
+        queues.values.map(&:name)
+      end
+    end
+    
+    ##
+    # Searches for a queue in the list by name.
+    # If it doesn't find it, it creates it.
+    #
+    # @param [String] name
+    #
+    # @return [Queue]
+    #
+    def find(name)
+      if queue = queues[name]
+        return queue
+      else
+        raise 'NonExistentQueue'
+      end
+    end
+    
+    ##
+    # Deletes a queue if it exists.
+    #
+    # @param [name]
+    #
+    def delete(name)
+      if queues[name]
+        queues.delete(name)
+      else
+        raise 'NonExistentQueue'
+      end
+    end
+    
+    ##
+    # Queries the list of queues.
+    #
+    def query
+      synchronize do
+        yield
+      end
+    end
+  end # QueueList
+end # LSQS

data/lib/lsqs/server.rb

@@ -0,0 +1,59 @@
+module LSQS
+  class Server < Sinatra::Base
+    configure do
+      set :dump_errors, false
+      set :raise_errors, true
+      set :show_exceptions, false
+      
+      use LSQS::ErrorHandler
+    end
+    
+    helpers do
+      
+      ##
+      # Gets the action that was requested.
+      #
+      # @return [String]
+      #
+      def action
+        params['Action']
+      end
+      
+      ##
+      # Retrieves a XML template and renders it.
+      #
+      # @param [LSQS::Actions::Base] action
+      #
+      # @return [String]
+      # 
+      def render(action)
+        LSQS.template.render(action)
+      end
+      
+      ##
+      # Returns the base URL of the server.
+      #
+      # @return [String]
+      #
+      def base_url
+        request.base_url
+      end
+    end
+    
+    post '/' do
+      params['base_url'] = base_url
+      
+      result = LSQS.router.distribute(action, params)
+  
+      return {:body => render(result)}.to_json
+    end
+    
+    # To keep the Amazon convention the queue name is stored
+    # in params['QueueName']
+    post "/:QueueName" do
+      result = LSQS.router.distribute(action, params)
+      
+      return {:body => render(result)}.to_json
+    end
+  end # Server
+end # LSQS

data/lib/lsqs/version.rb

@@ -0,0 +1,3 @@
+module LSQS
+  VERSION = '0.0.1'
+end # LSQS

data/lib/lsqs/xml_template.rb

@@ -0,0 +1,54 @@
+module LSQS
+  class XMLTemplate
+    attr_reader :template
+    
+    TEMPLATE_DIR = File.expand_path('../../../config', __FILE__)
+    
+    def initialize
+      xml = File.read("#{TEMPLATE_DIR}/template.xml.liquid")
+      @template = Liquid::Template.parse(xml)
+    end
+    
+    ##
+    # Renders the XML that is required as a body response.
+    #
+    # @param [Actions::Base] action
+    #
+    # @return [String]
+    #
+    def render(action)
+      options = { 
+        'action'     => action.name,
+        'content'    => action.to_xml,
+        'request_id' => request_id
+      }
+      
+      template.render(options)
+    end
+    
+    ##
+    # Renders the XML that is required for an error response
+    #
+    # @param [String] error
+    #
+    # @return [String]
+    #
+    def render_error(error)
+      options = {
+        'error'      => error,
+        'request_id' => request_id
+      }
+      
+      template.render(options)
+    end
+    
+    ##
+    # Generates a request ID.
+    #
+    # @return [String]
+    #
+    def request_id
+      SecureRandom.uuid
+    end
+  end # XMLTemplate
+end #LSQS

data/lib/lsqs.rb

@@ -0,0 +1,45 @@
+require 'sinatra'
+require 'puma/cli'
+require 'liquid'
+require 'securerandom'
+require 'digest/md5'
+require 'active_support/core_ext/string'
+require 'json'
+require 'builder'
+
+require_relative 'lsqs/version'
+require_relative 'lsqs/error_handler'
+require_relative 'lsqs/server'
+require_relative 'lsqs/xml_template'
+require_relative 'lsqs/action_router'
+require_relative 'lsqs/queue_list'
+require_relative 'lsqs/queue'
+require_relative 'lsqs/message'
+
+require_relative 'lsqs/actions/base'
+require_relative 'lsqs/actions/get_queue_url'
+require_relative 'lsqs/actions/receive_message'
+require_relative 'lsqs/actions/create_queue'
+require_relative 'lsqs/actions/send_message'
+require_relative 'lsqs/actions/delete_message_batch'
+require_relative 'lsqs/actions/purge_queue'
+require_relative 'lsqs/actions/list_queues'
+require_relative 'lsqs/actions/delete_queue'
+require_relative 'lsqs/actions/delete_message'
+require_relative 'lsqs/actions/send_message_batch'
+require_relative 'lsqs/actions/change_message_visibility'
+
+module LSQS
+  def self.template
+    @template ||= XMLTemplate.new
+  end
+  
+  def self.router
+    @router ||= ActionRouter.new(queue_list)
+  end
+  
+  def self.queue_list
+    QueueList.new
+  end
+end # LSQS
+

data/lsqs.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lsqs/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'lsqs'
+  gem.version       = LSQS::VERSION
+  gem.authors       = ['giannismelidis']
+  gem.email         = ['gmelidis@engineer.com']
+  gem.summary       = 'Gem that allows you to run a version of SQS server locally.'
+  gem.description   = gem.summary
+  gem.homepage      = 'http://github.com/giannismelidis/lsqs'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ['lib', 'config']
+  
+  gem.add_dependency 'liquid'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'puma'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'builder'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'aws-sdk'
+  gem.add_development_dependency 'webmock'
+end

data/spec/lsqs/action_router_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe LSQS::ActionRouter do
+  before do
+    @router = described_class.new(QueueList.new)
+  end
+  describe '#distribute' do
+    it 'throws an error for undefined action' do
+      expect{@router.distribute('Foo', {})}.to raise_error(LSQS::ActionRouter::ActionError)
+    end
+    
+    it 'does not throw an error for existing action' do
+      expect{@router.distribute('CreateQueue', {})}.not_to raise_error
+    end
+    
+    it 'returns an action object' do
+      @result = @router.distribute('CreateQueue', {})
+      @result.kind_of?(LSQS::Actions::CreateQueue).should be_truthy
+    end
+  end
+end