mail_envi 0.1.0

data/test/dummy/public/javascripts/rails.js

@@ -0,0 +1,191 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var csrf_meta_tag = $$('meta[name=csrf-token]')[0];
+
+      if (csrf_meta_tag) {
+        var header = 'X-CSRF-Token',
+            token = csrf_meta_tag.readAttribute('content');
+
+        if (!request.options.requestHeaders) {
+          request.options.requestHeaders = {};
+        }
+        request.options.requestHeaders[header] = token;
+      }
+    }
+  });
+})();

data/test/dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/mail_envi/test_config.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'mail_envi'
+
+class CustomInterceptor
+  def self.delivering_email(msg); end
+end
+
+class TestConfig < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def mail_envi
+    MailEnvi::Rails::Railtie.new
+  end
+
+  should "have defaults" do
+    config = MailEnvi::Config.new
+    assert_equal ['development', 'test'], config.environments
+    assert_equal MailEnvi::DefaultInterceptor, config.interceptor
+    assert_equal 'root@localhost', config.default_to
+  end
+
+  should "allow the interceptor to be assigned to a custom class" do
+    mock(MailEnvi).ronment {'development'}
+
+    MailEnvi.config do |config|
+      config.interceptor = CustomInterceptor
+    end
+
+    mock(::Mail).register_interceptor(CustomInterceptor)
+    mail_envi.run_initializers
+  end
+
+  should "allow additional environments to be included" do
+    MailEnvi.config do |config|
+      config.include_environments [:staging, 'beta']
+    end
+
+    assert_equal ['development', 'test', 'staging', 'beta'], 
+      MailEnvi.config.environments
+  end
+
+  should "allow the defaults in the default interceptor to be overwritten" do
+    MailEnvi.config do |config|
+      config.default_to = "another@company.com"
+    end
+
+    mock(msg = Object.new)
+    stub(msg).subject {"Hello world!"}
+    mock(msg).to=("another@company.com")
+    mock(msg).subject=(anything)
+    MailEnvi::DefaultInterceptor.delivering_email(msg)
+  end
+end

data/test/mailer/test_user_mailer.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+require File.expand_path("../../dummy/config/environment.rb",  __FILE__)
+
+class TestUserMailer < ActionMailer::TestCase
+  context "when configured with MailEnvi" do
+    should "be intercepted" do
+      mock(user = Object.new)
+      stub(user).email {'user@company.com'}
+
+      email = UserMailer.registration_complete(user).deliver
+      assert (not ActionMailer::Base.deliveries.empty?)
+      assert_equal ['configured@company.com'], email.to
+      assert_match /\(#{MailEnvi.ronment} Interception\)/i, email.subject
+      # assert_match /hello world/i, email.body
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+ENV["RAILS_ENV"] = "test"
+
+# load the gem lib/ for the require 'mail_envy'
+# $:.unshift File.expand_path('../../lib', __FILE__)
+
+# load the dummy app
+# require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+
+begin
+  require 'turn'
+rescue LoadError
+  # /
+end
+
+require 'test/unit'
+require 'shoulda'
+require 'rr'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end
+

data/test/test_mail_envi.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'mail_envi'
+
+class TestMailEnvi < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def mail_envi
+    MailEnvi::Rails::Railtie.new
+  end
+
+  context "in a production environment" do
+    setup { stub(MailEnvi).ronment {'production'} }
+
+    should "not register the Mail interceptor" do
+      dont_allow(::Mail).register_interceptor(anything)
+      mail_envi.run_initializers
+    end
+  end
+
+  context "in a development, test or included environments" do
+    should "register the default Mail interceptor" do
+      MailEnvi.config do |config|
+        config.include_environments [:staging, :beta]
+      end
+
+      %w(development test staging beta).each do |v|
+        stub(MailEnvi).ronment {v}
+        mock(::Mail).register_interceptor(MailEnvi::DefaultInterceptor)
+        mail_envi.run_initializers
+      end
+    end
+  end
+
+  context "self.ronment" do
+    should "return the Rails.env" do
+      mock(::Rails).env {'foo'}
+      assert_equal 'foo', MailEnvi.ronment
+
+      mock(::Rails).env {'bar'}
+      assert_equal 'bar', MailEnvi.ronment
+    end
+  end
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification 
+name: mail_envi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yung Hwa Kwon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: turn
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rr
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: ""
+email: yung.kwon@damncarousel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/mail_envi.rb
+- lib/mail_envi/config.rb
+- mail_envi.gemspec
+- test/dummy/.gitignore
+- test/dummy/Rakefile
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/user_mailer.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mail_envi.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/db/seeds.rb
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/public/images/rails.png
+- test/dummy/public/index.html
+- test/dummy/public/javascripts/application.js
+- test/dummy/public/javascripts/controls.js
+- test/dummy/public/javascripts/dragdrop.js
+- test/dummy/public/javascripts/effects.js
+- test/dummy/public/javascripts/prototype.js
+- test/dummy/public/javascripts/rails.js
+- test/dummy/public/robots.txt
+- test/dummy/public/stylesheets/.gitkeep
+- test/dummy/script/rails
+- test/mail_envi/test_config.rb
+- test/mailer/test_user_mailer.rb
+- test/test_helper.rb
+- test/test_mail_envi.rb
+homepage: http://github.com/nowk/mail_envi
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3370593094154357546
+      segments: 
+      - 0
+      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.5
+signing_key: 
+specification_version: 3
+summary: Mail interceptor for different environments
+test_files: []
+