rails_email_preview 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 316441f9fa1877b4421bc4ebe7fbaf4a0dc5f325
-  data.tar.gz: 3c3b9c876ae226366428581572419530652b6e29
+  metadata.gz: b46366e1472a3041b34ca170b5cc29825c9f5ed1
+  data.tar.gz: 8ba5c7bacfdfaef09c530d75672ff78f70690f11
 SHA512:
-  metadata.gz: c85362bd7e84b577695377cde1bdb78c54f88103180d8f934f54be3f43fc7aed93b79784da79bd53025d875b780519c282db037c96973a99d311d1af3fd0e442
-  data.tar.gz: 9061e1ea98c9b98a3e5f7d177f367629c139254bad43b26509e24c2caa7f5b90630dd5ffc4d26b52cee22a977f485c740086158a017dc4277e0ce85387954b0d
+  metadata.gz: 87929034726a606ffa0d438c3f91f99a4a89dbf760487d2c140e98d18fd46bb988f3cb4642012755612db68138706dd6dc4af7ab0f4ec1811ae9c524eba63233
+  data.tar.gz: beee657162ebe47a1e601e236fe12ff8f3c142136385c4a17b62a3fccc824ed18e76a3c1854a9754b976d36481a414e7f967a0ab9d8b501e0e0b17800233ebba

data/README.md

@@ -6,7 +6,7 @@ A Rails Engine to preview plain text and html email in your browser. Compatible
 ![screenshot][rep-show-screenshot]
 ![screenshot][rep-nav-screenshot]
 
