action_mailer-mandrill 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40b1ff1b2b82eeed4a9d7f7f669723bd8ce5dfe0
+  data.tar.gz: 99bbbe2c1cacc54a6b2341ccf914f1c0bf525195
+SHA512:
+  metadata.gz: e170fe53c8191d004f9dd32fcc565e2452690ab03956dffdea52ea787173b599fdef2a4258b36313526873f96a48629c914b92080a074ef54b28a47b7787d3d3
+  data.tar.gz: f112d5954a9b2f8b3399252c210b79570c1d0cebe91a6a95651a504b2ebe8c2d662a0db8b8482b83313e9bfd20a5c6799cd990c0d9c663351374be7093ec314e

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+<<<<<<< HEAD
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+=======
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+>>>>>>> c3fd987e6a92ebbb44c57694c6daf2bbeedf4d07

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action_mailer-mandrill.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Schulze
+
+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,59 @@
+# ActionMailer::Mandrill
+
+Use this gem to provide a nice `mandrill_mail` method to all your mailers.
+It allows you to send mails via Mandrill SMTP using Mandrill Templates (only).
+Using the mandrill_mail method you can easily set different Mandrill SMTP headers as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'action_mailer-mandrill'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action_mailer-mandrill
+
+## Usage
+
+In your Mailer include the Mandrill Mailer:
+
+    class UserMailer
+      include ActionMailer::Mandrill
+    end
+
+Now you can use the mandrill mail method in your mail methods:
+
+    def invitation_instructions(record)
+      mandrill_mail 'user-friend-request', # mandrill template slug
+        merge_objects:    [record.invited_by], # objects which attributes will 
+                                               # converted to merge tags
+        tags:             %w{ invite user },   # tag the email
+        to:               record.email,        # ...
+        receiver_name:    record.name,         # If a receiver name is given the email will be 
+                                               # sent to "receiver_name <email>", only works if to 
+                                               # is not an array
+        from:             'noreply@example.com',
+        subject:          subject,
+        merge_tags:       { 
+          receiver_name: record.name,
+          link: accept_invitation_url(record, :invitation_token => @token),
+          home_url: root_url
+        } # add additional merge tags, e.g. receiver_name = *|RECEIVER_NAME|*
+    end
+
+See the documentation or inline comment in the code to see all available options.
+
+**Also please use the [Mandrill::Serializer](https://github.com/maxschulze/mandrill-serializer) for `merge_objects`!**
+
+## Contributing
+
+1. Fork it ( https://github.com/maxschulze/action_mailer-mandrill/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/action_mailer-mandrill.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_mailer/mandrill/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_mailer-mandrill"
+  spec.version       = ActionMailer::Mandrill::VERSION
+  spec.authors       = ["Max Schulze"]
+  spec.email         = ["max@maxschulze.com"]
+  spec.summary       = %q{Use this gem to send mails with Mandrill Templates from Action Mailer.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://maxschulze.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "activesupport", '>= 2.0'
+  
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/action_mailer/mandrill.rb

@@ -0,0 +1,80 @@
+require "action_mailer/mandrill/version"
+require 'active_support/concern'
+
+module ActionMailer
+  # Adds a new way to send mails via Mandrill (actually uses normal SMTP 
+  # just sets specific SMTP headers)
+  # 
+  # @example Sending a mail via Mandrill with specific template
+  #   
+  #   def notification(user)
+  #     @user = user
+  #     
+  #     mandrill_mail('user_invite', 
+  #       to: 'max@example.com', 
+  #       subject: 'test', 
+  #       merge_objects: [user]
+  #     )
+  #   end
+  # 
+  module Mandrill
+    extend ActiveSupport::Concern
+    
+    # Sends a mail with a specific mandrill template
+    # See http://help.mandrill.com/entries/21688056-Using-SMTP-Headers-to-customize-your-messages
+    # to learn more about each option.
+    # 
+    # @param [String] template_slug The slug that identifies the template to use
+    # @param [Hash] options The options for the mail, such as sender, receiver, etc.
+    # 
+    # @option options [String|Array]    :to Recipient email
+    # @option options [String]          :from Sender email (respects AM defaults)
+    # @option options [String]          :subject The subject
+    # @option options [String]          :link_tracking See X-MC-Track
+    # @option options [Array]           :merge_objects Used to generate X-MC-MergeVars, 
+    #   need to be Mandrill Serializable (!)
+    # @option options [Hash]            :merge_tags Used to generate X-MC-MergeVars, 
+    #   need to be Mandrill Serializable (!)
+    # @option options [Array]           :tags Tag the email
+    #
+    # @raise [RuntimeError] if receivers are blank
+    def mandrill_mail(template_slug, options = {})
+      merge_tags = {}
+    
+      headers['X-MC-Template']      = template_slug
+      headers['X-MC-Track']         = options.delete(:link_tracking) if options.has_key?(:link_tracking)
+      headers['X-MC-Tags']          = options.delete(:tags).join(',') if options.has_key?(:tags)
+    
+      receiver_name                 = options.delete(:receiver_name)
+    
+      receivers = options.delete(:to)
+      receivers = [receivers] unless receivers.is_a?(Array)
+      raise RuntimeError.new("Please specify at least one receiver") if receivers.blank?
+    
+      if options.has_key?(:merge_objects)
+        options.delete(:merge_objects).each do |o| 
+          merge_tags = merge_tags.merge!(o.to_mandrill_merge_tags) 
+        end
+      end
+    
+      if options.has_key?(:merge_tags) 
+        merge_tags = merge_tags.merge! options.delete(:merge_tags)
+      end
+    
+      receivers.each do |receiver|
+        headers['X-MC-MergeVars'] = JSON.generate(
+          merge_tags.merge!('_rcpt' => receiver), 
+          ascii_only: true
+        )
+      end
+    
+      options[:to] = receivers
+      options[:to] = "#{receiver_name} <#{receivers.first}>" if receivers.length == 1 && receiver_name.present?
+    
+      mail(options) do |format|
+        format.text { render text: '' }
+      end
+    end
+    
+  end
+end

data/lib/action_mailer/mandrill/version.rb

@@ -0,0 +1,5 @@
+module ActionMailer
+  module Mandrill
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer-mandrill
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Schulze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
+email:
+- max@maxschulze.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_mailer-mandrill.gemspec
+- lib/action_mailer/mandrill.rb
+- lib/action_mailer/mandrill/version.rb
+homepage: http://maxschulze.com
+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: Use this gem to send mails with Mandrill Templates from Action Mailer.
+test_files: []