mail_logger 0.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 - 2009 Fusionary Media
+
+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/Manifest

@@ -0,0 +1,17 @@
+generators/mail_logger/lib/rake_commands.rb
+generators/mail_logger/mail_logger_generator.rb
+generators/mail_logger/templates/app/models/mail_log.rb
+generators/mail_logger/templates/db/migrate/create_mail_logs.rb
+generators/mail_logger/USAGE
+lib/mail_logger/app/models/mail_log.rb
+lib/mail_logger/lib/extensions/action_mailer.rb
+lib/mail_logger.rb
+mail_logger.gemspec
+Manifest
+MIT-LICENSE
+rails/init.rb
+Rakefile
+README.textile
+test/test_helper.rb
+test/unit/action_mailer_extension_test.rb
+test/unit/mail_log_test.rb

data/README.textile

@@ -0,0 +1,31 @@
+h1. Mail Logger
+
+Braindead-simple email logger for ActionMailer using ActiveRecord
+
+h2. Gem Installation for Rails 2.1+
+
+In config/environment.rb:
+
+    config.gem "fusionary-mail_logger",
+      :lib     => "mail_logger",
+      :source  => "http://gems.github.com"
+
+h2. Generator
+
+Ensure the environment's database is present and then run
+
+    script/generate mail_logger
+
+This will generate the migration and generate the MailLog ActiveRecord model.
+
+The model includes a module that attaches all the necessary code, allowing you to add other code (named scopes, etc) without interference
+
+h2. Ultra-Transparent
+
+You could install this gem and not notice *anything* different with your application.  It sits in the background, dumping all emails that get sent to your database.  The to, from, and subject line, as well as created_at, are all indexed for your querying pleasure.  Set up named scopes to search fields, or aggregate all common subjects and allow administrator accounts to filter/view them.  Whatever the case, the data is yours; whipping together the controller and setting permissions is the easy part.
+
+h2. About
+
+The purpose of this is to provide a simple audit trail, specific to ActionMailer, for Rails apps.  Without much work, you could write a controller and some views and then monitor the emails sent out; that's really beyond the scope of this project though.
+
+Copyright (c) 2009 Fusionary Media, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'echoe'
+
+Echoe.new("mail_logger", "0.1.5") do |p|
+  p.description = "Braindead-simple email logger for ActionMailer using ActiveRecord"
+  p.url = "http://github.com/fusionary/mail_logger"
+  p.author = ["Fusionary Media", "Josh Clayton"]
+  p.email = "joshua.clayton@gmail.com"
+  p.ignore_pattern = ["tmp/*"]
+  p.development_dependencies = ["actionmailer >= 2.1.0"]
+end

data/generators/mail_logger/USAGE

@@ -0,0 +1 @@
+script/generate mail_logger

data/generators/mail_logger/lib/rake_commands.rb

@@ -0,0 +1,22 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+    unless system("rake db:migrate")
+      logger.rake "db:migrate failed. Rolling back"
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake_db_migrate
+    logger.rake "db:rollback"
+    system "rake db:rollback"
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+  end
+end

data/generators/mail_logger/mail_logger_generator.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class MailLoggerGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory File.join("app", "models")
+      ["app/models/mail_log.rb"].each do |file|
+        m.file file, file
+      end
+      
+      unless ActiveRecord::Base.connection.table_exists?(:mail_logs)
+        m.migration_template 'db/migrate/create_mail_logs.rb', 'db/migrate', :migration_file_name => 'create_mail_logs'
+      end
+      
+      m.rake_db_migrate
+    end
+  end
+end

data/generators/mail_logger/templates/app/models/mail_log.rb

@@ -0,0 +1,3 @@
+class MailLog < ActiveRecord::Base
+  include MailLogger::App::Models::MailLog
+end

data/generators/mail_logger/templates/db/migrate/create_mail_logs.rb

@@ -0,0 +1,20 @@
+class CreateMailLogs < ActiveRecord::Migration
+  def self.up
+    create_table :mail_logs do |t|
+      t.string   :subject, :to, :from, :cc
+      t.text     :body, :message
+      t.timestamps
+    end
+    
+    change_table :mail_logs do |t|
+      t.index :subject
+      t.index :to
+      t.index :from
+      t.index :created_at
+    end
+  end
+  
+  def self.down
+    drop_table :mail_logs
+  end
+end

