email_blacklist 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Myron Marston
+
+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/README.rdoc

@@ -0,0 +1,35 @@
+= email_blacklist
+
+Blacklist particular email addresses so ActionMailer doesn't deliver emails to them.
+
+This is useful in a variety of situations:
+* You can blacklist an entire domain.
+* You can stop emails from being sent to users who have deactivated their accounts with your app.
+* Any other reason you might want to stop emails from being sent...
+
+== Installation
+  gem install email_blacklist
+
+== Configuration
+
+Blacklisting is as easy as:
+
+  EmailBlacklist::Config.blacklist do |email_address|
+    # return true if emails should not be sent to this email address.
+  end
+
+The block you provide will be called with every email address used by any ActionMailer email.  This includes to, cc and bcc addresses.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Myron Marston. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "email_blacklist"
+    gem.summary = %Q{Ensure no emails are ever sent to particular email addresses.}
+    gem.description = %Q{Blacklist particular email addresses so ActionMailer doesn't deliver emails to them.}
+    gem.email = "myron.marston@gmail.com"
+    gem.homepage = "http://github.com/myronmarston/email_blacklist"
+    gem.authors = ["Myron Marston"]
+    gem.add_dependency 'mynyml-override'
+    gem.add_dependency 'actionmailer'
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "email_blacklist #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/email_blacklist.rb

@@ -0,0 +1,39 @@
+require 'action_mailer'
+require 'override'
+
+module EmailBlacklist
+  ADDRESS_TYPES = [:to, :cc, :bcc].freeze
+
+  class Config
+    class << self
+      def blacklist(&blk)
+        @@blacklist_block = blk
+      end
+
+      def blacklisted?(email_address)
+        return false unless @@blacklist_block
+        @@blacklist_block.call(email_address) ? true : false
+      end
+    end
+  end
+end
+
+ActionMailer::Base.class_eval do
+  override :deliver!
+  def deliver!(mail = @mail)
+    if mail
+      all_addresses = []
+
+      EmailBlacklist::ADDRESS_TYPES.each do |address_type|
+        addresses = mail.send(address_type)
+        addresses.reject! { |a| EmailBlacklist::Config.blacklisted?(a) } if addresses
+        all_addresses << addresses
+        mail.send("#{address_type}=", addresses)
+      end
+
+      return if all_addresses.flatten.compact.empty?
+    end
+
+    super(mail)
+  end
+end

data/spec/email_blacklist_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/mailers/test_mailer')
+
+describe EmailBlacklist::Config do
+  context 'when the blacklisted.org domain is blacklisted' do
+    before(:all) do
+      EmailBlacklist::Config.blacklist do |email_address|
+        email_address =~ /blacklisted\.org/
+      end
+    end
+
+    it 'should return true for #blacklisted?("bob@blacklisted.org")' do
+      EmailBlacklist::Config.blacklisted?("bob@blacklisted.org").should == true
+    end
+
+    it 'should return false for #blacklisted?("bob@gmail.com")' do
+      EmailBlacklist::Config.blacklisted?("bob@gmail.com").should == false
+    end
+  end
+
+  context 'when no blacklist is defined' do
+    before(:all) do
+      EmailBlacklist::Config.blacklist # ensure it's nil...
+    end
+
+    it 'should return false for #blacklisted?("bob@blacklisted.org")' do
+      EmailBlacklist::Config.blacklisted?("bob@blacklisted.org").should == false
+    end
+
+    it 'should return false for #blacklisted?("bob@gmail.com")' do
+      EmailBlacklist::Config.blacklisted?("bob@gmail.com").should == false
+    end
+  end
+end
+
+describe ActionMailer do
+  context 'when the blacklisted.org domain is blacklisted' do
+    before(:all) do
+      EmailBlacklist::Config.blacklist do |email_address|
+        email_address =~ /blacklisted\.org/
+      end
+    end
+
+    EmailBlacklist::ADDRESS_TYPES.each do |blacklisted_address_type|
+      other_address_types = (EmailBlacklist::ADDRESS_TYPES - [blacklisted_address_type])
+      context "sending an email with #{blacklisted_address_type} set to 'bob@blacklisted.org' and #{other_address_types.join(" and ")} set to 'valid_address@gmail.com'" do
+        before(:all) do
+          options = { blacklisted_address_type => 'bob@blacklisted.org' }
+          other_address_types.each { |t| options[t] = 'valid_address@gmail.com' }
+          @email = TestMailer.deliver_email(options)
+        end
+
+        it "should not deliver it to 'bob@blacklisted.org' for the #{blacklisted_address_type} address" do
+          @email.send(blacklisted_address_type).should be_nil
+        end
+
+        other_address_types.each do |t|
+          it "should deliver it to 'valid_address@gmail.com' for the #{t} address" do
+            @email.send(t).should == ['valid_address@gmail.com']
+          end
+        end
+      end
+    end
+
+    context "sending an email to just 'bob@blacklisted.org'" do
+      before(:each) do
+        ActionMailer::Base.deliveries.clear
+        TestMailer.deliver_email({:to => 'bob@blacklisted.org'})
+      end
+
+      it "should not send the email at all" do
+        ActionMailer::Base.deliveries.should == []
+      end
+    end
+  end
+
+  it "should not include the friendly name in the call to #blacklisted?" do
+    EmailBlacklist::Config.should_receive(:blacklisted?).with('bob@blacklisted.org')
+    TestMailer.deliver_email({:to => 'Bob <bob@blacklisted.org>'})
+  end
+end

data/spec/mailers/test_mailer.rb

@@ -0,0 +1,10 @@
+class TestMailer < ActionMailer::Base
+  def email(options)
+    recipients options[:to]
+    cc         options[:cc]
+    bcc        options[:bcc]
+    from       'test@emailblacklist.org'
+    subject    "Email test"
+    body       "Here is the message body."
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--format specdoc
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'email_blacklist'
+require 'spec'
+require 'spec/autorun'
+
+ActionMailer::Base.delivery_method = :test
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: email_blacklist
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Myron Marston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mynyml-override
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Blacklist particular email addresses so ActionMailer doesn't deliver emails to them.
+email: myron.marston@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/email_blacklist.rb
+- spec/email_blacklist_spec.rb
+- spec/mailers/test_mailer.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/myronmarston/email_blacklist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ensure no emails are ever sent to particular email addresses.
+test_files: 
+- spec/email_blacklist_spec.rb
+- spec/mailers/test_mailer.rb
+- spec/spec_helper.rb