mail_checker 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eugenio Depalo
+
+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/README.md

@@ -0,0 +1,54 @@
+# MailChecker
+
+RSpec matchers and helpers to set expectations on mails delivered to MailCatcher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mail_checker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail_checker
+
+## Usage
+
+Configure RSpec to use MailChecker:
+
+    RSpec.configure do |config|
+      config.include MailChecker::Helpers
+      config.include MailChecker::Matchers
+
+      config.before(:each) do
+        MailChecker.clear
+      end
+
+      config.before(:suite) do
+        MailChecker.configure do |config|
+          config.host = 'localhost'
+          config.port = 1080
+        end
+      end
+    end
+
+Setup expectations in your tests:
+
+    an_email(/Example Subject/).
+    to('user@example.com').
+    from('noreply@example.com').
+    should have_been_delivered
+
+Every expectation method accepts strings, regexps, arrays of strings or arrays of regexps.
+
+## 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 @@
+require 'bundler/gem_tasks'

data/lib/mail_checker.rb

@@ -0,0 +1,17 @@
+require 'mail_checker/version'
+require 'mail_checker/mail'
+require 'mail_checker/configuration'
+require 'mail_checker/expectation_matcher'
+require 'mail_checker/expectation'
+require 'mail_checker/matchers'
+require 'mail_checker/helpers'
+
+module MailChecker
+  def self.configure(&block)
+    Configuration.new(&block).configure
+  end
+
+  def self.clear
+    Mail.destroy_all
+  end
+end

data/lib/mail_checker/configuration.rb

@@ -0,0 +1,14 @@
+module MailChecker
+  class Configuration
+    attr_accessor :host
+    attr_accessor :port
+
+    def initialize
+      yield self
+    end
+
+    def configure
+      MailChecker::Mail.site = "#{host}:#{port}"
+    end
+  end
+end

data/lib/mail_checker/expectation.rb

@@ -0,0 +1,26 @@
+module MailChecker
+  class Expectation
+    attr_reader :subject, :attributes
+
+    def initialize(subject = nil)
+      @subject = subject
+    end
+
+    def to(*args)
+      return @to if args.empty?
+      @to = args.first
+      self
+    end
+
+    def from(*args)
+      return @from if args.empty?
+      @from = args.first
+      self
+    end
+
+    def with(attributes)
+      @attributes = attributes
+      self
+    end
+  end
+end

data/lib/mail_checker/expectation_matcher.rb

@@ -0,0 +1,46 @@
+require 'timeout'
+
+module MailChecker
+  class ExpectationMatcher
+    def matches?(expectation)
+      attributes = {}
+      attributes['subject'] = expectation.subject if expectation.subject
+      attributes['sender'] = expectation.from if expectation.from
+      attributes['recipients'] = expectation.to if expectation.to
+      attributes.reverse_merge!(expectation.attributes) if expectation.attributes
+
+      @attributes = attributes
+
+      begin
+        Timeout::timeout(5) do
+          loop do
+            break if MailChecker::Mail.any? do |mail|
+              attributes.all? { |a, v| attribute_matches?([*mail.attributes[a]], to_regexp([*v])) }
+            end
+
+            sleep 0.5
+          end
+        end
+      rescue Timeout::Error
+        false
+      else
+        true
+      end
+    end
+
+    def failure_message
+      "A mail with #{@attributes} was expected to be delivered but was not.\n" +
+      "List of received mails: #{MailChecker::Mail.all.map(&:attributes)}"
+    end
+
+    private
+
+    def attribute_matches?(actual, expected)
+      !expected.any? { |e| actual.any? { |a| a !~ e } }
+    end
+
+    def to_regexp(values)
+      values.map { |v| Regexp.new(v) }
+    end
+  end
+end

data/lib/mail_checker/helpers.rb

@@ -0,0 +1,7 @@
+module MailChecker
+  module Helpers
+    def an_email(subject)
+      MailChecker::Expectation.new(subject)
+    end
+  end
+end

data/lib/mail_checker/mail.rb

@@ -0,0 +1,28 @@
+module MailChecker
+  class Mail < ActiveResource::Base
+    self.element_name = 'message'
+
+    [:element_path, :new_element_path, :collection_path].each do |method|
+      define_singleton_method method do |*args|
+        super(*args).gsub(/\.#{format.extension}/, '')
+      end
+    end
+
+    def self.destroy_all
+      connection.delete(collection_path)
+    end
+
+    def self.any?(&block)
+      all.any?(&block)
+    end
+
+    def load(attributes, remove_root = false)
+      super(attributes, remove_root)
+
+      @attributes['sender'].gsub!(/[<>]/, '')
+      @attributes['recipients'].map! { |r| r.gsub(/[<>]/, '') }
+
+      self
+    end
+  end
+end

data/lib/mail_checker/matchers.rb

@@ -0,0 +1,7 @@
+module MailChecker
+  module Matchers
+    def have_been_delivered
+      MailChecker::ExpectationMatcher.new
+    end
+  end
+end

data/lib/mail_checker/version.rb

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

data/mail_checker.gemspec

@@ -0,0 +1,20 @@
+lib = File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_checker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'mail_checker'
+  gem.version       = MailChecker::VERSION
+  gem.authors       = ['Eugenio Depalo']
+  gem.email         = %w(eugeniodepalo@gmail.com)
+  gem.description   = %q{RSpec matchers and helpers to set expectations on mails delivered to MailCatcher}
+  gem.summary       = %q{Test mails sent to a MailCatcher SMTP server}
+  gem.homepage      = 'https://github.com/responsa/mail_checker'
+  
+  gem.add_dependency  'activeresource'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: mail_checker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eugenio Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  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: RSpec matchers and helpers to set expectations on mails delivered to
+  MailCatcher
+email:
+- eugeniodepalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mail_checker.rb
+- lib/mail_checker/configuration.rb
+- lib/mail_checker/expectation.rb
+- lib/mail_checker/expectation_matcher.rb
+- lib/mail_checker/helpers.rb
+- lib/mail_checker/mail.rb
+- lib/mail_checker/matchers.rb
+- lib/mail_checker/version.rb
+- mail_checker.gemspec
+homepage: https://github.com/responsa/mail_checker
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: Test mails sent to a MailCatcher SMTP server
+test_files: []