em-mailer 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use em-mailer

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-mailer.gemspec
+gemspec

data/README

@@ -0,0 +1,120 @@
+#README
+
+WARNING: This is an experiment.
+
+You probably don't want to use this (quite yet). I haven't even begun
+to see if it works on Rails 3. But, I can assure you it *is* working
+in production for an old Rails 2 customer.
+
+For those that have read the aforementioned caveats and are gluttons
+for punishment, please read on.
+
+##Why?
+I wrote em-mailer to solve a problem that I was having. I wanted to
+send e-mails (to a fair # of subscribers) asynchronously. I didn't
+want to use Resque or another background job / worker solution for 
+this, I wanted a drop-dead simple mail server process whose sole job
+was to accept Mail messages encoded as JSON over a socket, and then 
+deliver them according to the delivery options (I've tested both
+:sendmail and :smtp configurations).
+
+##Rails 2
+I originally wrote em_mailer for an old Rails 2 app that I hadn't
+bothered getting around to migrating, so there's built-in support
+for similarly lazy-minded individuals.
+
+In config/environment.rb:
+
+    config.gem 'em_mailer'
+
+In config/environments/production.rb
+
+    config.action_mailer.delivery_method = :em_mailer
+
+Out of the box it works with :sendmail delivery as the default.
+
+If you wish to use SMTP you can do something like this:
+
+In config/initializers/em_mailer.rb
+
+    ActionMailer::Base.em_mailer_settings[:delivery_method] = :smtp
+    ActionMailer::Base.em_mailer_settings[:delivery_options] = {
+      :address => '<< your smtp server name>>',
+      :port => 25,
+      :domain => '<< your domain >>',
+      :authentication => :plain,
+      :user_name => '<< user with access to smtp host >>',
+      :password => '<< their password >>'
+    }
+    
+##Rails 3
+In your Gemfile
+
+    gem 'em_mailer'
+
+That should be all that's necessary. Again, haven't experimented (yet).
+
+##Running the Mail Server
+You'll need a running instance of the mail server running. The gem
+comes bundled with a binary em_mailer_server. You can run it from
+a command line thusly:
+
+    em_mailer_server
+
+To run it daemonized it's as easy as:
+
+    em_mailer_server -D
+
+You can also specify the port that you want the server to listen on
+(default is 5600)
+
+    em_mailer_server -p 5600 -D
+
+For a full list of configuration options pass it a -h, or --help.
+
+##Start/Stop Script
+I happen to be running em_mailer_server on a CentOS box. Here's my
+/etc/init.d/em_mailer script that I use to start|stop|restart the
+process on the host server
+
+    #!/bin/bash
+    #
+    # EM Mailer
+    #
+    # chkconfig: - 85 15
+    # description: start, stop, restart EM Mailer Server
+    #
+    RETVAL=0
+
+    case "$1" in
+        start)
+          /usr/local/bin/em_mailer_server -P /var/run/em_mailer.pid -D
+          RETVAL=$?
+      ;;
+        stop)
+          kill `cat /var/run/em_mailer.pid`
+          RETVAL=$?
+      ;;
+        restart)
+          kill `cat /var/run/em_mailer.pid`
+          /usr/local/bin/em_mailer_server -P /var/run/em_mailer.pid -D
+          RETVAL=$?
+      ;;
+        *)
+          echo "Usage: em_mailer {start|stop|restart}"
+          exit 1
+      ;;
+    esac
+ 
+    exit $RETVAL
+
+##Monitoring
+Lastly, I like to use monit to make sure my daemon processes are up and
+running. Here's my sample monit script:
+
+    check process em_mailer with pidfile /var/run/em_mailer.pid
+      start program = "/etc/init.d/em_mailer start"
+      stop program = "/etc/init.d/em_mailer stop"
+      if failed port 5600 then restart
+      group mail
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+

data/bin/em_mailer_server

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'eventmachine'
+require 'optparse'
+require 'mail'
+require 'yajl'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: em_mailer_server [options]"
+
+  options[:host] = '127.0.0.1'
+  opts.on('-o', '--host HOST', 'listen on HOST (default: 127.0.0.1)') do |host|
+    options[:host] = host
+  end
+
+  options[:port] = 5600
+  opts.on('-p', '--port PORT', 'use PORT (default: 5600)') do |port|
+    options[:port] = port
+  end
+
+  options[:pid] = 'tmp/pids/em_mailer.pid'
+  opts.on('-P', '--pid PID', 'specify path to write PID (default: tmp/pids/em_mailer.pid)') do |pid|
+    options[:pid] = pid
+  end
+
+  opts.on('-D', '--daemonize', 'run daemonized in the background') { |d|
+    options[:daemonize] = d ? true : false
+  }
+
+  opts.on('-h', '--help', 'display this screen') do
+    puts opts
+    exit 0
+  end
+
+  opts.parse! ARGV
+end
+
+module MailServer
+  def post_init
+    @parser = Yajl::Parser.new(:symbolize_keys => true)
+    @parser.on_parse_complete = Proc.new { |obj| object_parsed(obj) }
+  end
+
+  def object_parsed(obj)
+    puts "delivering #{obj[:message]}"
+    mail = Mail.new(obj[:message])
+    mail.delivery_method obj[:delivery_method].to_sym, obj[:delivery_options]
+    mail.deliver
+  end
+
+  def receive_data(data)
+    @parser << data
+  end
+end
+
+EM.run{
+  EM.start_server options[:host], options[:port], MailServer
+  if options[:daemonize]
+    if RUBY_VERSION < "1.9"
+      exit if fork
+      Process.setsid
+      exit if fork
+      Dir.chdir "/"
+      File.umask 0000
+      STDIN.reopen "/dev/null"
+      STDOUT.reopen "/dev/null", "a"
+      STDERR.reopen "/dev/null", "a"
+    else
+      Process.daemon
+    end
+  end
+  File.open(options[:pid], 'w') { |f| f << Process.pid }
+}

data/em-mailer.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-mailer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-mailer"
+  s.version     = Em::Mailer::VERSION
+  s.authors     = ["Chris Kraybill"]
+  s.email       = ["ckraybill@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Asynchronous mail client and server}
+  s.description = %q{Asynchronous mail client and server written in ruby,
+                  eventmachine to replace synchronous mail implementation
+                  in Rails 2 and 3}
+
+  s.rubyforge_project = "em-mailer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "eventmachine"
+  s.add_dependency "mail"
+  s.add_dependency "yajl-ruby"
+  s.add_dependency "actionmailer"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "em-spec"
+end

data/lib/em-mailer.rb

@@ -0,0 +1,25 @@
+require "action_mailer"
+require "em-mailer/version"
+require "em-mailer/client"
+
+if defined?(Rails) && Rails::VERSION::MAJOR == 2
+  module ActionMailer
+    class Base
+      @@em_mailer_settings = {
+        :host             => 'localhost',
+        :port             => 5600,
+        :delivery_method  => :sendmail,
+        :delivery_options => {}
+      }
+      cattr_accessor :em_mailer_settings
+
+      def perform_delivery_em_mailer(mail)
+        em_client = Em::Mailer::Client.new(em_mailer_settings)
+        em_client.deliver!(mail)
+      end
+    end
+  end
+else
+  ActionMailer::Base.add_delivery_method :em_mailer, Em::Mailer::Client
+end
+

data/lib/em-mailer/client.rb

@@ -0,0 +1,33 @@
+require 'socket'
+require 'yajl'
+
+module Em
+  module Mailer
+    class Client
+      def initialize(values)
+        self.settings = {
+          :host             => 'localhost',
+          :port             => 5600,
+          :delivery_method  => :sendmail,
+          :delivery_options => {}
+        }.merge!(values)
+      end
+
+      attr_accessor :settings
+
+      def deliver!(mail)
+        socket = open_socket
+        Yajl::Encoder.encode({
+          :message          => mail.to_s,
+          :delivery_method  => settings[:delivery_method],
+          :delivery_options => settings[:delivery_options]
+        }, socket)
+        socket.close
+      end
+
+      def open_socket
+        TCPSocket.new(settings[:host], settings[:port])
+      end
+    end
+  end
+end

data/lib/em-mailer/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Mailer
+    VERSION = "0.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rspec'
+require 'em-spec/rspec'
+
+require 'em-mailer'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end
+

data/spec/unit/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Em::Mailer::Client do
+  describe "#initialize" do
+    before do
+      @client = Em::Mailer::Client.new({})
+    end
+
+    it "default's host to localhost" do
+      @client.settings[:host].should == 'localhost'
+    end
+
+    it "default's port to 5600" do
+      @client.settings[:port].should == 5600
+    end
+
+    it "default's delivery method to :sendmail" do
+      @client.settings[:delivery_method].should == :sendmail
+    end
+
+    it "default's delivery options to an empty hash" do
+      @client.settings[:delivery_options].should == {}
+    end
+
+    it "allows overridding the port" do
+      @client = Em::Mailer::Client.new({:port => 5700})
+      @client.settings[:port].should == 5700
+    end
+
+    it "allows overridding the delivery method" do
+      @client = Em::Mailer::Client.new({:delivery_method => :smtp})
+      @client.settings[:delivery_method].should == :smtp
+    end
+
+    it "allows overridding the delivery options" do
+      @client = Em::Mailer::Client.new({:delivery_options => {:username => 'meh'}})
+      @client.settings[:delivery_options][:username].should == 'meh'
+    end
+  end
+
+  describe "#deliver!" do
+    before do
+      @mail = { :to => 'bleh@foo.com', :subject => 'Hai!' }
+      @socket = mock(TCPSocket, :close => true)
+      @client = Em::Mailer::Client.new({:host => 'foo', :port => 42})
+      @client.stub(:open_socket).and_return(@socket)
+    end
+
+    it "opens a socket" do
+      @client.should_receive(:open_socket)
+      @client.deliver!(@mail)
+    end
+
+    it "encodes a hash, along with the socket" do
+      Yajl::Encoder.should_receive(:encode).with(an_instance_of(Hash),@socket)
+      @client.deliver!(@mail)
+    end
+
+    it "converts the mail message to a String" do
+      @mail.should_receive(:to_s)
+      @client.deliver!(@mail)
+    end
+
+    it "closes the socket" do
+      @socket.should_receive(:close)
+      @client.deliver!(@mail)
+    end
+  end
+
+  describe "#open_socket" do
+    it "instantiates a socket on the correct host and port" do
+      @client = Em::Mailer::Client.new({:host => 'foo', :port => 42})
+      TCPSocket.should_receive(:new).with('foo',42)
+      @client.open_socket
+    end
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: em-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kraybill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70103820724380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103820724380
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &70103820723920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103820723920
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70103820723500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103820723500
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70103820723080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70103820723080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70103820722660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70103820722660
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: &70103820722240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70103820722240
+description: ! "Asynchronous mail client and server written in ruby,\n                  eventmachine
+  to replace synchronous mail implementation\n                  in Rails 2 and 3"
+email:
+- ckraybill@gmail.com
+executables:
+- em_mailer_server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- bin/em_mailer_server
+- em-mailer.gemspec
+- lib/em-mailer.rb
+- lib/em-mailer/client.rb
+- lib/em-mailer/version.rb
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: em-mailer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Asynchronous mail client and server
+test_files:
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb