mandrill_batch_mailer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 543546712df76b8951495980cc35097c2fef9254
+  data.tar.gz: ab6274490ddcb0cd98f6d39576d7d875e70fe78f
+SHA512:
+  metadata.gz: 13bf90c99ecf6819c6ee8b36c4b3e9e9b38eaf6c6686e2a010a0f3e69cf99a1c7852bd3173dd47f6e8582683e2a9e5b8d3ee950677ba5d0a00f8a9cc43a55ada
+  data.tar.gz: b5a2688b2f0b7fede0ad9a7305ff18c81d629a8816fdbb8fa7cddc2df0055da744523f924aaa2f02d9efaf60adcb322327ac5675084e5290e5e9d52a11f3ad88

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,15 @@
+# mandrill_batch_mailer
+
+[![Code Coverage](https://coveralls.io/repos/schasse/mandrill_batch_mailer/badge.png?branch=master)](https://coveralls.io/r/schasse/mandrill_batch_mailer)
+[![Build Status](https://travis-ci.org/schasse/mandrill_batch_mailer.png?branch=master)](https://travis-ci.org/schasse/mandrill_batch_mailer)
+
+
+Send batched Mails via Mandrill API.
+
+## INSTALLATION
+
+    gem install mandrill_batch_mailer
+
+## EXAMPLE
+
+  TODO

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/lib/mandrill_batch_mailer.rb

@@ -0,0 +1,4 @@
+require 'mandrill_batch_mailer/base_mailer'
+
+module MandrillBatchMailer
+end

data/lib/mandrill_batch_mailer/base_mailer.rb

@@ -0,0 +1,231 @@
+require 'active_support'
+require 'active_support/inflector'
+require 'active_support/core_ext/object/try'
+
+module MandrillBatchMailer
+  ENDPOINT = 'https://mandrillapp.com/api/1.0/messages/'\
+    'send-template.json'
+
+  def self.logger
+    @logger ||= rails_logger || Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.rails_logger
+    defined?(Rails) && Rails.logger
+  end
+
+  class BaseMailer
+    private
+
+      attr_accessor :caller_method_name
+
+    public
+
+      cattr_accessor :intercept_recipients, :interception_base_mail,
+        :perform_deliveries, :from_email, :from_name, :api_key
+
+    # Redirect all mails to one address.
+    self.intercept_recipients = true
+    # Set a mail address you want your mails redirected to. '+#{nr}' will be
+    # added for each recipient and the subject line includes the original mail
+    # address.
+    self.interception_base_mail = 'staging-notifier@gapfish.com'
+    # Set to true to *really* send data to mandrill.
+    self.perform_deliveries = false
+
+    def initialize(method)
+      self.caller_method_name = method
+    end
+
+    def mail(to: nil)
+      @tos = tos_from(to)
+      send_template mandrill_parameters
+    end
+
+    # feel free to override
+    def from_email
+      self.class.from_email
+    end
+
+    # feel free to override
+    def from_name
+      self.class.from_name || ''
+    end
+
+    # feel free to override
+    def tags
+      ["#{template_name}"]
+    end
+
+    def api_key
+      self.class.api_key
+    end
+
+    class << self
+      # do it just as ActionMailer
+      def method_missing(method, *args)
+        mailer = new method
+        if mailer.respond_to? method
+          mailer.public_send(method, *args)
+        else
+          super method, *args
+        end
+      end
+    end
+
+    protected
+
+      def scope
+        "#{class_name.underscore.gsub('/', '.')}.#{caller_method_name}"
+      end
+
+    private
+
+      def mandrill_parameters
+        {
+          key: api_key,
+          template_name: template_name,
+          template_content: [],
+          message: {
+            subject: subject,
+            from_email: from_email,
+            from_name: from_name,
+            to: to,
+            important: false,
+            track_opens: nil,
+            track_clicks: nil,
+            inline_css: true,
+            url_strip_qs: nil,
+            preserve_recipients: false,
+            view_content_link: nil,
+            tracking_domain: nil,
+            signing_domain: nil,
+            return_path_domain: nil,
+            merge: true,
+            global_merge_vars: global_merge_vars,
+            merge_vars: merge_vars,
+            tags: tags
+          },
+          async: true
+        }.deep_merge(_default)
+      end
+
+      def _default
+        given_defaults = (respond_to?(:default, true) && default) || {}
+        if MandrillBatchMailer::BaseMailer.intercept_recipients
+          given_defaults[:message].try(:delete, :to)
+        end
+        given_defaults
+      end
+
+      def template_name
+        "#{class_name.underscore}_#{caller_method_name}".split('/').last
+          .gsub '_', '-'
+      end
+
+      def tags
+        ["#{template_name}_#{locale}"]
+      end
+
+      def locale
+        I18n.locale
+      end
+
+      def subject
+        '*|subject|*'
+      end
+
+      def to
+        if MandrillBatchMailer::BaseMailer.intercept_recipients
+          @tos.keys.size.times.map do |i|
+            { email: MandrillBatchMailer::BaseMailer
+                .interception_base_mail.sub('@', "+#{i}@") }
+          end
+        else
+          @tos.keys.map { |to_email| { email: to_email } }
+        end
+      end
+
+      def global_merge_vars
+        merge_vars_from(translations.merge(shared_translations))
+      end
+
+      def merge_vars
+        @tos.each_with_index.map do |to, i|
+          to_email, vars = to.to_a
+          if MandrillBatchMailer::BaseMailer.intercept_recipients
+            { rcpt: MandrillBatchMailer::BaseMailer.interception_base_mail
+                .sub('@', "+#{i}@"),
+              vars: intercepted_merge_vars(to_email, vars)
+            }
+          else
+            { rcpt: to_email,
+              vars: merge_vars_from(vars)
+            }
+          end
+        end
+      end
+
+      def intercepted_merge_vars(to_email, vars)
+        merge_vars_from(vars.merge(
+          subject: "#{to_email} #{vars[:subject] || translations[:subject]}"))
+      end
+
+      ## HELPER METHODS ##
+
+      # @return [Hash]
+      #   p.e. { 'some@mail.ch' => { a_variable: 'Hello' } }
+      def tos_from(to)
+        case to
+        when String
+          { to => {} }
+        when Array
+          to.map { |single_to| [single_to, {}] }.to_h
+        when Hash
+          to
+        else
+          to.to_h
+        end
+      end
+
+      def translations
+        I18n.t scope, default: {}
+      end
+
+      def class_name
+        self.class.to_s
+      end
+
+      def shared_translations
+        I18n.t "#{class_name.deconstantize.underscore}.shared_translations",
+          default: {}
+      end
+
+      def merge_vars_from(translations)
+        translations.map do |key, translation|
+          { name: key, content: translation }
+        end
+      end
+
+      def send_template(params)
+        if MandrillBatchMailer::BaseMailer.perform_deliveries
+          RestClient.post MandrillBatchMailer::ENDPOINT, params.to_json
+          params
+        else
+          params_inspect =
+            if defined? AwesomePrint
+              params.ai
+            else
+              params.inspect
+            end
+          MandrillBatchMailer.logger
+            .info "Sending Mandrill Mail: #{params_inspect}"
+          params
+        end
+      end
+  end
+end

data/lib/mandrill_batch_mailer/version.rb

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

data/spec/mandrill_batch_mailer/base_mailer_spec.rb

@@ -0,0 +1,260 @@
+require 'spec_helper'
+
+describe MandrillBatchMailer::BaseMailer, :dbless do
+  let(:user_dup) do
+    -> do
+      double locale: :de, email: Faker::Internet.email, first_name: Faker.name
+    end
+  end
+  let(:user) do
+    user_dup.call
+  end
+  let(:more_users) do
+    2.times.map { user_dup.call } + [user]
+  end
+
+  let(:translations) do
+    {
+      mandrill_batch_mailer: {
+        shared_translations: {
+          salutation: 'Hello'
+        },
+        test_mailer: {
+          testing: {
+            subject: 'A Test Subject',
+            just_a_test: 'This is just a test',
+            regards: 'Regards, your dev team'
+          },
+          test_bulk: {
+            salutation: 'Hello %{name}'
+          }
+        }
+      }
+    }
+  end
+
+  class MandrillBatchMailer::TestMailer < MandrillBatchMailer::BaseMailer
+    def testing(user)
+      @user = user
+      mail to: user.email
+    end
+
+    def test_bulk(users)
+      @user = users.first # TODO: think about I18n.locale
+      to_params = users.map do |user|
+        [user.email,
+          { salutation: I18n.t(:salutation, name: user.first_name,
+              scope: 'mandrill.test_mailer.test_bulk') }]
+      end.to_h
+      mail to: to_params
+    end
+  end
+
+  let(:test_mailer) { MandrillBatchMailer::TestMailer.new :testing }
+  let(:base_mailer) { MandrillBatchMailer::BaseMailer.new :testing }
+
+  before do
+    I18n.backend.store_translations :en, translations
+  end
+
+  after do
+    I18n.backend.reload!
+  end
+
+  shared_context 'when intercepting', :intercept do
+    before do
+      @old_intercept = MandrillBatchMailer::BaseMailer.intercept_recipients
+      MandrillBatchMailer::BaseMailer.intercept_recipients = true
+      @old_intercept_mail =
+        MandrillBatchMailer::BaseMailer.interception_base_mail
+      MandrillBatchMailer::BaseMailer.interception_base_mail =
+        'notifier@gapfish.com'
+    end
+    after do
+      MandrillBatchMailer::BaseMailer.intercept_recipients = @old_value
+      MandrillBatchMailer::BaseMailer.interception_base_mail =
+        @old_intercept_mail
+    end
+  end
+
+  shared_context 'when not intercepting', intercept: false do
+    before do
+      @old_intercept = MandrillBatchMailer::BaseMailer.intercept_recipients
+      MandrillBatchMailer::BaseMailer.intercept_recipients = false
+    end
+    after do
+      MandrillBatchMailer::BaseMailer.intercept_recipients = @old_intercept
+    end
+  end
+
+  shared_context 'when delivering', :deliver do
+    before do
+      @old_deliveries = MandrillBatchMailer::BaseMailer.perform_deliveries
+      MandrillBatchMailer::BaseMailer.perform_deliveries = true
+    end
+    after do
+      MandrillBatchMailer::BaseMailer.perform_deliveries = @old_deliveries
+    end
+  end
+
+  shared_context 'when not delivering', deliver: false do
+    before do
+      @old_deveries = MandrillBatchMailer::BaseMailer.perform_deliveries
+      MandrillBatchMailer::BaseMailer.perform_deliveries = false
+    end
+    after do
+      MandrillBatchMailer::BaseMailer.perform_deliveries = @old_deliveries
+    end
+  end
+
+  describe '#mail', :intercept do
+    subject(:mail) { test_mailer.testing user }
+    it { should be_a Hash }
+
+    it 'has the correct template name' do
+      expect(mail[:template_name]).to eq 'test-mailer-testing'
+    end
+
+    context 'bulky' do
+      subject(:mail) { test_mailer.test_bulk more_users }
+      it { should be_a Hash }
+    end
+  end
+
+  describe '#template_name' do
+    subject { test_mailer.send :template_name }
+
+    it { should eq 'test-mailer-testing'}
+
+    context 'when calling from BaseMailer' do
+      subject { base_mailer.send :template_name }
+
+      it { should eq 'base-mailer-testing' }
+    end
+  end
+
+  describe '#subject' do
+    subject { test_mailer.send :subject }
+    context 'when intercepting', :intercept do
+      it { should eq '*|subject|*' }
+    end
+    context 'when not intercepting', intercept: false do
+      it { should eq '*|subject|*' }
+    end
+  end
+
+  describe '#from_name' do
+    # TODO: write the test, when mattr is defined
+    it 'uses the configured from_name'
+  end
+
+  describe '#to' do
+    before do
+      test_mailer.instance_variable_set :@tos, { user.email => [] }
+    end
+    subject { test_mailer.send :to }
+
+    context 'when intercepted', :intercept do
+      it { should eq [{ email: 'notifier+0@gapfish.com' }] }
+    end
+
+    context 'when not intercepted', intercept: false do
+      it { should eq [{ email: user.email }] }
+    end
+  end
+
+  describe '#global_merge_vars' do
+    let(:global_merge_vars) { test_mailer.send :global_merge_vars }
+
+    it 'should include the correct translations' do
+      expect([
+        { name: :subject, content: 'A Test Subject' },
+        { name: :just_a_test, content: 'This is just a test' },
+        { name: :regards, content: 'Regards, your dev team' },
+        { name: :salutation, content: 'Hello' }
+      ].to_set).to be_subset global_merge_vars.to_set
+    end
+  end
+
+  describe '#merge_vars' do
+    before do
+      test_mailer.instance_variable_set :@tos,
+        base_mailer.send(:tos_from, user.email)
+    end
+    subject(:merge_vars) { test_mailer.send :merge_vars }
+
+    context 'when not intercept', intercept: false do
+      it { should eq [{ rcpt: user.email, vars: [] }]}
+    end
+    context 'when intercept_recipients', :intercept do
+      it { expect(merge_vars.first[:rcpt]).to eq 'notifier+0@gapfish.com' }
+      it do
+        expect(merge_vars.first[:vars].first[:content]).to include user.email
+      end
+    end
+  end
+
+  describe '#tos_from' do
+    subject { test_mailer.send :tos_from, input }
+
+    {
+      nil => {},
+      '' => { '' => {} },
+      'some@mail.de' => { 'some@mail.de' => {} },
+      [] => {},
+      ['some@mail.de', 'some_other@mail.de'] => {
+        'some@mail.de' => {}, 'some_other@mail.de' => {} },
+      { hello: :world } => { hello: :world }
+    }.each do |input, output|
+      context "when #{input} given" do
+        let(:input) { input }
+        it { should eq output }
+      end
+    end
+  end
+
+  describe '#translations' do
+    subject { test_mailer.send :translations }
+    it do
+      should eq translations[:mandrill_batch_mailer][:test_mailer][:testing]
+    end
+  end
+
+  describe '#shared_translations' do
+    subject { test_mailer.send :shared_translations }
+    it do
+      should eq translations[:mandrill_batch_mailer][:shared_translations]
+        .deep_merge(subject)
+    end
+  end
+
+  describe '#send_template' do
+    let(:params) { {} }
+
+    context 'when delivering', :deliver do
+
+      it "calls mandrill's endoint, when performing deliveries" do
+        expect(RestClient).to receive(:post)
+          .with(MandrillBatchMailer::ENDPOINT, params.to_json)
+        test_mailer.send :send_template, params
+      end
+
+      context 'when there happens an exception' do
+        before do
+          allow(RestClient).to receive(:post).and_raise(RestClient::Exception)
+        end
+
+        it 'raises exception' do
+          expect { test_mailer.send :send_template, params }.to raise_exception
+        end
+      end
+    end
+
+    context 'when not performing deliveries', deliver: false do
+      after { test_mailer.send :send_template, params }
+      it 'just logs something' do
+        expect(MandrillBatchMailer.logger).to receive(:info)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path '../../lib', __FILE__
+require 'mandrill_batch_mailer'
+require 'mandrill_batch_mailer/base_mailer'
+
+require 'pry'
+require 'faker'
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start
+
+Coveralls.wear!
+
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: mandrill_batch_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- schasse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send batched Mails via Mandrill API
+email:
+- sebastian.schasse@gapfish.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mandrill_batch_mailer.rb
+- lib/mandrill_batch_mailer/base_mailer.rb
+- lib/mandrill_batch_mailer/version.rb
+- spec/mandrill_batch_mailer/base_mailer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/schasse/mandrill_batch_mailer
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Send batched Mails via Mandrill API
+test_files:
+- spec/spec_helper.rb
+- spec/mandrill_batch_mailer/base_mailer_spec.rb