email-example-spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2034214910583bef70d8126fb149f4f120e8d7f8
+  data.tar.gz: 85e8e2315c1cc6352f68a7291f559e437e8eef29
+SHA512:
+  metadata.gz: d36467df05f67658104489fe0fbddd4a47a400d615244dde557d032125c5fedd6539227e4509d25593e3438075539b24898043130917affc9bce1612b9764603
+  data.tar.gz: a15fd539690da96e548ffd6498e82e9e7c08df355a6e571d43597f4ccf838e75e27b9ea499f00cd7bbd350401ae428e8abb3f77d2e2e2c3e18a36f3a440414c8

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (Next)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to EmailExampleSpec
+
+This project is work of [many contributors](https://github.com/dblock/email-example-spec/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/email-example-spec/pulls), [propose features and discuss issues](https://github.com/dblock/email-example-spec/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/email-example-spec) and check out your copy.
+
+```
+git clone https://github.com/contributor/email-example-spec.git
+cd email-example-spec
+git remote add upstream https://github.com/dblock/email-example-spec.git
+```
+
+## Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+Add to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
+Run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+## Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+## Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
+Make it look like every other line, including your name and link to your Github account.
+
+## Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/grape and select your feature branch.
+Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+## Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/email-example-spec/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 10.4'
+gem 'rubocop', '0.30.0'
+gem 'rspec', '~> 3.2'

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    email-example-spec (0.1.0)
+      actionmailer
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    globalid (0.3.3)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.30.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  email-example-spec!
+  rake (~> 10.4)
+  rspec (~> 3.2)
+  rubocop (= 0.30.0)

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015 Daniel Doubrovkine, Artsy and Contributors
+
+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,47 @@
+ExampleExampleSpec
+==================
+
+[![Build Status](https://travis-ci.org/dblock/email-example-spec.png)](https://travis-ci.org/dblock/email-example-spec)
+
+VCR for e-mail templates.
+
+## Install
+
+```ruby
+gem 'email-example-spec'
+```
+
+## Configure
+
+Configure the root directory of your mail fixtures in *spec/spec_helper.rb*.
+
+```ruby
+EmailExampleSpec.configure do |config|
+  config.record = true # record new e-mails, don't commit this!
+  config.fixture_path = File.join(Rails.root, 'spec/support/fixtures/emails')
+end
+```
+
+## Use
+
+```ruby
+describe WelcomeMailer do
+  let(:user) { User.new }
+  subject do
+    WelcomeMailer.welcome(user)
+  end
+  it 'works' do
+    expect(subject).to match_email_example_in 'welcome_mail.txt'
+  end
+end
+```
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2015, Daniel Doubrovkine, Artsy and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/email-example-spec.gemspec

@@ -0,0 +1,17 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'email-example-spec/version'
+
+Gem::Specification.new do |s|
+  s.name = 'email-example-spec'
+  s.version = EmailExampleSpec::VERSION
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = Dir['**/*']
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/email-example-spec'
+  s.licenses = ['MIT']
+  s.summary = 'Integration testing with e-mail examples.'
+  s.add_dependency 'actionmailer'
+end

data/lib/email-example-spec.rb

@@ -0,0 +1,19 @@
+require 'action_mailer'
+
+require 'email-example-spec/version'
+require 'email-example-spec/config'
+require 'email-example-spec/fixture'
+require 'email-example-spec/email/content'
+require 'email-example-spec/rspec/match_email_example_in'
+
+module EmailExampleSpec
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/email-example-spec/config.rb

@@ -0,0 +1,8 @@
+module EmailExampleSpec
+  module Config
+    extend self
+
+    attr_accessor :fixture_path
+    attr_accessor :record
+  end
+end

data/lib/email-example-spec/email/content.rb

@@ -0,0 +1,14 @@
+module EmailExampleSpec
+  module Email
+    module Content
+      def self.encoded(email)
+        email = email.dup
+        email.add_date Time.at(0).utc
+        email.message_id = 1
+        email.content_type_parameters['boundary'] = 'boundary'
+        email.body.boundary = 'boundary'
+        email.encoded
+      end
+    end
+  end
+end

data/lib/email-example-spec/fixture.rb

@@ -0,0 +1,18 @@
+module EmailExampleSpec
+  module Fixture
+    def self.read_or_record!(fixture, content)
+      fixture = File.join(EmailExampleSpec.config.fixture_path, fixture) if EmailExampleSpec.config.fixture_path
+      if File.exist?(fixture)
+        File.read(fixture)
+      elsif EmailExampleSpec.config.record
+        FileUtils.mkdir_p File.dirname(fixture)
+        File.open(fixture, 'wt') do |file|
+          file.write(content)
+        end
+        content
+      else
+        fail "missing #{fixture}"
+      end
+    end
+  end
+end

data/lib/email-example-spec/rspec/match_email_example_in.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :match_email_example_in do |expected, _options = {}|
+  match do |actual|
+    actual_content = EmailExampleSpec::Email::Content.encoded(actual)
+    expected_content = EmailExampleSpec::Fixture.read_or_record! expected, actual_content
+    actual_content == expected_content
+  end
+end

data/lib/email-example-spec/version.rb

@@ -0,0 +1,3 @@
+module EmailExampleSpec
+  VERSION = '0.1.0'
+end

data/lib/email_example_spec.rb

@@ -0,0 +1 @@
+require 'email-example-spec'

data/spec/email-example-spec/rspec/match_email_example_in_html_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'html' do
+  subject do
+    Class.new(ActionMailer::Base) do
+      default from: 'Joe User <joe@example.org>'
+
+      def welcome_mail(username)
+        @username = username
+        mail to: 'user@example.org', subject: 'Welcome!' do |format|
+          format.html { render 'rspec/match_email_example_in/welcome_mail' }
+        end
+      end
+    end
+  end
+  it 'matches' do
+    expect(subject.welcome_mail('username')).to match_email_example_in 'rspec/match_email_example_in/welcome_mail.html'
+  end
+end

data/spec/email-example-spec/rspec/match_email_example_in_plain_text_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'plain text' do
+  subject do
+    Class.new(ActionMailer::Base) do
+      default from: 'Joe User <joe@example.org>'
+
+      def welcome_mail(username)
+        @username = username
+        mail to: 'user@example.org', subject: 'Welcome!' do |format|
+          format.text { render 'rspec/match_email_example_in/welcome_mail' }
+        end
+      end
+    end
+  end
+  it 'matches' do
+    expect(subject.welcome_mail('username')).to match_email_example_in 'rspec/match_email_example_in/welcome_mail.txt'
+  end
+end

data/spec/email-example-spec/rspec/match_email_example_multipart_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'multipart' do
+  subject do
+    Class.new(ActionMailer::Base) do
+      default from: 'Joe User <joe@example.org>'
+
+      def welcome_mail(username)
+        @username = username
+        mail to: 'user@example.org', subject: 'Welcome!' do |format|
+          format.html { render 'rspec/match_email_example_in/welcome_mail' }
+          format.text { render 'rspec/match_email_example_in/welcome_mail' }
+        end
+      end
+    end
+  end
+  it 'matches' do
+    expect(subject.welcome_mail('username')).to match_email_example_in 'rspec/match_email_example_in/welcome_mail.multipart'
+  end
+end

data/spec/email-example-spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe EmailExampleSpec do
+  it 'has a version' do
+    expect(EmailExampleSpec::VERSION).to_not be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'email-example-spec'
+
+ActionMailer::Base.view_paths = File.join(File.dirname(__FILE__), 'support/templates')
+
+EmailExampleSpec.configure do |config|
+  config.fixture_path = File.join(File.dirname(__FILE__), 'support/fixtures')
+  config.record = true
+end

data/spec/support/fixtures/rspec/match_email_example_in/welcome_mail.html

@@ -0,0 +1,16 @@
+Date: Thu, 01 Jan 1970 00:00:00 +0000
+From: Joe User <joe@example.org>
+To: user@example.org
+Message-ID: 1
+Subject: Welcome!
+Mime-Version: 1.0
+Content-Type: text/html;
+ boundary=boundary;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+<body>
+  <p>Hi username,</p>
+  <p>Thanks for joining our service! Please check back often.</p>
+</body>
+

data/spec/support/fixtures/rspec/match_email_example_in/welcome_mail.multipart

@@ -0,0 +1,33 @@
+Date: Thu, 01 Jan 1970 00:00:00 +0000
+From: Joe User <joe@example.org>
+To: user@example.org
+Message-ID: 1
+Subject: Welcome!
+Mime-Version: 1.0
+Content-Type: multipart/alternative;
+ boundary=boundary;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+
+--boundary
+Content-Type: text/plain;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+Hi username,
+
+Thanks for joining our service! Please check back often.
+
+--boundary
+Content-Type: text/html;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+<body>
+  <p>Hi username,</p>
+  <p>Thanks for joining our service! Please check back often.</p>
+</body>
+
+
+--boundary--

data/spec/support/fixtures/rspec/match_email_example_in/welcome_mail.txt

@@ -0,0 +1,14 @@
+Date: Thu, 01 Jan 1970 00:00:00 +0000
+From: Joe User <joe@example.org>
+To: user@example.org
+Message-ID: 1
+Subject: Welcome!
+Mime-Version: 1.0
+Content-Type: text/plain;
+ boundary=boundary;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+Hi username,
+
+Thanks for joining our service! Please check back often.

data/spec/support/templates/rspec/match_email_example_in/welcome_mail.html.erb

@@ -0,0 +1,5 @@
+<body>
+  <p>Hi <%= @username %>,</p>
+  <p>Thanks for joining our service! Please check back often.</p>
+</body>
+

data/spec/support/templates/rspec/match_email_example_in/welcome_mail.text.erb

@@ -0,0 +1,3 @@
+Hi <%= @username %>,
+
+Thanks for joining our service! Please check back often.

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: email-example-spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- email-example-spec.gemspec
+- lib/email-example-spec.rb
+- lib/email-example-spec/config.rb
+- lib/email-example-spec/email/content.rb
+- lib/email-example-spec/fixture.rb
+- lib/email-example-spec/rspec/match_email_example_in.rb
+- lib/email-example-spec/version.rb
+- lib/email_example_spec.rb
+- spec/email-example-spec/rspec/match_email_example_in_html_spec.rb
+- spec/email-example-spec/rspec/match_email_example_in_plain_text_spec.rb
+- spec/email-example-spec/rspec/match_email_example_multipart_spec.rb
+- spec/email-example-spec/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/rspec/match_email_example_in/welcome_mail.html
+- spec/support/fixtures/rspec/match_email_example_in/welcome_mail.multipart
+- spec/support/fixtures/rspec/match_email_example_in/welcome_mail.txt
+- spec/support/templates/rspec/match_email_example_in/welcome_mail.html.erb
+- spec/support/templates/rspec/match_email_example_in/welcome_mail.text.erb
+homepage: http://github.com/dblock/email-example-spec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Integration testing with e-mail examples.
+test_files: []