radiant-mailer-extension 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+.svn
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nathaniel Talbott, Sean Cribbs, Matt McCray
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,95 @@
+= Mailer Extension for Radiant
+
+The Mailer extension enables form mail on a page.
+
+
+== Usage
+
+You can define email templates using pages parts (email, and/or email_html).
+You configure the recipients and other Mailer settings in a "mailer" part:
+
+  subject: From the website of Whatever
+  from: noreply@example.com
+  redirect_to: /contact/thank-you
+  recipients:
+    - one@one.com
+    - two@two.com
+
+The following tags are available to help you build the form:
+
+  <r:mailer:form name=""> ... </r:mailer:form> 
+  <r:mailer:text name="" /> 
+  <r:mailer:checkbox name="" />
+  <r:mailer:radio name="" />
+  <r:mailer:radiogroup name=""> ... </r:mailer:radiogroup>
+  <r:mailer:select name=""> ... </r:mailer:select>
+  <r:mailer:date_select name=""/>
+  <r:mailer:textarea name=""> ... </r:mailer:textarea>
+  <r:mailer:option name="" />
+
+When processing the form (in email and email_html), the following tags are 
+available:
+
+  <r:mailer:get name="" />
+  <r:mailer:get_each name=""> ... </r:mailer:get_each>
+    <r:mailer:index />
+
+Simple example of a form:
+
+  <r:mailer:form>
+   <r:mailer:hidden name="subject" value="Email from my Radiant site!" /> <br/>
+    Name:<br/>
+   <r:mailer:text name="name" /> <br/>
+    Message:<br/>
+   <r:mailer:textarea name="message" /> <br/>
+   <input type="submit" value="Send" />
+  </r:mailer:form>
+
+
+== User-provided Configuration
+
+Sometimes, rather than explicitly configuring the recipients and such in the mailer part, you'd rather have them passed in by the person submitting the form. Mailer supports this by allowing you to specify a form field to pull the value from:
+
+  from_field: my_form_field_that_contains_the_from_email_address
+  
+Then you just have to add that field to your mailer form and you're all set.
+
+This is supported for the from (from_field), recipients (recipients_field) and reply_to (reply_to_field) properties.
+
+
+== Enabling action_mailer
+
+In environment.rb you'll probably need to change:
+
+  config.frameworks -= [ :action_mailer ]
+
+to:
+
+  config.frameworks -= []
+
+
+== Caveats
+
+Relative urls will almost certainly not work if the mailer fails validation. Solution? Only use absolute urls.
+
+
+== History
+
+Created by: M@ McCray - mattmccray.com
+  Version: 0.2.1
+  Contact: mmccray@elucidata.net
+
+Ported to 'mental' by: Sean Cribbs - seancribbs.com
+  Version: 0.1
+  Contact: seancribbs@gmail.com
+  
+Seriously restructured by: Nathaniel Talbott - terralien.com
+  Version: 0.2
+  Contact: nathaniel@terralien.com
+  Work sponsored by: Ignite Social Media, http://ignitesocialmedia.com/
+
+
+== Todo
+
+* Support for file attachments to emails
+* Tests

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-mailer-extension"
+    gem.summary = %Q{Enables form mail on a page.}
+    gem.description = %Q{An extension for Radiant CMS that allows you to create 'contact us' and other mail-bound forms.}
+    gem.email = "radiant@radiantcms.org"
+    gem.homepage = "http://github.com/radiant/radiant-mailer-extension"
+    gem.authors = ["Nathaniel Talbott", "Sean Cribbs", "Matt McCray"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "radiant-mailer-extension #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/mail_controller.rb

@@ -0,0 +1,37 @@
+class MailController < ApplicationController
+
+  no_login_required
+  skip_before_filter :verify_authenticity_token  
+
+  def create
+    @page = Page.find(params[:page_id])
+    @page.request, @page.response = request, response
+
+    config, part_page = config_and_page(@page)
+
+    mail = Mail.new(part_page, config, params[:mailer])
+    @page.last_mail = part_page.last_mail = mail
+    process_mail(mail, config)
+
+    if mail.send
+      redirect_to (config[:redirect_to] || "#{@page.url}#mail_sent")
+    else
+      render :text => @page.render
+    end
+  end
+  
+  private
+  
+  # Hook here to do additional things, like check a CAPTCHA
+  def process_mail(mail, config)
+  end
+
+  def config_and_page(page)
+    until page.part(:mailer) or (not page.parent)
+      page = page.parent
+    end
+    string = page.render_part(:mailer)
+    [(string.empty? ? {} : YAML::load(string).symbolize_keys), page]
+  end
+
+end

data/app/models/mail.rb

@@ -0,0 +1,121 @@
+class Mail
+  attr_reader :page, :config, :data, :errors
+  def initialize(page, config, data)
+    @page, @config, @data = page, config.with_indifferent_access, data
+    @required = @data.delete(:required)
+    @errors = {}
+  end
+
+  def self.valid_config?(config)
+    return false if config['recipients'].blank? and config['recipients_field'].blank?
+    return false if config['from'].blank? and config['from_field'].blank?
+    true
+  end
+
+  def valid?
+    unless defined?(@valid)
+      @valid = true
+      if recipients.blank? and !is_required_field?(config[:recipients_field])
+        errors['form'] = 'Recipients are required.'
+        @valid = false
+      end
+
+      if recipients.any?{|e| !valid_email?(e)}
+        errors['form'] = 'Recipients are invalid.'
+        @valid = false
+      end
+
+      if from.blank? and !is_required_field?(config[:from_field])
+        errors['form'] = 'From is required.'
+        @valid = false
+      end
+
+      if !valid_email?(from)
+        errors['form'] = 'From is invalid.'
+        @valid = false
+      end
+
+      if @required
+        @required.each do |name, msg|
+          if data[name].blank?
+            errors[name] = ((msg.blank? || %w(1 true required).include?(msg)) ? "is required." : msg)
+            @valid = false
+          end
+        end
+      end
+    end
+    @valid
+  end
+
+  def from
+    config[:from] || data[config[:from_field]]
+  end
+
+  def recipients
+    config[:recipients] || data[config[:recipients_field]].split(/,/).collect{|e| e.strip}
+  end
+
+  def reply_to
+    config[:reply_to] || data[config[:reply_to_field]]
+  end
+
+  def sender
+    config[:sender]
+  end
+
+  def subject
+    data[:subject] || config[:subject] || "Form Mail from #{page.request.host}"
+  end
+  
+  def cc
+    data[config[:cc_field]] || config[:cc] || ""
+  end
+  
+  def send
+    return false if not valid?
+
+    plain_body = (page.part( :email ) ? page.render_part( :email ) : page.render_part( :email_plain ))
+    html_body = page.render_part( :email_html ) || nil
+
+    if plain_body.blank? and html_body.blank?
+      plain_body = <<-EMAIL
+The following information was posted:
+#{data.to_hash.to_yaml}
+      EMAIL
+    end
+
+    headers = { 'Reply-To' => reply_to || from }
+    if sender
+      headers['Return-Path'] = sender
+      headers['Sender'] = sender
+    end
+
+    Mailer.deliver_generic_mail(
+      :recipients => recipients,
+      :from => from,
+      :subject => subject,
+      :plain_body => plain_body,
+      :html_body => html_body,
+      :cc => cc,
+      :headers => headers
+    )
+    @sent = true
+  rescue Exception => e
+    errors['base'] = e.message
+    @sent = false
+  end
+
+  def sent?
+    @sent
+  end
+
+  protected
+
+  def valid_email?(email)
+    (email.blank? ? true : email =~ /.@.+\../)
+  end
+  
+  def is_required_field?(field_name)
+    @required && @required.any? {|name,_| name == field_name}
+  end
+end

data/app/models/mailer.rb

@@ -0,0 +1,19 @@
+class Mailer < ActionMailer::Base
+  def generic_mail(options)
+    @recipients = options[:recipients]
+    @from = options[:from] || ""
+    @cc = options[:cc] || ""
+    @bcc = options[:bcc] || ""
+    @subject = options[:subject] || ""
+    @headers = options[:headers] || {}
+    # Not sure that charset works, can see no effect in tests
+    @charset = options[:charset] || "utf-8"
+    @content_type = "multipart/alternative"
+    if options.has_key? :plain_body
+      part :content_type => "text/plain", :body => (options[:plain_body] || "")
+    end
+    if options.has_key? :html_body and !options[:html_body].blank?
+      part :content_type => "text/html", :body => (options[:html_body] || "")
+    end
+  end
+end

data/lib/mailer_process.rb

@@ -0,0 +1,36 @@
+module MailerProcess
+  def self.included(base)
+    base.class_eval { 
+      alias_method_chain :process, :mailer 
+      attr_accessor :last_mail
+    }
+  end
+
+  def process_with_mailer(request, response)
+    # If configured to do so, receive and process the mailer POST
+    if Radiant::Config['mailer.post_to_page?'] && request.post? && request.parameters[:mailer]
+      config, part_page = mailer_config_and_page
+
+      mail = Mail.new(part_page, config, request.parameters[:mailer])
+      self.last_mail = part_page.last_mail = mail
+
+      if mail.send
+        response.redirect(config[:redirect_to], "302 Found") and return if config[:redirect_to]
+        # Clear out the data and errors so the form isn't populated, but keep the success status around.
+        self.last_mail.data.delete_if { true }
+        self.last_mail.errors.delete_if { true }
+      end
+    end
+    process_without_mailer(request, response)
+  end
+
+  private
+    def mailer_config_and_page
+      page = self
+      until page.part(:mailer) or (not page.parent)
+        page = page.parent
+      end
+      string = page.render_part(:mailer)
+      [(string.empty? ? {} : YAML::load(string).symbolize_keys), page]
+    end
+end