mitchellh-rsqs 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-06-03
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+License.txt
+Manifest.txt
+README.textile
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/rsqs.rb
+lib/rsqs/version.rb
+lib/rsqs/request.rb
+lib/rsqs/queue.rb
+lib/rsqs/message.rb
+lib/rsqs/exception.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/rsqs_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.textile

@@ -0,0 +1,81 @@
+h1. RSQS
+
+h2. Description
+
+A ruby implementation of the Amazon SQS API.
+
+h2. Installation
+
+sudo gem install rsqs
+
+h2. Pre-Requirements
+
+First, RSQS expects that you have the following environmental variables set:
+
+  # AMAZON_ACCESS_KEY - Your amazon web services access key which you can 
+      find under "Access Identifiers" in your AWS account.
+  # AMAZON_SECRET_ACCESS_KEY - Your AWS secret access key which is found in
+      in the same place as the access key.
+
+The easiest way to do this is to setup a file in your home directory and add
+the following lines:
+
+  export AMAZON_ACCESS_KEY=1848101948W18189491
+  export AMAZON_SECRET_ACCESS_KEY=10198DKLDSL101/W31019D/10X
+
+And then, assuming this file was called ".amazon_keys" you can load them:
+
+  source ~/.amazon_keys
+
+h2. Usage
+
+h3. Creating a New Queue
+
+  q = RSQS::Queue.create :new_queue
+  
+h3. Putting New Messages
+
+Note: This will assume that :new_queue exists to save you requests to
+  SQS service. A QueueDoesNotExistError will be raised if the
+  queue doesn't exist.
+  
+  RSQS::Queue.find :new_queue { send_message 'My New Message' }
+  
+OR
+
+  q = RSQS::Queue.find :new_queue
+  q.send_message 'My New Message'
+  
+NOTE: If you want RSQS to automatically create queues which do not exist,
+  use the find_or_create method instead!
+
+h3. Getting Messages
+
+  q = RSQS::Queue.find :new_queue
+  m = q.receive
+  m # <RSQS::Message>
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/rsqs.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'rexml/document'
+require 'rsqs/exception'
+require 'rsqs/message'
+require 'rsqs/queue'
+require 'rsqs/request'
+require 'rsqs/version'

data/lib/rsqs/exception.rb

@@ -0,0 +1,11 @@
+module RSQS
+  class SQSException < Exception
+    attr_reader :code
+    
+    def initialize(code, message)
+      super(message)
+      
+      @code = code
+    end
+  end
+end

data/lib/rsqs/message.rb

@@ -0,0 +1,17 @@
+module RSQS
+  class Message
+    attr_reader :id, :receipt, :body
+    
+    def initialize(xml, parent)
+      @id = REXML::XPath.first(xml, '//ReceiveMessageResponse/ReceiveMessageResult/Message/MessageId').text
+      @receipt = REXML::XPath.first(xml, '//ReceiveMessageResponse/ReceiveMessageResult/Message/ReceiptHandle').text
+      @body = REXML::XPath.first(xml, '//ReceiveMessageResponse/ReceiveMessageResult/Message/Body').text
+      
+      @parent = parent
+    end
+    
+    def delete
+      @parent.delete_message @receipt
+    end
+  end
+end

data/lib/rsqs/queue.rb

@@ -0,0 +1,49 @@
+module RSQS
+  # = Queue
+  # The queue object is used to manage an entire queue within SQS. 
+  class Queue
+    class <<self
+      def create(name)
+        Request.send('CreateQueue', {
+          'QueueName'  => name,
+          'DefaultVisibilityTimeout' => '30'
+        })
+      end
+    end
+    
+    def initialize(name)
+      @name = name
+    end
+    
+    def receive(max_number = nil, visibility = nil)
+      args = {}
+      args['MaxNumberOfMessages'] = max_number unless max_number.nil?
+      args['VisibilityTimeout'] = visibility unless visibility.nil?
+      
+      response = send_request('ReceiveMessage', args)
+      
+      # Parse the response
+      return nil unless REXML::XPath.first(response, '//ReceiveMessageResponse/ReceiveMessageResult').has_elements?
+      return Message.new(response, self)
+    end
+    
+    def send(message)
+      send_request('SendMessage', { 'MessageBody' => message })
+    end
+    
+    def delete
+      send_request('DeleteQueue')
+    end
+    
+    def delete_message(receipt)
+      send_request('DeleteMessage', { 'ReceiptHandle' => receipt })
+    end
+    
+    private
+      def send_request(action, args = {})
+        Request.send(action, args.merge({
+          'QueueURL' => @name
+        }))
+      end
+  end
+end

data/lib/rsqs/request.rb

@@ -0,0 +1,71 @@
+require 'openssl'
+require 'base64'
+require 'net/http'
+require 'uri'
+require 'cgi'
+    
+module RSQS
+  class Request
+    SQS_VERSION = '2008-01-01'
+    
+    class <<self
+      def send(action, extras = {})
+        query = {
+          'Action' => action,
+          'SignatureVersion' => '1',
+          'Timestamp' => time_arg,
+          'AWSAccessKeyId' => amazon_access_key,
+          'Version' => SQS_VERSION
+        }
+        
+        query.merge!(extras)
+        
+        queue_url = 'http://queue.amazonaws.com/'
+        if query.has_key?('QueueURL')
+          queue_url += query.delete('QueueURL')
+        end
+
+        query['Signature'] = sign(query)
+        
+        result = Net::HTTP.post_form(URI.parse(queue_url), query)
+        result = REXML::Document.new result.body
+        
+        # If we got an error as the response, raise exception
+        if result.root.name == 'ErrorResponse'
+          raise SQSException.new(
+            REXML::XPath.first(result, '//ErrorResponse/Error/Code').text.strip, 
+            REXML::XPath.first(result, '//ErrorResponse/Error/Message').text.strip)
+        end
+        
+        result
+      end
+      
+      # Creates the signature parameter for the SQS request. query should
+      # be a hash with the parameters that are going in the request.
+      def sign(query)
+        # Get the signature for the request:
+        #   1. Sort by keys alphabetically. (Downcase is required or uppercase comes before lowercase)
+        #   2. HMAC-Sha1 digest the string
+        #   3. Base64 encode.
+        digest_string = query.sort { |a,b| a[0].downcase <=> b[0].downcase }.to_a.flatten.collect { |x| x.to_s }.join('')
+        digest_string = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), amazon_secret_access_key, digest_string).to_s
+        
+        Base64.encode64(digest_string).strip
+      end
+      
+      def time_arg
+        Time.now.gmtime.strftime('%Y-%m-%dT%H:%M:%S.000Z')
+      end
+      
+      def amazon_secret_access_key
+        raise ArgumentError.new('You need to set your AMAZON_SECRET_ACCESS_KEY environmental variable.') if ENV['AMAZON_SECRET_ACCESS_KEY'].nil?
+        ENV['AMAZON_SECRET_ACCESS_KEY']
+      end
+      
+      def amazon_access_key
+        raise ArgumentError.new('You need to set your AMAZON_ACCESS_KEY environmental variable.') if ENV['AMAZON_ACCESS_KEY'].nil?
+        ENV['AMAZON_ACCESS_KEY']
+      end
+    end
+  end
+end

data/lib/rsqs/version.rb

@@ -0,0 +1,9 @@
+module RSQS #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rsqs.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "rsqs"
+  s.version = "0.0.1"
+  s.date = "2008-06-08"
+  s.summary = "A pure ruby gem to control an RSQS queue."
+  s.email = "mitchell.hashimoto@gmail.com"
+  s.homepage = "http://github.com/mitchellh/rsqs"
+  s.description = "RSQS is a pure ruby library to control Amazon SQS."
+  s.has_rdoc = false
+  s.authors = ["Mitchell Hashimoto"]
+  s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "rsqs.gemspec", "lib/rsqs.rb", "lib/rsqs/exception.rb", 
+    "lib/rsqs/message.rb", "lib/rsqs/queue.rb", "lib/rsqs/request.rb", "lib/rsqs/version.rb"]
+  #s.test_files = ["test/test_actor.rb", "test/test_blob.rb", "test/test_commit.rb", "test/test_config.rb", "test/test_diff.rb", "test/test_git.rb", "test/test_head.rb", "test/test_real.rb", "test/test_reality.rb", "test/test_repo.rb", "test/test_tag.rb", "test/test_tree.rb"]
+  s.rdoc_options = ["--main", "README.textile"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.textile"]
+  #s .add_dependency("mime-types", ["> 0.0.0"])
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: mitchellh-rsqs
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mitchell Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: RSQS is a pure ruby library to control Amazon SQS.
+email: mitchell.hashimoto@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.textile
+files: 
+- History.txt
+- Manifest.txt
+- README.textile
+- Rakefile
+- rsqs.gemspec
+- lib/rsqs.rb
+- lib/rsqs/exception.rb
+- lib/rsqs/message.rb
+- lib/rsqs/queue.rb
+- lib/rsqs/request.rb
+- lib/rsqs/version.rb
+has_rdoc: false
+homepage: http://github.com/mitchellh/rsqs
+post_install_message: 
+rdoc_options: 
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A pure ruby gem to control an RSQS queue.
+test_files: []
+