mandrill_mailer 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f1b23face89c57dcf4a9d63594a1d316adb67e5
-  data.tar.gz: 5311702dc42f69d2c6718177d6f790da846c56fa
+  metadata.gz: 79a6370588ee165bd28e0b2610236fb3bf533417
+  data.tar.gz: 52579261a95fc18eb4625cb41f9bb9c10fc09ad5
 SHA512:
-  metadata.gz: eda62b4c59aa3d60a60f15f851e5483cc1af155a3304c15ed28ee58ae1bccd59ff804e3af1913d018f451e11fac36ab14a95ebdde2ec6b44af30835060edb5fb
-  data.tar.gz: 094eed9cb7c1e02c72b9fd040ad2a7a03bb9ae46999601d0e654998d72e984e041383053094cf943e796c75875cd542319f9ec4db68f6d54fab9cb2d6c402990
+  metadata.gz: fd9651725cad09ddd52c4c796a14443ac7e91165b8da44be8e965f087989f74966310bd6d3cc72fcabc1bf90d817ed7d306030679804b1061880db80b6808e9f
+  data.tar.gz: c281185967f50d1036ba767875e2321afe0ac79e33e42ee4ddd097b9a19075a9d2a892ba62086769696daf36412c7f4dcbe3c5efd9d48eedb490e7b834b4b83c

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.1.0 - 2015-10-02
+### Added
+- Optional RSpec helper (`MandrillMailer::RSpecHelper`) with custom matchers
+to simplify testing mailers like:
+  - `expect(mailer).to be_from("email@example.com")`
+  - `expect(mailer).to have_merge_data('USER_EMAIL' => user.email)`
+  - `expect(mailer).to include_merge_var_content(user.email)`
+  - `expect(mailer).to have_subject("Hello")`
+  - `expect(mailer).to use_template('Example')`
+  - `expect(mailer).to send_email_to('email@example.com')`
+
+
 ## 1.0.4 - 2015-09-24
 ### Added
 - Allow default `view_content_link` on Mailer class.

data/lib/mandrill_mailer/rspec_helper.rb

@@ -0,0 +1,41 @@
+# MandrilMailer helper module that requires custom matchers for use in RSpec specs.
+# Example usage:
+#
+# In spec/spec_helper.rb):
+#
+# RSpec.configure do |config|
+#   # ...
+#   require "mandrill_mailer/rspec_helpers"
+#   config.include MandrillMailer::RSpecHelper
+# end
+#
+# In spec/mailers/user_mailer_spec.rb):
+#
+# require "rails_helper"
+#s
+# RSpec.describe UserMailer do
+#   let(:user) { create(:user) }
+#
+#   context ".welcome" do
+#     let(:mailer) { described_class.welcome(user) }
+#
+#     subject { mailer }
+#
+#     it 'has the correct data' do
+#       expect(mailer).to use_template('Welcome')
+#     end
+#   end
+# end
+#
+#
+
+module MandrillMailer
+  module RSpecHelper
+    require 'mandrill_mailer/rspec_helpers/from_matcher'
+    require 'mandrill_mailer/rspec_helpers/merge_var_matcher'
+    require 'mandrill_mailer/rspec_helpers/merge_var_content_matcher'
+    require 'mandrill_mailer/rspec_helpers/subject_matcher'
+    require 'mandrill_mailer/rspec_helpers/template_matcher'
+    require 'mandrill_mailer/rspec_helpers/to_email_matcher'
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/from_matcher.rb

@@ -0,0 +1,47 @@
+# Public: Matcher for asserting from email
+#
+# expected_options - The Hash options used to refine the selection (default: {}):
+#             :email - expected from email
+#             :name - expected from name
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to be_from('support@codeschool.com')
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :be_from do |expected_options|
+  match do |mailer|
+    bool_arr = [(mailer_from_email(mailer) == expected_options[:email] if expected_options[:email]),
+    (mailer_from_name(mailer) == expected_options[:name] if expected_options[:name])]
+    !bool_arr.compact.any? {|i| i == false}
+  end
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected from vars: #{mailer_from_email(mailer).inspect} to be: #{expected_options.inspect}.
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected from vars: #{mailer_from_email(mailer).inspect} to not be: #{expected_options.inspect}.
+  MESSAGE
+  end
+
+  description do
+    "be the same from vars as #{expected_options.inspect}"
+  end
+
+  def mailer_from_email(mailer)
+    mailer.message['from_email']
+  end
+
+  def mailer_from_name(mailer)
+    mailer.message['from_name']
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/merge_var_content_matcher.rb

