mail_engine 0.1.11 → 0.1.12

data/Gemfile

@@ -5,13 +5,13 @@ gem "activesupport", '>= 3.0.0'
 gem "httparty"
 gem "nokogiri"
 gem "deep_cloneable"
-gem "sqlite3-ruby", :require => "sqlite3"
 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"
 
 group :development do
+  gem "sqlite3-ruby", :require => "sqlite3"
   gem "annotate"
   gem "bluecloth"
   gem "yard"

data/README.mkd

@@ -25,6 +25,15 @@ to fit our needs in real project:
 6. It doesn't support reusable partials, which like you hope to put a fixed content of footer or header.
 7. It doesn't support recurring mail sending.
 
+Serveral places you need developer's help without Mail Engine:
+
+1. Change text in system email.
+2. Localize mail templates in system.
+3. Prepare user list for marketing mail if you want to use mailchimp.
+4. Analyse system mail send log.
+5. Add multipart for email, like text version email or html version email.
+6. Find untranslated mail templates.
+
 Installation
 ============
 ** Step 1: **
@@ -97,6 +106,7 @@ 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.
+      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.
@@ -213,6 +223,7 @@ You can set a mail sending schedule, here are some useful setting items:
 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 control if run the schedule or not.
+9. Users with different locale setting will receive different language of email. (if not found that language, you can set default template or not send.)
 
 ![Mail Schedule](https://github.com/hlxwell/mail-engine/raw/master/screenshots/schedule.png "Mail Schedule")
 

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.12

data/app/models/mail_engine/mail_schedule.rb

@@ -14,8 +14,11 @@
 #  last_sent_at     :datetime
 #  created_at       :datetime
 #  updated_at       :datetime
+#  default_locale   :string
 #
 
+class MailEngine::MissingMailTemplate < StandardError; end
+
 class MailEngine::MailSchedule < ActiveRecord::Base
   validates_presence_of :name, :user_group, :mail_template_id, :period, :count, :first_send_at
   validates_inclusion_of :period, :in => %w( once daily weekly monthly yearly), :message => "period should in 'daily', 'weekly' and 'monthly'"
@@ -63,7 +66,7 @@ class MailEngine::MailSchedule < ActiveRecord::Base
     end
 
     # other periods
-    rest_count     = (count == 0 ? schedule_count : count - sent_count)
+    rest_count = (count == 0 ? schedule_count : count - sent_count)
     (1..rest_count).map do |i|
       last_schedule_time + i.send(PERIOD_TO_UNIT_TABLE[period].first)
     end
@@ -138,20 +141,35 @@ class MailEngine::MailSchedule < ActiveRecord::Base
   # used in Rake task, the main mail sending method.
   def sendmail
     puts "---> Schedule: '#{self.name}'" if Rails.env != 'test'
-
-    unless ready_to_send?
-      puts "---> not ready"
-      return false
-    end
+    return false unless ready_to_send? # puts "---> not ready"
 
     MailEngine::USER_MODEL.send(self.user_group.to_sym).each do |user|
-      puts "-> sending mail to #{user.email}"
+      puts "-> sending mail to #{user.email}" if Rails.env != 'test'
       ### FIXME user.email, what if user don't have email column.
-      MailEngine::MailDispatcher.send(mail_template.template_name.to_sym, :to => user.email, :values => self.load_payload(user) ).deliver
+      user_locale = user.send(MailEngine::Base.current_config["user_locale_column"])
+
+      begin
+        # when there is default_locale been set, should fallback to default_locale template, when can't find the locale user in user settings.
+        if !mail_template.existed_variations.map(&:locale).include?(user_locale)
+          if self.default_locale.present?
+            raise MailEngine::MissingMailTemplate.new("not found template for user locale: #{user_locale}")
+          else
+            raise "skip sending mail since not found correspond locale template."
+          end
+        end
+
+        I18n.with_locale user_locale do
+          MailEngine::MailDispatcher.send(mail_template.template_name.to_sym, :to => user.email, :values => self.load_payload(user) ).deliver
+        end
+      rescue MailEngine::MissingMailTemplate
+        I18n.with_locale self.default_locale do
+          MailEngine::MailDispatcher.send(mail_template.template_name.to_sym, :to => user.email, :values => self.load_payload(user) ).deliver
+        end
+      rescue
+        # do nothing, just don't sent mail.
+      end
     end
 
-    self.last_sent_at = Time.now
-    self.sent_count += 1
-    self.save
+    self.update_attributes :last_sent_at => Time.now, :sent_count => self.sent_count + 1
   end
 end

data/app/models/mail_engine/mail_template.rb

@@ -123,17 +123,20 @@ class MailEngine::MailTemplate < ActiveRecord::Base
 
   # list the templates with same path, but different locale and format
   def variations(for_partial = false)
-    existed_variations = self.class.where(:path => self.path, :partial => for_partial).order("locale, format")
-
     all_variation_codes = I18n.available_locales.product([:html, :text])
-    existed_variation_codes = existed_variations.map do |template|
+    current_existed_variations = existed_variations(for_partial)
+    existed_variation_codes = current_existed_variations.map do |template|
                                 [template.locale.to_sym, template.format.to_sym]
                               end
     missing_variations = (all_variation_codes - existed_variation_codes).map do |locale, format|
       MailEngine::MailTemplate.new :locale => locale.to_s, :format => format.to_s
     end
 
-    missing_variations + existed_variations
+    missing_variations + current_existed_variations
+  end
+
+  def existed_variations for_partial = false
+    self.class.where(:path => self.path, :partial => for_partial).order("locale, format")
   end
 
   def actual_path

data/app/views/mail_engine/mail_schedules/_form.html.erb

@@ -39,6 +39,14 @@
   <%= f.check_box :available %>
   <div class="hint">If you don't want to execute this schedule, leave it unchecked.</div>
 </div>
+<div class="field">
+  <%= f.label :default_locale, "Default Locale" %><br />
+  <%= f.select :default_locale, I18n.available_locales, :include_blank => true %>
+  <div class="hint">
+    When can find mail template for user's locale, system will send default locale template to user.
+    If you leave this blank, system won't send mail to this kind of users.
+  </div>
+</div>
 <div class="field">
   <%= f.label :payload %><br />
   <% MailEngine::USER_MODEL.payload_columns.each do |column| %>

data/app/views/mail_engine/mail_schedules/show.html.erb

@@ -37,12 +37,16 @@
         <td>Last send at</td>
         <td><%= @mail_schedule.last_sent_at %></td>
       </tr>
+      <tr>
+        <td>Default Locale</td>
+        <td><%= @mail_schedule.default_locale %></td>
+      </tr>
       <tr>
         <td>Payload</td>
         <td><%= @mail_schedule.payload %></td>
       </tr>
     </table>
-    
+
     <%= render "mail_engine/mail_logs/related_logs", :logs => @mail_schedule.logs %>
   </div>
   <br />

data/db/migrate/20110126030525_create_mail_schedules.rb

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

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

@@ -1,6 +1,7 @@
 development:
   log_mail: false
   user_class_name: "User"
+  user_locale_column: "locale"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
   default_from: "your@email.address"
@@ -14,6 +15,7 @@ development:
 test:
   log_mail: false
   user_class_name: "User"
+  user_locale_column: "locale"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
   replacement_email: "dev@youdomain.com"
@@ -27,6 +29,7 @@ test:
 production:
   log_mail: false
   user_class_name: "User"
+  user_locale_column: "locale"
   mount_at: "/admin/mail_engine"
   access_check_method: "logged_in?"
   default_from: "your@email.address"

data/lib/mail_engine/rake_locker.rb

@@ -0,0 +1,43 @@
+module MailEngine
+  module RakeLocker
+    TRY_TIMES = 4
+
+    def lock_task
+      raise "Please pass block." unless block_given?
+
+      if locked?
+        puts 'locked!'
+        lock
+      else
+        lock
+        yield
+        unlock
+      end
+    end
+
+  private
+
+    def locked?
+      # if no convert_files_lock1, not locked
+      return false unless FileTest.exist? "#{Rails.root}/tmp/convert_files_lock1"
+      # if no convert_files_lock4, return locked
+      return true unless FileTest.exist? "#{Rails.root}/tmp/convert_files_lock#{TRY_TIMES}"
+      ### tried TRY_TIMES times, found convert_files_lock4 file, unlock it
+      unlock_task
+      return false
+    end
+
+    def lock
+      (1..TRY_TIMES).each do |n|
+        unless FileTest.exist? "#{Rails.root}/tmp/convert_files_lock#{n}"
+          `touch #{Rails.root}/tmp/convert_files_lock#{n}`
+          break
+        end
+      end
+    end
+
+    def unlock
+      `rm #{Rails.root}/tmp/convert_files_lock*`
+    end
+  end
+end

data/lib/mail_engine/tasks/sendmail.rake

@@ -1,8 +1,12 @@
+require 'mail_engine/rake_locker'
 namespace :mail_engine do
+  include MailEngine::RakeLocker
   desc "Check mail schedule table and send the scheduled mail."
   task :sendmail => :environment do
-    puts "==== Start sending scheduled mail ===="
-    MailEngine::MailSchedule.available.each { |schedule| schedule.sendmail }
-    puts "==== End sending scheduled mail ===="
+    lock_task do
+      puts "==== Start sending scheduled mail ===="
+      MailEngine::MailSchedule.available.each { |schedule| schedule.sendmail }
+      puts "==== End sending scheduled mail ===="
+    end
   end
 end

data/mail_engine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_engine}
-  s.version = "0.1.11"
+  s.version = "0.1.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael he"]
-  s.date = %q{2011-03-16}
+  s.date = %q{2011-03-17}
   s.description = %q{Rails system mail management solution.}
   s.email = %q{hlxwell@gmail.com}
   s.extra_rdoc_files = [
@@ -221,6 +221,7 @@ Gem::Specification.new do |s|
     "lib/mail_engine/liquid_view_patch/liquid_view.rb",
     "lib/mail_engine/mail_log_subscriber.rb",
     "lib/mail_engine/mail_template_resolver.rb",
+    "lib/mail_engine/rake_locker.rb",
     "lib/mail_engine/sendgrid.rb",
     "lib/mail_engine/sendgrid/base.rb",
     "lib/mail_engine/sendgrid/rest_api.rb",
@@ -382,8 +383,8 @@ Gem::Specification.new do |s|
     "test/dummy/app/mailers/test/test_mailer.rb",
     "test/dummy/app/mailers/user_mailer.rb",
     "test/dummy/app/models/user.rb",
-    "test/dummy/app/views/user_mailer/notify.html.erb",
-    "test/dummy/app/views/user_mailer/notify.text.liquid",
+    "test/dummy/app/views/user_mailer/notify.en.html.erb",
+    "test/dummy/app/views/user_mailer/notify.en.text.liquid",
     "test/dummy/config.ru",
     "test/dummy/config/application.rb",
     "test/dummy/config/boot.rb",
@@ -629,11 +630,11 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_runtime_dependency(%q<deep_cloneable>, [">= 0"])
-      s.add_runtime_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_runtime_dependency(%q<rack>, [">= 0"])
       s.add_runtime_dependency(%q<liquid>, [">= 0"])
       s.add_runtime_dependency(%q<kaminari>, [">= 0"])
       s.add_runtime_dependency(%q<carrierwave>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<annotate>, [">= 0"])
       s.add_development_dependency(%q<bluecloth>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
@@ -646,11 +647,11 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<deep_cloneable>, [">= 0"])
-      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<rack>, [">= 0"])
       s.add_dependency(%q<liquid>, [">= 0"])
       s.add_dependency(%q<kaminari>, [">= 0"])
       s.add_dependency(%q<carrierwave>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<annotate>, [">= 0"])
       s.add_dependency(%q<bluecloth>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
@@ -664,11 +665,11 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<httparty>, [">= 0"])
     s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<deep_cloneable>, [">= 0"])
-    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<rack>, [">= 0"])
     s.add_dependency(%q<liquid>, [">= 0"])
     s.add_dependency(%q<kaminari>, [">= 0"])
     s.add_dependency(%q<carrierwave>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<annotate>, [">= 0"])
     s.add_dependency(%q<bluecloth>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])

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

@@ -17,7 +17,7 @@ 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 = :smtp
+  config.action_mailer.delivery_method = :test
 
   config.action_mailer.smtp_settings = {
     :address              => "smtp.sendgrid.net",

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

@@ -11,6 +11,7 @@ class CreateMailSchedules < ActiveRecord::Migration
       t.datetime :first_send_at
       t.datetime :last_sent_at
       t.boolean :available
+      t.string :default_locale
 
       t.timestamps
     end

data/test/dummy/db/schema.rb

@@ -34,6 +34,7 @@ ActiveRecord::Schema.define(:version => 20110217062316) do
     t.datetime "first_send_at"
     t.datetime "last_sent_at"
     t.boolean  "available"
+    t.string   "default_locale"
     t.datetime "created_at"
     t.datetime "updated_at"
   end

data/test/factories.rb

@@ -105,6 +105,7 @@ FactoryGirl.define do
   factory :mail_schedule, :class => MailEngine::MailSchedule do
     name "New Data"
     association :mail_template, :factory => :marketing_mail_template, :format => "html"
+    # default_locale 'en'
     user_group "all"
     count 0
     sent_count 0

data/test/unit/mail_engine/mail_schedule_test.rb

@@ -2,6 +2,42 @@ require 'test_helper'
 
 class MailEngine::MailScheduleTest < ActiveSupport::TestCase
 
+  context "schedule with 2 locale users" do
+    setup do
+      User.destroy_all
+      ActionMailer::Base.deliveries.clear
+
+      @user_en = FactoryGirl.create(:user, :locale => 'en')
+      @user_zh = FactoryGirl.create(:user, :email => "mmm@gmail.com", :locale => 'zh')
+      @schedule = FactoryGirl.create(:mail_schedule, :period => "once")
+      @en_template = @schedule.mail_template
+    end
+
+    should "send correct language mail template to user" do
+      zh_template = FactoryGirl.create(:marketing_mail_template, :body => "chinese marketing template", :locale => "zh")
+
+      assert_equal 2, MailEngine::MailTemplate.count
+      assert @schedule.ready_to_send?
+      assert_equal 0, ActionMailer::Base.deliveries.size
+      @schedule.sendmail
+      assert_equal 2, ActionMailer::Base.deliveries.size
+      assert ActionMailer::Base.deliveries.first.body.raw_source.include?(@en_template.body)
+      assert ActionMailer::Base.deliveries.last.body.raw_source.include?(zh_template.body)
+    end
+
+    should "not send mail without correct template and default template" do
+      @schedule.sendmail
+      assert_equal 1, ActionMailer::Base.deliveries.size
+    end
+
+    should "send mail without correct template but has set default template" do
+      @schedule.default_locale = 'en'
+      @schedule.sendmail
+      assert_equal 2, ActionMailer::Base.deliveries.size
+      assert ActionMailer::Base.deliveries.last.body.raw_source.include?(@en_template.body)
+    end
+  end
+
   context "schedule" do
     setup do
       @user = FactoryGirl.create(:user)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail_engine
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - michael he
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 +08:00
+date: 2011-03-17 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,7 @@ dependencies:
         version: "0"
   requirement: *id005
   prerelease: false
-  name: sqlite3-ruby
+  name: rack
   type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id006 !ruby/object:Gem::Requirement 
@@ -102,7 +102,7 @@ dependencies:
         version: "0"
   requirement: *id006
   prerelease: false
-  name: rack
+  name: liquid
   type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id007 !ruby/object:Gem::Requirement 
@@ -116,7 +116,7 @@ dependencies:
         version: "0"
   requirement: *id007
   prerelease: false
-  name: liquid
+  name: kaminari
   type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id008 !ruby/object:Gem::Requirement 
@@ -130,7 +130,7 @@ dependencies:
         version: "0"
   requirement: *id008
   prerelease: false
-  name: kaminari
+  name: carrierwave
   type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id009 !ruby/object:Gem::Requirement 
@@ -144,8 +144,8 @@ dependencies:
         version: "0"
   requirement: *id009
   prerelease: false
-  name: carrierwave
-  type: :runtime
+  name: sqlite3-ruby
+  type: :development
 - !ruby/object:Gem::Dependency 
   version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -458,6 +458,7 @@ files:
 - lib/mail_engine/liquid_view_patch/liquid_view.rb
 - lib/mail_engine/mail_log_subscriber.rb
 - lib/mail_engine/mail_template_resolver.rb
+- lib/mail_engine/rake_locker.rb
 - lib/mail_engine/sendgrid.rb
 - lib/mail_engine/sendgrid/base.rb
 - lib/mail_engine/sendgrid/rest_api.rb
@@ -619,8 +620,8 @@ files:
 - test/dummy/app/mailers/test/test_mailer.rb
 - test/dummy/app/mailers/user_mailer.rb
 - test/dummy/app/models/user.rb
-- test/dummy/app/views/user_mailer/notify.html.erb
-- test/dummy/app/views/user_mailer/notify.text.liquid
+- test/dummy/app/views/user_mailer/notify.en.html.erb
+- test/dummy/app/views/user_mailer/notify.en.text.liquid
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb