mandrill_batch_mailer 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 543546712df76b8951495980cc35097c2fef9254
-  data.tar.gz: ab6274490ddcb0cd98f6d39576d7d875e70fe78f
+  metadata.gz: 9c6e6c5d426fdfc9462c81098e2c64f2146907a5
+  data.tar.gz: c2a7696bad891b2479cf370db9ee6753b25cc9dc
 SHA512:
-  metadata.gz: 13bf90c99ecf6819c6ee8b36c4b3e9e9b38eaf6c6686e2a010a0f3e69cf99a1c7852bd3173dd47f6e8582683e2a9e5b8d3ee950677ba5d0a00f8a9cc43a55ada
-  data.tar.gz: b5a2688b2f0b7fede0ad9a7305ff18c81d629a8816fdbb8fa7cddc2df0055da744523f924aaa2f02d9efaf60adcb322327ac5675084e5290e5e9d52a11f3ad88
+  metadata.gz: 284043167940b1473b76f4eff2b6b2c813a5853c9b50c549914567e76d737134730a12d0caf52e1dadd7bdc6f6254033d3c2393b0acf6fb6b321200a54137d3e
+  data.tar.gz: 6768a56dfb2d615fef6014f892906ce25eb5325fa12fd8be06b7ffe2f04bf7a6bb1f1776f0dc2eb686f05ad9cc122cfe5926beca256fe8be9adf3927e3cc2a3b

data/README.md

@@ -6,10 +6,89 @@
 
 Send batched Mails via Mandrill API.
 
-## INSTALLATION
+## Installation
 
     gem install mandrill_batch_mailer
 
-## EXAMPLE
+## Configuration
 
-  TODO
+    # config/mandrill_batch_mailer.rb
+
+    MandrillBatchMailer.configure do |config|
+      # enable sending mails via the Mandrill API, default is false
+      config.perform_deliveries = true
+
+      # Enables interception of mails. Default is false
+      config.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.
+      config.interception_base_mail = 'all-mails-to@some-domain.com'
+
+      # Set to your Mandrill API Key you get from Mandrill.
+      config.api_key = '3x4mpl3_k3y'
+
+      # Set your from e-mail address and name
+      config.from_email = 'mail@my-app.com'
+      config.from_name = 'My App'
+    end
+
+
+## Example
+
+    # config/locales/en.yml
+
+    en:
+      mandrill:
+        shared_translations:
+          cheers: 'Cheers Your App-Team''
+        welcome_mailer:
+          welcome:
+            subject: 'Welcome to our App!'
+            welcome_to_app: 'welcome to our App.'
+        mass_mailer:
+          mass_mail:
+            subject: 'This is a mass mail'
+            be_awesome: 'let's be awesome!'
+
+    # app/mailers/mandrill/welcome_mailer.rb
+
+    class Mandrill::WelcomeMailer < MandrillBatchMailer::BaseMailer
+      def welcome(user_id)
+        @user = User.find user_id
+        mail to: welcome_merge_vars
+      end
+
+      private
+
+      def welcome_merge_vars
+        {
+          @user.email => {
+            user_salutation: @user.salutation
+          }
+        }
+      end
+    end
+
+    # app/mailers/mandrill/mass_mailer.rb
+
+    class Mandrill::MassMailer < MandrillBatchMailer::BaseMailer
+
+      def mass_mail(user_ids)
+        @users = User.find user_ids
+        mail to: mass_mail_merge_vars
+      end
+
+      private
+
+      def mass_mail_merge_vars
+        @users.map do |user|
+          [user.email,
+            {
+              user_salutation: user.salutation
+            }
+          ]
+        end.to_h
+      end
+    end

data/lib/mandrill_batch_mailer.rb

@@ -1,4 +1,30 @@
 require 'mandrill_batch_mailer/base_mailer'
+require 'active_support/configurable'
 
 module MandrillBatchMailer
+  include ActiveSupport::Configurable
+
+  ENDPOINT = 'https://mandrillapp.com/api/1.0/messages/'\
+             'send-template.json'
+
+  config_accessor :perform_deliveries,
+                  :intercept_recipients,
+                  :interception_base_mail,
+                  :from_email,
+                  :from_name,
+                  :api_key
+
+  self.perform_deliveries = false
+  self.intercept_recipients = false
+  self.interception_base_mail = ''
+
+  attr_writer :logger
+
+  def self.logger
+    @logger ||= rails_logger || Logger.new(STDOUT)
+  end
+
+  def self.rails_logger
+    defined?(Rails) && Rails.logger
+  end
 end

data/lib/mandrill_batch_mailer/base_mailer.rb

@@ -3,21 +3,6 @@ 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
 
@@ -25,57 +10,41 @@ module MandrillBatchMailer
 
     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
+      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
+        MandrillBatchMailer.from_email
+      end
+
+      # feel free to override
+      def from_name
+        MandrillBatchMailer.from_name || ''
+      end
+
+      # feel free to override
+      def tags
+        ["#{template_name}"]
+      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
-    end
 
     protected
 
@@ -85,9 +54,10 @@ module MandrillBatchMailer
 
     private
 
+      # rubocop:disable MethodLength
       def mandrill_parameters
         {
-          key: api_key,
+          key: MandrillBatchMailer.api_key,
           template_name: template_name,
           template_content: [],
           message: {
@@ -113,10 +83,11 @@ module MandrillBatchMailer
           async: true
         }.deep_merge(_default)
       end
+      # rubocop:enable MethodLength
 
       def _default
         given_defaults = (respond_to?(:default, true) && default) || {}
-        if MandrillBatchMailer::BaseMailer.intercept_recipients
+        if MandrillBatchMailer.intercept_recipients
           given_defaults[:message].try(:delete, :to)
         end
         given_defaults
@@ -127,22 +98,14 @@ module MandrillBatchMailer
           .gsub '_', '-'
       end
 
-      def tags
-        ["#{template_name}_#{locale}"]
-      end
-
-      def locale
-        I18n.locale
-      end
-
       def subject
         '*|subject|*'
       end
 
       def to
-        if MandrillBatchMailer::BaseMailer.intercept_recipients
+        if MandrillBatchMailer.intercept_recipients
           @tos.keys.size.times.map do |i|
-            { email: MandrillBatchMailer::BaseMailer
+            { email: MandrillBatchMailer
                 .interception_base_mail.sub('@', "+#{i}@") }
           end
         else
@@ -157,22 +120,20 @@ module MandrillBatchMailer
       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)
-            }
+          if MandrillBatchMailer.intercept_recipients
+            intercepted_merge_vars(to_email, vars, i)
           else
-            { rcpt: to_email,
-              vars: merge_vars_from(vars)
-            }
+            { 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]}"))
+      def intercepted_merge_vars(to_email, vars, i)
+        subject = vars[:subject] || translations[:subject]
+        {
+          rcpt: MandrillBatchMailer.interception_base_mail.sub('@', "+#{i}@"),
+          vars: merge_vars_from(vars.merge(subject: "#{to_email} #{subject}"))
+        }
       end
 
       ## HELPER METHODS ##
@@ -201,8 +162,9 @@ module MandrillBatchMailer
       end
 
       def shared_translations
-        I18n.t "#{class_name.deconstantize.underscore}.shared_translations",
-          default: {}
+        I18n.t(
+          "#{class_name.deconstantize.underscore}.shared_translations",
+          default: {})
       end
 
       def merge_vars_from(translations)
@@ -212,20 +174,24 @@ module MandrillBatchMailer
       end
 
       def send_template(params)
-        if MandrillBatchMailer::BaseMailer.perform_deliveries
+        if MandrillBatchMailer.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}"
+          log_sending(params)
           params
         end
       end
+
+      def log_sending(params)
+        params_inspect =
+          if defined? AwesomePrint
+            params.ai
+          else
+            params.inspect
+          end
+        MandrillBatchMailer.logger
+          .info "Sending Mandrill Mail: #{params_inspect}"
+      end
   end
 end

data/lib/mandrill_batch_mailer/version.rb

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

data/spec/mandrill_batch_mailer/base_mailer_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe MandrillBatchMailer::BaseMailer, :dbless do
+describe MandrillBatchMailer::BaseMailer do
   let(:user_dup) do
-    -> do
+    lambda do
       double locale: :de, email: Faker::Internet.email, first_name: Faker.name
     end
   end
@@ -15,42 +15,50 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
 
   let(:translations) do
     {
-      mandrill_batch_mailer: {
-        shared_translations: {
-          salutation: 'Hello'
+      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_mailer: {
-          testing: {
-            subject: 'A Test Subject',
-            just_a_test: 'This is just a test',
-            regards: 'Regards, your dev team'
-          },
-          test_bulk: {
-            salutation: 'Hello %{name}'
-          }
+        test_bulk: {
+          salutation: 'Hello %{name}'
         }
       }
     }
   end
 
-  class MandrillBatchMailer::TestMailer < MandrillBatchMailer::BaseMailer
+  class 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') }]
+      @user = users.first
+      mail to: to_params(users)
+    end
+
+    private
+
+    def to_params(users)
+      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(:test_mailer) { TestMailer.new :testing }
   let(:base_mailer) { MandrillBatchMailer::BaseMailer.new :testing }
 
   before do
@@ -63,47 +71,44 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
 
   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'
+      @old_intercept = MandrillBatchMailer.intercept_recipients
+      MandrillBatchMailer.intercept_recipients = true
+      @old_intercept_mail = MandrillBatchMailer.interception_base_mail
+      MandrillBatchMailer.interception_base_mail = 'notifier@some-domain.com'
     end
     after do
-      MandrillBatchMailer::BaseMailer.intercept_recipients = @old_value
-      MandrillBatchMailer::BaseMailer.interception_base_mail =
-        @old_intercept_mail
+      MandrillBatchMailer.intercept_recipients = @old_value
+      MandrillBatchMailer.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
+      @old_intercept = MandrillBatchMailer.intercept_recipients
+      MandrillBatchMailer.intercept_recipients = false
     end
     after do
-      MandrillBatchMailer::BaseMailer.intercept_recipients = @old_intercept
+      MandrillBatchMailer.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
+      @old_deliveries = MandrillBatchMailer.perform_deliveries
+      MandrillBatchMailer.perform_deliveries = true
     end
     after do
-      MandrillBatchMailer::BaseMailer.perform_deliveries = @old_deliveries
+      MandrillBatchMailer.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
+      @old_deveries = MandrillBatchMailer.perform_deliveries
+      MandrillBatchMailer.perform_deliveries = false
     end
     after do
-      MandrillBatchMailer::BaseMailer.perform_deliveries = @old_deliveries
+      MandrillBatchMailer.perform_deliveries = @old_deliveries
     end
   end
 
@@ -124,7 +129,7 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
   describe '#template_name' do
     subject { test_mailer.send :template_name }
 
-    it { should eq 'test-mailer-testing'}
+    it { should eq 'test-mailer-testing' }
 
     context 'when calling from BaseMailer' do
       subject { base_mailer.send :template_name }
@@ -150,12 +155,12 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
 
   describe '#to' do
     before do
-      test_mailer.instance_variable_set :@tos, { user.email => [] }
+      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' }] }
+      it { should eq [{ email: 'notifier+0@some-domain.com' }] }
     end
 
     context 'when not intercepted', intercept: false do
@@ -178,16 +183,16 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
 
   describe '#merge_vars' do
     before do
-      test_mailer.instance_variable_set :@tos,
-        base_mailer.send(:tos_from, user.email)
+      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: [] }]}
+      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 { expect(merge_vars.first[:rcpt]).to eq 'notifier+0@some-domain.com' }
       it do
         expect(merge_vars.first[:vars].first[:content]).to include user.email
       end
@@ -216,14 +221,14 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
   describe '#translations' do
     subject { test_mailer.send :translations }
     it do
-      should eq translations[:mandrill_batch_mailer][:test_mailer][:testing]
+      should eq translations[: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]
+      should eq translations[:shared_translations]
         .deep_merge(subject)
     end
   end
@@ -251,9 +256,44 @@ describe MandrillBatchMailer::BaseMailer, :dbless do
     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)
+        test_mailer.send :send_template, params
+      end
+
+      context 'awesome_print is available' do
+        before { module AwesomePrint; end }
+        after { Object.send :remove_const, 'AwesomePrint' }
+
+        it 'uses awesome_print' do
+          expect_any_instance_of(Hash).to receive :ai
+          test_mailer.send :send_template, params
+        end
+      end
+    end
+  end
+
+  describe '#tags' do
+    before do
+      allow(base_mailer)
+        .to receive(:template_name)
+        .and_return 'my_template_name'
+    end
+
+    it 'defaults to template name' do
+      expect(base_mailer.tags).to eq ['my_template_name']
+    end
+  end
+
+  describe 'calling the Mailer with class methods' do
+    it 'should create an instance and call instance_method' do
+      expect_any_instance_of(TestMailer).to receive :testing
+      TestMailer.testing
+    end
+
+    context 'when instance method does not exist' do
+      it 'throws an error' do
+        expect { TestMailer.method_does_not_exist }.to raise_error
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,17 +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.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start
 
-Coveralls.wear!
-
-# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+require 'mandrill_batch_mailer'
+require 'mandrill_batch_mailer/base_mailer'
 
 RSpec.configure do |config|
   config.order = 'random'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_batch_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - schasse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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