mandriller 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c351e2c133134f9ea0c40bf558e28bae8eda5cd
-  data.tar.gz: 9607f04622e8fc70d7a98728b85a569fd2903056
+  metadata.gz: c57d0cef20fb012f1d81d456f5fd1d672ffe29c7
+  data.tar.gz: f648f0400cbf9955bf54ff1a52f33480219e547a
 SHA512:
-  metadata.gz: 847fc944af9d6d500cd654c6e73958b9f2ea7b4a43f64df91ad07372590add7e8bfe521f8c50a6ceba9ae8e4cce6c3bc6a15ad38d3e0e4445f57ea82724e45b3
-  data.tar.gz: dd405529ef25b90f52d642ed2458f9da2eaad014efeb70c985b923b52c32549345ed1df5491cbab938769ee1901aa3d67ea7018eba42a9e7a8626034c6096adc
+  metadata.gz: d1e81dba186fe87e613128cf97b7abc1b020454037b3beefd75fcee4323476fa9bc66803cab7b026c8b00cd0e4002da96ae7e63011a7f169e1a46a203ad2c20a
+  data.tar.gz: a7d2e3e3149847839731f4347bf9d51fe67f48043fa71efe840964632f3d3a2c41735dd0dd83a3681352c1dd8cf02d1754d25a3b1a44269b2f8638d111738aa8

data/README.md

@@ -15,17 +15,38 @@ gem "mandriller"
 
 And run `bundle install`.
 
