mailer_callbacks 2.0.0a

data/README.md

@@ -0,0 +1,39 @@
+[![Build Status](https://travis-ci.org/kelyar/mailer_callbacks.png?branch=2.0)](https://travis-ci.org/kelyar/mailer_callbacks)
+
+Mailer Callbacks
+================
+
+
+I had a task to save all emails we send to user - not content, of course, but at least email and subject (or template). It's pretty useful if you send lots of emails and want to know which ones this particular user received. 
+
+Easy way was to put some SentMailLog.create() in the end of every method of ActionMailer::Base ancestors. Doesn't look really DRY, but it will work. I looked thru ActionMailer API but there were no hooks like AR or even ActionController has. That's why I wrote this tiny 1Kb extension to AM that adds `after_deliver` callback for my Notifier class.
+
+Right after that I plugged in open_id_authentication which is great but many more issues came out. It appears that my users no longer have emails because they could register with openid and some providers just ignore `required => {:email}`. I had to add `unless User.current_user.openid?` to all of my deliver_* methods.  That's when `before_deliver` saved me. If any of your actions specified in `before_deliver` method returns false, no email will be sent. But no one cares what your `after_deliver` returns. It's pretty similar to ActiveRecord's before_save/after_save callbacks.
+
+Many use cases can be found: you can mark your users as bounced if there are problems with their email accounts - no emails should be sent to them. Or you can have `unsubscribe all our news` flag like we have. This can also be verified in `before_deliver`. If you need to access email data just use instance variables inside your callbacks, like `@subject, @recipients, @body`,etc.
+
+ok, no more words, here is the code:
+
+```ruby
+class Notifier < ActionMailer::Base
+  before_deliver :openid_stub?
+  after_deliver :save_email
+
+  def openid_stub?
+    @recipients.to_s.include?('openid_stub')
+  end
+
+  def save_email
+    ...
+    SentMailLog.create(email: @recipients.join(','), subj: @subject)
+  end
+end
+```
+
+TODO:
+- <del>run on new action_mailer</del> DONE
+- add usual [:except, :only] params
+- yield if block_given?
+- <del>add some tests</del> DONE
+
+Copyright (c) 2008-2013 Evgeniy Kelyarsky, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mailer_callbacks plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mailer_callbacks plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MailerCallbacks'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mailer_callbacks/mailer_callbacks.rb

@@ -0,0 +1,40 @@
+module MailerCallbacks
+  def self.included(base)
+    base.class_eval do
+      cattr_accessor :before_filters, :before_options, :after_filters
+
+      def self.before_deliver(*args)
+        self.before_options = args.last.is_a?(Hash) ? args.pop : {}
+        self.before_filters = args
+
+        register_interceptor(self)
+      end
+
+      # before
+      def self.delivering_email(message)
+        result, skip_before = true, false
+
+        if !skip_before
+          self.before_filters.each do |filter|
+            if __send__(filter.to_sym, message).is_a? ActionMailer::Base::NullMail
+              message.perform_deliveries = false
+              break
+            end
+          end
+        end
+      end
+
+      # after
+      def self.delivered_email(message)
+        self.after_filters.each do |filter|
+          self.__send__(filter.to_sym, message)
+        end
+      end
+
+      def self.after_deliver(*args)
+        self.after_filters = args
+        register_observer(self)
+      end
+    end
+  end
+end

data/lib/mailer_callbacks/version.rb

@@ -0,0 +1,3 @@
+module MailerCallbacks
+  VERSION = "2.0.0"
+end

data/lib/mailer_callbacks.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require 'mailer_callbacks/mailer_callbacks'
+require 'mailer_callbacks/version'
+
+ActionMailer::Base.class_eval do
+  include MailerCallbacks
+end

data/mailer_callbacks.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name            = "mailer_callbacks"
+  s.version         = "2.0.0a"
+  s.platform        = Gem::Platform::RUBY
+  s.summary         = "Mailer callbacks"
+
+  s.description = <<-EOF
+Small set of callbacks that can be useful if you do pre-post mail processing
+EOF
+
+  s.files           = Dir['{lib/**/*,test/**/*}'] +
+                        %w(mailer_callbacks.gemspec Rakefile README.md)
+  s.require_path    = 'lib'
+  s.test_files      = Dir['test/*_test.rb']
+
+  s.author          = 'Evgeniy Kelyarsky'
+  s.email           = 'kelyar@gmail.com'
+  s.homepage        = 'http://github.com/kelyar/mailer_callbacks'
+
+  s.add_development_dependency 'rake'
+end

data/test/mailer_callbacks_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class MailerCallbacksTest < ActionMailer::TestCase
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @recipient = 'test@localhost'
+
+    Notifier.class_eval do
+      def stop(m); end
+      def start(m); end
+    end
+  end
+
+  test "before: deny" do
+    Notifier.class_eval do
+      def start(message); false end
+    end
+
+    assert_emails(0) do
+      Notifier.run.deliver
+    end
+  end
+
+  test "before: allow" do
+    Notifier.class_eval do
+      def start(message)
+        true
+      end
+    end
+
+    assert_emails(1) do
+      Notifier.run.deliver
+    end
+  end
+
+  test "after delivery" do
+    Notifier.class_eval do
+      def stop(message) raise "111" end
+    end
+    assert_raise(RuntimeError) do
+      Notifier.run.deliver
+    end
+  end
+end
+
+class Notifier < ActionMailer::Base
+
+  def run
+    to    = "test@example.com"
+    from  = "tester@example.com"
+    body  = render(inline: 'test', body: 'zhenya', layout: false)
+    mail(:to => to, :body => body, :from => from)
+  end
+
+  def start(message)
+  end
+
+  def stop(message)
+  end
+
+
+  before_deliver :start, :except => [:index ]
+  after_deliver :stop
+end
+

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+require 'turn/autorun'
+require 'active_support'
+require 'active_support/test_case'
+require 'action_mailer'
+
+require 'mailer_callbacks'
+
+ActionMailer::Base.logger = Logger.new("mailer.log")
+
+Turn.config do |c|
+ # use one of output formats:
+ # :outline  - turn's original case/test outline mode [default]
+ # :progress - indicates progress with progress bar
+ # :dotted   - test/unit's traditional dot-progress mode
+ # :pretty   - new pretty reporter
+ # :marshal  - dump output as YAML (normal run mode only)
+ # :cue      - interactive testing
+ c.format  = :outline
+ # turn on invoke/execute tracing, enable full backtrace
+ c.trace   = 100
+ # use humanized test names (works only with :outline format)
+ c.natural = true
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: mailer_callbacks
+version: !ruby/object:Gem::Version
+  version: 2.0.0a
+  prerelease: 5
+platform: ruby
+authors:
+- Evgeniy Kelyarsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Small set of callbacks that can be useful if you do pre-post mail
+  processing
+
+'
+email: kelyar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailer_callbacks/mailer_callbacks.rb
+- lib/mailer_callbacks/version.rb
+- lib/mailer_callbacks.rb
+- test/mailer_callbacks_test.rb
+- test/test_helper.rb
+- mailer_callbacks.gemspec
+- Rakefile
+- README.md
+homepage: http://github.com/kelyar/mailer_callbacks
+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.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Mailer callbacks
+test_files:
+- test/mailer_callbacks_test.rb