-*(styles are from the application)*
+*styles are provided by the application, above is [Zuigo](http://zuigo.com/), a platform to organize & discover events*
 
 How to
 -----
@@ -63,6 +63,15 @@ You can access REP urls like this:
     # email show:
     rails_email_preview.rep_email_url(mail_class: "user_mailer", mail_action: "welcome")
 
+Sending test emails
+-------------------
+
+You can send emails via REP. This is especially useful when testing with limited clients (Blackberry, Outlook, etc.).
+This will use the environment's mailer settings, but the handler will `perform_deliveries`.
+Uncomment this line in the initializer to disable sending test emails:
+
+  config.enable_send_email = false
+
 Email editing 
 -------------
 

data/app/controllers/rails_email_preview/emails_controller.rb

@@ -5,7 +5,7 @@ class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationCont
 
   # list screen
   def index
-    @preview_class_names = (RailsEmailPreview.preview_classes || []).map { |klass| klass.is_a?(String) ? klass : klass.name }
+    @preview_class_names = (RailsEmailPreview.preview_classes || []).map { |klass| klass.is_a?(String) ? klass : klass.name }.sort
   end
 
   # preview screen
@@ -13,25 +13,18 @@ class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationCont
     I18n.with_locale @email_locale do
       @part_type = params[:part_type] || 'text/html'
       if @preview_class.respond_to?(:new)
-        @mail = @preview_class.new.send(params[:mail_action])
+        @mail = preview_mail
       else
-        # @preview_class is not a preview class
-        arg_info = "#{@preview_class}"
-        if @preview_class.is_a?(Module)
-          chain = @preview_class.ancestors.map(&:to_s)
-          chain = chain[1 .. chain.index { |c| c =~ /^Application[A-Z][A-z]+$/ } || -1]
-        end
-        raise ArgumentError.new("#{arg_info} is not a preview class #{"(ancestors: #{chain * ' < '})"} ")
+        raise ArgumentError.new("#{@preview_class} is not a preview class, does not respond_to?(:new)")
       end
     end
-    render
   end
 
   # render actual email content
   def show_raw
     I18n.with_locale @email_locale do
-      @mail = @preview_class.new.send(params[:mail_action])
-      RailsEmailPreview.run_before_render(@mail)
+      @mail = preview_mail
+      RailsEmailPreview.run_before_render(@mail, @preview_class.name, @mail_action)
       if @part_type == 'raw'
         body = "<pre id='raw_message'>#{html_escape(@mail.to_s)}</pre>"
       else
@@ -49,8 +42,39 @@ class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationCont
     end
   end
 
+  def test_deliver
+    redirect_url = rep_email_url(params.slice(:mail_class, :mail_action, :email_locale))
+    if (address = params[:recipient_email]).blank? || address !~ /@/
+      redirect_to redirect_url, alert: t('rep.test_deliver.provide_email')
+      return
+    end
+    if !(delivery_method = Rails.application.config.action_mailer.delivery_method)
+      redirect_to redirect_url, alert: t('rep.test_deliver.no_delivery_method', environment: Rails.env)
+      return
+    end
+    I18n.with_locale @email_locale do
+      delivery_handler = RailsEmailPreview::DeliveryHandler.new(preview_mail, to: address, cc: nil, bcc: nil)
+      deliver_email!(delivery_handler.mail)
+
+      redirect_to redirect_url, notice: t('rep.test_deliver.sent_notice', address: address, delivery_method: delivery_method)
+    end
+  end
+
   protected
 
+  def deliver_email!(mail)
+    # support deliver! if present
+    if mail.respond_to?(:deliver!)
+      mail.deliver!
+    else
+      mail.deliver
+    end
+  end
+
+  def preview_mail
+    @preview_class.new.send(@mail_action)
+  end
+
   def set_email_preview_locale
     @email_locale = (params[:email_locale] || I18n.default_locale).to_s
   end
@@ -62,6 +86,7 @@ class RailsEmailPreview::EmailsController < ::RailsEmailPreview::ApplicationCont
       (pc.is_a?(String) ? pc : pc.name).underscore == params[:mail_class]
     }
     @preview_class = @preview_class.constantize if @preview_class.is_a?(String)
-    @part_type = params[:part_type] || 'text/html'
+    @mail_action = params[:mail_action]
+    @part_type   = params[:part_type] || 'text/html'
   end
 end

data/app/helpers/rails_email_preview/emails_helper.rb

@@ -6,4 +6,22 @@ module RailsEmailPreview::EmailsHelper
       value.to_s
     end
   end
+
+  def email_methods(m)
+    m.constantize.instance_methods(false).map(&:to_s).sort
+  end
+
+  def split_in_halves(elements, &weight)
+    tot_w = elements.map(&weight).sum
+    cols = [elements.dup, []]
+    col2_w = 0
+    cols[0].reverse_each do |cl|
+      n = weight.call(cl)
+      break if col2_w + n > tot_w / 2
+      col2_w += n
+      cols[1] << cols[0].pop
+    end
+    cols[1].reverse!
+    cols
+  end
 end

data/app/views/rails_email_preview/emails/_headers.html.slim

@@ -1,15 +1,17 @@
 ruby:
-  headers = {
-    'From'     => @mail.from,
-    'To'       => @mail.to,
-    'Reply to' => @mail.reply_to,
-    'CC'       => @mail.cc,
-    'BCC'      => @mail.bcc,
-    'Subject'  => @mail.subject || '(no subject)'
-  }.delete_if { |k, v| v.blank? }
+  headers = I18n.with_locale @email_locale do
+    {
+      'Subject'  => @mail.subject || '(no subject)',
+      'From'     => @mail.from,
+      'Reply to' => @mail.reply_to,
+      'To'       => @mail.to,
+      'CC'       => @mail.cc,
+      'BCC'      => @mail.bcc
+    }.delete_if { |k, v| v.blank? }
+  end
 
 
-dl
+dl.inline-dl
   - headers.each do |header, value|
-    dt #{header}
-    dd #{format_header(value)}
+    dt = header
+    dd = format_header(value)

data/app/views/rails_email_preview/emails/_send_form.html.slim

@@ -0,0 +1,6 @@
+div style="max-width: 250px"
+  = form_tag rails_email_preview.rep_test_deliver_url, method: :post do
+    = hidden_field_tag :email_locale, @email_locale
+    .input-group
+      span.input-group-btn: button.btn.btn-danger type='submit' data-confirm=t('rep.send_are_you_sure') #{t('rep.send_btn')}
+      = text_field_tag :recipient_email, '', class: 'form-control', placeholder: t('rep.send_recipient_placeholder')

data/app/views/rails_email_preview/emails/_toolbar.html.slim

@@ -0,0 +1,13 @@
+.btn-toolbar.pull-right
+  .btn-group
+    - I18n.available_locales.each do |locale|
+      a.btn href=rails_email_preview.rep_email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s)
+        = locale
+
+  .btn-group
+    - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
+      a.btn href=rails_email_preview.rep_email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime)
+        = label
+
+  - if RailsEmailPreview.enable_send_email
+    .btn-group= render 'rails_email_preview/emails/send_form'

data/app/views/rails_email_preview/emails/index.html.slim

