fusionary-mail_logger 0.1.1 → 0.1.2

data/Manifest

@@ -6,8 +6,12 @@ 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

@@ -16,11 +16,16 @@ Ensure the environment's database is present and then run
 
     script/generate mail_logger
 
-This will generate the migration and generate the MailLog AR model.
+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.
+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

@@ -3,7 +3,7 @@ require 'rake'
 require 'rake/testtask'
 require 'echoe'
 
-Echoe.new("mail_logger", "0.1.1") do |p|
+Echoe.new("mail_logger", "0.1.2") 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"]

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

@@ -9,7 +9,11 @@ module MailLogger
         module ClassMethods
           def create_from_mail(email)
             [:to, :from, :subject, :quoted_body, :encoded].each do |att|
-              return unless email.respond_to?(att)
+              raise(ArgumentError, "object is not an email") unless email.respond_to?(att)
+            end
+            
+            [:to, :from].each do |required_att|
+              raise(ArgumentError, "email does not have attribute '#{required_att}' assigned") if email.send(required_att).blank?
             end
             
             self.create(:to => email.to.join(", "), :from => email.from.join(", "), :subject => email.subject, :body => email.quoted_body, :message => email.encoded)

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

@@ -5,13 +5,14 @@ module MailLogger
         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}" unless logger.nil?
+                  logger.info "MailLogger logged #{mail.encoded}" if logger
                   MailLog.create_from_mail(mail)
                 rescue
-                  logger.info "MailLogger failed" unless logger.nil?
+                  logger.info "MailLogger failed" if logger
                 end
               end
               

data/mail_logger.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mail_logger}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   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-04-14}
+  s.date = %q{2009-04-17}
   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", "Manifest", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README.textile", "mail_logger.gemspec"]
+  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"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{mail_logger}
   s.rubygems_version = %q{1.3.1}
   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

data/rails/init.rb

@@ -1 +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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fusionary-mail_logger
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Fusionary Media, Josh Clayton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-14 00:00:00 -07:00
+date: 2009-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,12 +45,15 @@ files:
 - 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
-- mail_logger.gemspec
+- 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
 post_install_message: 
@@ -82,5 +85,7 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Braindead-simple email logger for ActionMailer using ActiveRecord
-test_files: []
-
+test_files: 
+- test/test_helper.rb
+- test/unit/action_mailer_extension_test.rb
+- test/unit/mail_log_test.rb