mail_engine 0.1.4 → 0.1.5

data/Gemfile

@@ -10,6 +10,7 @@ gem 'rack', :git => 'git://github.com/rack/rack.git'
 gem "liquid"
 gem 'kaminari', :git => 'https://github.com/amatsuda/kaminari.git'
 gem "carrierwave", :git => "git://github.com/jnicklas/carrierwave.git"
+gem "mail_safe"
 
 group :development do
   gem "annotate"

data/README.mkd

@@ -89,6 +89,22 @@ Add below line to the crontab list of your sever:
     ### check mail schedule for every 15 minutes ###
     */4 * * * * sh -c "cd /path/to/your/system && rake mail_engine:sendmail RAILS_ENV=production"
 
+Configuration
+=============
+
+Below is the config for development env.
+
+    development:
+      log_mail: false                                 # if you want to enable the mail log, set true.
+      user_class_name: "User"                         # Specify the User model in your system, which will used for mail schedule feature to find user groups and payloads.
+      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.
+      sendgrid:                                       # Below you need to set the sendgrid account info.
+        sendgrid_user: "you send grid username"       # 
+        sendgrid_key: "password"                      # 
+        sendgrid_category: "my sendgrid category"     # 
+
 
 Usage
 =====
@@ -189,7 +205,7 @@ You can set a mail sending schedule, here are some useful setting items:
 5. Sending Period.
 6. Payloads which load from user model and send to template when sending.
 7. First send date time, this date will indicate when this mail will be send first time, and according to the seding period it will resend at the same time after one period.
-8. You can set requirements, which been predefined in the system, let the mail not been sent if the requirements is unreached.
+8. You can control if run the schedule or not.
 
 ![Mail Schedule](https://github.com/hlxwell/mail-engine/raw/master/screenshots/schedule.png "Mail Schedule")
 

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/app/models/mail_engine/mail_log.rb

@@ -13,7 +13,7 @@
 #  updated_at         :datetime
 #
 
-class MailEngine::MailLog < ActiveRecord::Base  
+class MailEngine::MailLog < ActiveRecord::Base
   validates_presence_of :mail_template_path
 
   # # Callback of Mail gem when delivering mails
@@ -23,7 +23,7 @@ class MailEngine::MailLog < ActiveRecord::Base
   #   # pp email.from
   #   # pp email.subject
   #   # pp email.mime_type
-  # 
+  #
   #   ##################
   #   # pp mail.mime_type
   #   # pp mail.content_type
@@ -32,12 +32,12 @@ class MailEngine::MailLog < ActiveRecord::Base
   #   # pp mail.subject         #=> "This is the subject"
   #   # pp mail.body.decoded    #=> 'This is the body of the email...
   #   ###################
-  # 
+  #
   #   # pp mail.parts.map { |p| p.content_type }  #=> ['text/plain', 'application/pdf']
   #   # pp mail.parts.map { |p| p.class }         #=> [Mail::Message, Mail::Message]
   #   # pp mail.parts[0].content_type_parameters  #=> {'charset' => 'ISO-8859-1'}
   #   # pp mail.parts[1].content_type_parameters  #=> {'name' => 'my.pdf'}
-  # 
+  #
   #   # mail_type = email.header["X-mail-type"].value
   #   # record = create! :recipient => email.to.join(","), :mail_type => mail_type
   #   # email.encoded # kick email to set content_transfer_encoding

data/lib/mail_engine.rb

@@ -1,9 +1,6 @@
 require 'active_support'
 require "action_view/template"
 require 'mail_engine/engine'
-require 'mail_engine/mail_log_subscriber'
-require 'mail_engine/zip_processor'
-require 'mail_engine/html_document_assets_replacer'
 
 module MailEngine
   extend ::ActiveSupport::Autoload
@@ -21,5 +18,4 @@ module MailEngine
   autoload :ActsAsMailReceiver
   autoload :Configuration
   autoload :MailTemplateResolver
-end
-
+end

data/lib/mail_engine/action_mailer_patch.rb

@@ -27,7 +27,13 @@ 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
-        self.sendgrid_config.set_send_to headers[:to]
+        # if add "replacement_email" option in config
+        receiver = if MailSafe::Config.replacement_address
+                     MailSafe::Config.get_replacement_address(headers[:to])
+                   else
+                     headers[:to]
+                   end
+        self.sendgrid_config.set_send_to receiver
         origin_mail(headers.merge(self.sendgrid_config.to_hash), &block)
       else
         origin_mail(headers, &block)

data/lib/mail_engine/engine.rb

@@ -5,6 +5,9 @@ module MailEngine
     require 'kaminari'
     require 'deep_cloneable'
     require 'liquid'
+    require 'mail_engine/mail_log_subscriber'
+    require 'mail_engine/zip_processor'
+    require 'mail_engine/html_document_assets_replacer'
     require 'mail_engine/liquid_view_patch/liquid_view'
 
     initializer "mail_engine" do
@@ -45,6 +48,12 @@ module MailEngine
       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)
