blackhole-mailer 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+doc/
+.yardoc/

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    blackhole-mailer (0.0.1)
+      resque_mailer (~> 2.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.12)
+      actionpack (= 3.2.12)
+      mail (~> 2.4.4)
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bluecloth (2.0.11)
+    builder (3.0.4)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.4)
+    journey (1.0.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.7.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    resque_mailer (2.1.0)
+      actionmailer (~> 3.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    yard (0.8.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blackhole-mailer!
+  bluecloth (~> 2.0.11)
+  rspec (~> 2.4)
+  yard

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 K$
+
+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.md

@@ -0,0 +1,56 @@
+blackhole-mailer
+====================
+A mail utility so dense, no message can escape.
+
+
+Installation Gemspec
+------------
+	gem 'blackhole-mailer'
+
+
+Sample Use
+------------------
+
+Calling `abort_delivery` sends the message into a blackhole & the message is never sent.
+
+    class UserMailer < BaseMailer
+      def daily(user_id)
+        @user = User.find(user_id)
+        abort_delivery unless @user.wants_daily?
+        mail(:to => @user.email, 
+          :from => "MyApp <hello@myapp.com>",
+          :subject => "Daily mailer from MyApp!")    
+      end  
+    end
+
+
+Further, you can inherit from AsyncMailer to get all the benefits of blackhole-mailer & integration with resque_mailer.
+
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/kdmny/blackhole-mailer/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+
+Copyright
+---------
+Copyright (c) 2013 K$.
+See [LICENSE](https://github.com/kdmny/blackhole-mailer/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+  rescue LoadError
+    # ignore
+  else
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+      task.options = [
+        '--protected',
+        '--output-dir', 'doc/yard',
+        '--tag', 'format:Supported formats',
+        '--tag', 'authenticated:Requires Authentication',
+        '--tag', 'rate_limited:Rate Limited',
+        '--markup', 'markdown',
+      ]
+    end
+  end
+end

data/blackhole-mailer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/blackhole-mailer/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rspec', '~> 2.4')
+  s.add_development_dependency('bluecloth', '~> 2.0.11')
+  s.add_development_dependency('yard') 
+  s.add_runtime_dependency('resque_mailer', '~> 2.1.0')
+  s.authors = ["K$"]
+  s.description = %q{A mail utility so dense, no message can escape.}
+  s.email = ['kdmny30@gmail.com']
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/kdmny/blackhole-mailer'
+  s.name = 'blackhole-mailer'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{A mail utility so dense, no message can escape.}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = BlackHoleMailer::VERSION
+end

data/lib/blackhole-mailer.rb

@@ -0,0 +1,3 @@
+require 'blackhole-mailer/black_hole_mailer'
+require 'blackhole-mailer/base_mailer'
+require 'blackhole-mailer/async_mailer'

data/lib/blackhole-mailer/async_mailer.rb

@@ -0,0 +1,4 @@
+# Adds resque_mailer methods to any subclass.
+class AsyncMailer < BaseMailer
+  include Resque::Mailer
+end

data/lib/blackhole-mailer/base_mailer.rb

@@ -0,0 +1,17 @@
+# Offers subclasses a hook to abort deliver of a mail message.
+class BaseMailer < ActionMailer::Base
+
+  class AbortDeliveryError < StandardError;end;
+  
+  def abort_delivery
+    raise AbortDeliveryError
+  end
+
+  def process(*args)
+    begin
+      super *args
+    rescue AbortDeliveryError
+      self.message = BlackholeMailMessage
+    end
+  end  
+end

data/lib/blackhole-mailer/black_hole_mailer.rb

@@ -0,0 +1,6 @@
+# A mail message that self destructs.
+class BlackholeMailMessage < Mail::Message
+  def self.deliver
+    false
+  end
+end

data/lib/blackhole-mailer/version.rb

@@ -0,0 +1,3 @@
+module BlackHoleMailer
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: blackhole-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- K$
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70365208959960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: *70365208959960
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: &70365208936360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.11
+  type: :development
+  prerelease: false
+  version_requirements: *70365208936360
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70365208935860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70365208935860
+- !ruby/object:Gem::Dependency
+  name: resque_mailer
+  requirement: &70365208935260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70365208935260
+description: A mail utility so dense, no message can escape.
+email:
+- kdmny30@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- blackhole-mailer.gemspec
+- lib/blackhole-mailer.rb
+- lib/blackhole-mailer/async_mailer.rb
+- lib/blackhole-mailer/base_mailer.rb
+- lib/blackhole-mailer/black_hole_mailer.rb
+- lib/blackhole-mailer/version.rb
+homepage: https://github.com/kdmny/blackhole-mailer
+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: 1.3.6
+requirements: []
+rubyforge_project: blackhole-mailer
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A mail utility so dense, no message can escape.
+test_files: []
+has_rdoc: