default-url-options-for-mailers 0.1.0

data/README.markdown

@@ -0,0 +1,66 @@
+## Overview
+`default-url-options-for-mailers` allows us to set or infer `ActionController::Base.default_url_options` within the context of a `ActionMailer` deliver event.
+
+This functionality is inspired by [How I Learned to Stop Hating and Love Action Mailer](http://pivotallabs.com/users/nick/blog/articles/281-how-i-learned-to-stop-hating-and-love-action-mailer "nick - How I Learned to Stop Hating and Love Action Mailer").  Quoting from that post heavily, `ActionMailer` makes it difficult to generate URL's. It's common enough when sending an email that it includes a link. But `ActionMailer`, by default, gives you no access to `url_for` or named routes.  One solution to this is to manually set `ActionController::Base.default_url_options`, but this is a global change and would affect all Controller actions.  Also, it is often preferable to have these values be inferred from the local environment.  `default-url-options-for-mailers` allows for setting or inferring these values within the context of a mail-sending action.
+
+## Installation
+Install `default-url-options-for-mailers` as a gem.
+
+## Usage
+Here is a sample initializer.
+
+     # your_rails_app/config/initializers/pivotal_initializers.rb
+     PivotalCore::Initializer::DefaultUrlOptionsForMailers.run do |config|
+       # *** Use this line to automatically derive protocol/host/port using incoming rails request:
+       # PivotalCore::Initializer::DefaultUrlOptionsForMailers.run
+       # config.action_controller.default_url_options_for_mailers = :infer_url_options
+
+       # *** Use this line to explicitly set protocol/host/port:
+       # config.action_controller.default_url_options_for_mailers = { :protocol => "http", :host => "example.com", :port => 3333 }
+
+       # *** Comment out both lines to disable any default URL option functionality for mailers.
+
+       # *** NOTE: ActionMailer::Base.default_url_options always takes precedence over this facility and if *any* options are
+       # *** set there, default_url_options_for_mailers does nothing.
+     end
+
+## Requirements
+To initialize properly, this gem requires Rails 2.3.8 or above.
+
+## Running Tests and Build Dependencies
+To run the tests and/or build the gem:
+
+     gem install jeweler -v1.5.1 --no-rdoc --no-ri
+     rake install_test_gems
+
+To run tests:
+
+     rake
+     # or
+     rake spec
+
+## MIT License
+
+Copyright (c) 2010 Pivotal Labs (www.pivotallabs.com)
+Contact email: info@pivotallabs.com
+
+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/lib/default_url_options_for_mailers/default_url_options_for_mailers.rb

@@ -0,0 +1,70 @@
+module PivotalCore
+  module RailsCoreExtensions
+    module DefaultUrlOptionsForMailers
+      module ActionController
+        def self.included(ac)
+          ac.module_eval do
+            include InstanceMethods
+            around_filter :set_default_url_options_for_mailers
+          end
+        end
+
+        module InstanceMethods
+          def set_default_url_options_for_mailers
+            save_current_url_options
+            begin
+              new_url_options = calculate_new_url_options
+              ::ActionMailer::Base.class_eval { self.default_url_options = new_url_options if default_url_options.empty? }
+
+              yield
+            ensure
+              restore_previous_url_options
+            end
+          end
+
+          private
+
+          def calculate_new_url_options
+            if ::ActionController::Base.default_url_options_for_mailers.is_a?(Hash)
+              returning(::ActionController::Base.default_url_options_for_mailers) do |url_options|
+                url_options.delete(:port) if standard_port?(self.request, url_options[:port])
+              end
+            elsif ::ActionController::Base.default_url_options_for_mailers == :infer_url_options
+              inferred_url_options_for(self.request)
+            else
+              raise "Invalid option for default_url_options_for_mailers: #{::ActionController::Base.default_url_options_for_mailers}"
+            end
+          end
+
+          def inferred_url_options_for(request)
+            returning({ :protocol => request.protocol, :host => request.host }) do |url_options|
+              url_options[:port] = request.port unless standard_port?(request, request.port)
+            end
+          end
+
+          def standard_port?(request, port)
+            port == request.standard_port
+          end
+
+          def save_current_url_options
+            ::ActionMailer::Base.class_eval do
+              @old_default_url_options = default_url_options.clone
+            end
+          end
+
+          def restore_previous_url_options
+            ::ActionMailer::Base.class_eval do
+              [:host, :port, :protocol].each do |key|
+                if @old_default_url_options.key?(key)
+                  default_url_options[key] = @old_default_url_options[key]
+                else
+                  default_url_options.delete(key)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/default_url_options_for_mailers/initializer.rb

@@ -0,0 +1,44 @@
+module PivotalCore
+  class Configuration
+    def action_controller
+      @action_controller ||= Rails::OrderedOptions.new
+    end
+
+    def active_record
+      @active_record ||= Rails::OrderedOptions.new
+    end
+  end
+
+  class Initializer
+    class DefaultUrlOptionsForMailers
+      def self.run
+        configuration = Configuration.new
+        yield(configuration) if block_given?
+
+        new(configuration).process
+      end
+
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def process
+        process_action_controller_configuration(@configuration)
+      end
+
+      private
+
+      def process_action_controller_configuration(configuration)
+        if configuration.action_controller.default_url_options_for_mailers
+          ActionController::Base.class_eval do
+            include PivotalCore::RailsCoreExtensions::DefaultUrlOptionsForMailers::ActionController
+          end
+          ActionController::Base.instance_eval do
+            cattr_accessor :default_url_options_for_mailers
+            self.default_url_options_for_mailers = configuration.action_controller.default_url_options_for_mailers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/default_url_options_for_mailers.rb

@@ -0,0 +1,2 @@
+require File.expand_path(File.join(File.dirname(__FILE__),'default_url_options_for_mailers','default_url_options_for_mailers'))
+require File.expand_path(File.join(File.dirname(__FILE__),'default_url_options_for_mailers','initializer'))

data/spec/default_url_options_for_mailers_spec.rb

@@ -0,0 +1,164 @@
+require File.join(File. dirname(__FILE__), "/spec_helper")
+
+class DefaultUrlOptionsForMailersController < ApplicationController
+  around_filter :set_default_url_options_for_mailers
+
+#  def rescue_action(e) ; raise e; end
+  def index
+    DefaultUrlOptionsForMailersMailer.deliver_mail_with_url
+    head :ok
+  end
+end
+
+class DefaultUrlOptionsForMailersMailer < ActionMailer::Base
+  def mail_with_url
+  end
+end
+
+shared_examples_for "a good URL options citizen" do
+  it "should preserve any pre-existing default_url_options which were explicitly set" do
+    ActionMailer::Base.default_url_options[:protocol] = "https://"
+    ActionMailer::Base.default_url_options[:host] = "mycustomhost"
+    ActionMailer::Base.default_url_options[:port] = 1234
+    execute_request(true, "NOTmycustomhost", "9999")
+    latest_mail_should_include_link("https://mycustomhost:1234/")
+  end
+
+  it "should not overwrite any options when default_url_options are partially defined" do
+    ActionMailer::Base.default_url_options[:protocol] = "https://"
+    ActionMailer::Base.default_url_options[:host] = "mycustomhost"
+    execute_request(true, "NOTmycustomhost", "9999")
+    latest_mail_should_include_link("https://mycustomhost/")
+  end
+
+  it "should keep port blank if originally blank" do
+    ActionMailer::Base.default_url_options.key?(:port).should be_false
+    execute_request(false, "host", "800")
+    ActionMailer::Base.default_url_options.key?(:port).should be_false
+  end
+end
+
+describe "default_url_options_for_mailer" do
+  include ActionController::TestProcess
+
+  before(:each) do
+    ActionMailer::Base.default_url_options = {}
+  end
+
+  context "when not used (outside of a request/controller)" do
+    it "should default to mailing from existing default_url_options" do
+      ActionMailer::Base.default_url_options[:protocol] = "https://"
+      ActionMailer::Base.default_url_options[:host] = "mycustomhost"
+      ActionMailer::Base.default_url_options[:port] = 1234
+      DefaultUrlOptionsForMailersMailer.deliver_mail_with_url
+      latest_mail_should_include_link("https://mycustomhost:1234/")
+    end
+  end
+
+  context "when explicitly disabled" do
+    before(:each) do
+#      configure_default_url_options_for_mailers_with(nil)
+      PivotalCore::Initializer::DefaultUrlOptionsForMailers.run { |config| config.action_controller.default_url_options_for_mailers = options }
+      @controller = DefaultUrlOptionsForMailersController.new      
+    end
+
+    it "should default to mailing from existing default_url_options" do
+      ActionMailer::Base.default_url_options[:protocol] = "https://"
+      ActionMailer::Base.default_url_options[:host] = "mycustomhost"
+      ActionMailer::Base.default_url_options[:port] = 1234
+      execute_request(false, "host", "800")
+      latest_mail_should_include_link("https://mycustomhost:1234/")
+    end
+  end
+
+  context "when set to an explicit hash" do
+    before(:each) do
+      configure_default_url_options_for_mailers_with({ :host => "example.com", :protocol => "http", :port => 4217 })
+    end
+
+    it_should_behave_like "a good URL options citizen"
+
+    it "should pass the specified host/port/protocols to all associated mailers" do
+      mail_sent_from_domain_should_include_link(false, "host", "3333", "http://example.com:4217/")
+    end
+
+    it "should drop default port" do
+      ActionController::Base.default_url_options_for_mailers[:port] = 80
+      mail_sent_from_domain_should_include_link(false, "host", "80", "http://example.com/")
+    end
+  end
+
+  context "when set to infer URL options" do
+    before(:each) do
+      configure_default_url_options_for_mailers_with(:infer_url_options)
+    end
+
+    it_should_behave_like "a good URL options citizen"
+
+    it "should pass host/port/protocols from the request to all associated mailers" do
+      mail_sent_from_domain_should_include_link(false, "host", "3333", "http://host:3333/")
+    end
+
+    it "should drop default port" do
+      mail_sent_from_domain_should_include_link(false, "host", "80", "http://host/")
+    end
+
+    it "should handle SSL" do
+      mail_sent_from_domain_should_include_link(true, "host", "3333", "https://host:3333/")
+    end
+
+    it "should handle SSL with default port" do
+      mail_sent_from_domain_should_include_link(true, "host", "443", "https://host/")
+    end
+  end
+
+  context "when set to some garbage" do
+    before(:each) do
+      configure_default_url_options_for_mailers_with("bad data here")
+    end
+
+    after(:each) do
+      # Clean up so as not to affect later tests.  This is a class-level config option, after all.
+      configure_default_url_options_for_mailers_with(nil)
+    end
+
+    it "should raise an exception (resulting in a non-successful response)" do
+      lambda { execute_request(true, "ahost", "2342") }.should raise_error
+      @response.should be_error
+    end
+  end
+
+  private
+
+  def configure_default_url_options_for_mailers_with(options)
+    @controller = DefaultUrlOptionsForMailersController.new
+#    @controller.class.send(:include, (PivotalCore::RailsCoreExtensions::DefaultUrlOptionsForMailers::ActionController))
+    PivotalCore::Initializer::DefaultUrlOptionsForMailers.run { |config| config.action_controller.default_url_options_for_mailers = options }
+  end
+
+  def mail_sent_from_domain_should_include_link(is_ssl, host, port, expected_link)
+    execute_request(is_ssl, host, port)
+    latest_mail_should_include_link(expected_link)
+  end
+
+  def execute_request(is_ssl, host, port)
+    @request = make_request_with(is_ssl, host, port)
+    @response = ActionController::TestResponse.new
+
+    get :index
+    @response.should be_success
+  end
+
+  def latest_mail_should_include_link(expected_link)
+    mail = ActionMailer::Base.deliveries.last
+    mail.body.should include(expected_link)
+  end
+
+  def make_request_with(is_ssl, host, port)
+    request = ActionController::TestRequest.new
+    request.host = host
+    request.env["SERVER_PORT"] = port
+    request.env["HTTPS"] = is_ssl ? "on" : "off"
+    request
+  end
+end

data/spec/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/spec/rails_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/rails_app/config/environment.rb

@@ -0,0 +1,41 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.8' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/spec/rails_app/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/spec/rails_app/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/spec/rails_app/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/spec/rails_app/config/initializers/action_controller.rb

@@ -0,0 +1 @@
+#ActionController::Base.include()

data/spec/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/rails_app/config/initializers/cookie_verification_secret.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.cookie_verifier_secret = '0a7eaaad9ea96cb7b789098bb578ecaf8788c6a44d4c0f5b405e12f478136d60832956382e7603e404d529e737ed5dcf2af60d74b5146508b3655ddde944d9fd';

data/spec/rails_app/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/rails_app/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/rails_app/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/spec/rails_app/config/initializers/pivotal.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(__FILE__, '../../../../../lib/default_url_options_for_mailers'))
+
+PivotalCore::Initializer::DefaultUrlOptionsForMailers.run do |config|
+  # *** Default URL Options For Mailers ***
+  # Use this line to automatically derive protocol/host/port using incoming rails request:
+  #  PivotalCore::Initializer::DefaultUrlOptionsForMailers.run
+  #  config.action_controller.default_url_options_for_mailers = :infer_url_options
+
+  # Use this line to explicitly set protocol/host/port:
+  # config.action_controller.default_url_options_for_mailers = { :protocol => "http", :host => "example.com", :port => 3333 }
+
+  # Comment out both lines to disable any default URL option functionality for mailers.
+
+  # NOTE: ActionMailer::Base.default_url_options always takes precedence over this facility and if *any* options are
+  # set there, default_url_options_for_mailers does nothing.
+end

data/spec/rails_app/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_rails_app_session',
+  :secret      => '80aa4a64add2bc52bf834b29b35be54a5824f3585a051f689a4874e056fa1a505bc3398bac52dfd24e49deec59889847b89076835a58e5edde5b3e659075fd29'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/spec/rails_app/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/spec/rails_app/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#   
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Major.create(:name => 'Daley', :city => cities.first)

data/spec/rails_app/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/spec/rails_app/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+#ENV["RAILS_ENV"] ||= "test"
+#require(File.join(File.dirname(__FILE__), 'rails_app', 'config', 'environment'))
+#
+#require "spec"
+#require 'spec/rails'
+#
+#Spec::Example::ExampleGroupFactory.register(:functional, Spec::Rails::Example::FunctionalExampleGroup)
+#Spec::Runner.configure do |configuration|
+#  configuration.use_transactional_fixtures = true
+#  configuration.use_instantiated_fixtures  = false
+#end
+
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path(File.join(File.dirname(__FILE__),'rails_app','config','environment'))
+require 'spec/autorun'
+require 'spec/rails'
+
+# Uncomment the next line to use webrat's matchers
+#require 'webrat/integrations/rspec-rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  # If you're not using ActiveRecord you should remove these
+  # lines, delete config/database.yml and disable :active_record
+  # in your config/boot.rb
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+#  config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+
+  # == Fixtures
+  #
+  # You can declare fixtures for each example_group like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so right here. Just uncomment the next line and replace the fixture
+  # names with your fixtures.
+  #
+  # 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.
+  #
+  # You can also declare which fixtures to use (for example fixtures for test/fixtures):
+  #
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures/'
+  #
+  # == Mock Framework
+  #
+  # RSpec uses its own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  #
+  # == Notes
+  #
+  # For more information take a look at Spec::Runner::Configuration and Spec::Runner
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: default-url-options-for-mailers
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joe Moore
+- Pivotal Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+description: ""
+email: pivotal-opensource@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/default_url_options_for_mailers.rb
+- lib/default_url_options_for_mailers/default_url_options_for_mailers.rb
+- lib/default_url_options_for_mailers/initializer.rb
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/pivotal/default-url-options-for-mailers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Default or infer the :protocol, :host, and :port values for ActionMailer
+test_files: 
+- spec/default_url_options_for_mailers_spec.rb
+- spec/rails_app/app/controllers/application_controller.rb
+- spec/rails_app/app/helpers/application_helper.rb
+- spec/rails_app/config/boot.rb
+- spec/rails_app/config/environment.rb
+- spec/rails_app/config/environments/development.rb
+- spec/rails_app/config/environments/production.rb
+- spec/rails_app/config/environments/test.rb
+- spec/rails_app/config/initializers/action_controller.rb
+- spec/rails_app/config/initializers/backtrace_silencers.rb
+- spec/rails_app/config/initializers/cookie_verification_secret.rb
+- spec/rails_app/config/initializers/inflections.rb
+- spec/rails_app/config/initializers/mime_types.rb
+- spec/rails_app/config/initializers/new_rails_defaults.rb
+- spec/rails_app/config/initializers/pivotal.rb
+- spec/rails_app/config/initializers/session_store.rb
+- spec/rails_app/config/routes.rb
+- spec/rails_app/db/seeds.rb
+- spec/rails_app/test/performance/browsing_test.rb
+- spec/rails_app/test/test_helper.rb
+- spec/spec_helper.rb