sparkpost_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6daae188c29ed7eb15c6a8dbd0c5617755f0e5b3
-  data.tar.gz: 23751028cb6b932d786b812a894656da1b4221e9
+  metadata.gz: 81fd8507b990b04184b483dd003722b8ca08289f
+  data.tar.gz: 8b1007d2d0ddd41f8391215e873675d9bc58fc55
 SHA512:
-  metadata.gz: 970b8a2255cf43de5c63164715993edca7a55deb0a0eb75c47da3079c0938e1132e482a88c9244df73852a4894ba0d94e848d41f9287f0265ec065b8c799570a
-  data.tar.gz: 63fcc3276a23701abdf75bdd14be5000425e5369a78d3dd9c9f1e2d166209e535f1f66df25278e3caf836265e622727d7bc9b5b6dddc6c7c4212b84ceb0419a7
+  metadata.gz: 5fcc12025be8147f289b17ff1dcb56ea568c2018ab3cb98499e77fea53241ca41b077c1bbcbcdb01b7e4bf8fa22169e8731ff9160fa08ad51a993c6a85035181
+  data.tar.gz: c2521eca5c10a02e8d313882653ebfdfb7c4423d5f117d054c29bc5d2f3af6f912be938b45714266267fe29d5bc575eeede28035216cbc678406c1e1934701c3

data/README.md

@@ -45,6 +45,8 @@ SparkPostRails.configure do |c|
   c.track_clicks = true
   c.return_path = 'BOUNCE-EMAIL@YOUR-DOMAIN.COM'
   c.campaign_id = 'YOUR-CAMPAIGN'
+  c.transactional = true
+  c.ip_pool = "MY-POOL"
 end
 ```
 
@@ -56,6 +58,8 @@ track_opens = false
 track_clicks = false
 return_path = nil
 campaign_id = nil
+transactional = false
+ip_pool = nil
 ```
 
 Usage
@@ -90,7 +94,11 @@ to the mail message in a field named "sparkpost_data":
 ```
 data = { track_opens: true,
          track_clicks: false,
-         campaign_id: "My Campaign"}
+         campaign_id: "My Campaign",
+         transactional: true,
+         ip_pool = "SPECIAL_POOL",
+         subaccount_api_key = "SUBACCOUNT_API_KEY"
+       }
 
 mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
 ```
@@ -101,6 +109,33 @@ Additionally, return_path can be overriden on a specific email by setting that f
 mail(to: to_email, subject: "Test", body: "test", return_path: "bounces@example.com")
 ```
 
+### Transmission Specific Settings
+
+For an individual transmisison you can specifiy that SparkPost should ignore customer supression rules - if your SparkPost account allows for this 
+feature.  Simply include the flag in the "sparkpost_data" field on the message:
+
+```
+data = { skip_suppression: true }
+
+mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
+```
+
+To schedule the generation of messages for a future date and time, specify a start time in the date parameter of the mail. Date must be in the future and less than 1 year from today. If date is in the past or too far in the future, no date will be passed, and no delivery schedule will be set.
+
+```
+start_time = DateTime.now + 4.hours 
+
+mail(to: to_email, subject: "Test", body: "test", date: start_time)
+```
+
+You can set a description for a transmission via the "sparkpost_data" as well.  The maximum length of the decription is 1024 characters - values
+longer than the maxium will be truncated.
+
+```
+data = { description: "My Important Message" }
+
+mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
+```
 
 ### Recipient Lists
 SparkPostRails supports using SparkPost stored recipient lists.  Simply add the list_id to the sparkpost_data hash on the mail message:
@@ -121,7 +156,7 @@ to your sparkpost_data hash, with the key :substitution_data.
 
 ```
 sub_data = {first_name: "Sam",
-            last_name: "Test}
+            last_name: "Test"}
 
 data = { substitution_data: sub_data }
 
@@ -141,6 +176,17 @@ mail(to: to_email, sparkpost_data: data)
 **NOTE**: All inline-content that may exist in your mail message will be ignored, as the SparkPost API does not accept that data when a template id is 
 supplied.  This includes Subject, From, ReplyTo, Attachments, and Inline Images.
 
+###Other Mail Headers
+If you need to identify custom mail headers for your messages, utilize the ActionMailer header[] method.  The gem will pass all approprite headers through 
+to the api.  Note, per the SparkPost API documentation, "Headers such as 'Content-Type' and 'Content-Transfer-Encoding' are not allowed here as they are auto 
+generated upon construction of the email."
+
+```
+headers["Priority"] = "urgent"
+headers["Sensitivity"] = "private"
+
+mail(to: to_email, subject: "Test", body: "test")
+```
 
 Update Note!
 ============

data/lib/sparkpost_rails.rb

@@ -22,6 +22,10 @@ module SparkPostRails
     attr_accessor :campaign_id
     attr_accessor :return_path
 
+    attr_accessor :transactional
+    attr_accessor :ip_pool
+
+    attr_accessor :subaccount
 
     def initialize
       set_defaults
@@ -41,6 +45,11 @@ module SparkPostRails
 
       @campaign_id = nil
       @return_path = nil
+
+      @transactional = false
+      @ip_pool = nil
+
+      @subaccount = nil
     end
   end
 end

data/lib/sparkpost_rails/delivery_method.rb

@@ -2,7 +2,7 @@ module SparkPostRails
   class DeliveryMethod
     require 'net/http'
 
-    attr_accessor :settings, :data, :response
+    attr_accessor :settings, :data, :response, :headers
 
     def initialize(options = {})
       @settings = options
@@ -28,8 +28,11 @@ module SparkPostRails
       end
 
       prepare_substitution_data_from sparkpost_data
+      prepare_description_from sparkpost_data
       prepare_options_from mail, sparkpost_data
-      prepare_headers
+      prepare_additional_mail_headers_from mail
+
+      prepare_api_headers_from sparkpost_data
 
       result = post_to_api
 
@@ -162,9 +165,9 @@ module SparkPostRails
       mail.attachments.each do |attachment|
         #We decode and reencode here to ensure that attachments are 
         #Base64 encoded without line breaks as required by the API.
-        attachment_data = { name: attachment.filename,
+        attachment_data = { name: attachment.inline? ? attachment.url : attachment.filename,
                             type: attachment.content_type,
-                            data: Base64.encode64(attachment.body.decoded).gsub("\n","") }
+                            data: Base64.strict_encode64(attachment.body.decoded) }
 
         if attachment.inline?
           inline_images << attachment_data
@@ -190,7 +193,10 @@ module SparkPostRails
       prepare_click_tracking_from sparkpost_data
       prepare_campaign_id_from sparkpost_data
       prepare_return_path_from mail
-
+      prepare_transactional_from sparkpost_data
+      prepare_skip_suppression_from sparkpost_data
+      prepare_ip_pool_from sparkpost_data
+      prepare_delivery_schedule_from mail
     end
 
     def prepare_sandbox_mode_from sparkpost_data
@@ -247,11 +253,99 @@ module SparkPostRails
       end
     end
 
-    def prepare_headers
+    def prepare_transactional_from sparkpost_data
+      @data[:options][:transactional] = SparkPostRails.configuration.transactional
+
+      if sparkpost_data.has_key?(:transactional)
+        @data[:options][:transactional] = sparkpost_data[:transactional]
+      end
+    end
+
+
+    def prepare_skip_suppression_from sparkpost_data
+      if sparkpost_data[:skip_suppression]
+        @data[:options][:skip_suppression] = sparkpost_data[:skip_suppression]
+      end
+    end
+
+    def prepare_description_from sparkpost_data
+      if sparkpost_data[:description]
+        @data[:description] = sparkpost_data[:description].truncate(1024)
+      end
+    end
+
+    def prepare_ip_pool_from sparkpost_data
+      ip_pool = SparkPostRails.configuration.ip_pool
+
+      if sparkpost_data.has_key?(:ip_pool)
+        ip_pool = sparkpost_data[:ip_pool]
+      end
+
+      if ip_pool
+        @data[:options][:ip_pool] = ip_pool
+      end
+    end
+
+    def prepare_delivery_schedule_from mail
+      # Format YYYY-MM-DDTHH:MM:SS+-HH:MM or "now". Example: '2015-02-11T08:00:00-04:00'. -From SparkPost API Docs
+      if mail.date && (mail.date > DateTime.now) && (mail.date < (DateTime.now + 1.year))
+        @data[:options][:start_time] = mail.date.strftime("%Y-%m-%dT%H:%M:%S%:z")
+      end
+    end
+
+    def prepare_additional_mail_headers_from mail
+      valid_headers = Hash.new
+
+      invalid_names = ["sparkpost-data",
+                       "from",
+                       "to",
+                       "cc",
+                       "bcc",
+                       "subject",
+                       "reply-to",
+                       "return-path",
+                       "date",
+                       "mime-version",
+                       "content-type",
+                       "content-transfer-encoding",
+                       "text-part"]
+
+      mail.header.fields.each do |field|
+        unless invalid_names.include?(field.name.downcase)
+          valid_headers[field.name] = field.value
+        end
+      end
+
+      if valid_headers.count > 0
+        unless @data[:content].has_key?(:headers)
+          @data[:content][:headers] = Hash.new
+        end
+
+        @data[:content][:headers].merge!(valid_headers)
+      end
+    end
+
+    def prepare_api_headers_from sparkpost_data
+      if sparkpost_data.has_key?(:api_key)
+        api_key = sparkpost_data[:api_key]
+      else
+        api_key = SparkPostRails.configuration.api_key
+      end
+
       @headers = {
-        "Authorization" => SparkPostRails.configuration.api_key,
+        "Authorization" => api_key,
         "Content-Type"  => "application/json"
       }
+
+      if sparkpost_data.has_key?(:subaccount)
+        subaccount = sparkpost_data[:subaccount]
+      else
+        subaccount = SparkPostRails.configuration.subaccount
+      end
+
+      if subaccount
+        @headers["X-MSYS-SUBACCOUNT"] = subaccount.to_s
+      end
     end
 
     def post_to_api

