maildir-queue 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Aaron Suggs
+
+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.rdoc

@@ -0,0 +1,17 @@
+= maildir-queue
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Aaron Suggs. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "maildir-queue"
+    gem.summary = %Q{A simple queue API with a maildir backend.}
+    gem.description = %Q{A simple queue API with a maildir backend. Also includes an HTTP API}
+    gem.email = "aaron@ktheory.com"
+    gem.homepage = "http://github.com/ktheory/maildir-queue"
+    gem.authors = ["Aaron Suggs"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "rack-test", ">= 0"
+    gem.add_development_dependency "ktheory-fakefs", ">= 0"
+    gem.add_dependency "maildir", ">= 0.3.0"
+    gem.add_dependency "sinatra", ">= 0.0.0"
+    gem.add_dependency "json", ">= 0.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "maildir-queue #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/examples/config.ru

@@ -0,0 +1,5 @@
+# A rackup file suitable for thin, passenger, unicorn, etc.
+
+require "maildir/web_queue"
+Maildir::WebQueue.path = "/tmp/my_maildir"
+run Maildir::WebQueue

data/lib/maildir/queue.rb

@@ -0,0 +1,60 @@
+require 'maildir'
+class Maildir::Queue < Maildir
+  # How many times to retry getting a key.
+  # Default is -1 (infinite retries)
+  SHIFT_RETRIES = -1
+
+  # Adds a new message to the queue. Returns a Maildir::Message object
+  def push(data)
+    add(data)
+  end
+
+  # Finds a new message and marks it as being processed (i.e. moves message
+  # from new to cur). Returns message if successful; nil if there are no
+  # pending messages.
+  def shift
+    retries = 0
+    begin
+      # Get a pending message
+      message = list(:new, :limit => 1).first
+      return nil if message.nil?
+
+      # Move the message from new to cur
+      if message.process
+        return message
+      else
+        raise Errno::ENOENT
+      end
+    rescue Errno::ENOENT
+      # Either message.process failed. Retry.
+      if SHIFT_RETRIES < 0 || retries < SHIFT_RETRIES
+        retries += 1
+        retry
+      else
+        # After several failures, act as if there are no pending messages
+        return nil
+      end
+    end
+  end
+
+  # Returns messages in cur that haven't been modified since +time+
+  def stalled_messages(time)
+    list(:cur).select do |message|
+      (mtime = message.mtime) && mtime < time
+    end
+  end
+
+  # Returns a count of requeued messages
+  def requeue_stalled_messages(time)
+    stalled_messages(time).inject(0) do |count, message|
+      begin
+        push(message.data)
+        message.destroy
+        count + 1
+      rescue Errno::ENOENT
+        # Could not read message.data
+        count
+      end
+    end
+  end
+end

data/lib/maildir/web_queue.rb

@@ -0,0 +1,74 @@
+require "maildir/queue"
+require "sinatra/base"
+require "json"
+
+class Maildir::WebQueue < Sinatra::Base
+
+  KEY_VALIDATOR = /^cur\/\d{10}\.\w+(\.\w+)+:2,(\w+)?$/
+
+  def self.path=(path)
+    @@queue = Maildir::Queue.new(path)
+  end
+
+  def queue
+    @@queue
+  end
+
+  # Test that key is well-formed. If not, return 403 Forbidden error.
+  def sanitize(key)
+    # E.g. cur/1263444769.M975543P58179Q11.gnt.local:2,
+    unless key.match(KEY_VALIDATOR)
+      content_type "text/plain"
+      halt 403, "Malformed key: #{key}"
+    end
+  end
+
+  # Return a 204 No Content response
+  def no_content
+    halt 204, ""
+  end
+
+  # Check the server status
+  get "/status" do
+    content_type "application/json"
+    {"new" => queue.list(:new).size,"cur" => queue.list(:cur).size}.to_json
+  end
+
+  # Create a new message. Requires params[:data]
+  # Returns the message's key as json
+  post "/message" do
+    halt 400, "Must specify data parameter" unless params[:data]
+    message = queue.push(params[:data])
+    content_type "application/json"
+    message.key.to_json
+  end
+
+  # Shift a new message off the queue
+  get "/message" do
+    message = queue.shift
+    content_type "application/json"
+    if message
+      {"key" => message.key, "data" => message.data}.to_json
+    else
+      not_found "No pending messages".to_json
+    end
+  end
+
+  # Delete a message from the queue
+  delete "/message/*" do |key|
+    sanitize(key)
+    queue.delete(key)
+    no_content
+  end
+
+  # # Update the timestamps on a message
+  # post "/message/touch/*" do |key|
+  #   sanitize(key)
+  #   if queue.get(key).utime(Time.now, Time.now)
+  #     no_content
+  #   else
+  #     not_found "Key #{key} does not exist"
+  #   end
+  # end
+end
+

data/maildir-queue.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{maildir-queue}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Suggs"]
+  s.date = %q{2010-01-15}
+  s.description = %q{A simple queue API with a maildir backend. Also includes an HTTP API}
+  s.email = %q{aaron@ktheory.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/config.ru",
+     "lib/maildir/queue.rb",
+     "lib/maildir/web_queue.rb",
+     "maildir-queue.gemspec",
+     "test/helper.rb",
+     "test/test_maildir_queue.rb",
+     "test/test_maildir_web_queue.rb"
+  ]
+  s.homepage = %q{http://github.com/ktheory/maildir-queue}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A simple queue API with a maildir backend.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_maildir_queue.rb",
+     "test/test_maildir_web_queue.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<ktheory-fakefs>, [">= 0"])
+      s.add_runtime_dependency(%q<maildir>, [">= 0.3.0"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.0.0"])
+      s.add_runtime_dependency(%q<json>, [">= 0.0.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<ktheory-fakefs>, [">= 0"])
+      s.add_dependency(%q<maildir>, [">= 0.3.0"])
+      s.add_dependency(%q<sinatra>, [">= 0.0.0"])
+      s.add_dependency(%q<json>, [">= 0.0.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<ktheory-fakefs>, [">= 0"])
+    s.add_dependency(%q<maildir>, [">= 0.3.0"])
+    s.add_dependency(%q<sinatra>, [">= 0.0.0"])
+    s.add_dependency(%q<json>, [">= 0.0.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+require 'shoulda'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'maildir/queue'
+require 'maildir/web_queue'
+
+# Require 'ktheory-fakefs' until issues 28, 29, and 30 are resolved in
+# defunkt/fakefs. See http://github.com/defunkt/fakefs/issues
+gem "ktheory-fakefs"
+require 'fakefs'
+
+
+# Create a reusable MaildirQueue that's cleaned up when the tests are done
+def temp_queue
+  Maildir::Queue.new("/tmp/maildir_queue_test")
+end

data/test/test_maildir_queue.rb

@@ -0,0 +1,47 @@
+require 'helper'
+class TestMaildirQueue < Test::Unit::TestCase
+
+  context "A maildir queue" do
+
+    setup { FakeFS::FileSystem.clear }
+
+    should "shift messages" do
+      temp_queue.add("1")
+      temp_queue.add("2")
+      message = temp_queue.shift
+      assert_equal "1", message.data
+    end
+
+    should "put shifted messages in cur" do
+      temp_queue.add("")
+      message = temp_queue.shift
+      assert_equal :cur, message.dir
+    end
+
+    should "list stalled messages" do
+      temp_queue.add("")
+      message = temp_queue.shift
+      mtime = Time.now - 100
+      message.utime(mtime, mtime)
+      assert temp_queue.stalled_messages(Time.now - 50).include?(message)
+    end
+
+    should "requeue stalled messages" do
+      data = "my data"
+      temp_queue.add(data)
+      stalled_message = temp_queue.shift
+      mtime = Time.now - 100
+      stalled_message.utime(mtime, mtime)
+      temp_queue.requeue_stalled_messages(Time.now - 50)
+      assert_equal data, temp_queue.list(:new).first.data
+    end
+
+    should "return the number of requeued stalled messages" do
+      temp_queue.add("")
+      stalled_message = temp_queue.shift
+      mtime = Time.now - 100
+      stalled_message.utime(mtime, mtime)
+      assert_equal 1, temp_queue.requeue_stalled_messages(Time.now - 50)
+    end
+  end
+end

data/test/test_maildir_web_queue.rb

@@ -0,0 +1,85 @@
+require 'helper'
+class TestMaildirWebQueue < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Maildir::WebQueue.path = temp_queue.path
+    Maildir::WebQueue
+  end
+
+  context "The webcontroller" do
+
+    setup do
+      FakeFS::FileSystem.clear
+      @data = "my message"
+    end
+
+    should "have a status" do
+      get "/status"
+      assert last_response.ok?
+    end
+
+    should "accept posted messages" do
+      post "/message", :data => @data
+      assert last_response.ok?
+    end
+
+    should "add posted messages to the queue" do
+      post "/message", :data => @data
+      assert_equal 1, temp_queue.list(:new).size
+    end
+
+    should "save messages with the right data" do
+      post "/message", :data => @data
+      assert_equal @data, temp_queue.list(:new).first.data
+    end
+
+    should "return 404 when no pending messages" do
+      get "/message"
+      assert_equal 404, last_response.status
+    end
+
+    should "return successfully when messages are pending" do
+      post "/message", :data => @data
+      get "/message"
+      assert last_response.ok?
+    end
+
+    should "return a well-formed key when messages are pending" do
+      post "/message", :data => @data
+      get "/message"
+      assert_match Maildir::WebQueue::KEY_VALIDATOR, JSON.parse(last_response.body)["key"]
+    end
+
+    should "return message data when messages are pending" do
+      post "/message", :data => @data
+      get "/message"
+      assert_equal @data, JSON.parse(last_response.body)["data"]
+    end
+
+  end
+
+  # Test the Maildir::WebQueue::KEY_VALIDATOR
+  bad_keys = [ "/etc/passwd", "cur/../../etc/password",
+    "cur/123456789.M975543P58179Q11.host:2,",
+    "cur/1234567890.M975543P58179Q11:2,",
+    "cur/1234567890.M975543P58179Q11.host"
+  ]
+  bad_keys.each_with_index do |key, i|
+    define_method "test_bad_key_#{i}" do
+      delete "/message/#{key}"
+      assert_equal 403, last_response.status, "Key: #{key}"
+    end
+  end
+
+  good_keys = [ "cur/1234567890.M975543P58179Q11.host:2,",
+    "cur/1234567890.abc123.really.long.domain.co.uk:2,",
+    "cur/1234567890.M975543P58179Q11.host:2,FRS"
+  ]
+  good_keys.each_with_index do |key, i|
+    define_method "test_good_key_#{i}" do
+      delete "/message/#{key}"
+      assert last_response.successful?
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: maildir-queue
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Aaron Suggs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ktheory-fakefs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: maildir
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: A simple queue API with a maildir backend. Also includes an HTTP API
+email: aaron@ktheory.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/config.ru
+- lib/maildir/queue.rb
+- lib/maildir/web_queue.rb
+- maildir-queue.gemspec
+- test/helper.rb
+- test/test_maildir_queue.rb
+- test/test_maildir_web_queue.rb
+has_rdoc: true
+homepage: http://github.com/ktheory/maildir-queue
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A simple queue API with a maildir backend.
+test_files: 
+- test/helper.rb
+- test/test_maildir_queue.rb
+- test/test_maildir_web_queue.rb