lsqs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ffe37c92591bcb25697b60e65c4786ec81443ad
+  data.tar.gz: 3030401e3eea31364806a2c77412381e69eba483
+SHA512:
+  metadata.gz: bd0452e069a1c855dd6439e9076e81cb1a213a53b3741f4c001c39aa7111676beb3a23ecf957068646a091e71c4022bdfba445940c0e55b3b89b5afa8e4454dc
+  data.tar.gz: 2ebb96c28769c1df0b2b21a43595eea9ba1a9687ec837bded0ec8a0604adf8bf889e36fb3099a3d2f33f4c8385c07390283b2e6f5000e1298322f03dd6b0bf47

data/.gitignore

@@ -0,0 +1,7 @@
+yardoc
+Gemfile.lock
+pkg
+coverage
+log/*.log
+.DS_Store
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lsqs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 giannismelidis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# README
+
+This is a Sinatra server (using Puma) that mimics basic functionality of the 
+Amazon SQS Service (for development purposes).
+
+The messages are stored in hashes therefore they are not persisted. When you 
+shut down the server, the messages are lost.
+
+There is no authentication mechanism in place (yet), so no access key id and
+secret key are needed.
+
+At the moment these types of transactions are implemented:
+`CreateQueue`
+`PurgeQueue`
+`ListQueues`
+`DeleteQueue`
+`GetQueueUrl`
+`ReceiveMessage`
+`SendMessage`
+`SendMessageBatch`
+`DeleteMessage`
+`DeleteMessageBatch`
+`ChangeMessageVisibility`
+
+## Requirements
+
+* Ruby 2.2 or newer
+
+## Installation
+
+Just install the gem:
+
+    gem install lsqs
+
+It doesn't require the `aws-sdk` itself.
+
+## Usage
+
+Run `lsqs-server` in the console.
+
+In your application set the AWS configuration like this (change `base_url` and
+`port` number if you are not using the default ones):
+
+```
+
+	require 'aws-sdk' # version 2
+	
+	# it requires a dot in the URI when polling (to retrieve the region)
+	# so 'localhost' won't work.
+	base_url = '127.0.0.1' 
+	port 		 = 9292
+	
+	Aws.config.update(:endpoint => "http://#{base_url}:#{port}")
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/lsqs'
+require 'pry'
+
+Pry.start

data/bin/lsqs-server

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../lib/lsqs', __FILE__)
+
+Puma::CLI.new(ARGV).run

data/config/template.xml.liquid

@@ -0,0 +1,9 @@
+<xml>
+  <{{action}}Result>
+    {{content}}
+  </{{action}}Result>
+  <ResponseMetadata>
+    <RequestId>{{request_id}}</RequestId>
+  </ResponseMetadata>
+  {{error}}
+</xml>

data/config.ru

@@ -0,0 +1,4 @@
+require File.expand_path('../lib/lsqs', __FILE__)
+require File.expand_path('../lib/lsqs/server', __FILE__)
+
+run LSQS::Server

data/lib/lsqs/action_router.rb

@@ -0,0 +1,35 @@
+module LSQS
+  class ActionRouter
+    class ActionError < NameError; end
+    attr_reader :queue_list
+    
+    ##
+    # @param [LSQS::QueueList] queue_list
+    #
+    def initialize(queue_list)
+      @queue_list = queue_list
+    end
+    
+    ##
+    # Distributes an action to the appropriate class. If an action does not
+    # exist, it throws an error.
+    #
+    # @param [String] action_name
+    # @param [Hash] options
+    #
+    # @return [LSQS::Actions::Base]
+    #
+    def distribute(action_name, options)
+      if LSQS::Actions.const_defined?(action_name)
+        action = LSQS::Actions.const_get(action_name).new(queue_list)
+        queue_list.query do
+          action.perform(options)
+        end
+        
+        return action
+      else
+        raise ActionError, "undefined action `#{action_name}`"
+      end
+    end
+  end # ActionRouter
+end # LSQS

data/lib/lsqs/actions/base.rb

@@ -0,0 +1,51 @@
+module LSQS
+  module Actions
+    class Base
+      attr_accessor :queue_list
+      attr_reader :builder
+      
+      def initialize(queue_list)
+        @queue_list = queue_list
+      end
+          
+      ##
+      # Returns the name of the class without namespacing.
+      #
+      # @return [String]
+      #
+      def name
+        return self.class.name.split('::').last
+      end
+      
+      ##
+      # Initializes a XML builder.
+      #
+      # @return [Builder::XmlMarkup]
+      #
+      def builder
+        @builder ||= Builder::XmlMarkup.new(:indent => 2)
+      end
+      
+      ##
+      # Outputs XML from the builder as a string.
+      #
+      # @return [String]
+      #
+      def to_xml
+        builder.target!
+      end
+      
+      ##
+      # Builds the URL of the queue.
+      #
+      # @param [String] base_url
+      # @param [String] queue_name
+      
+      # @return [String]
+      #
+      def build_url(base_url, queue_name)
+        return "#{base_url}/#{queue_name}"
+      end
+    end # Base
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/change_message_visibility.rb

@@ -0,0 +1,23 @@
+module LSQS
+  module Actions
+    class ChangeMessageVisibility < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name       = params['QueueName']
+        visibility = params['VisibilityTimeout']
+        receipt    = params['ReceiptHandle']
+        queue = queue_list.find(name)
+        
+        queue.change_message_visibility(receipt, visibility.to_i)
+
+        return
+      end
+    end # ChangeMessageVisibility
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/create_queue.rb

@@ -0,0 +1,22 @@
+module LSQS
+  module Actions
+    class CreateQueue < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.create(name, params)
+
+        base_url = params['base_url']
+        url = build_url(base_url, name)
+
+        builder.QueueUrl build_url(base_url, name)
+      end
+    end # CreateQueue
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/delete_message.rb

@@ -0,0 +1,22 @@
+module LSQS
+  module Actions
+    class DeleteMessage < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        
+        queue = queue_list.find(name)
+        
+        receipt = params['ReceiptHandle']
+        queue.delete_message(receipt)
+        return
+      end
+    end # DeleteMessage
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/delete_message_batch.rb

@@ -0,0 +1,36 @@
+module LSQS
+  module Actions
+    class DeleteMessageBatch < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.find(name)
+        
+        queue    = queue_list.find(name)
+        receipts = params.select do |key, value| 
+          key.match(/DeleteMessageBatchRequestEntry\.\d+\.ReceiptHandle/)
+        end
+
+        deleted = []
+
+        receipts.each do |key, value|
+          id = key.split('.')[1]
+          queue.delete_message(value)
+          deleted << params["DeleteMessageBatchRequestEntry.#{id}.Id"]
+        end
+
+        deleted.compact.each do |id|
+          builder.DeleteMessageBatchResultEntry do
+            builder.Id id
+          end
+        end
+      end
+    end # DeleteMessageBatch
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/delete_queue.rb

@@ -0,0 +1,18 @@
+module LSQS
+  module Actions
+    class DeleteQueue < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.delete(name)
+        return
+      end
+    end # DeleteQueue
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/get_queue_url.rb

@@ -0,0 +1,23 @@
+module LSQS
+  module Actions
+    class GetQueueUrl < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        base_url = params['base_url']
+        name     = params['QueueName']
+        
+        queue = queue_list.delete(name)
+        
+        url = build_url(base_url, name)
+
+        builder.QueueUrl build_url(base_url, name)
+      end
+    end # GetQueueUrl
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/list_queues.rb

@@ -0,0 +1,22 @@
+module LSQS
+  module Actions
+    class ListQueues < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        base_url = params['base_url']
+        
+        queues = queue_list.inspect(params)
+        
+        queues.each do |queue|
+          builder.QueueUrl build_url(base_url, queue)
+        end
+      end
+    end # ListQueues
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/purge_queue.rb

@@ -0,0 +1,19 @@
+module LSQS
+  module Actions
+    class PurgeQueue < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.find(name)
+        queue.purge
+        return
+      end
+    end # PurgeQueue
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/receive_message.rb

@@ -0,0 +1,27 @@
+module LSQS
+  module Actions
+    class ReceiveMessage < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.find(name)
+        messages = queue.get_messages(params)
+        
+        messages.each do |receipt, message|
+          builder.Message do
+            builder.MessageId message.id
+            builder.ReceiptHandle receipt
+            builder.MD5OfBody message.md5
+            builder.Body message.body
+          end
+        end
+      end
+    end # ReceiveMessage
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/send_message.rb

@@ -0,0 +1,21 @@
+module LSQS
+  module Actions
+    class SendMessage < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.find(name)
+        message = queue.create_message(params)
+        
+        builder.MD5OfMessageBody message.md5
+        builder.MessageId message.id
+      end
+    end # SendMessage
+  end # Actions
+end # LSQS

data/lib/lsqs/actions/send_message_batch.rb

@@ -0,0 +1,42 @@
+module LSQS
+  module Actions
+    class SendMessageBatch < Base
+      ##
+      # Performs the specific action.
+      #
+      # @param [Hash] params
+      #
+      # @return [String]
+      #
+      def perform(params)
+        name  = params['QueueName']
+        queue = queue_list.find(name)
+        
+        messages = params.select do |key, value| 
+          key.match(/SendMessageBatchRequestEntry\.\d+\.MessageBody/)
+        end
+        
+        result = {}
+
+        messages.each do |key, value|
+          id      = key.split('.')[1]
+          msg_id  = params["SendMessageBatchRequestEntry.#{id}.Id"]
+          delay   = params["SendMessageBatchRequestEntry.#{id}.DelaySeconds"]
+          message = queue.create_message(
+            'MessageBody' => value, 
+            'DelaySeconds' => delay
+          )
+          result[msg_id] = message
+        end
+
+        result.each do |msg_id, message|
+          builder.SendMessageBatchResultEntry do
+            builder.MD5OfMessageBody message.md5
+            builder.MessageId message.id
+            builder.Id msg_id
+          end
+        end
+      end
+    end # SendMessageBatch
+  end # Actions
+end # LSQS

data/lib/lsqs/error_handler.rb

@@ -0,0 +1,65 @@
+module LSQS
+  class ErrorHandler
+    ERROR_LIST = {
+      'AccessDenied'                => 403,
+      'AuthFailure'                 => 401,
+      'ConflictingQueryParameter'   => 400,
+      'InternalError'               => 500,
+      'InvalidAccessKeyId'          => 401,
+      'InvalidAction'               => 400,
+      'InvalidAddress'              => 404,
+      'InvalidAttributeName'        => 400,
+      'InvalidHttpRequest'          => 400,
+      'InvalidMessageContents'      => 400,
+      'InvalidParameterCombination' => 400,
+      'InvalidParameterValue'       => 400,
+      'InvalidQueryParameter'       => 400,
+      'InvalidRequest'              => 400,
+      'InvalidSecurity'             => 403,
+      'InvalidSecurityToken'        => 400,
+      'MalformedVersion'            => 400,
+      'MessageTooLong'              => 400,
+      'MessageNotInflight'          => 400,
+      'MissingClientTokenId'        => 403,
+      'MissingCredentials'          => 401,
+      'MissingParameter'            => 400,
+      'NoSuchVersion'               => 400,
+      'NonExistentQueue'            => 400,
+      'NotAuthorizedToUseVersion'   => 401,
+      'QueueDeletedRecently'        => 400,
+      'QueueNameExists'             => 400,
+      'ReadCountOutOfRange'         => 400,
+      'ReceiptHandleIsInvalid'      => 400,
+      'RequestExpired'              => 400,
+      'RequestThrottled'            => 403,
+      'ServiceUnavailable'          => 503,
+      'X509ParseError'              => 400  
+    }
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      begin
+        @app.call env
+      rescue => error
+        xml = Builder::XmlMarkup.new(:index => 2)
+        
+        status = ERROR_LIST[error.message] || 500
+        
+        
+        xml.ErrorResponse do
+          xml.Error do
+            xml.Type error.message
+            xml.Code status
+            xml.Message error.to_s
+            xml.Detail
+          end
+        end
+
+        [status, {}, [LSQS.template.render_error(xml)]]
+      end
+    end
+  end # ErrorHandler
+end # LSQS

data/lib/lsqs/message.rb

@@ -0,0 +1,49 @@
+module LSQS
+  class Message
+    attr_reader :body, :id, :md5
+    attr_accessor :visibility_timeout
+
+    def initialize(options = {})
+      @body = options['MessageBody'] || ''
+      @id   = options.fetch('Id') { SecureRandom.uuid }
+      @md5  = options.fetch('MD5') { Digest::MD5.hexdigest(body) }
+    end
+
+    def attributes
+      {
+        "MessageBody" => body,
+        "Id"          => id,
+        "MD5"         => md5,
+      }
+    end
+    
+    ##
+    # Check if a message's visibility has timed out.
+    #
+    # @return [TrueClass|FalseClass]
+    #
+    def expired?
+      visibility_timeout.nil? || visibility_timeout < Time.now
+    end
+    
+    ##
+    # Sets the time when the message should expire.
+    #
+    # @param [Fixnum] seconds
+    #
+    # @return [Time]
+    #
+    def expire_in(seconds)
+      @visibility_timeout = Time.now + seconds
+    end
+    
+    ##
+    # Resets the visibility time of the message.
+    #
+    # @return [NilClass]
+    #
+    def expire
+      @visibility_timeout = nil
+    end
+  end # Message
+end # LSQS