data/lib/mail_logger.rb

@@ -0,0 +1,4 @@
+require "mail_logger/app/models/mail_log"
+require "mail_logger/lib/extensions/action_mailer"
+
+ActionMailer::Base.send :include, MailLogger::Lib::Extensions::ActionMailer

data/lib/mail_logger/app/models/mail_log.rb

@@ -0,0 +1,34 @@
+module MailLogger
+  module App
+    module Models
+      module MailLog
+        def self.included(base)
+          base.extend ClassMethods
+        end
+        
+        module ClassMethods
+          def create_from_mail(email)
+            ensure_object_is_email(email)
+            ensure_required_attributes_are_assigned(email)
+            
+            self.create(:to => email.to.join(", "), :from => email.from.join(", "), :subject => email.subject, :body => email.quoted_body, :message => email.encoded)
+          end
+          
+          private
+          
+          def ensure_object_is_email(email)
+            [:to, :from, :subject, :quoted_body, :encoded].each do |att|
+              raise(ArgumentError, "object is not an email") unless email.respond_to?(att)
+            end
+          end
+          
+          def ensure_required_attributes_are_assigned(email)
+            [:to, :from].each do |required_att|
+              raise(ArgumentError, "email does not have attribute '#{required_att}' assigned") if email.send(required_att).blank?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mail_logger/lib/extensions/action_mailer.rb

@@ -0,0 +1,28 @@
+module MailLogger
+  module Lib
+    module Extensions
+      module ActionMailer
+        def self.included(base)
+          base.class_eval do
+            def deliver_with_hooks!(*args)
+              logger ||= nil
+              mail = args.first || @mail # depend on ActionMailer::Base's @mail ivar is pretty nasty but has to be done
+              if !mail.nil?
+                begin
+                  logger.info "MailLogger logged #{mail.encoded}" if logger
+                  MailLog.create_from_mail(mail)
+                rescue
+                  logger.info "MailLogger failed" if logger
+                end
+              end
+              
+              deliver_without_hooks!(*args)
+            end
+            
+            alias_method_chain :deliver!, :hooks
+          end
+        end
+      end
+    end
+  end
+end

