mail_engine 0.0.1

data/lib/mail_engine/action_mailer_patch.rb

@@ -0,0 +1,104 @@
+### override mail method
+module ActionMailer
+  class Base
+    alias_method :origin_mail, :mail
+    def mail(headers={}, &block)
+      headers[:message_id] = "#{controller_path}/#{action_name}"
+      # Add sendgrid header before sending mail.
+      # Why here but not add to default_params of action_mailer? because the receiver email [:to] only can get here.
+      if self.sendgrid_config
+        self.sendgrid_config.add_to headers[:to]
+        origin_mail(headers.merge(self.sendgrid_config.to_hash), &block)
+      else
+        origin_mail(headers, &block)
+      end
+    end
+
+  protected
+
+    ###
+    # REASON TO OVERRIDE THIS METHOD:
+    # need to set layout and pass partial path to each format of mail template.
+    #
+    # Completed copied from lib/action_mailer/base.rb#665
+    # but used revisioned ActionMailer::Collector
+    def collect_responses_and_parts_order(headers) #:nodoc:
+      responses, parts_order = [], nil
+
+      if block_given?
+        ### modified this like, it's very strange when use resolver.is_a?(MailEngine::MailTemplate::Resolver) it will give false sometime.
+        if lookup_context.view_paths.detect {|resolver| resolver.class.to_s == "MailEngine::MailTemplate::Resolver" }
+          collector = ActionMailer::Collector.new(lookup_context) { |mime| set_layout_and_partials(mime) }
+        else
+          collector = ActionMailer::Collector.new(lookup_context) { render(action_name) }
+        end
+        ######################################################################################
+
+        yield(collector)
+        responses  = collector.responses
+      elsif headers[:body]
+        responses << {
+          :body => headers.delete(:body),
+          :content_type => self.class.default[:content_type] || "text/plain"
+        }
+      else
+        templates_path = headers.delete(:template_path) || self.class.mailer_name
+        templates_name = headers.delete(:template_name) || action_name
+
+        each_template(templates_path, templates_name) do |template|
+          self.formats = template.formats
+
+          responses << {
+            :body => render(:template => template),
+            :content_type => template.mime_type.to_s
+          }
+        end
+      end
+
+      [responses, parts_order]
+    end
+
+
+    # set layout and partials
+    def set_layout_and_partials(format)
+      template = MailEngine::MailTemplate.where(:path => "#{controller_path}/#{action_name}", :format => format, :locale => I18n.locale, :partial => false, :for_marketing => false).first
+      template = MailEngine::MailTemplate.where(:path => action_name, :format => format, :locale => I18n.locale, :partial => false, :for_marketing => true).first if template.blank?
+
+      # if found db template set the layout and partial for it.
+      if template
+        related_partial_paths = {}
+        # set @footer or @header
+        template.template_partials.each do |tmp|
+          related_partial_paths["#{tmp.placeholder_name}_path".to_sym] = tmp.partial.path
+        end
+
+        # set layout
+        render :template => "#{controller_path}/#{action_name}", :layout => "layouts/mail_engine/mail_template_layouts/#{template.layout}", :locals => related_partial_paths
+      else
+        # if not found db template should render file template
+        render(action_name)
+     end
+    end
+  end
+end
+
+###
+# REASON TO OVERRIDE THIS METHOD:
+# pass mime format to renderrer
+#
+# One concern if user provided block, there will be problem. like:
+# format.text { xxxx; render 'xxx' }
+#
+module ActionMailer
+  class Collector
+    def custom(mime, options={})
+      options.reverse_merge!(:content_type => mime.to_s)
+      @context.freeze_formats([mime.to_sym])
+      ### modified this line
+      # change from:
+      # options[:body] = block_given? ? yield : @default_render.call
+      options[:body] = block_given? ? yield : @default_render.call(mime.to_sym)
+      @responses << options
+    end
+  end
+end

data/lib/mail_engine/acts_as_mail_receiver.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+
+module MailEngine
+  module ActsAsMailReceiver
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :payload_columns
+      cattr_accessor :groups
+    end
+
+    module ClassMethods
+      def acts_as_mail_receiver(options)
+        self.payload_columns = options[:payload_columns]
+        self.groups = options[:groups]
+      end
+    end
+
+    # module InstanceMethods
+    # end
+  end
+end

data/lib/mail_engine/base.rb

@@ -0,0 +1,26 @@
+module MailEngine
+  class Base
+    cattr_accessor :configurations, :instance_writer => false
+    @@configurations = HashWithIndifferentAccess.new
+
+    class << self
+      def current_config
+        MailEngine::Base.configurations[Rails.env]
+      end
+
+      ### send mail template with given data.
+      # MailEngine::Base.send_mail("gogogo", :to => 'm@theplant.jp', :values => {:users => User.last})
+      def send_mail(template, *args)
+        options = args.extract_options!
+        raise "Should specify :to option" if options[:to].blank?
+
+        # find if the template was stored in database.
+        template_path = File.join("mail_engine", "mail_dispatcher", template)
+        raise "Can't find the template: #{template_path}" unless mail_template = MailEngine::MailTemplate.where(:path => template_path).first
+
+        options[:subject] = mail_template.name
+        MailEngine::MailDispatcher.send(template, options).deliver
+      end
+    end
+  end
+end

data/lib/mail_engine/configuration.rb

@@ -0,0 +1,11 @@
+module MailEngine
+  class Configuration
+    class << self
+      def load
+        require 'erb'
+        config_path = File.join(Rails.root, "config", "mail_engine_config.yml")
+        MailEngine::Base.configurations = YAML::load(ERB.new(IO.read(config_path)).result)
+      end
+    end
+  end
+end

data/lib/mail_engine/engine.rb

@@ -0,0 +1,42 @@
+module MailEngine
+  class Engine < Rails::Engine
+    require 'mail_engine'
+
+    initializer "mail_engine" do
+      ActionMailer::Base.send(:include, MailEngine::Sendgrid::Base)
+      require 'mail_engine/action_mailer_patch'
+    end
+
+    initializer "mail_engine.register_liquid_template" do
+      require 'liquid'
+      require 'extras/liquid_view'
+      ActionView::Template.register_template_handler(:liquid, LiquidView)
+    end
+
+    initializer "mail_engine.register_database_template" do
+      ActionMailer::Base.layout "layouts/mail_engine/mail_template_layouts/none"
+      ActionMailer::Base.send(:prepend_view_path, MailEngine::MailTemplate::Resolver.instance)
+    end
+
+    initializer "mail_engine.add_acts_as_mail_receiver" do
+      ActiveRecord::Base.send(:include, MailEngine::ActsAsMailReceiver)
+    end
+
+    # initializer "mail_engine.register_mail_log" do
+    #   ActionMailer::Base.register_interceptor MailEngine::MailLog
+    # end
+
+    rake_tasks do
+      load "mail_engine/tasks/sendmail.rake"
+    end
+
+    generators do
+      require 'mail_engine/generators/create_config.rb'
+      require 'mail_engine/generators/create_migration.rb'
+    end
+
+    config.to_prepare do
+      MailEngine::Configuration.load
+    end
+  end
+end

data/lib/mail_engine/generators/create_config.rb

@@ -0,0 +1,20 @@
+module MailEngine
+  class CreateConfig < Rails::Generators::Base
+    desc "Add mail template config file."
+    source_root File.expand_path("../templates", __FILE__)
+
+    # def generate_config
+    #   case backend_type
+    #   when "amazon"
+    #   when "sendgrid"
+    #   when "sendmail"
+    #   when "smtp"
+    #   else
+    #   end
+    # end
+
+    def create_config_file
+      template "mail_engine_config.yml", "config/mail_engine_config.yml"
+    end
+  end
+end # MailEngine

data/lib/mail_engine/generators/create_migration.rb

@@ -0,0 +1,20 @@
+module MailEngine
+  class CreateMigration < Rails::Generators::Base
+    desc "Add mail template model migration to your application."
+    source_root File.join(File.dirname(__FILE__))
+
+    def create_migrations
+      [
+        "20110114030841_create_table_mail_template",
+        "20110126030525_create_mail_schedules",
+        "20110204114145_create_template_partials",
+        "20110206025002_create_mail_logs",
+        "20110217062316_create_mail_template_files"
+      ].each do |filename|
+        from = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "db", "migrate", "#{filename}.rb"))
+        to = File.expand_path(File.join(Rails.root, "db", "migrate", "#{filename}.rb"))
+        copy_file from, to
+      end
+    end
+  end # CreateMigration
+end

data/lib/mail_engine/generators/templates/mail_engine_config.yml

@@ -0,0 +1,14 @@
+development:
+  log_mail: false
+  sendgrid_user: "you send grid username"
+  sendgrid_key: "password"
+
+test:
+  log_mail: false
+  sendgrid_user: "you send grid username"
+  sendgrid_key: "password"
+
+production:
+  log_mail: false
+  sendgrid_user: "you send grid username"
+  sendgrid_key: "password"