data/lib/sparkpost_rails/version.rb

@@ -1,4 +1,4 @@
 module SparkPostRails
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end
 

data/spec/attachments_spec.rb

@@ -44,7 +44,11 @@ describe SparkPostRails::DeliveryMethod do
       test_email = Mailer.test_email inline_attachments: 1
       @delivery_method.deliver!(test_email)
 
-      expect(@delivery_method.data[:content][:inline_images]).to eq([{:name=>"image_0.png", :type=>"image/png; filename=image_0.png", :data=>"iVBORw0KGgoAAAANSUhEUgAAAfIAAACCCAMAAACKGrqXAAAAY1BMVEX////6ZCNVVVr6ZCP6ZCNVVVr6ZCNVVVr6ZCP6ZCNVVVpVVVr6ZCNVVVpVVVr6ZCNVVVpVVVr6ZCNVVVpVVVpVVVpVVVr6ZCP6ZCNVVVr6ZCP6ZCP6ZCP6ZCNVVVpVVVr6ZCO+CfRXAAAAH3RSTlMAgMBAEPBgoDAg4NBwkIDAUBDwQLBgMOCgIFCQ0LBwPgQxPgAADDFJREFUeF7s2kGLnEAYhOFqbERhSROHZFzXWer//8rAJo172jklhK73OXsrKItP9Q/hmBQGZ1EWLD6roqB4W5QEdbNnJUFxWOaoTssce1rmOGznbTia3VtVDJy27aYYePjDi1KgOLPaidy7whC5V4Uh8l1hiNxVEdDcvSgCTnenIsCXVQEw+TIrBOstarPjtKNe5lj9mbLQ6/ak4eEeFjkOf+ai0aGFRY7JYZGjhUWOyWGRo4VFjsNhkeMeFjmKsyLHurnLuL7h4dTI2W4Zv8Wg3t1drHHhzV3iLxLc3bqmLNS6i6JQ6/asKNS6vSgKtW5raNQ6641a95uGRa2z3qj1rPXGbb3TiFA3+9l6WzQQPOwn662ehyJQ6z7+JO6qBNR6/1jefNc4sNtP1luJuMhwhLnW2+qIyDnCXOutBUTOEaYrvQY2DQKLvzT1d72rxoD2NPLqD4eGgNlfux7ZNTQurd11mts0NLZbJ2nz/9Hs328/vv32fnvV3/N6u/zUaH61d4bLjatIFLZJCL4owsKScEgm8n3/p9zazexi6yC6Wz2pqbo752diLBUfNN3QtP/6m9LdZ85tHkv40jB+B4fUd7cHmVB/Tm+2FQJnrPjbnYjPz6apPsyJ17RGx61fn/FcF5Yxynw3RP5OX1QanX/A4d0Q18iMSI8dFRd/q8i6CnVza8u7oU1xeGgQ2sjDjda0ZLppjfjtUV3kPrfrk2DfDRMkjlQx17nKY4VjvIn00Hi22wDnCMhJ+VAaUWPGKpAXTaMc+bwe4EnyXL9E7iTHNKi39n3EwW/hMOMvQR7bEO0CxGjZ7cmbVw1mDfIik4TI0xpiEj7XLsJJXmb2uXVvJbryCPMfPUDPeuTJkgN6BOS0uoKAMKc65EVBhDxbGHrQ2IW1jDEWuh8mOaHLc0GOv5oWu5+47xbvOPYdLoU5VOTKi6+UgXhLfQTkpGx9+kZ43qhDXuQigRw7tqiH5269WRx6X9YCnOS0Pq6rHXckbmFBzcHiSEONZJdmK5izNHLaZC9ISosc/S8a+QQv0UCOGn+2tyNMcpFwmk9l9K4Vg8WRJkfeia2m4SMYqhEaKOuQIzgaeYDBQiAHjR30Pj3J6VuoS9O/if3XShtJ5Poe7eSGvT4ah8Zw0iO/LQzk6KxjHyJylMOmb3uQX2HZWxpEPXSrDHm0InY0ctI1m24o++uQ28xBniwMTS5yHDgBNt6kelk91hwaigZsgAj5Ipo8cuTwdpn4lBb5zRHIYaADWkBOzfOM9d1Q53PjfwWIZ2xIDgcNcg+7Sss4DsGt/m4Oe5H7FcG+2sCokRdlGnkHI24n8ugfff1r1T17ezn9NALvX6466PSwVzAdCGmQpxXw8sm8dGAta8h9uJPrkMDMWkgSE3l4VF95YCCROwjPJMixf30rdf38vori3loXURfoMgVyyq7j6EoOHG9EbiB2bK7mM2GOxbumcYEHUk0XeLYMOZrJtOm8nZ+wyV+faAgenpq+CTmaWQtea55gKBDIK7u3GXqopshEjooTPLDZdIDwTIM83BuWy5rka73RO+RQvN/37eGbkCM9txF82ihAjj75zDoHCHuRo6Eemk2ThfBMg3wsPQd2/cdpM2/mB+y6/xbkYaPLh4MMefSwUlZHw6NPwEVOR5qh1TR2EJ6pkB/uOuFjRbyRvvr8Bpa9dFD+VuTABhUPEuS4YJuNCM1HMAZ7kCNb12pqiPBMg/wKxPn3Uk/sp+qR0xNNjDxuhWn942R0+EVy5Bjsm0ZTB/GEFrn5Qg77MFcg3rTtr3euZf/dyIsWBfLG124Y4LwKERMbOYqLfCbCMxXyF5i2giLtnxD0fSfyohC/DTl0+LTeEnEK5B0PeYLwTI/c/g/5h7Bg52ttMSe22PXIAyb3aJGj+ayDGWHSxf3IPQt5tkR4plvLz2DWCZ0r9dkd+JR65NTOyDTHb5jlEKF5tPTL9xp2dNbjQY98LOuDuMjXU+VXGDLGEXrk9CGHWZIOuYdjMpj7C/7J70aeWEHaBOGZDnnxSOe193aV/4b98fGlgxI5hQ9lpzmzkdMONP41Vv427EXu0AvFpgHSNzTI8eTrSV688QWQFyR+/ibkszBXG5GTBKYaAEd8lwh52gi1A3Wqq0c+l/d+lVfye64coJb1x4esRi7Pg+qWKEee6kftFrDAkMty5LihZjeaorOuRx5tGT1HsOsiB+5cOzTolqRFTvFBWZeFyLOvnovO9dMuCxykyEcLMGnk00GLvHSFh/QI9hXiY71282Lvl9hlVCJH00QpRD5yJOBr5mQmzvL4yAfwRgYG8i6qkZcVbIQd1OOe2nB4eaHI9EMUItcx9yMbORLoy4sAWnDgFgq5eVRXTcOhkdukRV4MsEMj/bSnbhSZeLAkJfKiwZLQZ1ZWTG/sZl6S2zLgE/DSJULNrKZdVCMfffkmRC7335CLQ+pRgRyGK5+5EWYf4mROm0nOgxa5YTY1SuRpKmOHjRxFFG8ew6qzbYgq5EWjYTGXI7exAs4Qm6UK5DZzmzoF8rx0aC30yOsaF+fh7qMcOSo7S/elHPlQ4zo3mGYd8sRvOjOQLyMoBOOrWSVvO5CfmIFdHO6wm6hEjmtHXWYPcldzEW3rdL0XI+cOJkfcfpQ/16SNgOtV7r7RhR4T3n2UI0eVK62oJEfu5E1s3I/cplbT2MHHVcjNDDG2+MdyXgF5U7MBk6tDjjakPv+MmHiSTNTdyE17tOAd2y7uRu77JJ+xqDdWLI/lPjol8rp7AvJS5AtsunPkdyL3M0GtMvKmPci96efcWJcldTqvvONW3F0OauSo3MPCnkXIuwSrNU/jHuTdTFKDXSddIhTqIuZ3gpMYLnMb9chRMQALPnI/73a6pz3IF94hnLsp0h0lZyRiu37hc7H44nrk9Sz/hY18GiDyFijvQG6Zh3BdI6rTIn+FtCZB4c9PPpYZJoYYOfcqcmAh7+AEYL7J1De4lfh4Bc/wkEcLY0WBHMy0jOCRnTmFUa1VIXdD68uLAnnzdBgTmXlDy7IKvqS6aaeaJnTbtcirV42fOIU/5Q5fARAVyF3Di6GRG3p5uEk108jR4tvEQo42Z/plyF9lKa5nuJPGVI9Q5eflXWIgX/Yhd2LknoEc1+WOhxyLGvR65HguRkM8Qn4rV0GHfGzdWki0x24YDqZYIwM5pqUHHnJcaGYtcvTA6V3XF6gc8s3I0Sn3M7UK513Il5tcjoMcvzrxkEePbrseOd5KeyGIwyQXGfa8E3nsGldVosM0QjlyT6+baKUzAznO146HHF04G5XI6zXAjhRx+SQvAHR30oqmkmyTFw9TT4ocMyCY6ViBgxxNe08gh5cCtx2Qq35i4/N542MfX6gxil96ZpDWEchFnpUxLjjj8ehbjBwjOu6Sb1nI0bSPPOS4v+O0yOsFgi7v1SPTK1R3LAPf8bZi+n3IZ6kbLUeO2Yy84TdzkKOZ8pGHHAsOBhXyok+yPtDTeV1f5NFd7iKn8FgSIkcctGYxcgQZ2eF7t7PCds9EHjtw2+vI9b98ef043Tl4rz+gGlQx6xYrAaMcdLtklltZZU458og3E5h+xUhwI0w72RRduKRBXnS6/A26nD+O/9b58jfqhC/VRyoHfeQhRyXPTzgRIUcg0nx6x0KOpt1GHnJ04WxUIS/MxfVbi3K3KmUP6sGYSYM0JzHrcuReUovGQpxGI0fTPjGR44ZBFzXIi17kxBGIr0LPBt6UQo4aPJu4HPkguuvZoz9FI0d0AxM5xitOhbzo6SInjhdJLORaJQdjk4kcK/kTssNhH/IJDCffu7cUN9q0Y1PChQsK5Lie07qc2pbXTmEY4xfIufdgjZrINdBNPuxDnhuhL81u5iJH0y5cE4oGFfKi5zOH+I+NRIpkqJ+50Sc1x7mjU5rkyHtyI5suEYjcaNO+sO8po5eqRE5XZmelPo+O/J00fVZMCh2R0iRGHi1EeYQ8jBHkxjHtmYkcN6N81CEvOhET/do+SolLR/4AoD4RKg7hfp/Vbl1qnsOdGj5ZDvfivMRQaTGGexFPKi2ZTZeATe8a54NCL9fGKn7k8Hi4ytu5GXBsdkbe86vDB63+6Pl42QLOz3tKXzjyHwC/TfqZfgXg/yj90dPb6kD1/Q+Af77e/0v98vny/zLB/+j0+vl5PP1uAP8CV/GqdTJ4tWwAAAAASUVORK5CYII="}])
+      images = @delivery_method.data[:content][:inline_images]
+      expect(images.length).to eq(1)
+      image = images[0]
+      expect(image).to include(:name, :type=>"image/png; filename=image_0.png", :data=>"iVBORw0KGgoAAAANSUhEUgAAAfIAAACCCAMAAACKGrqXAAAAY1BMVEX////6ZCNVVVr6ZCP6ZCNVVVr6ZCNVVVr6ZCP6ZCNVVVpVVVr6ZCNVVVpVVVr6ZCNVVVpVVVr6ZCNVVVpVVVpVVVpVVVr6ZCP6ZCNVVVr6ZCP6ZCP6ZCP6ZCNVVVpVVVr6ZCO+CfRXAAAAH3RSTlMAgMBAEPBgoDAg4NBwkIDAUBDwQLBgMOCgIFCQ0LBwPgQxPgAADDFJREFUeF7s2kGLnEAYhOFqbERhSROHZFzXWer//8rAJo172jklhK73OXsrKItP9Q/hmBQGZ1EWLD6roqB4W5QEdbNnJUFxWOaoTssce1rmOGznbTia3VtVDJy27aYYePjDi1KgOLPaidy7whC5V4Uh8l1hiNxVEdDcvSgCTnenIsCXVQEw+TIrBOstarPjtKNe5lj9mbLQ6/ak4eEeFjkOf+ai0aGFRY7JYZGjhUWOyWGRo4VFjsNhkeMeFjmKsyLHurnLuL7h4dTI2W4Zv8Wg3t1drHHhzV3iLxLc3bqmLNS6i6JQ6/asKNS6vSgKtW5raNQ6641a95uGRa2z3qj1rPXGbb3TiFA3+9l6WzQQPOwn662ehyJQ6z7+JO6qBNR6/1jefNc4sNtP1luJuMhwhLnW2+qIyDnCXOutBUTOEaYrvQY2DQKLvzT1d72rxoD2NPLqD4eGgNlfux7ZNTQurd11mts0NLZbJ2nz/9Hs328/vv32fnvV3/N6u/zUaH61d4bLjatIFLZJCL4owsKScEgm8n3/p9zazexi6yC6Wz2pqbo752diLBUfNN3QtP/6m9LdZ85tHkv40jB+B4fUd7cHmVB/Tm+2FQJnrPjbnYjPz6apPsyJ17RGx61fn/FcF5Yxynw3RP5OX1QanX/A4d0Q18iMSI8dFRd/q8i6CnVza8u7oU1xeGgQ2sjDjda0ZLppjfjtUV3kPrfrk2DfDRMkjlQx17nKY4VjvIn00Hi22wDnCMhJ+VAaUWPGKpAXTaMc+bwe4EnyXL9E7iTHNKi39n3EwW/hMOMvQR7bEO0CxGjZ7cmbVw1mDfIik4TI0xpiEj7XLsJJXmb2uXVvJbryCPMfPUDPeuTJkgN6BOS0uoKAMKc65EVBhDxbGHrQ2IW1jDEWuh8mOaHLc0GOv5oWu5+47xbvOPYdLoU5VOTKi6+UgXhLfQTkpGx9+kZ43qhDXuQigRw7tqiH5269WRx6X9YCnOS0Pq6rHXckbmFBzcHiSEONZJdmK5izNHLaZC9ISosc/S8a+QQv0UCOGn+2tyNMcpFwmk9l9K4Vg8WRJkfeia2m4SMYqhEaKOuQIzgaeYDBQiAHjR30Pj3J6VuoS9O/if3XShtJ5Poe7eSGvT4ah8Zw0iO/LQzk6KxjHyJylMOmb3uQX2HZWxpEPXSrDHm0InY0ctI1m24o++uQ28xBniwMTS5yHDgBNt6kelk91hwaigZsgAj5Ipo8cuTwdpn4lBb5zRHIYaADWkBOzfOM9d1Q53PjfwWIZ2xIDgcNcg+7Sss4DsGt/m4Oe5H7FcG+2sCokRdlGnkHI24n8ugfff1r1T17ezn9NALvX6466PSwVzAdCGmQpxXw8sm8dGAta8h9uJPrkMDMWkgSE3l4VF95YCCROwjPJMixf30rdf38vori3loXURfoMgVyyq7j6EoOHG9EbiB2bK7mM2GOxbumcYEHUk0XeLYMOZrJtOm8nZ+wyV+faAgenpq+CTmaWQtea55gKBDIK7u3GXqopshEjooTPLDZdIDwTIM83BuWy5rka73RO+RQvN/37eGbkCM9txF82ihAjj75zDoHCHuRo6Eemk2ThfBMg3wsPQd2/cdpM2/mB+y6/xbkYaPLh4MMefSwUlZHw6NPwEVOR5qh1TR2EJ6pkB/uOuFjRbyRvvr8Bpa9dFD+VuTABhUPEuS4YJuNCM1HMAZ7kCNb12pqiPBMg/wKxPn3Uk/sp+qR0xNNjDxuhWn942R0+EVy5Bjsm0ZTB/GEFrn5Qg77MFcg3rTtr3euZf/dyIsWBfLG124Y4LwKERMbOYqLfCbCMxXyF5i2giLtnxD0fSfyohC/DTl0+LTeEnEK5B0PeYLwTI/c/g/5h7Bg52ttMSe22PXIAyb3aJGj+ayDGWHSxf3IPQt5tkR4plvLz2DWCZ0r9dkd+JR65NTOyDTHb5jlEKF5tPTL9xp2dNbjQY98LOuDuMjXU+VXGDLGEXrk9CGHWZIOuYdjMpj7C/7J70aeWEHaBOGZDnnxSOe193aV/4b98fGlgxI5hQ9lpzmzkdMONP41Vv427EXu0AvFpgHSNzTI8eTrSV688QWQFyR+/ibkszBXG5GTBKYaAEd8lwh52gi1A3Wqq0c+l/d+lVfye64coJb1x4esRi7Pg+qWKEee6kftFrDAkMty5LihZjeaorOuRx5tGT1HsOsiB+5cOzTolqRFTvFBWZeFyLOvnovO9dMuCxykyEcLMGnk00GLvHSFh/QI9hXiY71282Lvl9hlVCJH00QpRD5yJOBr5mQmzvL4yAfwRgYG8i6qkZcVbIQd1OOe2nB4eaHI9EMUItcx9yMbORLoy4sAWnDgFgq5eVRXTcOhkdukRV4MsEMj/bSnbhSZeLAkJfKiwZLQZ1ZWTG/sZl6S2zLgE/DSJULNrKZdVCMfffkmRC7335CLQ+pRgRyGK5+5EWYf4mROm0nOgxa5YTY1SuRpKmOHjRxFFG8ew6qzbYgq5EWjYTGXI7exAs4Qm6UK5DZzmzoF8rx0aC30yOsaF+fh7qMcOSo7S/elHPlQ4zo3mGYd8sRvOjOQLyMoBOOrWSVvO5CfmIFdHO6wm6hEjmtHXWYPcldzEW3rdL0XI+cOJkfcfpQ/16SNgOtV7r7RhR4T3n2UI0eVK62oJEfu5E1s3I/cplbT2MHHVcjNDDG2+MdyXgF5U7MBk6tDjjakPv+MmHiSTNTdyE17tOAd2y7uRu77JJ+xqDdWLI/lPjol8rp7AvJS5AtsunPkdyL3M0GtMvKmPci96efcWJcldTqvvONW3F0OauSo3MPCnkXIuwSrNU/jHuTdTFKDXSddIhTqIuZ3gpMYLnMb9chRMQALPnI/73a6pz3IF94hnLsp0h0lZyRiu37hc7H44nrk9Sz/hY18GiDyFijvQG6Zh3BdI6rTIn+FtCZB4c9PPpYZJoYYOfcqcmAh7+AEYL7J1De4lfh4Bc/wkEcLY0WBHMy0jOCRnTmFUa1VIXdD68uLAnnzdBgTmXlDy7IKvqS6aaeaJnTbtcirV42fOIU/5Q5fARAVyF3Di6GRG3p5uEk108jR4tvEQo42Z/plyF9lKa5nuJPGVI9Q5eflXWIgX/Yhd2LknoEc1+WOhxyLGvR65HguRkM8Qn4rV0GHfGzdWki0x24YDqZYIwM5pqUHHnJcaGYtcvTA6V3XF6gc8s3I0Sn3M7UK513Il5tcjoMcvzrxkEePbrseOd5KeyGIwyQXGfa8E3nsGldVosM0QjlyT6+baKUzAznO146HHF04G5XI6zXAjhRx+SQvAHR30oqmkmyTFw9TT4ocMyCY6ViBgxxNe08gh5cCtx2Qq35i4/N542MfX6gxil96ZpDWEchFnpUxLjjj8ehbjBwjOu6Sb1nI0bSPPOS4v+O0yOsFgi7v1SPTK1R3LAPf8bZi+n3IZ6kbLUeO2Yy84TdzkKOZ8pGHHAsOBhXyok+yPtDTeV1f5NFd7iKn8FgSIkcctGYxcgQZ2eF7t7PCds9EHjtw2+vI9b98ef043Tl4rz+gGlQx6xYrAaMcdLtklltZZU458og3E5h+xUhwI0w72RRduKRBXnS6/A26nD+O/9b58jfqhC/VRyoHfeQhRyXPTzgRIUcg0nx6x0KOpt1GHnJ04WxUIS/MxfVbi3K3KmUP6sGYSYM0JzHrcuReUovGQpxGI0fTPjGR44ZBFzXIi17kxBGIr0LPBt6UQo4aPJu4HPkguuvZoz9FI0d0AxM5xitOhbzo6SInjhdJLORaJQdjk4kcK/kTssNhH/IJDCffu7cUN9q0Y1PChQsK5Lie07qc2pbXTmEY4xfIufdgjZrINdBNPuxDnhuhL81u5iJH0y5cE4oGFfKi5zOH+I+NRIpkqJ+50Sc1x7mjU5rkyHtyI5suEYjcaNO+sO8po5eqRE5XZmelPo+O/J00fVZMCh2R0iRGHi1EeYQ8jBHkxjHtmYkcN6N81CEvOhET/do+SolLR/4AoD4RKg7hfp/Vbl1qnsOdGj5ZDvfivMRQaTGGexFPKi2ZTZeATe8a54NCL9fGKn7k8Hi4ytu5GXBsdkbe86vDB63+6Pl42QLOz3tKXzjyHwC/TfqZfgXg/yj90dPb6kD1/Q+Af77e/0v98vny/zLB/+j0+vl5PP1uAP8CV/GqdTJ4tWwAAAAASUVORK5CYII=")
+      expect(image[:name]).to match(/cid:.*@.*/)
     end
 
   end

