radiant-mailer_confirmation-extension 1.0.0

data/README.md

@@ -0,0 +1,26 @@
+# Mailer Confirmation
+
+Allows you to set up a second email to the form submitter that differs from the email sent to regular mail receiver. 
+
+## Requirements
+
+[Radiant Mailer extension](https://github.com/radiant/radiant-mailer-extension/) is required.
+
+## Configuration
+
+Create a page part 'confirmation_email' in which you can compose the email in the same way as in the usual 'email' page part. There is no code to cater for 'confirmation_html_email'. If you need that functionality and write it yourself, please send me a pull request. If you would like you can [contact me](mailto:hi@monkeypatch.be) to write this for you for a small fee.
+
+In the 'mailer' page part, add these fields:
+
+		confirmation_from_field: foo@example.com
+
+The from: that will be used for the confirmation mail. This is optional; if not present this will default to the 'from_field' or 'from' config entries.
+
+		confirmation_subject: Thank you for reaching out to us
+
+The subject of the confirmation email. Will default to 'Confirmation email'.
+
+		confirmation_recipients_field: email
+
+This is the only required field. It defines in which POSTed form field the recipient of the confirmation mail can be found.
+Unlike the mailer extension, there is no 'confirmation_recipients' config entry, as it didn't make sense to me.

data/Rakefile

@@ -0,0 +1,123 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the mailer_confirmation extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MailerConfirmationExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the mailer_confirmation extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+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__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :mailer_confirmation
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/mailer_confirmation/mail_extensions.rb

@@ -0,0 +1,35 @@
+module MailerConfirmation
+  module MailExtensions
+    
+    def self.included(base)
+      base.class_eval { 
+        alias_method_chain :send, :confirmation 
+      }
+    end
+    
+    def send_with_confirmation
+      if sent? && !page.part(:confirmation_email).nil? # Only if the original mail succeeded and confirmation mail is set up.
+        confirmation_body = page.render_part( :confirmation_email )
+        from_address = data[config[:confirmation_from_field]] || data[config[:from_field]] || config[:from]
+        subject = config[:confirmation_subject] || "Confirmation email"
+
+        headers = { 'Reply-To' => from_address, 'Return-Path' => from_address, 'Sender' => from_address }
+        recipients = data[config[:confirmation_recipients_field]].split(/,/).collect{|e| e.strip}
+        
+        raise StandardError, "Recipients field was left blank, email not sent." if recipients.empty?
+
+        Mailer.deliver_generic_mail(
+          :recipients => recipients,
+          :from => from_address,
+          :subject => subject,
+          :plain_body => confirmation_body,
+          :headers => headers
+        )
+        send_without_confirmation
+      else
+        send_without_confirmation
+      end
+    end
+    
+  end
+end

data/lib/radiant-mailer_confirmation-extension.rb

@@ -0,0 +1,8 @@
+module RadiantMailerConfirmationExtension
+  VERSION     = "1.0.0"
+  SUMMARY     = "Confirmation emails for Radiant CMS's mailer extension"
+  DESCRIPTION = "Allows you to set up a second email to the form submitter that differs from the email sent to regular mail receiver."
+  URL         = "https://github.com/jomz/radiant-mailer_confirmation-extension"
+  AUTHORS     = ["Benny Degezelle"]
+  EMAIL       = ["benny@gorilla-webdesign.be"]
+end

data/mailer_confirmation_extension.rb

@@ -0,0 +1,15 @@
+require "radiant-mailer_confirmation-extension"
+
+class MailerConfirmationExtension < Radiant::Extension
+  version     RadiantMailerConfirmationExtension::VERSION
+  description RadiantMailerConfirmationExtension::DESCRIPTION
+  url         RadiantMailerConfirmationExtension::URL
+  
+  def activate
+    Mail.send :include, MailerConfirmation::MailExtensions
+  end
+  
+  def deactivate
+  end
+  
+end

data/radiant-mailer_confirmation-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-mailer_confirmation-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-mailer_confirmation-extension"
+  s.version     = RadiantMailerConfirmationExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantMailerConfirmationExtension::AUTHORS
+  s.email       = RadiantMailerConfirmationExtension::EMAIL
+  s.homepage    = RadiantMailerConfirmationExtension::URL
+  s.summary     = RadiantMailerConfirmationExtension::SUMMARY
+  s.description = RadiantMailerConfirmationExtension::DESCRIPTION
+
+  # Define gem dependencies here.
+  # Don't include a dependency on radiant itself: it causes problems when radiant is in vendor/radiant.
+  # s.add_dependency "something", "~> 1.0.0"
+  s.add_dependency "radiant-mailer-extension"
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: radiant-mailer_confirmation-extension
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: radiant-mailer-extension
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows you to set up a second email to the form submitter that differs
+  from the email sent to regular mail receiver.
+email:
+- benny@gorilla-webdesign.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- cucumber.yml
+- features/support/env.rb
+- features/support/paths.rb
+- lib/mailer_confirmation/mail_extensions.rb
+- lib/radiant-mailer_confirmation-extension.rb
+- mailer_confirmation_extension.rb
+- radiant-mailer_confirmation-extension.gemspec
+- Rakefile
+- README.md
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/jomz/radiant-mailer_confirmation-extension
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.26
+signing_key: 
+specification_version: 3
+summary: Confirmation emails for Radiant CMS's mailer extension
+test_files:
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb