mail_queue 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+binlog*

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in mail_queue.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    mail_queue (0.1.0)
+      mail (~> 2.2.14)
+      stalker (>= 0.6.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    beanstalk-client (1.1.0)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    json_pure (1.4.6)
+    mail (2.2.14)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    stalker (0.6.1)
+      beanstalk-client
+      json_pure
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0.rc.5)
+  mail (~> 2.2.14)
+  mail_queue!
+  rspec (~> 2.4.0)
+  stalker (>= 0.6.1)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mail_queue.rb

@@ -0,0 +1,47 @@
+require 'stalker'
+
+module MailQueue
+  class Beanstalk
+    
+    def initialize(options = {})
+      self.settings = {
+        :pri => 65536,
+        :delay => 0,
+        :ttr => 120,
+        :tube => 'email.send'
+      }.merge!(options)
+    end
+    
+    attr_accessor :settings
+
+    
+    def deliver!(mail)
+      # render mail and push onto queue
+      envelope_from = mail.return_path || mail.sender || mail.from_addrs.first
+      if envelope_from.blank?
+        raise ArgumentError.new('A sender (Return-Path, Sender or From) is required to send a message') 
+      end
+      
+      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
+      if destinations.blank?
+        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
+      end
+
+      message ||= mail.encoded if mail.respond_to?(:encoded)
+      if message.blank?
+        raise ArgumentError.new('Encoded content is required to send a message')
+      end
+
+      envelope = {
+        :from => envelope_from,
+        :destinations => destinations,
+        :message => message
+      }
+      
+      Stalker.enqueue(settings[:tube], envelope, settings)
+
+      self
+    end
+    
+  end
+end

data/lib/mail_queue/version.rb

@@ -0,0 +1,3 @@
+module MailQueue
+  VERSION = "0.1.0"
+end

data/mail_queue.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'mail_queue/version'
+
+Gem::Specification.new do |s|
+  s.name        = "mail_queue"
+  s.version     = MailQueue::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Han Kessels"]
+  s.email       = ["han.kessels@gmail.com"]
+  s.homepage    = "https://github.com/han/mailqueue"
+  s.summary     = "Delivery method for Mail gem to deliver to a beanstalk queue"
+  s.description = "Delivery method for Mail gem. Delivers mail to a beanstalk queue"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "mail_queue"
+
+  s.add_dependency "stalker", ">= 0.6.1"
+  s.add_dependency "mail", "~> 2.2.14"
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.5"
+  s.add_development_dependency "rspec", "~> 2.4.0 "
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = 'lib'
+end

data/readme.md

@@ -0,0 +1,63 @@
+MailQueue
+=========
+
+
+MailQueue is an asynchronous mail delivery method for the Mail gem. It delivers mail to a [Beanstalk](http://kr.github.com/beanstalkd/) queue. Worker processes can then pick up the mail from the queue and send it on over SMTP or the like.
+
+Installation
+------------
+
+gem install mail_queue
+
+Configuration
+-------------
+
++ Mail gem:
+
+    Mail.defaults { delivery_method MailQueue::Beanstalk, :tube => 'rculosis' }
+
++ Rails:
+
+    ActionMailer::Base.delivery_method = MailQueue::Beanstalk
+
+or, if you insist on changing the default options:
+
+    ActionMailer::Base.add_delivery_method(:beanstalk, MailQueue::Beanstalk)
+    ActionMailer::Base.beanstalk_settings = {
+      :tube => "email"
+    }
+    ActionMailer::Base.delivery_method = :beanstalk
+
+
+options are:
+* :pri    priority, from 0 to 2^32, 0 being the highest, 65536 the default 
+* :ttr    time to run, default 120 (seconds)
+* :delay  how many seconds before the job is put on the ready queue (default 0)
+* :tube   tube name used on beanstalk, defaults to 'email.send'
+
+
+Worker
+------
+
+Have a worker pull the mails off the queue.
+For example, using [Stalker](http://github.com/adamwiggins/stalker):
+
+    smtp = Net::SMTP.new('smtp.example.com', 25)
+    job 'email.send' do |args|
+      smtp.start('example.com', 'me', 'mypassword', 'plain') do |smtp|
+        smtp.sendmail(args['message'], args['from'], args['destinations'])
+      end
+    end 
+
+See [Stalker](http://github.com/adamwiggins/stalker) documentation for how to run a job.
+
+
+Meta
+----
+
+Created by Han Kessels
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://github.com/han/mailqueue
+

data/spec/mail_queue_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'mail'
+require 'stalker'
+require 'mail_queue'
+#  require 'ruby-debug'
+#  Debugger.start
+
+def Stalker.log(msg)  
+end
+
+
+describe "beanstalk" do
+  it "should be running" do
+    Stalker.beanstalk.stats
+  end
+end 
+
+describe MailQueue do
+  
+  it "should be valid" do
+    MailQueue.should be_a(Module)
+  end
+    
+  describe "sending a mail"
+
+  before(:each) do
+    @mail = Mail.new do
+      from 'sjeng@example.com'
+      to 'sjeng@example.com'
+      subject 'test from MailQueue'
+      body 'this is my body'
+    end
+    @mail.delivery_method MailQueue::Beanstalk
+    @msg = @mail.to_s
+  end
+  
+  it "should use Mail to serialize an e-mail" do
+    @msg.should match /From: sjeng@example\.com/
+    @msg.should match /this is my body/
+    @msg.should_not match /and my soul/
+  end
+  
+  
+  it "should put the message on a queue" do
+    @mail.deliver!
+    
+    Stalker.job 'email.send' do |args|
+      msg = args['message']
+      msg.should match /From: sjeng@example\.com/
+      msg.should match /this is my body/
+      msg.should_not match /and my soul/
+      args['from'].should == "sjeng@example.com"
+      args['destinations'].should == ["sjeng@example.com"]
+    end
+    Stalker.prep
+    Stalker.work_one_job
+      
+  end
+  
+  it "should validate presence of from attribute" do
+    expect {
+      @mail.from = ""
+      @mail.deliver!
+    }.to raise_error(ArgumentError)
+  end
+  
+  it "should validate presence of to attribute" do
+    expect {
+      @mail.to = []
+      @mail.deliver!
+    }.to raise_error(ArgumentError)
+  end
+
+  it "should put a message on the correct tube" do
+    @mail.delivery_method.settings["tube"] = "boe"
+    @mail.deliver!
+    
+    Stalker.job 'boe' do |args|
+      msg = args['message']
+      msg.should match /From: sjeng@example\.com/
+      msg.should match /this is my body/
+      msg.should_not match /and my soul/
+      args['from'].should == "sjeng@example.com"
+      args['destinations'].should == ["sjeng@example.com"]
+    end
+    Stalker.prep
+    Stalker.work_one_job
+ 
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: mail_queue
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Han Kessels
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-17 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: stalker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 2
+        - 14
+        version: 2.2.14
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15424063
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 5
+        version: 1.0.0.rc.5
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+description: Delivery method for Mail gem. Delivers mail to a beanstalk queue
+email: 
+- han.kessels@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/mail_queue.rb
+- lib/mail_queue/version.rb
+- mail_queue.gemspec
+- readme.md
+- spec/mail_queue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/han/mailqueue
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: mail_queue
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Delivery method for Mail gem to deliver to a beanstalk queue
+test_files: []
+