mail-x_smtpapi 1.0.0.alpha2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aa241982d4d0042b269a45812005b55639ed5aa
-  data.tar.gz: c3287e3ae8bf85afc9a29ea472f8830926bb78d0
+  metadata.gz: ff36feee769b1735b03c6334a653e02eba9b0866
+  data.tar.gz: 5e54b8c395024ca89d1df5f4930118905a7f6aee
 SHA512:
-  metadata.gz: 12e2dd0e22ee789a2c4e37fb26245f900dde5125a9d2d4d4209a13f8b8c4b390df8c77e0b578e34e39b6d16c73f4df629d1ff0936d730d13830960fd146a8874
-  data.tar.gz: c8e86d4849d4f7ed2eb6af0674c39709695b2c10b1ff4abad333856c2f61c7b0357c2de4e90823eb385b64edc33c5a69faf04077ada9e4c9fece2b6005f70d44
+  metadata.gz: f6e9b53cec3cba4b2af9574f850eb1eda94064c3e5fcc0e73a58dd51270171639948987cd7b81c3f156cff4c676d06bbc557562e1f322f175fa10b99720bd41d
+  data.tar.gz: efb9fdc5fc2c6bb3f61f70ec6d4bf64cfc1bfe49c776099bd53198c78ab49a59315cafd304c0d35dfa5ab2985ccbc6785793cac120fc2da8b4376cf57e810004

data/README.md

@@ -1,6 +1,8 @@
 # Mail::X::Smtpapi
 
-Integrates a custom X-SMTPAPI field into the [Mail](https://github.com/mikel/mail) gem.
+Integrates support for SendGrid's X-SMTPAPI field into the [Mail](https://github.com/mikel/mail) gem.
+
+Please refer to [SendGrid docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html) for ideas of what you can do with the X-SMTPAPI header!
 
 ## Installation
 
@@ -20,19 +22,51 @@ Or install it yourself as:
 
 ## Usage
 
-Write into the SMTPAPI header from anywhere with access to the `mail` object.
+Write into the X-SMTPAPI header from anywhere with access to the `mail` object.
 
 ### Example: Rails Mailer
 
-(TODO)
+Adapting the [Rails Guide example](http://guides.rubyonrails.org/v4.0.8/action_mailer_basics.html#edit-the-mailer):
 
-### Example: Template Helper
+```ruby
+class UserMailer < ActionMailer::Base
+
+  def welcome(user)
+    @user = user
 
-(TODO)
+    mail.smtpapi.category = 'welcome'
+    mail.smtpapi.unique_args['user_id'] = @user.id
+
+    mail(to: @user.email, subject: 'Welcome to My Awesome Site')
+  end
+
+end
+```
 
 ### Example: Mail Interceptor
 
-(TODO)
+Adapting the [Rails Guide example](http://guides.rubyonrails.org/v4.0.8/action_mailer_basics.html#intercepting-emails):
+
+```ruby
+class SandboxEmailInterceptor
+  def self.delivering_email(message)
+    message.smtpapi.unique_args['original'] = message.to
+    message.to = ['sandbox@example.com']
+  end
+end
+```
+
+### Example: Template Helper
+
+```ruby
+module MailerABHelper
+  def show_variant?(name)
+    variant = rand(2) == 0 ? 'main' : 'alternate'
+    mail.smtpapi.unique_args["#{name}_variant"] = variant
+    return variant == 'alternate'
+  end
+end
+```
 
 ## Contributing
 

data/lib/mail_x_smtpapi/accessors.rb

@@ -55,4 +55,10 @@ module MailXSMTPAPI
     end
   end
 
+  module Sections
+    def sections
+      value['sections'] ||= {}
+    end
+  end
+
 end

data/lib/mail_x_smtpapi/field.rb

@@ -12,6 +12,7 @@ module MailXSMTPAPI
     include UniqueArguments
     include Category
     include Filters
+    include Sections
 
     def initialize(value = nil, charset = 'utf-8')
       self.charset = charset
@@ -27,8 +28,8 @@ module MailXSMTPAPI
       end
     end
 
-    # to take advantage of folding, decoded must return a string with
-    # emits JSON with extra spaces inserted for line wrapping.
+    # to take advantage of folding, decoded must return a string of
+    # JSON with extra spaces inserted for line wrapping.
     def decoded
       JSON.generate(value).gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
     end

data/lib/mail_x_smtpapi/version.rb

@@ -1,3 +1,3 @@
 module MailXSMTPAPI
-  VERSION = '1.0.0.alpha2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-x_smtpapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0
 platform: ruby
 authors:
 - Lance Ivy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,9 +88,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2