+
+        # in development mode all mails send to replacement_email_in_dev_mode
+        if defined?(MailSafe::Config) and replacement_email = MailEngine::Base.current_config["replacement_email"]
+          MailSafe::Config.internal_address_definition = /#{replacement_email}/
+          MailSafe::Config.replacement_address = replacement_email
+        end
       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

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

@@ -3,6 +3,7 @@ development:
   user_class_name: "User"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
+  replacement_email: "dev@youdomain.com"
   sendgrid:
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"
@@ -13,6 +14,7 @@ test:
   user_class_name: "User"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
+  replacement_email: "dev@youdomain.com"
   sendgrid:
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"
@@ -23,6 +25,7 @@ production:
   user_class_name: "User"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
+  replacement_email: "dev@youdomain.com"
   sendgrid:
     sendgrid_user: "you send grid username"
     sendgrid_key: "password"

data/mail_engine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_engine}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael he"]
-  s.date = %q{2011-03-09}
+  s.date = %q{2011-03-14}
   s.description = %q{Rails system mail management solution.}
   s.email = %q{hlxwell@gmail.com}
   s.extra_rdoc_files = [
@@ -618,6 +618,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<liquid>, [">= 0"])
       s.add_runtime_dependency(%q<kaminari>, [">= 0"])
       s.add_runtime_dependency(%q<carrierwave>, [">= 0"])
+      s.add_runtime_dependency(%q<mail_safe>, [">= 0"])
       s.add_development_dependency(%q<annotate>, [">= 0"])
       s.add_development_dependency(%q<bluecloth>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
@@ -635,6 +636,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<liquid>, [">= 0"])
       s.add_dependency(%q<kaminari>, [">= 0"])
       s.add_dependency(%q<carrierwave>, [">= 0"])
+      s.add_dependency(%q<mail_safe>, [">= 0"])
       s.add_dependency(%q<annotate>, [">= 0"])
       s.add_dependency(%q<bluecloth>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
@@ -653,6 +655,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<liquid>, [">= 0"])
     s.add_dependency(%q<kaminari>, [">= 0"])
     s.add_dependency(%q<carrierwave>, [">= 0"])
+    s.add_dependency(%q<mail_safe>, [">= 0"])
     s.add_dependency(%q<annotate>, [">= 0"])
     s.add_dependency(%q<bluecloth>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])

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

@@ -17,9 +17,10 @@ class UserMailer < ActionMailer::Base
     @username = "Michael He"
 
     # html must below text
+    # should use subject in the db mail template.
     mail :to => to, :subject => "subject in mailer" do |f|
-      f.html
       f.text
+      f.html
     end
   end
 
@@ -29,8 +30,8 @@ class UserMailer < ActionMailer::Base
 
     # html must below text
     mail :to => user.email do |f|
-      f.html
       f.text
+      f.html
     end
   end
 end

data/test/dummy/config/environments/development.rb

@@ -17,23 +17,13 @@ Dummy::Application.configure do
   # Don't care if the mailer can't send
   config.action_mailer.perform_deliveries = true
   config.action_mailer.raise_delivery_errors = true
-  config.action_mailer.delivery_method = :test
-
-  # config.action_mailer.smtp_settings = {
-  #   :address              => "smtp.gmail.com",
-  #   :port                 => 587,
-  #   :domain               => 'itjob.fm',
-  #   :user_name            => 'itjob.fm',
-  #   :password             => 'whoafeedback',
-  #   :authentication       => 'plain',
-  #   :enable_starttls_auto => true
-  # }
+  config.action_mailer.delivery_method = :smtp
 
   config.action_mailer.smtp_settings = {
     :address              => "smtp.sendgrid.net",
     :port                 => 25,
     :domain               => 'smtp.sendgrid.met',
-    :user_name            => "a@theplant.jp",
+    :user_name            => "",
     :password             => "",
     :authentication       => :plain
   }

data/test/dummy/config/routes.rb

@@ -48,7 +48,7 @@ Dummy::Application.routes.draw do
 
   # You can have the root of your site routed with "root"
   # just remember to delete public/index.html.
-  root :to => redirect("/admin")
+  root :to => redirect("/admin/mail_engine")
 
   # See how all your routes lay out with "rake routes"
 

data/test/functional/user_mailer_test.rb

@@ -6,6 +6,15 @@ class UserMailerTest < ActionController::TestCase
       assert UserMailer.sendgrid_config.to_hash["X-SMTPAPI"].present?
     end
 
+    should "send to safe mail address" do
+      replacement_email = "xxx@xxx.com"
+      MailSafe::Config.internal_address_definition = /#{replacement_email}/
+      MailSafe::Config.replacement_address = replacement_email
+
+      UserMailer.notify("x@x.com").deliver
+      assert UserMailer.sendgrid_config.to_hash["X-SMTPAPI"].include?("[\"#{replacement_email}\"]")
+    end
+
     should "only send mail to the receiver" do
       UserMailer.notify("x@x.com").deliver
       assert UserMailer.sendgrid_config.to_hash["X-SMTPAPI"].include?("[\"x@x.com\"]")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail_engine
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - michael he
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-09 00:00:00 +08:00
+date: 2011-03-14 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -158,8 +158,8 @@ dependencies:
         version: "0"
   requirement: *id010
   prerelease: false
-  name: annotate
-  type: :development
+  name: mail_safe
+  type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
@@ -172,7 +172,7 @@ dependencies:
         version: "0"
   requirement: *id011
   prerelease: false
-  name: bluecloth
+  name: annotate
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id012 !ruby/object:Gem::Requirement 
@@ -186,7 +186,7 @@ dependencies:
         version: "0"
   requirement: *id012
   prerelease: false
-  name: yard
+  name: bluecloth
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id013 !ruby/object:Gem::Requirement 
@@ -200,7 +200,7 @@ dependencies:
         version: "0"
   requirement: *id013
   prerelease: false
-  name: bundler
+  name: yard
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id014 !ruby/object:Gem::Requirement 
@@ -214,7 +214,7 @@ dependencies:
         version: "0"
   requirement: *id014
   prerelease: false
-  name: jeweler
+  name: bundler
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id015 !ruby/object:Gem::Requirement 
@@ -228,7 +228,7 @@ dependencies:
         version: "0"
   requirement: *id015
   prerelease: false
-  name: rcov
+  name: jeweler
   type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id016 !ruby/object:Gem::Requirement 
@@ -242,6 +242,20 @@ dependencies:
         version: "0"
   requirement: *id016
   prerelease: false
+  name: rcov
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id017
+  prerelease: false
   name: reek
   type: :development
 description: Rails system mail management solution.