data/spec/delivery_schedule_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Delivery Schedule" do
+    it "handles supplied future DateTime value less than a year from now" do
+      start_time = (DateTime.now + 4.hours)
+      formatted_start_time = start_time.strftime("%Y-%m-%dT%H:%M:%S%:z")
+
+      test_email = Mailer.test_email date: start_time
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:start_time]).to eq(formatted_start_time)
+    end
+
+    it "does not include start_time if date is in the past" do
+      start_time = (DateTime.now - 4.hours)
+      
+      test_email = Mailer.test_email date: start_time
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options].has_key?(:start_time)).to eq(false)
+    end
+
+    it "does not include start_time if date is more than 1 year from now" do
+      start_time = (DateTime.now + 4.years)
+      
+      test_email = Mailer.test_email date: start_time
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options].has_key?(:start_time)).to eq(false)
+    end
+
+    it "does not include start_time if not set" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options].has_key?(:start_time)).to eq(false)
+    end
+  end
+end
+

data/spec/description_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Description" do
+    it "handles value from message" do
+      test_email = Mailer.test_email sparkpost_data: {description: "Test Email"}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:description]).to eq("Test Email")
+    end
+
+    it "truncates values longer than 1024 characters" do
+      raw_description = "X" * 1050
+      truncated_description = ("X" * 1021) + "..."
+
+      test_email = Mailer.test_email sparkpost_data: {description: raw_description}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:description]).to eq(truncated_description)
+    end
+
+    it "does not include description element if not supplied" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:description)).to eq(false)
+    end
+
+  end
+end
+
+

data/spec/headers_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Headers" do
+    it "passes appropriate headers through to the API" do
+      test_email = Mailer.test_email headers: {"Priority" => "urgent", "Sensitivity" => "private"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:headers]).to eq({"Priority" => "urgent", "Sensitivity" => "private"})
+    end
+
+    it "is compatible with CC functionality" do
+      test_email = Mailer.test_email cc: "Carl Test <cc@example.com>", headers: {"Priority" => "urgent", "Sensitivity" => "private"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"], "Priority" => "urgent", "Sensitivity" => "private"})
+    end
+
+    it "does not pass inappropriate headers through to the API" do
+      test_email = Mailer.test_email headers: {content_type: "POSTSCRIPT", "Priority" => "urgent", "Sensitivity" => "private"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:headers]).to eq({"Priority" => "urgent", "Sensitivity" => "private"})
+    end
+
+  end
+end
+

data/spec/ip_pool_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "IP Pool" do
+    it "handles ip_pool set in the configuration" do
+      SparkPostRails.configure do |c|
+        c.ip_pool = "default_ip"
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:ip_pool]).to eq("default_ip")
+    end
+
+    it "handles ip_pool set on an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {ip_pool: "message_ip"}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:ip_pool]).to eq("message_ip")
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.ip_pool = "default_ip"
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {ip_pool: "message_ip"}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:ip_pool]).to eq("message_ip")
+    end
+
+    it "handles a default setting of none" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options].has_key?(:ip_pool)).to eq(false)
+    end
+
+  end
+end

data/spec/skip_suppression_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Skip Suppression" do
+    it "handles value from message" do
+      test_email = Mailer.test_email sparkpost_data: {skip_suppression: true}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:skip_suppression]).to eq(true)
+    end
+
+    it "does not include skip_suppression element if not supplied" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options].has_key?(:skip_suppression)).to eq(false)
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -52,6 +52,14 @@ class Mailer < ActionMailer::Base
       options.delete(:inline_attachments)
     end
 
+    if options.has_key?(:headers)
+      if options[:headers].class == Hash
+        headers options[:headers]
+      end
+
+      options.delete(:headers)
+    end
+
     data.merge! options
 
     if data.has_key?(:html_part)

data/spec/subaccount_api_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Message-Specific API Key" do
+    it "uses supplied API key instead of default" do
+      SparkPostRails.configure do |c|
+        c.api_key = 'NEW_DEFAULT_API_KEY'
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {api_key: 'SUBACCOUNT_API_KEY'}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers).to include("Authorization" => "SUBACCOUNT_API_KEY")
+    end
+
+    it "uses default API if no message-specific API key applied" do
+      SparkPostRails.configure do |c|
+        c.api_key = 'NEW_DEFAULT_API_KEY'
+      end
+      
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers).to include("Authorization" => "NEW_DEFAULT_API_KEY")
+    end
+  end
+
+  context "Subaccount ID" do
+    it "accepts a subaccount ID in the configuration" do
+      SparkPostRails.configure do |c|
+        c.subaccount = 123
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers).to include("X-MSYS-SUBACCOUNT" => "123")
+    end
+
+    it "defaults to no subaccount ID in the configuration" do
+      expect(SparkPostRails.configuration.subaccount).to eq(nil)
+    end
+
+    it "accepts subaccount ID for an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {subaccount: 456}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers).to include("X-MSYS-SUBACCOUNT" => "456")
+    end
+
+    it "uses subaccount ID on message instead of value in configuration" do
+      SparkPostRails.configure do |c|
+        c.subaccount = 123
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {subaccount: 456}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers).to include("X-MSYS-SUBACCOUNT" => "456")
+    end
+    
+    it "does not include the subaccount header when none is specified" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.headers.has_key?("X-MSYS-SUBACCOUNT")).to eq(false)
+    end
+  end
+end

data/spec/transactional_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Transactional" do
+    it "handles transactional flag set in the configuration" do
+      SparkPostRails.configure do |c|
+        c.transactional = true
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:transactional]).to eq(true)
+    end
+
+    it "handles transactional set on an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {transactional: true}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:transactional]).to eq(true)
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.transactional = true
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {transactional: false}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:transactional]).to eq(false)
+    end
+
+    it "handles unset value" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:transactional]).to eq(false)
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkpost_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kevin Kimball
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,8 +74,12 @@ files:
 - spec/campaign_id_spec.rb
 - spec/cc_recipients_spec.rb
 - spec/click_tracking_spec.rb
+- spec/delivery_schedule_spec.rb
+- spec/description_spec.rb
 - spec/from_spec.rb
+- spec/headers_spec.rb
 - spec/inline_content_spec.rb
+- spec/ip_pool_spec.rb
 - spec/open_tracking_spec.rb
 - spec/recipients_list_spec.rb
 - spec/recipients_spec.rb
@@ -83,9 +87,12 @@ files:
 - spec/response_spec.rb
 - spec/return_path_spec.rb
 - spec/sandbox_mode_spec.rb
+- spec/skip_suppression_spec.rb
 - spec/spec_helper.rb
+- spec/subaccount_api_spec.rb
 - spec/substitution_data_spec.rb
 - spec/template_spec.rb
+- spec/transactional_spec.rb
 homepage: https://github.com/the-refinery/sparkpost_rails
 licenses:
 - MIT
@@ -112,15 +119,21 @@ specification_version: 4
 summary: SparkPost for Rails
 test_files:
 - spec/cc_recipients_spec.rb
+- spec/subaccount_api_spec.rb
+- spec/ip_pool_spec.rb
 - spec/inline_content_spec.rb
 - spec/return_path_spec.rb
+- spec/transactional_spec.rb
 - spec/recipients_list_spec.rb
 - spec/campaign_id_spec.rb
+- spec/description_spec.rb
 - spec/response_spec.rb
 - spec/bcc_recipients_spec.rb
 - spec/sandbox_mode_spec.rb
 - spec/from_spec.rb
 - spec/recipients_spec.rb
+- spec/delivery_schedule_spec.rb
+- spec/headers_spec.rb
 - spec/spec_helper.rb
 - spec/template_spec.rb
 - spec/open_tracking_spec.rb
@@ -128,3 +141,4 @@ test_files:
 - spec/attachments_spec.rb
 - spec/click_tracking_spec.rb
 - spec/substitution_data_spec.rb
+- spec/skip_suppression_spec.rb