safety_mailer 0.0.2

data/README.rdoc

@@ -0,0 +1,41 @@
+== safety_mailer
+
+Restrict email sent by your application to only approved domains or accounts.
+
+Specify a domain (or set of domains, or magic word in email address) email is allowed to go to, and email to all other domains is silently dropped.
+
+This is useful for testing or staging environments where you want to be certain email to real customers doesn't escape the lab.
+
+Layered on the Mail gem, so Rails >= 3.0 applications can use safety_mailer.
+
+== Rails >= 3.0
+
+Add the gem to your +Gemfile+, specifying groups (probably not production) to include it in.
+
+  gem "safety_mailer", :group => :development
+
+Don't forget to <tt>bundle install</tt> to install
+
+In your environment file <tt>config/environments/development.rb</tt> configure it, and some regular expressions.
+
+  config.action_mailer.delivery_method = :safety_mailer
+  SafetyMailer::Config.allowed_matchers = [ /mydomain.com/, /mytestacct@gmail.com/, /super_secret_test/ ]
+
+... and now, email to anyone@mydomain.com, mytestacct@gmail.com, bob+super_secret_test@yahoo.com all get sent
+and email to other recipients (like the real users in the production database you copied to a test server) is suppressed.
+
+== Non-Rails
+
+Any user of the Mail gem can configure safety_mailer:
+
+  require "safety_mailer"
+  Mail.defaults do
+    delivery_method SafetyMailer::Carrier
+  end
+  SafetyMailer::Config.allowed_matchers = [ /mydomain.com/, /mytestacct@gmail.com/, /super_secret_test/ ]
+
+== License
+
+safety_mailer is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/lib/safety_mailer/railtie.rb

@@ -0,0 +1,7 @@
+module SafetyMailer
+  class Railtie < Rails::Railtie
+    initializer "safety_mailer.add_delivery_method" do
+      ActionMailer::Base.add_delivery_method :safety_mailer, SafetyMailer::Carrier
+    end
+  end
+end

data/lib/safety_mailer/safety_mailer.rb

@@ -0,0 +1,33 @@
+module SafetyMailer
+  class Config
+    @@allowed_matchers = []
+    cattr_accessor :allowed_matchers
+    @@delivery_method = :smtp
+    cattr_accessor :delivery_method
+  end
+  class Carrier
+    attr_accessor :params
+    def initialize(params = {})
+      self.params = params
+    end
+    def log(msg)
+      Rails.logger.warn(msg) if defined?(Rails)
+    end
+    def deliver!(mail)
+      mail.to = mail.to.reject do |recipient|
+        if SafetyMailer::Config.allowed_matchers.any?{ |m| recipient =~ m }
+          false
+        else
+          log "*** safety_mailer suppressing mail to #{recipient}"
+          true
+        end
+      end
+      if mail.to.nil? || mail.to.empty?
+        log "*** safety_mailer - no recipients left ... suppressing delivery altogether"
+      else
+        log "*** safety_mailer allowing delivery to #{mail.to}"
+        Mail::Configuration.instance.lookup_delivery_method(SafetyMailer::Config.delivery_method).deliver!(mail)
+      end
+    end
+  end
+end

data/lib/safety_mailer.rb

@@ -0,0 +1,2 @@
+require "safety_mailer/safety_mailer"
+require "safety_mailer/railtie" if defined? Rails

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: safety_mailer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Bill Kirtley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-08 00:00:00 Z
+dependencies: []
+
+description: Specify a domain (or set of domains, or magic word in email address) email is allowed to go to, and email to all other domains is silently dropped. Useful for testing and staging environments.
+email: bill.kirtley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/safety_mailer/railtie.rb
+- lib/safety_mailer/safety_mailer.rb
+- lib/safety_mailer.rb
+- README.rdoc
+homepage: http://github.com/cluesque/safety_opener
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Restrict email sent by your application to only approved domains or accounts.
+test_files: []
+