mail_engine 0.1.1 → 0.1.2

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
+# gemspec
 
 gem "activesupport", '>= 3.0.0'
 gem "httparty"
@@ -6,7 +7,7 @@ gem "nokogiri"
 gem "deep_cloneable"
 gem "sqlite3-ruby", :require => "sqlite3"
 gem 'rack', :git => 'git://github.com/rack/rack.git'
-gem "liquid", :git => "git://github.com/hlxwell/liquid.git"
+gem "liquid"
 gem 'kaminari', :git => 'https://github.com/amatsuda/kaminari.git'
 gem "carrierwave", :git => "git://github.com/jnicklas/carrierwave.git"
 

data/README.mkd

@@ -42,9 +42,21 @@ Add management page needed javascript lib and css files, migration files and mai
 Run migration.
 
     rake db:migrate
-
+    
 ** Step 4: **
 
+Add acts_as_mail_receiver definition to "Your User" model.
+
+  class User < AR
+    acts_as_mail_receiver :payload_columns => %w{firstname lastname},
+                          :groups => %w{all english_users chinese_users}
+  end
+  
+  1. User model must have 'email' and payload specified columns, or else you can delegate to other model.
+  2. "acts_as_mail_receiver" statement has to place below the scope statements.
+
+** Step 5: **
+
 Add below line to the crontab list of your sever:
 
     ### check mail schedule for every 15 minutes ###

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/app/controllers/mail_engine/application_controller.rb

@@ -1,10 +1,15 @@
-class MailEngine::ApplicationController < ActionController::Base
+class MailEngine::ApplicationController < ApplicationController
   prepend_view_path MailEngine::MailTemplate::Resolver.instance
-
   layout 'mail_engine/mail_engine'
+
+  # set the access check method.
+  if MailEngine::Base.current_config["access_check_method"].present?
+    before_filter MailEngine::Base.current_config["access_check_method"]
+  end
+
   include MailEngine
   helper MailEngine::MailEngineHelper
-  
+
   def close_modal_and_refresh
     render :text => "<script>parent.$.fancybox.close();parent.window.location.reload();</script>"
   end

data/app/models/mail_engine/mail_schedule.rb

@@ -7,7 +7,7 @@ class MailEngine::MailSchedule < ActiveRecord::Base
   def logs(count = 10)
     MailEngine::MailLog.where(:mail_template_path => self.mail_template.actual_path).order("id desc").limit(count)
   end
-  
+
   # load user info into payload hash used at mail template.
   def load_payload user
     payload_hash = {}
@@ -62,6 +62,7 @@ class MailEngine::MailSchedule < ActiveRecord::Base
 
     MailEngine::USER_MODEL.send(self.user_group.to_sym).each do |user|
       puts "-> sending mail to #{user.email}"
+      ### 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
     end
 

data/app/models/mail_engine/mail_template.rb

@@ -57,8 +57,8 @@ class MailEngine::MailTemplate < ActiveRecord::Base
   end
 
   # list the templates with same path, but different locale and format