@@ -1,10 +1,16 @@
-h1 Application emails
-ul.list-unstyled
-  - @preview_class_names.each do |m|
-    li.col-lg-6.col-sm-6
-      h2= m.underscore.sub(/(_mailer)?_preview$/, '').humanize
-      ul.list-group
-        - m.constantize.instance_methods(false).map(&:to_s).each do |method|
-          li.list-group-item
-            a href=rails_email_preview.rep_email_url(mail_class: m.to_s.underscore, mail_action: method.to_s, email_locale: @email_locale)
-              = method.to_s.humanize
+h1 #{t 'rep.list_title'}
+
+- previews_group = proc do |m|
+  - capture do
+    h2= m.underscore.sub(/(_mailer)?_preview$/, '').humanize
+    ul.list-group
+      - email_methods(m).each do |method|
+        li.list-group-item
+          a href=rails_email_preview.rep_email_url(mail_class: m.to_s.underscore, mail_action: method.to_s, email_locale: @email_locale)
+            = method.to_s.humanize
+
+.row
+  - split_in_halves(@preview_class_names) { |c| email_methods(c).length } .each do |classes|
+    .col-sm-6
+      - classes.each do |class_name|
+        = previews_group.call(class_name)

data/app/views/rails_email_preview/emails/show.html.slim

@@ -1,11 +1,14 @@
-a.btn.btn-link href=rails_email_preview.rep_emails_url(email_locale: @email_locale) « Back to list
+.row
+  .pull-left
+    a.btn.btn-link href=rails_email_preview.rep_emails_url(email_locale: @email_locale) « #{t 'rep.back_to_list'}
+  .margin-right= render 'rails_email_preview/emails/toolbar'
 
-#email-show
-  -# email format and language
-  .pull-right = render 'rails_email_preview/emails/options'
-
-  -# from, to, subject
+#email-show: .row
+  -# From, To, Subject and other
   = render 'rails_email_preview/emails/headers'
+  -# Locale, format and actions
 
 -# actual email content, rendered in an iframe to prevent browser styles from interfering
-= render 'rails_email_preview/emails/email_iframe'
+.row
+  .margin-right
+    = render 'rails_email_preview/emails/email_iframe'

data/config/initializers/rails_email_preview.rb

@@ -1,18 +1,26 @@
 require 'rails_email_preview'
 
-#= Premailer
+#= REP hooks and config
+#RailsEmailPreview.setup do |config|
 #
-# # process preview with premailer-rails:
-# RailsEmailPreview.before_render { |message| Premailer::Rails::Hook.delivering_email(message) }
-# # process preview with actionmailer-inline-css:
-# RailsEmailPreview.before_render { |message| ActionMailer::InlineCssHook.delivering_email(message) }
+#  # hook before rendering preview:
+#  config.before_render do |message, preview_class_name, mailer_action|
+#    # apply premailer-rails:
+#    Premailer::Rails::Hook.delivering_email(message)
+#    # or actionmailer-inline-css:
+#    ActionMailer::InlineCssHook.delivering_email(message)
+#  end
+#
+#  # do not show Send Email button
+#  config.enable_send_email = false
+#end
 
-#= Comfortable Mexican Sofa
+#= REP + Comfortable Mexican Sofa integration
 #
 # # enable comfortable_mexican_sofa integration:
 # require 'rails_email_preview/integrations/comfortable_mexica_sofa'
 
-#= Application-specific
+#= Application-specific (layout, permissions, customizations)
 #
 # # You can specify a controller for RailsEmailPreview::ApplicationController to inherit from:
 # RailsEmailPreview.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'

data/config/locales/rep.en.yml

@@ -0,0 +1,12 @@
+en:
+  rep:
+    test_deliver:
+      no_delivery_method: Please set "config.action_mailer.delivery_method" to send emails in "%{environment}" environment
+      provide_email: Send to which address?
+      sent_notice: "Sent to %{address} via %{delivery_method}"
+    list_title: Application Emails
+    back_to_list: Back to list
+    send_recipient_placeholder: Email
+    send_btn: Send to
+    send_are_you_sure: This will actually send this email. Are you sure?
+

data/config/routes.rb

@@ -3,6 +3,7 @@ RailsEmailPreview::Engine.routes.draw do
 
   get 'raw/:mail_class/:mail_action' => 'emails#show_raw', as: :rep_raw_email
   get ':mail_class/:mail_action' => 'emails#show', as: :rep_email
+  post 'test_deliver/:mail_class/:mail_action' => 'emails#test_deliver', as: :rep_test_deliver
 
   # define alias for the root url as part of stable api
   get '/' => 'emails#index', as: :rep_root

