mail-logger 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+  - jruby
+  - ruby-head
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh McArthur
+
+MIT License
+
+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/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2013 Josh McArthur
+
+
+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,46 @@
+# MailLogger
+
+[![Build Status](https://travis-ci.org/joshmcarthur/mail_logger.png?branch=master)](https://travis-ci.org/joshmcarthur/mail_logger)
+
+> Please note: There's another project around called [**mail_logger**](https://rubygems.org/gems/mail_logger), which records details of mail to the database via ActiveRecord, instead of a log file (which is what this project does). While I certainly didn't intend to infringe, the other project hasn't been updated in a few years, so I'm sticking with this name.
+
+You know how you're looking through your logs to see how your mailing is doing, and after all that request rubbish, you just can't see that **Sent mail** stuff? Annoying, right?
+
+MailLogger to the rescue! It lodges a callback with `Mail`, capturing all of the mail being sent, and logging it to it's own file, so you can simply look back through that file to see what's up. Easy peasy!
+
+I could be a pain and require Rails here, but I don't. If you are using Rails, then this gem should put things in the right place: `#{Rails.root}/log/mail_{development,etc}.log` - no extra work necessary. If you are not using Rails, then the gem will place the log file in `./log` - wherever that may be.
+
+Default paths getting you down? Not to worry, this gem is configurable!
+
+``` ruby
+Mail::Logger.configure do |config|
+  config.log_path = "Whatever you want"
+  config.log_file_name = "all my emails.log"
+end
+```
+
+(If you're using Rails, this belongs in `config/initializers/mail_logger.rb`)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mail-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail-logger
+    
+   
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*.rb']
+  t.verbose = true
+end
+
+desc "Run Tests"
+task :default => :test

data/lib/mail/logger/callback.rb

@@ -0,0 +1,8 @@
+class Mail::Logger::Callback
+  def self.delivered_email(email)
+    Mail::Logger.logger.info email.inspect
+  end
+end
+
+require 'mail'
+Mail.register_observer(Mail::Logger::Callback)

data/lib/mail/logger/configuration.rb

@@ -0,0 +1,20 @@
+class Mail::Logger::Configuration
+  attr_accessor :log_path, :log_file_name
+
+  def initialize
+    self.log_path = rails_log_path || File.expand_path("./log")
+    self.log_file_name = rails_log_file_name || "mail.log"
+  end
+
+  def rails_log_path
+    return nil unless defined? Rails
+
+    Rails.root
+  end
+
+  def rails_log_file_name
+    return nil unless defined? Rails
+
+    "mail_#{Rails.env}.log"
+  end
+end

data/lib/mail/logger/logfile.rb

@@ -0,0 +1,8 @@
+class Mail::Logger::Logfile < ::Logger
+  def initialize
+    path = Mail::Logger.configuration.log_path
+    filename =  Mail::Logger.configuration.log_file_name
+
+    super(File.open(File.join(path, filename), 'a+'))
+  end
+end

data/lib/mail/logger/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Logger
+    VERSION = "0.0.1"
+  end
+end

data/lib/mail_logger.rb

@@ -0,0 +1,25 @@
+require "mail"
+require "logger"
+require "mail/logger/version"
+require "mail/logger/configuration"
+require "mail/logger/logfile"
+require "mail/logger/callback"
+
+module Mail::Logger
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.logger
+    @logger ||= Mail::Logger::Logfile.new
+  end
+end

data/mail_logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail-logger"
+  spec.version       = Mail::Logger::VERSION
+  spec.authors       = ["Josh McArthur"]
+  spec.email         = ["joshua.mcarthur@gmail.com"]
+  spec.description   = %q{Lodges a callback with `Mail`, capturing all of the mail being sent, and logging it to it's own file, so you can simply look back through that file to see what's up. }
+  spec.summary       = %q{A Rubygem to capture information about sent emails, and log them to a file all to their own!}
+  spec.homepage      = "https://github.com/joshmcarthur/mail_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency 'mocha', '~> 0.13.3'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency "rake"
+  spec.add_dependency "mail"
+end

data/test/mail/logger/callback_test.rb

@@ -0,0 +1,44 @@
+require_relative "../../test_helper"
+
+describe Mail::Logger::Callback do
+  before do
+
+  end
+
+  describe "#delivered_email" do
+    subject do
+      mail_object
+    end
+
+    it "Logs the email" do
+      Mail::Logger.logger.expects(:info).with(subject.inspect).returns(true)
+      Mail::Logger::Callback.delivered_email(subject)
+    end
+  end
+
+  describe "Callback registration" do
+    before do
+      Mail.defaults do
+        delivery_method :test
+      end
+    end
+
+    it "Calls our callback method from Mail" do
+      Mail::Logger::Callback.stubs(:delivered_email).returns(true)
+      deliver_email
+    end
+  end
+
+  def deliver_email
+    Mail.new do
+      from "tester@example.com"
+      to   "tester@example.com"
+      subject "Test"
+      body "Test"
+    end.deliver
+  end
+
+  def mail_object
+    Mail.new
+  end
+end

data/test/mail/logger/configuration_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../test_helper'
+
+describe Mail::Logger::Configuration do
+  describe "with Rails" do
+    before do
+      module ::Rails
+        def self.env
+          "development"
+        end
+
+        def self.root
+            "log"
+          end
+      end
+    end
+
+    after do
+      Object.send(:remove_const, :Rails)
+    end
+
+    subject do
+      Mail::Logger::Configuration.new
+    end
+
+    it "Uses the Rails log folder as its path" do
+      subject.log_path.must_equal "log"
+    end
+
+    it "Uses the Rails environment to name the file" do
+      subject.log_file_name.must_equal "mail_development.log"
+    end
+  end
+
+  describe "without Rails" do
+    subject do
+      Mail::Logger::Configuration.new
+    end
+
+    it "Uses the log folder relative to the current directory" do
+      subject.log_path.must_equal File.expand_path("./log")
+    end
+
+    it "Uses a default string to name the file" do
+      subject.log_file_name.must_equal "mail.log"
+    end
+  end
+end

data/test/mail/logger/logfile_test.rb

@@ -0,0 +1,22 @@
+require_relative '../../test_helper'
+
+describe Mail::Logger::Logfile do
+  subject do
+    Mail::Logger::Logfile.new
+  end
+
+  it "Inherits from Logger" do
+    subject.class.superclass.must_equal ::Logger
+  end
+
+  it "derives its path from the config" do
+    Mail::Logger.configuration.expects(:log_path).returns(File.expand_path("./test/log"))
+    Mail::Logger::Logfile.new
+  end
+
+  it "Derives its filename from the config" do
+    Mail::Logger.configuration.expects(:log_file_name).returns("mail.log")
+    Mail::Logger::Logfile.new
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'test/unit'
+require 'mocha/setup'
+require 'mail_logger'
+
+Mail::Logger.configure do |config|
+  config.log_path = File.expand_path("./test/log")
+end
+
+unless File.directory?("./test/log")
+  require 'fileutils'
+  FileUtils.mkdir("./test/log")
+end
+
+Bundler.require(:default)
+

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: mail-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Lodges a callback with `Mail`, capturing all of the mail being sent,
+  and logging it to it''s own file, so you can simply look back through that file
+  to see what''s up. '
+email:
+- joshua.mcarthur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mail/logger/callback.rb
+- lib/mail/logger/configuration.rb
+- lib/mail/logger/logfile.rb
+- lib/mail/logger/version.rb
+- lib/mail_logger.rb
+- mail_logger.gemspec
+- test/mail/logger/callback_test.rb
+- test/mail/logger/configuration_test.rb
+- test/mail/logger/logfile_test.rb
+- test/test_helper.rb
+homepage: https://github.com/joshmcarthur/mail_logger
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3950467139491618074
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3950467139491618074
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Rubygem to capture information about sent emails, and log them to a file
+  all to their own!
+test_files:
+- test/mail/logger/callback_test.rb
+- test/mail/logger/configuration_test.rb
+- test/mail/logger/logfile_test.rb
+- test/test_helper.rb