-  def variations
-    existed_variations = self.class.where(:path => self.path, :partial => false).order("locale, 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|

data/app/views/mail_engine/mail_templates/index.html.erb

@@ -25,7 +25,7 @@
         <% end %>
         <td style="width: 200px;">
           <table style="margin-bottom: 0px;">
-            <% mail_template.variations.group_by(&:locale).each do |locale, templates| %>
+            <% mail_template.variations(params[:type] == 'partial').group_by(&:locale).each do |locale, templates| %>
               <tr>
                 <td colspan="2" style="background-color: grey; font-weight: bold; color: white; padding: 2px 5px"><%= locale.humanize %></td>
               </tr>

data/lib/mail_engine/base.rb

@@ -8,11 +8,13 @@ module MailEngine
       # === example
       #
       #   log_mail: true
-      #   sendgrid_user: "xxx@theplant.jp"
-      #   sendgrid_key: "xxx"
-      #   sendgrid_category: "development"
       #   user_class_name: "User"
       #   mount_at: "/admin"
+      #   access_check_method: "logged_in?"
+      #   sendgrid:
+      #     sendgrid_user: "xxx@theplant.jp"
+      #     sendgrid_key: "xxx"
+      #     sendgrid_category: "development"
       #
       def current_config
         MailEngine::Base.configurations[Rails.env] || {}

data/lib/mail_engine/engine.rb

@@ -3,15 +3,16 @@ module MailEngine
     require 'mail_engine'
     require 'carrierwave'
     require 'kaminari'
-    
+    require 'deep_cloneable'
+    require 'liquid'
+    require 'mail_engine/liquid_view_patch/liquid_view'
+
     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
 
@@ -19,7 +20,7 @@ module MailEngine
       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

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

@@ -1,23 +1,29 @@
 development:
   log_mail: false
-  sendgrid_user: "you send grid username"
-  sendgrid_key: "password"
-  sendgrid_category: "my sendgrid category"
   user_class_name: "User"
-  mount_at: "/admin"
+  mount_at: "/admin/mail_engine"
+  access_check_method: "logged_in?"
+  sendgrid:
+    sendgrid_user: "you send grid username"
+    sendgrid_key: "password"
+    sendgrid_category: "my sendgrid category"
 
 test:
   log_mail: false
-  sendgrid_user: "you send grid username"
-  sendgrid_key: "password"
-  sendgrid_category: "my sendgrid category"
   user_class_name: "User"
-  mount_at: "/admin"
+  mount_at: "/admin/mail_engine"
+  access_check_method: "logged_in?"
+  sendgrid:
+    sendgrid_user: "you send grid username"
+    sendgrid_key: "password"
+    sendgrid_category: "my sendgrid category"
 
 production:
   log_mail: false
-  sendgrid_user: "you send grid username"
-  sendgrid_key: "password"
-  sendgrid_category: "my sendgrid category"
   user_class_name: "User"
-  mount_at: "/admin"
+  mount_at: "/admin/mail_engine"
+  access_check_method: "logged_in?"
+  sendgrid:
+    sendgrid_user: "you send grid username"
+    sendgrid_key: "password"
+    sendgrid_category: "my sendgrid category"

data/lib/mail_engine/liquid_view_patch/liquid_view.rb

@@ -0,0 +1,52 @@
+# LiquidView is a action view extension class. You can register it with rails
+# and use liquid as an template system for .liquid files
+#
+# Example
+#
+#   ActionView::Base::register_template_handler :liquid, LiquidView
+class LiquidView
+  PROTECTED_ASSIGNS = %w( template_root response _session template_class action_name request_origin session template
+                          _response url _request _cookies variables_added _flash params _headers request cookies
+                          ignore_missing_templates flash _params logger before_filter_chain_aborted headers )
+  PROTECTED_INSTANCE_VARIABLES = %w( @_request @controller @_first_render @_memoized__pick_template @view_paths
+                                     @helpers @assigns_added @template @_render_stack @template_format @assigns )
+
+  def self.call(template)
+    "LiquidView.new(self).render('#{template.source.gsub(/\'/, '"')}', local_assigns)"
+  end
+
+  def initialize(view)
+    @view = view
+  end
+
+  def render(template, local_assigns = nil)
+    ### when I render text layout, it still set me html content type. so remove it.
+    # @view.controller.headers["Content-Type"] ||= 'text/html; charset=utf-8'
+
+    # Rails 2.2 Template has source, but not locals
+    if template.respond_to?(:source) && !template.respond_to?(:locals)
+      assigns = (@view.instance_variables - PROTECTED_INSTANCE_VARIABLES).inject({}) do |hash, ivar|
+                  hash[ivar[1..-1]] = @view.instance_variable_get(ivar)
+                  hash
+                end
+    else
+      assigns = @view.assigns.reject{ |k,v| PROTECTED_ASSIGNS.include?(k) }
+    end
+
+    source = template.respond_to?(:source) ? template.source : template
+    local_assigns = (template.respond_to?(:locals) ? template.locals : local_assigns) || {}
+
+    if content_for_layout = @view.instance_variable_get("@content_for_layout")
+      assigns['content_for_layout'] = content_for_layout
+    end
+    assigns.merge!(local_assigns.stringify_keys)
+
+    liquid = Liquid::Template.parse(source)
+    liquid.render(assigns, :filters => [@view.helpers], :registers => {:action_view => @view, :controller => @view.controller})
+  end
+
+  def compilable?
+    false
+  end
+
+end

data/lib/mail_engine/sendgrid/rest_api.rb

@@ -9,7 +9,7 @@ module MailEngine
     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"]
+      default_params :api_key => MailEngine::Base.current_config["sendgrid"]["sendgrid_key"], :api_user => MailEngine::Base.current_config["sendgrid"]["sendgrid_user"]
 
       class << self
         # <stats>

data/lib/mail_engine.rb

@@ -20,4 +20,5 @@ module MailEngine
   autoload :Mailer
   autoload :ActsAsMailReceiver
   autoload :Configuration
-end
+end
+

data/mail_engine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_engine}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["michael he"]
-  s.date = %q{2011-03-04}
+  s.date = %q{2011-03-05}
   s.description = %q{Rails system mail management solution.}
   s.email = %q{hlxwell@gmail.com}
   s.extra_rdoc_files = [
@@ -88,7 +88,6 @@ Gem::Specification.new do |s|
     ".yardoc/objects/root.dat",
     ".yardoc/proxy_types",
     "Gemfile",
-    "Gemfile.lock",
     "MIT-LICENSE",
     "README.mkd",
     "Rakefile",
@@ -202,6 +201,7 @@ Gem::Specification.new do |s|
     "lib/mail_engine/generators/install.rb",
     "lib/mail_engine/generators/templates/mail_engine_config.yml",
     "lib/mail_engine/html_document_assets_replacer.rb",
+    "lib/mail_engine/liquid_view_patch/liquid_view.rb",
     "lib/mail_engine/mail_log_subscriber.rb",
     "lib/mail_engine/sendgrid.rb",
     "lib/mail_engine/sendgrid/base.rb",

data/test/unit/mail_engine/mail_template_test.rb

@@ -55,7 +55,8 @@ class MailEngine::MailTemplateTest < ActiveSupport::TestCase
     end
 
     should "be able to get missing variations" do
-      assert_equal 4, @template.variations.count
+      assert_equal 4, @template.variations.count # all normal templates
+      assert_equal 4, @template.variations(true).count # all partials
       assert_equal 3, @template.variations.delete_if {|v| v.persisted? }.size
 
       variations = @template.variations.map { |v|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mail_engine
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - michael he
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 +08:00
+date: 2011-03-05 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -311,7 +311,6 @@ files:
 - .yardoc/objects/root.dat
 - .yardoc/proxy_types
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.mkd
 - Rakefile
@@ -425,6 +424,7 @@ files:
 - lib/mail_engine/generators/install.rb
 - lib/mail_engine/generators/templates/mail_engine_config.yml
 - lib/mail_engine/html_document_assets_replacer.rb
+- lib/mail_engine/liquid_view_patch/liquid_view.rb
 - lib/mail_engine/mail_log_subscriber.rb
 - lib/mail_engine/sendgrid.rb
 - lib/mail_engine/sendgrid/base.rb

data/Gemfile.lock

@@ -1,180 +0,0 @@
-GIT
-  remote: git://github.com/hlxwell/liquid.git
-  revision: d70ed7582215507a579fee8b5e5b3269600f3fb3
-  specs:
-    liquid (2.2.2)
-
-GIT
-  remote: git://github.com/jnicklas/carrierwave.git
-  revision: d85841ca51fa2c546bd73d9d7ba871c7c0d9455b
-  specs:
-    carrierwave (0.5.2)
-      activesupport (~> 3.0)
-
-GIT
-  remote: git://github.com/rack/rack.git
-  revision: e3ffeac0dc04bb8d5994b7923bf12e55d549a279
-  specs:
-    rack (1.2.1)
-
-GIT
-  remote: git://github.com/thoughtbot/factory_girl.git
-  revision: a7f7e85187e9178f4da2db1b87fa38aec6a96178
-  specs:
-    factory_girl (2.0.0.beta1)
-
-GIT
-  remote: https://github.com/amatsuda/kaminari.git
-  revision: 91e9137096e2e5aedfe91f9ebab35b4af8de2408
-  specs:
-    kaminari (0.10.4)
-      rails (>= 3.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.4)
-      actionpack (= 3.0.4)
-      mail (~> 2.2.15)
-    actionpack (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.4)
-      activesupport (= 3.0.4)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.4)
-      activemodel (= 3.0.4)
-      activesupport (= 3.0.4)
-    activesupport (3.0.4)
-    arel (2.0.9)
-    bluecloth (2.0.11)
-    builder (2.1.2)
-    capybara (0.4.1.2)
-      celerity (>= 0.7.9)
-      culerity (>= 0.2.4)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      selenium-webdriver (>= 0.0.27)
-      xpath (~> 0.1.3)
-    celerity (0.8.8)
-    childprocess (0.1.7)
-      ffi (~> 0.6.3)
-    crack (0.1.8)
-    culerity (0.2.15)
-    deep_cloneable (1.2.1)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    fakeweb (1.3.0)
-    ffi (0.6.3)
-      rake (>= 0.8.7)
-    git (1.2.5)
-    httparty (0.6.1)
-      crack (= 0.1.8)
-    i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    json_pure (1.5.1)
-    mail (2.2.15)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    mocha (0.9.10)
-      rake
-    nokogiri (1.4.4)
-    polyglot (0.3.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
-      rack (>= 1.0)
-    rails (3.0.4)
-      actionmailer (= 3.0.4)
-      actionpack (= 3.0.4)
-      activerecord (= 3.0.4)
-      activeresource (= 3.0.4)
-      activesupport (= 3.0.4)
-      bundler (~> 1.0)
-      railties (= 3.0.4)
-    railties (3.0.4)
-      actionpack (= 3.0.4)
-      activesupport (= 3.0.4)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    rcov (0.9.9)
-    reek (1.2.8)
-      ruby2ruby (~> 1.2)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby2ruby (1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby_parser (2.0.6)
-      sexp_processor (~> 3.0)
-    rubyzip (0.9.4)
-    selenium-webdriver (0.1.3)
-      childprocess (~> 0.1.5)
-      ffi (~> 0.6.3)
-      json_pure
-      rubyzip
-    sexp_processor (3.0.5)
-    shoulda (2.11.3)
-    sqlite3 (1.3.3)
-    sqlite3-ruby (1.3.3)
-      sqlite3 (>= 1.3.3)
-    test_benchmarker (1.2.1)
-    thor (0.14.6)
-    timecop (0.3.5)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.24)
-    xpath (0.1.3)
-      nokogiri (~> 1.3)
-    yard (0.6.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (>= 3.0.0)
-  bluecloth
-  bundler
-  capybara (>= 0.4.0)
-  carrierwave!
-  deep_cloneable
-  factory_girl!
-  fakeweb
-  httparty
-  jeweler
-  kaminari!
-  liquid!
-  mocha
-  nokogiri
-  rack!
-  rack-test
-  rcov
-  reek
-  shoulda
-  sqlite3-ruby
-  test_benchmarker
-  timecop
-  yard