data/lib/rails_email_preview.rb

@@ -2,6 +2,7 @@
 require 'rails_email_preview/engine'
 require 'rails_email_preview/main_app_route_delegator'
 require 'rails_email_preview/version'
+require 'rails_email_preview/delivery_handler'
 
 require 'slim'
 require 'slim-rails'
@@ -14,10 +15,14 @@ module RailsEmailPreview
   # auto-loading configured in initializer
   mattr_accessor :preview_classes
 
+  # send email button (experimental, false by default)
+  mattr_accessor :enable_send_email
+  self.enable_send_email = true
+
   class << self
-    def run_before_render(mail)
+    def run_before_render(mail, preview_class_name, mailer_action)
       (defined?(@hooks) && @hooks[:before_render] || []).each do |block|
-        block.call(mail)
+        block.call(mail, preview_class_name, mailer_action)
       end
     end
 

data/lib/rails_email_preview/delivery_handler.rb

@@ -0,0 +1,15 @@
+module RailsEmailPreview
+  class DeliveryHandler
+    def initialize(mail, headers)
+      @mail = mail
+      @mail.headers(headers)
+      @mail.delivery_handler = self
+    end
+      
+    attr_accessor :mail
+      
+    def deliver_mail(mail)
+      yield
+    end
+  end
+end

data/lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # simply require this file to enable Comfortable Mexican Sofa integration
 # read more https://github.com/glebm/rails_email_preview/wiki/Edit-Emails-with-Comfortable-Mexican-Sofa
 
@@ -48,7 +49,7 @@ module RailsEmailPreview
         result = (content || fallback_content).to_s
 
         # If rendering in preview from admin, add edit/create lnk
-        if caller.grep(/emails_controller/).present?
+        if caller.grep(/rails_email_preview\/emails_controller/).present? && !caller.grep(/rails_email_preview\/delivery_handler/).present?
           snippet = site.snippets.find_by_identifier(snippet_id)
 
 
@@ -67,11 +68,10 @@ module RailsEmailPreview
                        })
                      end
 
-          result = safe_join [result, "\n\n",
-                              "<table><tr><td>".html_safe,
+          result = safe_join ["<table class='rep-edit-link'><tr><td>".html_safe,
                               cms_edit_email_snippet_link(cms_path),
                               "</td></tr></table>".html_safe,
-                              "\n"]
+                              "\n\n", result]
         end
         result
       end

data/lib/rails_email_preview/version.rb

@@ -1,3 +1,3 @@
 module RailsEmailPreview
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_email_preview
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,17 +110,20 @@ files:
 - app/views/layouts/rails_email_preview/application.html.slim
 - app/views/rails_email_preview/emails/_email_iframe.html.slim
 - app/views/rails_email_preview/emails/_headers.html.slim
-- app/views/rails_email_preview/emails/_options.html.slim
+- app/views/rails_email_preview/emails/_send_form.html.slim
+- app/views/rails_email_preview/emails/_toolbar.html.slim
 - app/views/rails_email_preview/emails/index.html.slim
 - app/views/rails_email_preview/emails/show.html.slim
 - lib/generators/rails_email_preview/install_generator.rb
 - lib/generators/rails_email_preview/update_previews_generator.rb
+- lib/rails_email_preview/delivery_handler.rb
 - lib/rails_email_preview/engine.rb
 - lib/rails_email_preview/integrations/comfortable_mexica_sofa.rb
 - lib/rails_email_preview/main_app_route_delegator.rb
 - lib/rails_email_preview/version.rb
 - lib/rails_email_preview.rb
 - config/initializers/rails_email_preview.rb
+- config/locales/rep.en.yml
 - config/routes.rb
 - MIT-LICENSE
 - Rakefile

data/app/views/rails_email_preview/emails/_options.html.slim

@@ -1,9 +0,0 @@
-p.btn-group
-  - { 'text/html' => 'HTML', 'text/plain' => 'Text', 'raw' => 'Raw'}.each do |mime, label|
-    a.btn.btn-link href=rails_email_preview.rep_email_url(params.merge(part_type: mime)) class=('active' if @part_type == mime)
-      = label
-br
-p.btn-group
-  - I18n.available_locales.each do |locale|
-    a.btn.btn-link href=rails_email_preview.rep_email_url(params.merge(part_type: @part_type, email_locale: locale)) class=('active' if @email_locale == locale.to_s)
-      = locale