mail_engine 0.1.12 → 0.1.13

data/README.mkd

@@ -81,9 +81,9 @@ Add sendgrid smtp api configure:
         }
       end
     end
-  
+
 For the detail information please check sendgrid.com.
-  
+
 ** Step 6: **
 
 Add below line to production.rb or development.rb for specifing the host.
@@ -109,11 +109,11 @@ Below is the config for development env.
       user_locale_column: "locale"                    # Specify the locale column of user table, this will help sending correct language of mail to user.
       mount_at: "/admin/mail_engine"                  # set the url path for mail engine.
       access_check_method: "logged_in?"               # set a method name which will execute before each page action in mail engine.
-      replacement_email: "dev@youdomain.com"          # if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.
+      intercept_email: "dev@youdomain.com"          # if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.
       sendgrid:                                       # Below you need to set the sendgrid account info.
-        sendgrid_user: "you send grid username"       # 
-        sendgrid_key: "password"                      # 
-        sendgrid_category: "my sendgrid category"     # 
+        sendgrid_user: "you send grid username"       #
+        sendgrid_key: "password"                      #
+        sendgrid_category: "my sendgrid category"     #
 
 
 Usage
@@ -152,10 +152,19 @@ Currently only support above rails3.
 
 Tips
 ====
-Use below rake task, you can export local mail engine data, then import to production environment.
+1. Use below rake task, you can export local mail engine data, then import to production environment.
 
     rake mail_engine:export_mail_engine_database
 
+2. You can setup postfix or sendmail MTA on the server then use it to queue the mail locally.
+
+    http://support.sendgrid.com/entries/142079-getting-started-configuring-postfix
+
+then you can set delivery_method as:
+
+    config.action_mailer.delivery_method = :sendmail
+    
+
 Sendgrid Whitelabel Wizard
 ==========================
 

data/VERSION

@@ -1 +1 @@
-0.1.12
+0.1.13

data/app/mailers/mail_engine/mail_dispatcher.rb

@@ -1,7 +1,7 @@
 class MailEngine::MailDispatcher < ActionMailer::Base
   default :from => MailEngine::Base.current_config["default_from"]
   sendgrid_header do