+Add the following into any environment's settings in `config/environments/`.
+
+```ruby
+config.action_mailer.delivery_method = :smtp
+config.action_mailer.smtp_settings = {
+  :user_name => 'UserName',
+  :password => 'Password',
+  :address => "smtp.mandrillapp.com",
+  :domain => "your-domain.com",
+  :enable_starttls_auto => true,
+  :authentication => 'login',
+  :port => 587,
+}
+```
+
 ## Usage
 
 e.g.
 
 ```ruby
 class UserMailer < Mandriller::Base
+  include AbstractController::Callbacks # To use before_filter in ActionMailer::Base
+
   set_open_track
   set_click_track
+  set_google_analytics Settings.root_host, Settings.admin.host
 
-  def test_mail
+  before_filter do
     set_google_analytics_campaign "#{mailer_name.gsub(/_mailer$/, '')}/#{action_name.gsub(/_email$/, '')}"
+  end
+
+  def test_mail
     mail from: 'from@example.com', to: 'to@example.com'
   end
 end
@@ -39,145 +60,147 @@ You can set the options globally and locally. Locally set option overwrites the
 
 Enable open-tracking for the message.
 
-`set_open_track` or `set_open_track true`: Enable
-`set_open_track false`: Disable
+- `set_open_track` or `set_open_track true`: Enable
+- `set_open_track false`: Disable
 
 ### set_click_track
 
 Enable click-tracking for the message.
 
-`set_click_track 'all'`: enables click tracking on all emails
-`set_click_track 'htmlonly'`: enables click tracking only on html emails
-`set_click_track 'textonly'`: enables click tracking only on text emails
+- `set_click_track 'all'`: enables click tracking on all emails
+- `set_click_track 'htmlonly'`: enables click tracking only on html emails
+- `set_click_track 'textonly'`: enables click tracking only on text emails
 
 ### set_auto_text
 
 Automatically generate a plain-text version of the email from the HTML content.
 
-`set_auto_text` or `set_auto_text true`: Enable
-`set_auto_text false`: Disable
+- `set_auto_text` or `set_auto_text true`: Enable
+- `set_auto_text false`: Disable
 
 ### set_auto_html
 
 Automatically generate an HTML version of the email from the plain-text content.
 
-`set_auto_html` or `set_auto_html true`: Enable
-`set_auto_html false`: Disable
+- `set_auto_html` or `set_auto_html true`: Enable
+- `set_auto_html false`: Disable
 
 ### set_template
 
 Use an HTML template stored in your Mandrill account
 
-`set_auto_html 'template_name'` or `set_auto_html 'template_name', 'block_name'`: 
+- `set_auto_html 'template_name'` or `set_auto_html 'template_name', 'block_name'`: 
 
 `template_name`
+
 the name of the stored template.
 
 `block_name`
+
 the name of the mc:edit region where the body of the SMTP generated message will be placed. Optional and defaults to "main".
 
 ### set_merge_vars
 
 Add dynamic data to replace mergetags that appear in your message content.
 
-`set_merge_vars {foo: 1, bar: 2}`
+- `set_merge_vars {foo: 1, bar: 2}`
 
 ### set_google_analytics
 
 Add Google Analytics tracking to links in your email for the specified domains.
 
-`set_google_analytics 'foo.com', 'bar.com'`
+- `set_google_analytics 'foo.com', 'bar.com'`
 
 ### set_google_analytics_campaign
 
 Add an optional value to be used for the __utm_campaign parameter__ in Google Analytics tracked links.
 
-`set_google_analytics 'campaign_name'`
+- `set_google_analytics 'campaign_name'`
 
 ### set_metadata
 
 Information about any custom fields or data you want to append to the message.
 
-`set_metadata {foo: 1, bar: 2}`
+- `set_metadata {foo: 1, bar: 2}`
 
 ### set_url_strip_qs
 
 Whether to strip querystrings from links for reporting.
 
-`set_url_strip_qs` or `set_url_strip_qs true`: Enable
-`set_url_strip_qs false`: Disable
+- `set_url_strip_qs` or `set_url_strip_qs true`: Enable
+- `set_url_strip_qs false`: Disable
 
 ### set_preserve_recipients
 
 Whether to show recipients of the email other recipients, such as those in the "cc" field.
 
-`set_preserve_recipients` or `set_preserve_recipients true`: Enable
-`set_preserve_recipients false`: Disable
+- `set_preserve_recipients` or `set_preserve_recipients true`: Enable
+- `set_preserve_recipients false`: Disable
 
 ### set_inline_css
 
 Whether to inline the CSS for the HTML version of the email (only for HTML documents less than 256KB).
 
-`set_inline_css` or `set_inline_css true`: Enable
-`set_inline_css false`: Disable
+- `set_inline_css` or `set_inline_css true`: Enable
+- `set_inline_css false`: Disable
 
 ### set_tracking_domain
 
 Set a [custom domain to use for tracking opens and clicks](http://help.mandrill.com/entries/23353682-Can-I-customize-the-domain-used-for-open-and-click-tracking-) instead of mandrillapp.com.
 
-`set_tracking_domain` or `set_tracking_domain true`: Enable
-`set_tracking_domain false`: Disable
+- `set_tracking_domain` or `set_tracking_domain true`: Enable
+- `set_tracking_domain false`: Disable
 
 ### set_signing_domain
 
 Set a [custom domain to use for SPF/DKIM signing](http://help.mandrill.com/entries/23374656-Can-I-send-emails-on-behalf-of-my-clients-) instead of mandrill (for "via" or "on behalf of" in email clients).
 
-`set_signing_domain` or `set_signing_domain true`: Enable
-`set_signing_domain false`: Disable
+- `set_signing_domain` or `set_signing_domain true`: Enable
+- `set_signing_domain false`: Disable
 
 ### set_subaccount
 
 Select a [subaccount](http://help.mandrill.com/entries/25523278-What-are-subaccounts-) for sending the mail.
 
-`set_subaccount 'subaccount_id'`
+- `set_subaccount 'subaccount_id'`
 
 ### set_view_content_link
 
 Control whether the View Content link appears for emails sent for your account.
 
-`set_view_content_link` or `set_view_content_link true`: Enable
-`set_view_content_link false`: Disable
+- `set_view_content_link` or `set_view_content_link true`: Enable
+- `set_view_content_link false`: Disable
 
 ### set_bcc_address
 
 An optional address that will receive an exact copy of the message, including all tracking data
 
-`set_bcc_address 'email_address'`
+- `set_bcc_address 'email_address'`
 
 ### set_important
 
 Whether this message is [important](http://help.mandrill.com/entries/23664027-Does-Mandrill-allow-me-to-prioritize-messages-) and should be delivered ahead of non-important messages
 
-`set_important` or `set_important true`: Enable
-`set_important false`: Disable
+- `set_important` or `set_important true`: Enable
+- `set_important false`: Disable
 
 ### set_ip_pool
 
 Specify a [dedicated IP pool](http://help.mandrill.com/entries/24182062-Can-I-choose-which-dedicated-IP-pool-my-Mandrill-emails-send-from-) for the message.
 
-`set_ip_pool 'dedicated_ip_pool'`
+- `set_ip_pool 'dedicated_ip_pool'`
 
 ### set_retun_path_domain
 
 Specify a [custom domain](http://help.mandrill.com/entries/25241243-Can-I-customize-the-Return-Path-bounce-address-used-for-my-emails-) to use for the message's return-path
 
-`set_return_path_domain 'example.com'`
+- `set_return_path_domain 'example.com'`
 
 ### set_send_at
 
 Specify a future date/time that the message should be [scheduled](http://help.mandrill.com/entries/24331201-Can-I-schedule-a-message-to-send-at-a-specific-time-) for delivery
 
-`set_send_at 5.days.from_now`
+- `set_send_at 5.days.from_now`
 
 __Only available for paid accounts__
 

data/lib/mandriller/base.rb

@@ -37,7 +37,7 @@ class Mandriller::Base < ActionMailer::Base
   class_attribute :mandrill_template, :mandrill_google_analytics
 
   class << self
-    def set_template(template_name, block_name)
+    def set_template(template_name, block_name = nil)
       self.mandrill_template = [template_name, block_name]
     end
 

data/lib/mandriller/version.rb

@@ -1,3 +1,3 @@
 module Mandriller
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandriller
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer