radiant-database_mailer-extension 1.0.1

data/config/routes.rb

@@ -0,0 +1,7 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin do |admin|
+    admin.resources :form_datas do |form_data|
+      form_data.resources :form_data_assets
+    end
+  end
+end

data/database_mailer_extension.rb

@@ -0,0 +1,31 @@
+require_dependency 'application_controller'
+require 'radiant-database_mailer-extension/version'
+
+class DatabaseMailerExtension < Radiant::Extension
+  version     RadiantDatabaseMailerExtension::VERSION
+  description RadiantDatabaseMailerExtension::DESCRIPTION
+  url         RadiantDatabaseMailerExtension::URL
+  
+  def activate
+    throw "MailerExtension must be loaded before DatabaseMailerExtension" unless defined?(MailerExtension)
+    MailController.class_eval do
+      include DatabaseMailerProcessing
+      alias_method_chain :process_mail, :database
+    end
+
+    MailerProcess.class_eval do
+      include DatabaseMailerProcessing
+      alias_method_chain :process_mail, :database
+    end
+    admin.tabs.add "Database Mailer", "/admin/form_datas", :after => "Layouts", :visibility => [:all]
+
+    tab "Content" do
+      add_item "Database Mailer", "/admin/form_datas"
+    end
+
+    Mime::Type.register "application/vnd.ms-excel", :xls
+  end
+
+  def deactivate
+  end
+end

data/db/migrate/001_create_form_datas.rb

@@ -0,0 +1,16 @@
+class CreateFormDatas < ActiveRecord::Migration
+  def self.up
+    create_table :form_datas do |t|
+      t.column :url, :string
+      t.column :blob, :text
+      t.column :exported, :datetime
+      t.timestamps
+    end
+    
+    add_index :form_datas, :url
+  end
+
+  def self.down
+    drop_table :form_datas
+  end
+end

data/db/migrate/002_add_data_columns.rb

@@ -0,0 +1,13 @@
+class AddDataColumns < ActiveRecord::Migration
+  def self.up
+    DATABASE_MAILER_COLUMNS.each do |k, v|
+      unless FormData.column_names.include?(k.to_s)
+        add_column(:form_datas, k, v)
+        add_index(:form_datas, k) unless v == :text
+      end
+    end
+  end
+  
+  def self.down
+  end
+end

data/db/migrate/20090722135916_create_form_data_assets.rb

@@ -0,0 +1,21 @@
+class CreateFormDataAssets < ActiveRecord::Migration
+  def self.up
+    create_table :form_data_assets do |t|
+      t.references :form_data
+      t.string :field_name
+      t.string :attachment_file_name
+      t.string :attachment_content_type
+      t.integer :attachment_file_size
+      t.datetime :attachment_updated_at
+    
+      t.timestamps
+    end
+    
+    add_index :form_data_assets, :form_data_id
+  end
+
+  def self.down
+    remove_index :form_data_assets, :form_data_id
+    drop_table :form_data_assets
+  end
+end

data/features/datasets/database_mailer_dataset.rb

@@ -0,0 +1,19 @@
+class DatabaseMailerDataset < Dataset::Base
+  
+  def load
+    create_record :form_datas, :eric_cartman, {
+      :name => "Eric Cartman",
+      :email => "eric_cartman@example.com",
+      :message => "test message"
+    }
+    
+    create_record :form_data_assets, :attachment, {
+      :form_data_id => form_datas(:eric_cartman).id,
+      :field_name => "attachment",
+      :attachment_file_name => "attachment.jpg",
+      :attachment_content_type => "image/jpg",
+      :attachment_file_size => "1234"
+    }
+  end
+  
+end

data/features/datasets/mailers_dataset.rb

@@ -0,0 +1,69 @@
+class MailersDataset < Dataset::Base
+  uses :home_page
+  
+  def load    
+    create_page "Contact" do
+      create_page_part "contact_body", 
+        :name => "body", 
+        :content => %Q{
+          <r:mailer:form>
+            <label for="name">Name:</label><br/>
+            <r:mailer:text name="name" /><br/>
+
+            <label for="email">Email:</label><br/>
+            <r:mailer:text name="email" /><br/>
+            
+            <label for="message">Message:</label><br/>
+            <r:mailer:textarea name="message" /> <br/>
+            
+            <label for="attachment">Image:</label><br/>
+            <r:mailer:file name="attachment" /><br/>
+            
+            <input type="submit" value="Send" />
+          </r:mailer:form>}          
+          
+      create_page_part "contact_mailer",
+        :name => "mailer",
+        :content =>  %Q{
+          subject: Contact email
+          from: website@example.com
+          redirect_to: /contact/thank-you
+          recipients:
+            - contact@example.com
+          }
+      create_page "Thank you"
+    end
+    
+    create_page "Contact No Save" do
+      create_page_part "contact_body_no_save", 
+        :name => "body", 
+        :content => %Q{
+          <r:mailer:form>
+            <label for="name">Name:</label><br/>
+            <r:mailer:text name="name" /><br/>
+
+            <label for="email">Email:</label><br/>
+            <r:mailer:text name="email" /><br/>
+            
+            <label for="message">Message:</label><br/>
+            <r:mailer:textarea name="message" /> <br/>
+            
+            <label for="attachment">Image:</label><br/>
+            <r:mailer:file name="attachment" /><br/>
+            
+            <input type="submit" value="Send" />
+          </r:mailer:form>}
+          
+      create_page_part "mailer_no_save",
+        :name => 'mailer',
+        :content =>  %Q{
+          subject: Contact email
+          from: website@example.com
+          redirect_to: /contact/thank-you
+          save_to_database: false
+          recipients:
+            - contact@example.com
+          }
+    end
+  end  
+end

data/features/saving_emails_to_database.feature

@@ -0,0 +1,45 @@
+Feature: Database Mailer
+  In order to add database persistency to emailed forms
+  As an admin
+  I want to manage form fields
+  
+  Background:
+    Given I am logged in as an admin
+
+  Scenario: Saving an email to database if 'save_to_database' is true
+    Given I am on the contact page
+      And I fill in "Name" with "Stan Marsh"
+      And I fill in "Email" with "stan_marsh@example.com"
+      And I fill in "Message" with "Hello from South Park"
+      And I fill in "attachment"
+     When I press "Send"
+          # email is sent
+     Then I should be on the thank you page
+      And "contact@example.com" should receive 1 email
+          # email is saved to database
+     When I go to the form datas index
+     Then I should see "Stan Marsh"
+      And I should see "Hello from South Park"
+          # email attachment is saved to database
+     When I follow "Show"
+     Then I should see "attachment.jpg"
+
+  Scenario: Sending an email without saving it to the database
+    Given I am on the contact no save page
+      And I fill in "Name" with "Stan Marsh"
+      And I fill in "Email" with "stan_marsh@example.com"
+      And I fill in "Message" with "Hello from South Park"
+      And I fill in "attachment"
+     When I press "Send"
+     Then I should be on the thank you page
+      And "contact@example.com" should receive 1 email
+     When I go to the form datas index
+     Then I should not see "Stan Marsh"
+      And I should not see "Hello from South Park"
+  
+  Scenario: Deleting an existing form data
+    Given I am on the form datas index
+     When I follow "Delete"
+     Then I should be on the form datas index
+      And I should see "Record deleted!"
+      And I should not see "Eric Cartman"

data/features/step_definitions/admin_steps.rb

@@ -0,0 +1,6 @@
+Given /^I am logged in as an admin$/ do
+  Given "I go to to \"the welcome page\""
+  When "I fill in \"Username\" with \"admin\""
+  When "I fill in \"Password\" with \"password\""
+  When "I press \"Login\""
+end

data/features/step_definitions/email_steps.rb

@@ -0,0 +1,73 @@
+#Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# reset_mailer 
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+
+module EmailHelpers
+  def current_email_address
+    "example@aissac.ro" # Replace with your a way to find your current_email. e.g current_user.email
+  end
+end
+World(EmailHelpers)
+
+# Use this step to reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+# Use this step to open the most recently sent e-mail. 
+When /^I open the email$/ do
+  open_email(current_email_address)
+end
+
+When %r{^I follow "([^"]*?)" in the email$} do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (an|\d+) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount.to_i
+end
+
+Then %r{^"([^"]*?)" should receive (\d+) emails?$} do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then %r{^"([^"]*?)" should not receive an email$} do |address|
+  find_email(address).should be_nil
+end
+
+Then %r{^I should see "([^"]*?)" in the subject$} do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then %r{^I should see "([^"]*?)" in the email$} do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^I click the first link in the email$/ do
+  click_first_link_in_email
+end

data/features/step_definitions/form_data_steps.rb

@@ -0,0 +1,3 @@
+Given /^I fill in "([^\"]*)"$/ do |field|
+  fill_in(field, :with => "#{RAILS_ROOT}/vendor/extensions/database_mailer/features/fixtures/attachment.jpg")
+end

data/features/step_definitions/webrat_steps.rb

@@ -0,0 +1,119 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value) 
+end
+
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field) 
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time 
+When /^I select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or 
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it. 
+When /^I select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^I select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field) 
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field) 
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response.should contain(text)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response.should_not contain(text)
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should_not =~ /#{value}/
+end
+    
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  field_labeled(label).should be_checked
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  field_labeled(label).should_not be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  URI.parse(current_url).path.should == path_to(page_name)
+end

data/features/support/env.rb

@@ -0,0 +1,28 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+ 
+require 'cucumber/rails/world'
+require 'cucumber/formatter/unicode' # Comment out this line if you don't want Cucumber Unicode support
+
+require 'webrat'
+ 
+Webrat.configure do |config|
+  config.mode = :rails
+end
+
+require 'spec'
+require 'email_spec/cucumber'
+
+# Comment out the next two lines if you're not using RSpec's matchers (should / should_not) in your steps.
+require 'cucumber/rails/rspec'
+require 'webrat/core/matchers'
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  dataset :pages, :users, :mailers, :database_mailer
+end

data/features/support/paths.rb

@@ -0,0 +1,25 @@
+module NavigationHelpers
+  def path_to(page_name)
+    case page_name
+    
+    when /the welcome page/
+      admin_path
+    when /the contact page/
+      '/contact'
+    when /the contact no save page/
+      '/contact-no-save'
+    when /the thank you page/
+      '/contact/thank-you'
+    when /the form datas index/
+      admin_form_datas_path
+    
+    # Add more page name => path mappings here
+    
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in features/support/paths.rb"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/lib/radiant-database_mailer-extension.rb

@@ -0,0 +1,8 @@
+module RadiantDatabaseMailerExtension
+  VERSION     = '1.0.1'
+  SUMMARY     = %q{Database mailer for Radiant CMS}
+  DESCRIPTION = %q{Save fields from mailer forms to the database.}
+  URL         = "http://blog.aissac.ro/radiant/database-mailer-extension/"
+  AUTHORS     = ["Cristi Duma", "Istvan Hoka"]
+  EMAIL       = ["cristi.duma@aissac.ro"]
+end

data/lib/tasks/database_mailer_extension_tasks.rake

@@ -0,0 +1,31 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :database_mailer do
+      
+      desc "Runs the migration of the Database Mailer extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        
+        DatabaseMailerExtension.migrator.set_schema_version(1) if DatabaseMailerExtension.migrator.current_version > 1
+        
+        if ENV["VERSION"]
+          DatabaseMailerExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          DatabaseMailerExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Database Mailer to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from DatabaseMailerExtension"
+        Dir[DatabaseMailerExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(DatabaseMailerExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end  
+    end
+  end
+end

data/public/javascripts/admin/database_mailer.js

@@ -0,0 +1,73 @@
+document.observe("dom:loaded", function () {
+  var element = $('expander');
+  element.observe('click', function() {
+    if (element.up('#filters').hasClassName('expanded')) {
+      hideForm()
+    } else {
+      showForm()
+    }
+  });
+  center('blob-popup');
+});
+
+function hideForm() {
+  Effect.SlideUp('form',{ duration: 0.5, afterFinish:function() {
+    $('expander').up('#filters').removeClassName('expanded')
+    }
+  });
+}
+
+function showForm () {
+  $('expander').up('#filters').addClassName('expanded')
+    Effect.SlideDown('form', { duration: 0.5 });
+}
+
+function close() {
+  if ($('expander').up('#filters').hasClassName('expanded')) {
+    hideForm()
+  }
+}
+
+
+document.observe("dom:loaded", function () {
+  var element = $('x_expander');
+  element.observe('click', function() {
+    if (element.up('#x_filters').hasClassName('expanded')) {
+      hideXForm()
+    } else {
+      showXForm()
+    }
+   });
+});
+
+function hideXForm() {
+  Effect.SlideUp('x_form',{ duration: 0.5, afterFinish:function() {
+    $('x_expander').up('#x_filters').removeClassName('expanded')
+    }
+  });
+}
+
+function showXForm () {
+  $('x_expander').up('#x_filters').addClassName('expanded')
+    Effect.SlideDown('x_form', { duration: 0.5 });
+}
+
+function closeX() {
+  if ($('x_expander').up('#x_filters').hasClassName('expanded')) {
+    hideXForm()
+  }
+}
+
+function show_details() {
+  $('attachments').hide();
+  $('details').show();
+  $('details_lnk').addClassName('here');
+  $('attachments_lnk').removeClassName('here');  
+}
+
+function show_attachments() {
+  $('attachments').show();
+  $('details').hide();
+  $('details_lnk').removeClassName('here');
+  $('attachments_lnk').addClassName('here');
+}