-    category MailEngine::Base.current_config["sendgrid"]["category_name"]
+    category MailEngine::Base.current_config["sendgrid"]["sendgrid_category"]
     filters {
       opentrack "enable" => 1
       clicktrack "enable" => 1

data/app/models/mail_engine/mail_schedule.rb

@@ -146,7 +146,11 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     MailEngine::USER_MODEL.send(self.user_group.to_sym).each do |user|
       puts "-> sending mail to #{user.email}" if Rails.env != 'test'
       ### FIXME user.email, what if user don't have email column.
-      user_locale = user.send(MailEngine::Base.current_config["user_locale_column"])
+      user_locale = begin
+                      user.send(MailEngine::Base.current_config["user_locale_column"])
+                    rescue
+                      I18n.default_locale
+                    end
 
       begin
         # when there is default_locale been set, should fallback to default_locale template, when can't find the locale user in user settings.

data/doc/ActionMailer/Base.html

@@ -205,7 +205,7 @@
   <span class='comment val'># Add sendgrid header before sending mail.</span>
   <span class='comment val'># Why here but not add to default_params of action_mailer? because the receiver email [:to] only can get here.</span>
   <span class='if if kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='sendgrid_config identifier id'>sendgrid_config</span>
-    <span class='comment val'># if add &quot;replacement_email&quot; option in config</span>
+    <span class='comment val'># if add &quot;intercept_email&quot; option in config</span>
     <span class='receiver identifier id'>receiver</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='defined? defined kw'>defined?</span><span class='lparen token'>(</span><span class='colon3 op'>::</span><span class='MailSafe constant id'>MailSafe</span><span class='colon2 op'>::</span><span class='Config constant id'>Config</span><span class='rparen token'>)</span> <span class='and and kw'>and</span> <span class='colon3 op'>::</span><span class='MailSafe constant id'>MailSafe</span><span class='colon2 op'>::</span><span class='Config constant id'>Config</span><span class='dot token'>.</span><span class='replacement_address identifier id'>replacement_address</span>
                  <span class='colon3 op'>::</span><span class='MailSafe constant id'>MailSafe</span><span class='colon2 op'>::</span><span class='Config constant id'>Config</span><span class='dot token'>.</span><span class='get_replacement_address identifier id'>get_replacement_address</span><span class='lparen token'>(</span><span class='headers identifier id'>headers</span><span class='lbrack token'>[</span><span class='symbol val'>:to</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
                <span class='else else kw'>else</span>

data/doc/file.README.html

@@ -157,7 +157,7 @@ it will used when generate resource url when upload zip file.</p>
   <span class='user_class_name identifier id'>user_class_name</span><span class='colon op'>:</span> <span class='string val'>&quot;User&quot;</span>                         <span class='comment val'># Specify the User model in your system, which will used for mail schedule feature to find user groups and payloads.</span>
   <span class='mount_at identifier id'>mount_at</span><span class='colon op'>:</span> <span class='string val'>&quot;/admin/mail_engine&quot;</span>                  <span class='comment val'># set the url path for mail engine.</span>
   <span class='access_check_method identifier id'>access_check_method</span><span class='colon op'>:</span> <span class='string val'>&quot;logged_in?&quot;</span>               <span class='comment val'># set a method name which will execute before each page action in mail engine.</span>
-  <span class='replacement_email identifier id'>replacement_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
+  <span class='intercept_email identifier id'>intercept_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
   <span class='sendgrid identifier id'>sendgrid</span><span class='colon op'>:</span>                                       <span class='comment val'># Below you need to set the sendgrid account info.</span>
     <span class='sendgrid_user identifier id'>sendgrid_user</span><span class='colon op'>:</span> <span class='string val'>&quot;you send grid username&quot;</span>       <span class='comment val'># </span>
     <span class='sendgrid_key identifier id'>sendgrid_key</span><span class='colon op'>:</span> <span class='string val'>&quot;password&quot;</span>                      <span class='comment val'># </span>

data/doc/index.html

@@ -157,7 +157,7 @@ it will used when generate resource url when upload zip file.</p>
   <span class='user_class_name identifier id'>user_class_name</span><span class='colon op'>:</span> <span class='string val'>&quot;User&quot;</span>                         <span class='comment val'># Specify the User model in your system, which will used for mail schedule feature to find user groups and payloads.</span>
   <span class='mount_at identifier id'>mount_at</span><span class='colon op'>:</span> <span class='string val'>&quot;/admin/mail_engine&quot;</span>                  <span class='comment val'># set the url path for mail engine.</span>
   <span class='access_check_method identifier id'>access_check_method</span><span class='colon op'>:</span> <span class='string val'>&quot;logged_in?&quot;</span>               <span class='comment val'># set a method name which will execute before each page action in mail engine.</span>
-  <span class='replacement_email identifier id'>replacement_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
+  <span class='intercept_email identifier id'>intercept_email</span><span class='colon op'>:</span> <span class='string val'>&quot;dev@youdomain.com&quot;</span>          <span class='comment val'># if you want to send all mail to one email, like on staging server or development environment, you can set this, or else don't set it.</span>
   <span class='sendgrid identifier id'>sendgrid</span><span class='colon op'>:</span>                                       <span class='comment val'># Below you need to set the sendgrid account info.</span>
     <span class='sendgrid_user identifier id'>sendgrid_user</span><span class='colon op'>:</span> <span class='string val'>&quot;you send grid username&quot;</span>       <span class='comment val'># </span>
     <span class='sendgrid_key identifier id'>sendgrid_key</span><span class='colon op'>:</span> <span class='string val'>&quot;password&quot;</span>                      <span class='comment val'># </span>

data/lib/mail_engine/action_mailer_patch.rb

@@ -16,9 +16,9 @@ module ActionMailer
       # 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
-        # if add "replacement_email" option in config
-        receiver = if (replacement_email = MailEngine::Base.current_config["replacement_email"]).present?
-                     headers[:to] = replacement_email
+        # if add "intercept_email" option in config
+        receiver = if (intercept_email = MailEngine::Base.current_config["intercept_email"]).present?
+                     headers[:to] = intercept_email
                    else
                      headers[:to]
                    end

data/lib/mail_engine/configuration.rb

@@ -1,14 +1,65 @@
 module MailEngine
+  class ConfigurationError < StandardError; end
   # Load configure file from config/mail_engine_config.yml
   # you can access the config by MailEngine::Base.current_config[]
   class Configuration
     class << self
-      def load
+      def load_and_check
         require 'erb' # make config file support erb tags. like <% %>
         config_path = File.join(Rails.root, "config", "mail_engine_config.yml")
         MailEngine::Base.configurations = {}
         MailEngine::Base.configurations = YAML::load(ERB.new(IO.read(config_path)).result) if File.exist?(config_path)
+        config_check
       end
+
+      ### Need check below config options
+      #
+      # log_mail: true
+      # user_class_name: "User"
+      # user_locale_column: "locale"
+      # mount_at: "/admin/mail_engine"
+      # intercept_email: "hlxwell@gmail.com"
+      # default_from: "hlxwell@gmail.com"
+      # access_check_method: "logged_in?"
+      # sendgrid:
+      #   sendgrid_user: "a@theplant.jp"
+      #   sendgrid_key: "plant^o^"
+      #   sendgrid_category: "development"
+      #
+      def config_check
+        if MailEngine::Base.current_config.blank?
+          puts "\e[1;31;40m[Mail Engine Warning]\e[0m Not found mail_engine_config.yml, so mail_engine won't be able to work."
+          raise ConfigurationError.new("did't find config file at config/mail_engine_config.yml")
+        end
+
+        %w{log_mail user_class_name user_locale_column mount_at default_from access_check_method}.each do |option|
+          raise ConfigurationError.new("Please add :#{option} config into mail_engine_config.yml.") if MailEngine::Base.current_config[option].blank?
+        end
+
+        %w{sendgrid_category sendgrid_user sendgrid_key}.each do |option|
+          raise ConfigurationError.new("Please add :#{option} config under not :sendgrid into mail_engine_config.yml.") if MailEngine::Base.current_config["sendgrid"][option].blank?
+        end
+      rescue ConfigurationError => e
+        puts <<-NOTE
+\e[1;31;40m[Mail Engine Warning - Below is a sample config]\e[0m
+===============================================
+  log_mail: true
+  user_class_name: 'User'
+  user_locale_column: 'locale'
+  mount_at: '/admin/mail_engine'
+  intercept_email: 'hlxwell@gmail.com'
+  default_from: 'hlxwell@gmail.com'
+  access_check_method: 'logged_in?'
+  sendgrid:
+    sendgrid_user: 'a@theplant.jp'
+    sendgrid_key: 'plant^o^'
+    sendgrid_category: 'development'
+===============================================
+        NOTE
+
+        raise e
+      end
+
     end
   end
 end

data/lib/mail_engine/engine.rb

@@ -42,15 +42,9 @@ module MailEngine
 
     config.to_prepare do
       # load config
-      MailEngine::Configuration.load
-
-      # don't process config file if not fine it.
-      if MailEngine::Base.current_config.present?
-        raise "Please add :user_class_name config into mail_engine_config.yml." if MailEngine::Base.current_config["user_class_name"].blank?
-        MailEngine::USER_MODEL = MailEngine::Base.current_config["user_class_name"].constantize unless defined?(MailEngine::USER_MODEL)
-      else
-        puts "\e[1;31;40m[Mail Engine Warning]\e[0m Not found mail_engine_config.yml, so mail_engine won't be able to work."
-      end
+      MailEngine::Configuration.load_and_check
+
+      MailEngine::USER_MODEL = MailEngine::Base.current_config["user_class_name"].constantize unless defined?(MailEngine::USER_MODEL)
     end
   end
 end

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

@@ -5,9 +5,8 @@ development:
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
   default_from: "your@email.address"
-  replacement_email: "dev@youdomain.com"
+  intercept_email: "dev@youdomain.com"
   sendgrid:
-    category_name: "you category name"
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"
     sendgrid_category: "my sendgrid category"
@@ -18,10 +17,9 @@ test:
   user_locale_column: "locale"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
-  replacement_email: "dev@youdomain.com"
+  intercept_email: "dev@youdomain.com"
   default_from: "your@email.address"
   sendgrid:
-    category_name: "you category name"
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"
     sendgrid_category: "my sendgrid category"
@@ -34,7 +32,6 @@ production:
   access_check_method: "logged_in?"
   default_from: "your@email.address"
   sendgrid:
-    category_name: "you category name"
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"
     sendgrid_category: "my sendgrid category"

data/mail_engine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_engine}
-  s.version = "0.1.12"
+  s.version = "0.1.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael he"]
-  s.date = %q{2011-03-17}
+  s.date = %q{2011-03-18}
   s.description = %q{Rails system mail management solution.}
   s.email = %q{hlxwell@gmail.com}
   s.extra_rdoc_files = [

data/test/dummy/app/mailers/user_mailer.rb

@@ -1,7 +1,7 @@
 class UserMailer < ActionMailer::Base
   default :from => MailEngine::Base.current_config["default_from"]
   sendgrid_header do
-    category MailEngine::Base.current_config["sendgrid"]["category_name"]
+    category MailEngine::Base.current_config["sendgrid"]["sendgrid_category"]
 
     filters {
       opentrack "enable" => 1

data/test/dummy/db/migrate/20110126030525_create_mail_schedules.rb

@@ -10,7 +10,7 @@ class CreateMailSchedules < ActiveRecord::Migration
       t.string :payload
       t.datetime :first_send_at
       t.datetime :last_sent_at
-      t.boolean :available
+      t.boolean :available, :default => false
       t.string :default_locale
 
       t.timestamps

data/test/functional/user_mailer_test.rb

@@ -7,7 +7,7 @@ class UserMailerTest < ActionController::TestCase
     end
 
     should "send to safe mail address" do
-      MailEngine::Base.current_config["replacement_email"] = "xxx@xxx.com"
+      MailEngine::Base.current_config["intercept_email"] = "xxx@xxx.com"
       mail = UserMailer.notify("x@x.com").deliver
       assert_equal mail.to, ["xxx@xxx.com"]
       assert UserMailer.sendgrid_config.to_hash["X-SMTPAPI"].include?("[\"xxx@xxx.com\"]")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail_engine
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 1
-  - 12
-  version: 0.1.12
+  - 13
+  version: 0.1.13
 platform: ruby
 authors: 
 - michael he
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 +08:00
+date: 2011-03-18 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency