queued_mail 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,118 @@
+= QueuedMail
+
+Author:: Yuichi Takeuchi uzuki05@takeyu-web.com
+Website:: http://takeyu-web.com/
+Copyright:: Copyright 2012 Yuichi Takeuchi
+License:: MIT-LICENSE.
+
+
+== 何が嬉しいの？
+
+時間のかかるメール送信処理をバックグラウンドで処理することで、ユーザーに素早いレスポンスを返すことができます。
+
+ActionMailer::Base#deliverでを実際のメール送信ではなくジョブキューへの登録を行うようになります。
+特徴はActionMailerの設定を変更するだけよく、アプリケーションコードへの変更が不要なことです。
+このため、とても簡単に導入することができます。
+
+なおジョブキューは、選べる2タイプ。
+
+- Amazon SQS （要 aws-sdk gem）
+- Resque (要 resque gem & Redis)
+
+== 環境
+
+- Ruby 1.9.3
+- Ruby on Rails 3.2.8
+
+これより古い環境は今のところ試してないのでわかりません。
+
+
+== インストール
+
+Gemfile
+
+    gem 'queued_mail', git: 'git://github.com/uzuki05/queued_mail.git'
+
+    bundle install
+
+マイグレーション。
+
+    rake queued_mail:install:migrations
+    rake db:migrate
+
+設定変更。mail_queue_outbound_delivery_method には :test 含め、delivery_methodに指定可能なものならなんでも大丈夫、のはず。
+
+    # in config/environments/production.rb (or other environment)
+
+    config.action_mailer.delivery_method = :queued
+    config.mail_queue_service = :resque # or :amazon_sqs
+    config.mail_queue_name = :mail_queue
+    config.mail_queue_outbound_delivery_method = :smtp # default: :sendmail
+    config.action_mailer.smtp_settings = {
+      address: "smtp.sendgrid.net",
+      port: 25,
+      domain: "site.com",
+      user_name: "sendgrid@site.com",
+      password: "smtp-password"
+    }
+
+ワーカー起動
+
+    PIDFILE=/tmp/queued_mail.pid rake environment queued_mail:work
+
+もちろんPIDFILEは省略できます。
+
+またはResqueであれば以下のようにもできます。
+
+    QUEUE=mail_queue rake environment resque:work
+
+実運用では適当にdaemon化すればよいと思います。
+
+
+== キューの設定
+
+高速性優先のResqueと手軽さ優先のSQSが選択できます。
+
+=== Resqueを使う（デフォルト）
+
+(1) Redisサーバーを準備する
+
+(2) Railsでresqueを使用する設定を行う
+
+(3) config/application.rb等でキューとしてResqueを使うことを設定する（省略可能）
+      config.mail_queue_service = :resque
+
+
+=== Amazon SQSを使う
+
+(1) AWS ManagementConsoleなどでキューを作成
+
+(2) Railsでaws-sdkを使用する設定を行う（config/aws.yml など。必要に応じてsqs_endpoint も設定する。）
+
+(3) config/application.rb等でキューとしてAmazonSQSを使うことを設定する
+      config.mail_queue_service = :amazon_sqs
+      config.mail_queue_name = '1で作成したキューの名前'
+
+
+== TODO
+
+- Workerとかめんどくさい人用 cronで叩けるコントローラ
+
+- テスト
+
+
+== 元ネタ
+
+こういうのを作りたいなと思ったらもうあったので参考にさせて戴きました。
+
+Customizing ActionMailer delivery methods
+https://gist.github.com/1176236
+
+
+== 注意
+
+- 仕様変更があっても泣かない。
+
+- バグっても泣かない。
+
+- 何が起きても責任はとれません。

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QueuedMail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/queued_mail/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/queued_mail/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/queued_mail/application_controller.rb

@@ -0,0 +1,4 @@
+module QueuedMail
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/queued_mail/application_helper.rb

@@ -0,0 +1,4 @@
+module QueuedMail
+  module ApplicationHelper
+  end
+end

data/app/models/queued_mail/message.rb

@@ -0,0 +1,18 @@
+require 'mail/elements/address'
+
+module QueuedMail
+  class Message < ActiveRecord::Base
+    attr_accessible :body, :recipient_address, :recipient_name, :reply_to_address, :reply_to_name, :sender_address, :sender_name, :subject, :content_type, :mime_version, :content_transfer_encoding
+
+    %w(sender recipient reply_to).each do |key|
+      class_eval %Q{
+        def formatted_#{key}
+          address = Mail::Address.new
+          address.address = #{key}_address
+          address.display_name = #{key}_name
+          address.to_s
+        end
+      }
+    end
+  end
+end

data/app/views/layouts/queued_mail/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>QueuedMail</title>
+  <%= stylesheet_link_tag    "queued_mail/application", :media => "all" %>
+  <%= javascript_include_tag "queued_mail/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+QueuedMail::Engine.routes.draw do
+end

data/db/migrate/20120906053621_create_queued_mail_messages.rb

@@ -0,0 +1,19 @@
+class CreateQueuedMailMessages < ActiveRecord::Migration
+  def change
+    create_table :queued_mail_messages do |t|
+      t.string :subject
+      t.binary :body
+      t.string :recipient_address
+      t.string :recipient_name
+      t.string :sender_address
+      t.string :sender_name
+      t.string :reply_to_address
+      t.string :reply_to_name
+      t.string :content_type
+      t.string :mime_version
+      t.string :content_transfer_encoding
+
+      t.timestamps
+    end
+  end
+end

data/lib/queued_mail/delivery_method.rb

@@ -0,0 +1,29 @@
+module QueuedMail
+  class DeliveryMethod
+    def initialize(options)
+      @options = options
+    end
+
+    def deliver!(mail)
+      message = QueuedMail::Message.new(:subject           => mail.subject,
+                                        :body              => mail.body.encoded(mail.content_transfer_encoding),
+                                        :recipient_address => mail.to.first,
+                                        :recipient_name    => mail[:to].display_names.first,
+                                        :sender_address    => mail.from.first,
+                                        :sender_name       => mail[:from].display_names.first,
+                                        :reply_to_address  => mail.reply_to ? mail.reply_to.first : nil,
+                                        :reply_to_name     => mail.reply_to ? mail[:reply_to].display_names.first : nil,
+                                        :content_type      => mail.content_type,
+                                        :mime_version      => mail.mime_version,
+                                        :content_transfer_encoding => mail.content_transfer_encoding)
+      message.save
+      enqueue(message.id)
+    end
+
+    private
+    def enqueue(message_id)
+      service = instance_eval("QueuedMail::Queue::#{ Rails.application.config.mail_queue_service.to_s.camelcase }")
+      service.enqueue(message_id)
+    end
+  end
+end

data/lib/queued_mail/engine.rb

@@ -0,0 +1,14 @@
+require 'queued_mail/delivery_method'
+module QueuedMail
+  class Engine < ::Rails::Engine
+    engine_name "queued_mail"
+    isolate_namespace QueuedMail
+
+    ActionMailer::Base.add_delivery_method :queued, QueuedMail::DeliveryMethod
+
+    # default configurations
+    config.mail_queue_service = :resque
+    config.mail_queue_name = :mail_queue
+    config.mail_queue_outbound_delivery_method = :sendmail
+  end
+end

data/lib/queued_mail/job.rb

@@ -0,0 +1,15 @@
+module QueuedMail
+  class Job
+    @queue = Rails.application.config.mail_queue_name.to_sym
+    
+    def self.perform(args)
+      message = QueuedMail::Message.find(args["message_id"].to_i)
+      
+      message.lock!
+      QueuedMail::Mailer.original_email(message).deliver
+      message.destroy
+    rescue ActiveRecord::RecordNotFound => e
+      # nothing raises
+    end
+  end
+end

data/lib/queued_mail/mailer.rb

@@ -0,0 +1,18 @@
+module QueuedMail
+  class Mailer < ActionMailer::Base
+    self.delivery_method = Rails.application.config.mail_queue_outbound_delivery_method
+    layout nil
+
+    def original_email(message)
+      mail = mail(:from => message.formatted_sender,
+                  :to => message.formatted_recipient,
+                  :reply_to => message.formatted_reply_to,
+                  :subject => message.subject,
+                  :content_type => message.content_type,
+                  :mime_version => message.mime_version,
+                  :content_transfer_encoding => message.content_transfer_encoding)
+      
+      mail.body = message.body
+    end
+  end
+end

data/lib/queued_mail/queue/amazon_sqs.rb

@@ -0,0 +1,54 @@
+module QueuedMail
+  module Queue
+    module AmazonSqs
+      module ModuleMethods
+        def enqueue(message_id)
+          begin
+            sent_message = queue.send_message(JSON.dump('message_id' => message_id))
+            Rails.logger.info "send message_id:#{sent_message.message_id} md5:#{sent_message.md5} (id:#{message_id})"
+          rescue => e
+            Rails.logger.error e
+          end
+        end
+        
+        def dequeue
+          raise "TODO"
+        end
+        
+        def task
+          if ENV['PIDFILE']
+            File.open(ENV['PIDFILE'], 'w'){ |f| f << Process.pid }
+          end
+
+          begin
+            queue.poll(poll_interval: 5, batch_size: 1) do |received_message|
+              begin
+                Rails.logger.info "receive message_id:#{received_message.id} md5:#{received_message.md5}"
+                args = JSON.parse(received_message.body)
+                QueuedMail::Job.perform(args)
+              rescue => e
+                received_message.visibility_timeout = 60
+                raise e
+              end
+            end
+          rescue SignalException
+            # C-c
+          rescue Exception => e
+            Rails.logger.error e
+            retry
+          end
+        end
+
+        private
+        def sqs
+          @sqs ||= AWS::SQS.new
+        end
+        
+        def queue
+          sqs.queues.named(Rails.application.config.mail_queue_name.to_s)
+        end
+      end
+      extend ModuleMethods
+    end
+  end
+end

data/lib/queued_mail/queue/resque.rb

@@ -0,0 +1,22 @@
+module QueuedMail
+  module Queue
+    module Resque
+      module ModuleMethods
+        def enqueue(message_id)
+          ::Resque.enqueue(QueuedMail::Job, message_id: message_id)
+        end
+        
+        def dequeue
+          raise "TODO"
+        end
+        
+        def task
+          require 'resque/tasks'
+          ENV['QUEUES'] = Rails.application.config.mail_queue_name.to_s
+          Rake::Task['resque:work'].invoke
+        end
+      end
+      extend ModuleMethods
+    end
+  end
+end