data/lib/mail_engine/html_document_assets_replacer.rb

@@ -0,0 +1,86 @@
+module MailEngine
+  class HtmlDocumentAssetsReplacer
+
+    class << self
+      def check! file_paths
+        html_file_pathes = file_paths.select { |path| path =~ /\/[^_\/]+\.htm(l)?$/i }
+        raise "No html was passed in." if html_file_pathes.blank?
+        raise "Please only include one html file in the zip file." if html_file_pathes.size > 1
+        html_file_pathes.first
+      end
+
+      # MailEngine::HtmlDocumentAssetsReplacer.process(mail_template, file_paths)
+      def process mail_template, file_paths, hostname
+        raise "Host should not include http://" if hostname =~ /^http:\/\//i
+
+        # check if there is a html file
+        html_file_path = check! file_paths
+
+        # persist files into databases.
+        other_file_paths = file_paths - Array.wrap(html_file_path)
+        stored_file_objects = other_file_paths.map do |path|
+          f = File.open(path)
+          mail_template.mail_template_files.create :file => f, :size => File.size(f)
+        end
+
+        ### replace images and csses from the html document.
+        # possible will use this in the future to take care of encoding problem:
+        # doc = Nokogiri.XML('<foo><bar/><foo>', nil, 'EUC-JP')
+        doc = Nokogiri::HTML(File.read(html_file_path))
+
+        doc.css('img, link').each do |element|
+          # FIXME seems will have the problem if have duplicated filename in different dir
+          case
+          when element.name == "link" && substitution_object = stored_file_objects.detect { |file_object| file_object.attributes["file"] == File.basename(element['href']) }
+            element['href'] = "http://#{File.join(hostname, substitution_object.file.url)}"
+          when element.name == "img" && substitution_object = stored_file_objects.detect { |file_object| file_object.attributes["file"] == File.basename(element['src']) }
+            element['src'] = "http://#{File.join(hostname, substitution_object.file.url)}"
+          end
+        end
+
+        doc.to_html
+      end
+
+      def replace_resource_filename_in_html html, original_filename, new_filename
+        return false if original_filename.blank? or new_filename.blank?
+
+        doc = Nokogiri::HTML(html)
+
+        doc.css('img, link').each do |element|
+          # FIXME seems will have the problem if have duplicated filename in different dir
+          next if element.name == "link" && element['href'].blank?
+          next if element.name == "img" && element['src'].blank?
+
+          case
+          when element.name == "link" && File.basename(element['href']) == original_filename
+            element['href'] = element['href'].sub(original_filename, new_filename)
+          when element.name == "img" && File.basename(element['src']) == original_filename
+            element['src'] = element['src'].sub(original_filename, new_filename)
+          end
+        end
+
+        doc.to_html
+      end
+
+      def replace_resource_url_in_html html, original_file_url, new_file_url
+        return false if original_file_url.blank? or new_file_url.blank?
+        doc = Nokogiri::HTML(html)
+
+        doc.css('img, link').each do |element|
+          # FIXME seems will have the problem if have duplicated filename in different dir
+          next if element.name == "link" && element['href'].blank?
+          next if element.name == "img" && element['src'].blank?
+
+          case
+          when element.name == "link" && element['href'].include?(original_file_url)
+            element['href'] = element['href'].sub(original_file_url, new_file_url)
+          when element.name == "img" && element['src'].include?(original_file_url)
+            element['src'] = element['src'].sub(original_file_url, new_file_url)
+          end
+        end
+
+        doc.to_html
+      end
+    end
+  end
+end

data/lib/mail_engine/mail_log_subscriber.rb