@@ -0,0 +1,49 @@
+# Public: Matcher for asserting specific merge vars content contains something.
+#
+# expected_data - Data to look for in the specified merge var key.
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { FactoryGirl.create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to include_merge_var_content(user.email)
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :include_merge_var_content do |expected_data|
+  match do |actual|
+    has_match = false
+
+    matches = merge_vars_from(actual).find do |hash|
+      hash['name'] == 'CONTENT'
+    end
+
+    has_match = matches['content'].include?(expected_data)
+
+    has_match
+  end
+
+  failure_message do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected merge variables: #{merge_vars_from(actual).inspect} to include content: #{expected_data}.
+  MESSAGE
+  end
+
+  failure_message_when_negated do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected merge variables: #{merge_vars_from(actual).inspect} to not include content: #{expected_data}.
+  MESSAGE
+  end
+
+  description do
+    "include merge var content: #{expected_data}"
+  end
+
+  def merge_vars_from(mailer)
+    # Merge vars are in format:
+    # [{"name"=>"USER_EMAIL", "content"=>"zoila@homenick.name"},{"name"=>"USER_NAME", "content"=>"Bob"}]
+    mailer.message['global_merge_vars']
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/merge_var_matcher.rb

@@ -0,0 +1,48 @@
+# Public: Matcher for asserting merge vars have certain data.
+#
+# expected_data - Data to compare to the merge vars
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to have_merge_data('USER_EMAIL' => user.email)
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :have_merge_data do |expected_data|
+  match do |actual|
+    has_match = false
+    expected_data.each_pair do |key, value|
+      has_match = merge_vars_from(actual).any? do |obj|
+        obj['name'] == key && obj['content'] == value
+      end
+      break unless has_match
+    end
+    has_match
+  end
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected merge variables: #{merge_vars_from(actual).inspect} to include data: #{expected_data.inspect} but it does not.
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected merge variables: #{merge_vars_from(actual).inspect} to not include data: #{expected_data.inspect} but it does.
+  MESSAGE
+  end
+
+  description do
+    "be the same data as #{expected_data.inspect}"
+  end
+
+  def merge_vars_from(mailer)
+    # Merge vars are in format:
+    # [{"name"=>"USER_EMAIL", "content"=>"zoila@homenick.name"},{"name"=>"USER_NAME", "content"=>"Bob"}]
+    mailer.message['global_merge_vars']
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/subject_matcher.rb

@@ -0,0 +1,39 @@
+# Public: Matcher for asserting subject
+#
+#   expected_subject: - Expected subject of email
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to have_subject('Welcome Subscriber')
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :have_subject do |expected_subject|
+  match do |mailer|
+    mailer_subject(mailer) == expected_subject
+  end
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected subject: #{mailer_subject(mailer).inspect} to be: #{expected_subject.inspect}.
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected subject: #{mailer_subject(mailer).inspect} to not be: #{expected_subject.inspect}.
+  MESSAGE
+  end
+
+  description do
+    "be the same subject as #{expected_subject.inspect}"
+  end
+
+  def mailer_subject(mailer)
+    mailer.message['subject']
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/template_matcher.rb

@@ -0,0 +1,39 @@
+# Public: Matcher for asserting template
+#
+#   template_name: - name of template in mandrill the mailer sends to
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to use_template('Welcome Subscriber')
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :use_template do |expected_template|
+  match do |mailer|
+    mailer_template(mailer) == expected_template
+  end
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected template: #{mailer_template(mailer).inspect} to be: #{expected_template.inspect}.
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected template: #{mailer_template(mailer).inspect} to not be: #{expected_template.inspect}.
+  MESSAGE
+  end
+
+  description do
+    "be the same template as #{expected_template.inspect}"
+  end
+
+  def mailer_template(mailer)
+    mailer.template_name
+  end
+end

data/lib/mandrill_mailer/rspec_helpers/to_email_matcher.rb

@@ -0,0 +1,63 @@
+# Public: Matcher for asserting to email
+#
+# expected_to - The Hash options used to designate to whom the email is sent, options are optional (default: {}):
+#             :name - Name of reciever
+#             :email - email of reciever
+#
+# WelcomeMailer is an instance of MandrillMailler::TemplateMailer
+#
+# let(:user) { create(:user) }
+# let(:mailer) { WelcomeMailer.welcome_registered(user) }
+# it 'has the correct data' do
+#   expect(mailer).to send_email_to(email: user.email, name: 'Code School Customer')
+# end
+#
+# it 'has the correct to name' do
+#   expect(mailer).to send_email_to(name: 'Code School Customer')
+# end
+#
+# it 'has the correct email' do
+#   expect(mailer).to send_email_to(email: user.email')
+# end
+#
+# Returns true or an error message on failure
+#
+RSpec::Matchers.define :send_email_to do |expected_to|
+  match do |mailer|
+    to_arr = mailer_to_data(mailer)
+    opts_found = false
+    expected_to.each_pair do |key, value|
+      opts_found = to_arr.any? do |to_opt|
+        to_opt.symbolize_keys!
+        bool_arr = [
+          (to_opt[:email] == value if key.to_sym == :email),
+          (to_opt[:name] == value if key.to_sym == :name)
+        ]
+        !bool_arr.compact.any? {|i| i == false}
+      end
+      break unless opts_found
+    end
+    opts_found
+  end
+
+  failure_message_for_should do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected to variables: #{mailer_to_data(mailer).inspect} to include data: #{expected_to.inspect} but it does not.
+  MESSAGE
+  end
+
+  failure_message_for_should_not do |actual|
+    <<-MESSAGE.strip_heredoc
+    Expected to variables: #{mailer_to_data(mailer).inspect} to not include data: #{expected_to.inspect} but it does.
+  MESSAGE
+  end
+
+  description do
+    "be the same to data as #{expected_to.inspect}"
+  end
+
+  def mailer_to_data(mailer)
+    # {email: 'user@email.com', name: 'larry'}
+    mailer.message['to']
+  end
+end

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,6 +100,13 @@ files:
 - lib/mandrill_mailer/mock.rb
 - lib/mandrill_mailer/offline.rb
 - lib/mandrill_mailer/railtie.rb
+- lib/mandrill_mailer/rspec_helper.rb
+- lib/mandrill_mailer/rspec_helpers/from_matcher.rb
+- lib/mandrill_mailer/rspec_helpers/merge_var_content_matcher.rb
+- lib/mandrill_mailer/rspec_helpers/merge_var_matcher.rb
+- lib/mandrill_mailer/rspec_helpers/subject_matcher.rb
+- lib/mandrill_mailer/rspec_helpers/template_matcher.rb
+- lib/mandrill_mailer/rspec_helpers/to_email_matcher.rb
 - lib/mandrill_mailer/template_mailer.rb
 - lib/mandrill_mailer/version.rb
 - mandrill_mailer.gemspec
@@ -130,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Transactional Mailer for Mandrill