data/mail_logger.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mail_logger}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fusionary Media, Josh Clayton"]
+  s.date = %q{2009-05-15}
+  s.description = %q{Braindead-simple email logger for ActionMailer using ActiveRecord}
+  s.email = %q{joshua.clayton@gmail.com}
+  s.extra_rdoc_files = ["lib/mail_logger/app/models/mail_log.rb", "lib/mail_logger/lib/extensions/action_mailer.rb", "lib/mail_logger.rb", "README.textile"]
+  s.files = ["generators/mail_logger/lib/rake_commands.rb", "generators/mail_logger/mail_logger_generator.rb", "generators/mail_logger/templates/app/models/mail_log.rb", "generators/mail_logger/templates/db/migrate/create_mail_logs.rb", "generators/mail_logger/USAGE", "lib/mail_logger/app/models/mail_log.rb", "lib/mail_logger/lib/extensions/action_mailer.rb", "lib/mail_logger.rb", "mail_logger.gemspec", "Manifest", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README.textile", "test/test_helper.rb", "test/unit/action_mailer_extension_test.rb", "test/unit/mail_log_test.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/fusionary/mail_logger}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Mail_logger", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mail_logger}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Braindead-simple email logger for ActionMailer using ActiveRecord}
+  s.test_files = ["test/test_helper.rb", "test/unit/action_mailer_extension_test.rb", "test/unit/mail_log_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<actionmailer>, [">= 2.1.0"])
+    else
+      s.add_dependency(%q<actionmailer>, [">= 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<actionmailer>, [">= 2.1.0"])
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require "action_mailer"
+require "mail_logger"

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+
+require File.join(File.dirname(__FILE__), "../rails/init")
+ 
+require 'redgreen'
+require 'shoulda'
+
+class MailLog
+  include MailLogger::App::Models::MailLog
+end
+
+class FakeMailer
+  def initialize(email)
+    @mail = email
+  end
+  
+  def deliver!(*args)
+    "sent email"
+  end
+end
+
+FakeMailer.send :include, MailLogger::Lib::Extensions::ActionMailer
+
+class ValidEmail
+  attr_accessor :to, :from, :subject, :quoted_body, :encoded
+end

data/test/unit/action_mailer_extension_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), "../test_helper")
+ 
+class ActionMailerExtensionTest < ActiveSupport::TestCase
+  context "sending a valid email" do
+    should "trigger the default #deliver!" do
+      mailer = FakeMailer.new(nil)
+      assert_equal "sent email", mailer.deliver!
+    end
+    
+    should "not attempt to create a new mail log if mail is nil" do
+      mailer = FakeMailer.new(nil)
+      MailLog.expects(:create_from_mail).never
+      assert_equal "sent email", mailer.deliver!
+    end
+    
+    should "attempt to create a new mail log if email if present" do
+      email = ValidEmail.new
+      email.to = email.from = ["user@example.com"]
+      mailer = FakeMailer.new(email)
+      MailLog.expects(:create_from_mail).with(email)
+      assert_equal "sent email", mailer.deliver!
+    end
+    
+    should "proceed even if MailLog raises an error" do
+      mailer = FakeMailer.new("my email")
+      MailLog.expects(:create_from_mail).with("my email").raises("an error")
+      assert_equal "sent email", mailer.deliver!
+    end
+  end
+end

data/test/unit/mail_log_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "../test_helper")
+ 
+class MailLogTest < ActiveSupport::TestCase
+  context "Mail log creation" do
+    setup { MailLog.stubs(:create) }
+    
+    should "ensure the email responds to the correct methods" do
+      email = ValidEmail.new
+      email.to = email.from = ["user@example.com"]
+      
+      [:to, :from, :subject, :quoted_body, :encoded].each do |att|
+        email.expects(:respond_to?).with(att).returns(true)
+      end
+      
+      MailLog.create_from_mail(email)
+    end
+    
+    should "raise an error if the object is not an email" do
+      assert_raise ArgumentError, "object is not an email" do
+        MailLog.create_from_mail("not an email")
+      end
+    end
+    
+    should "raise an error if to or from is not set" do
+      email = ValidEmail.new
+      email.to = ["user@example.com"]
+      assert_raise ArgumentError, "email does not have attribute 'from' assigned" do
+        MailLog.create_from_mail(email)
+      end
+      
+      email.from, email.to = ["user@example.com"]
+      assert_raise ArgumentError, "email does not have attribute 'to' assigned" do
+        MailLog.create_from_mail(email)
+      end
+    end
+    
+    should "pass all attributes when creating a new mail log" do
+      email = ValidEmail.new
+      email.from        = ["user-1@example.com", "user-2@example.com"]
+      email.to          = ["user-3@example.com", "user-4@example.com"]
+      email.subject     = "Subject line"
+      email.quoted_body = "This is a quoted body"
+      email.encoded     = "Encoded message"
+      
+      MailLog.expects(:create).with({:from => "user-1@example.com, user-2@example.com", :to => "user-3@example.com, user-4@example.com", :subject => "Subject line", :body => "This is a quoted body", :message => "Encoded message"})
+      MailLog.create_from_mail(email)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: mail_logger
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Fusionary Media, Josh Clayton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: Braindead-simple email logger for ActionMailer using ActiveRecord
+email: joshua.clayton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/mail_logger/app/models/mail_log.rb
+- lib/mail_logger/lib/extensions/action_mailer.rb
+- lib/mail_logger.rb
+- README.textile
+files: 
+- generators/mail_logger/lib/rake_commands.rb
+- generators/mail_logger/mail_logger_generator.rb
+- generators/mail_logger/templates/app/models/mail_log.rb
+- generators/mail_logger/templates/db/migrate/create_mail_logs.rb
+- generators/mail_logger/USAGE
+- lib/mail_logger/app/models/mail_log.rb
+- lib/mail_logger/lib/extensions/action_mailer.rb
+- lib/mail_logger.rb
+- mail_logger.gemspec
+- Manifest
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README.textile
+- test/test_helper.rb
+- test/unit/action_mailer_extension_test.rb
+- test/unit/mail_log_test.rb
+has_rdoc: true
+homepage: http://github.com/fusionary/mail_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Mail_logger
+- --main
+- README.textile
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: mail_logger
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Braindead-simple email logger for ActionMailer using ActiveRecord
+test_files: 
+- test/test_helper.rb
+- test/unit/action_mailer_extension_test.rb
+- test/unit/mail_log_test.rb