@@ -0,0 +1,30 @@
+# {
+#   :mailer=>"UserMailer",
+#   :subject=>"Notify",
+#   :date=>nil,
+#   :message_id=>nil,
+#   :mail=>
+#   "Date: Sun, 06 Feb 2011 11:11:54 +0800\r\nFrom: info@itjob.fm\r\nTo: m@theplant.jp\r\nMessage-ID: <4d4e117a766f9_13db981b0456013966@localhost.mail>\r\nSubject: Notify\r\nMime-Version: 1.0\r\nContent-Type: text/plain;\r\n charset=UTF-8\r\nContent-Transfer-Encoding: 7bit\r\nX-SMTPAPI: {\"category\": \"itjob\", \"to\": [\"m@theplant.jp\"], \"filters\":\r\n {\"opentrack\": {\"settings\": {\"enable\":1}}, \"clicktrack\": {\"settings\":\r\n {\"enable\":1}}, \"template\": {\"settings\": {\"enable\":0}}, \"footer\": {\"settings\":\r\n {\"enable\":0}}, \"subscriptiontrack\": {\"settings\": {\"text/html\": \"Unsubscribe\r\n link.html\", \"landing\": \"http://landing.com\", \"url\": \"http://url.com\",\r\n \"enable\":1,\"text/plain\": \"Unsubscribe link.txt\"}}}}\r\n\r\n",
+#   :to=>["m@theplant.jp"],
+#   :from=>["info@itjob.fm"]
+# }
+
+module MailEngine
+  class MailLogSubscriber < ActiveSupport::LogSubscriber
+    def deliver(event)
+      log_mail_config = MailEngine::Base.current_config["log_mail"]
+      return false if log_mail_config.blank? or !log_mail_config
+
+      MailEngine::MailLog.create!({
+        :mail_template_path => event.payload[:message_id],
+        :subject => event.payload[:subject],
+        :raw_body => event.payload[:mail],
+        :recipient => event.payload[:to].inspect,
+        :sender => event.payload[:from].inspect,
+        :mime_type => event.payload[:mail].scan(/Content-Type: ([^;\r\n]*)/).flatten.inspect
+      })
+    end
+  end
+end
+
+MailEngine::MailLogSubscriber.attach_to :action_mailer

data/lib/mail_engine/placeholders_in_layout.rb

@@ -0,0 +1,5 @@
+PLACEHOLDERS_IN_LAYOUT = {
+  :none => [],
+  :only_footer => ['footer'],
+  :header_and_footer => ['header', 'footer']
+}

data/lib/mail_engine/sendgrid/base.rb

@@ -0,0 +1,45 @@
+# ### Usage
+# class UserMailer < SendgridMailer
+#   sendgrid_header do
+#     category "itjob"
+#
+#     filters {
+#       opentrack "enable" => 1
+#       clicktrack "enable" => 1
+#       gravatar "enable" => 1
+#       template "enable" => 1, "text/html" => "<p>Thanks for your subscription.</p>"
+#       footer "enable" => 1, "text/plain" => "Thanks for your subscription.", "text/html" => "<p>Thanks for your subscription.</p>"
+#     }
+#   end
+#
+#   def notification(user)
+#     mail :to => "x@x.com" do |format|
+#       format.text
+#       format.html_from_db
+#     end
+#   end
+# end
+
+require 'active_support/concern'
+
+module MailEngine
+  module Sendgrid
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        cattr_accessor :sendgrid_config
+      end
+
+      module ClassMethods
+        def sendgrid_header(&block)
+          self.sendgrid_config = SmtpApi.new
+          self.sendgrid_config.instance_eval(&block)
+        end
+      end
+
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/mail_engine/sendgrid/rest_api.rb

@@ -0,0 +1,85 @@
+require 'httparty'
+
+### Usage
+# MailEngine::Sendgrid::RestApi.stats
+module MailEngine
+  module Sendgrid
+    class RestApiError < StandardError; end
+
+    class RestApi
+      include HTTParty
+      base_uri "https://sendgrid.com/api"
+      default_params :api_key => MailEngine::Base.current_config["sendgrid_key"], :api_user => MailEngine::Base.current_config["sendgrid_user"]
+
+      class << self
+        # <stats>
+        #   <day>
+        #     <date>2009-06-20</date>
+        #     <requests>12342</requests>
+        #     <bounces>12</bounces>
+        #     <clicks>10223</clicks>
+        #     <opens>9992</opens>
+        #     <spamreports>5</spamreports>
+        #     <unique_clicks>3</unique_clicks>
+        #     <unique_opens>6</unique_opens>
+        #     <blocked>7</blocked>
+        #   </day>
+        # </stats>
+        def stats options = {}
+          response = get "/stats.get.xml", :query => options
+          response["stats"].try(:send, :[], "day")
+        end
+
+        # <bounces>
+        #   <bounce>
+        #     <email>email1@domain.com</email>
+        #     <status>5.1.1</status>
+        #     <reason>host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com</reason>
+        #     <created>2009-06-10 12:40:30</created>
+        #   </bounce>
+        # </bounces>
+        def bounces options = {}
+          response = get "/bounces.get.xml", :query => options
+          response["bounces"].try(:send, :[], "bounce")
+        end
+
+        # <spamreports>
+        #   <spamreport>
+        #     <email>email1@domain.com</email>
+        #     <created>2009-06-10 12:40:30</created>
+        #   </spamreport>
+        # </spamreports>
+        def spamreports options = {}
+          response = get "/spamreports.get.xml", :query => options
+          response["spamreports"].try(:send, :[], "spamreport")
+        end
+
+        # <invalidemails>
+        #   <invalidemail>
+        #     <email>isaac@hotmail.comm</email>
+        #     <reason>Mail domain mentioned in email address is unknown</reason>
+        #     <created>2009-06-10 12:40:30</created>
+        #   </invalidemail>
+        # </invalidemails>
+        def invalidemails options = {}
+          response = get "/invalidemails.get.xml", :query => options
+          response["invalidemails"].try(:send, :[], "invalidemail")
+        end
+
+        # <blocks>
+        #   <block>
+        #     <email>exp_block_0466@sendgrid.com</email>
+        #     <status></status>
+        #     <reason>Some random block reason</reason>
+        #     <created>2010-11-08 20:39:29</created>
+        #   </block>
+        # </blocks>
+        def blocks options = {}
+          response = get "/blocks.get.xml", :query => options
+          response["blocks"].try(:send, :[], "block")
+        end
+
+      end
+    end # end of rest api class
+  end # end of sendgrid module
+end # end of mail engine module

data/lib/mail_engine/sendgrid/smtp_api.rb

@@ -0,0 +1,85 @@
+require 'json'
+
+module MailEngine
+  module Sendgrid
+    class FilterSetting
+      attr_accessor :data
+
+      def initialize
+        @data = {}
+      end
+
+      ### Please check API: http://sendgrid.com/documentation/apps
+      #
+      # sendgrid_header do
+      #   category "itjob"
+      #
+      #   filters {
+      #     opentrack "enable" => 1
+      #     clicktrack "enable" => 1
+      #     subscriptiontrack "enable" => 1, "text/html" => "Unsubscribe link.html", "text/plain" => "Unsubscribe link.txt", "url" => "http://url.com", "landing" => "http://landing.com"
+      #     template "enable" => 1, "text/html" => "<p>Thanks for your subscription.</p>"
+      #     footer "enable" => 1, "text/plain" => "Thanks for your subscription.", "text/html" => "<p>Thanks for your subscription.</p>"
+      #   }
+      # end
+      #
+      %w(opentrack clicktrack subscriptiontrack footer spamcheck ganalytics template bcc list domainkeys).each do |method_name|
+        define_method method_name do |config_hash|
+          validate_config! method_name, config_hash
+          @data[method_name] ||= {}
+          @data[method_name]["settings"] = config_hash
+        end
+      end
+
+      private
+
+      def validate_config!(name, config_hash)
+        raise "'#{name}' Config should be a hash value." unless config_hash.is_a?(Hash)
+      end
+    end
+
+    ### smtp api class
+    class SmtpApi
+      def initialize()
+        @data = {}
+      end
+
+      def category(cat)
+        @data['category'] = cat
+      end
+
+      def filters(&block)
+        filter_setting = FilterSetting.new
+        filter_setting.instance_eval(&block)
+        @data["filters"] = filter_setting.data
+      end
+
+      def add_to(to)
+        @data['to'] ||= []
+        @data['to'] += to.kind_of?(Array) ? to : [to]
+        @data['to'].uniq!
+      end
+
+      def add_sub_val(var, val)
+        @data['sub'] ||= {}
+        @data['sub'][var] = val.instance_of?(Array) ? var : [var]
+      end
+      
+      def set_unique_args(val)
+        @data['unique_args'] = val if val.instance_of?(Hash)
+      end
+
+      def to_json
+        @data.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
+      end
+
+      def to_hash
+        {'X-SMTPAPI' => self.to_json}
+      end
+
+      def to_s
+        'X-SMTPAPI: %s' % self.to_json
+      end
+    end
+  end
+end

data/lib/mail_engine/sendgrid.rb

@@ -0,0 +1,9 @@
+module MailEngine
+  module Sendgrid
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :SmtpApi
+    autoload :RestApi
+  end
+end

data/lib/mail_engine/tasks/sendmail.rake

@@ -0,0 +1,8 @@
+namespace :mail_engine do
+  desc "Check mail schedule table and send the scheduled mail."
+  task :sendmail => :environment do
+    puts "==== Start sending scheduled mail ===="
+    MailEngine::MailSchedule.all.each { |schedule| schedule.sendmail }
+    puts "==== End sending scheduled mail ===="
+  end
+end

data/lib/mail_engine/version.rb

@@ -0,0 +1,3 @@
+module MailEngine
+  VERSION = "0.0.1"
+end