sparkpost_rails 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1824c8a4ed0368d9063eadf820ff0e53b8469af7
-  data.tar.gz: b7ba7d9806925dfcc2e6f859a484a85cd43e24f2
+  metadata.gz: 7dd8e6ff5990addebb68d59f37adda1b51f8b676
+  data.tar.gz: 0e250da6bd76270214b057608fc23a0fb835ccc3
 SHA512:
-  metadata.gz: de4ea6d3e24d6414ec768867816d1ddb3f17a4dbe01994b05fa5ba43a3d53663ca315b5202c0d8d0b918c3d1b0f6b12b86738536f62049f12c2fcd813a0ca8e6
-  data.tar.gz: c4431d3186b89221cc0f8270a04b7c698f31a1594d1de39bb8cf3068a2b4f6e999369b22c3244714fc28f2e51359f45d63adbb84a89a8638b73fe210efc3ef51
+  metadata.gz: 977a7c03477a3fb275317172f5eb8821127f1df2a063902eaa6781dd046b73019a10683daf3ee0fc057cfd48c7ef67deb109555a057bbae22c1c029f7338502d
+  data.tar.gz: f115139d0f015c8f97a57fd5eb55a7f6b49e1962831f9dc0088e409b48961378ef87a6a1437f1c914e622601294d42f8237886c79669534c4afc479d54c9a2e4

data/README.md

@@ -4,90 +4,74 @@
 SparkPost Rails
 ===============
 
-This gem provides seamless integration of SparkPost with ActionMailer. It provides a delivery_method based upon the SparkPost API, and
-makes getting setup and sending email via SparkPost in a Rails app pretty painless.
+This gem provides seamless integration of SparkPost with ActionMailer. It provides a `delivery_method` based upon the SparkPost API, and makes getting setup and sending email via SparkPost in a Rails app pretty painless.
 
 Getting Started
 ---------------
 
 Add the gem to your Gemfile
 
-```
+```ruby
 gem 'sparkpost_rails'
 ```
 
 Then run the bundle command to install it.
 
-By default, the gem will look for your SparkPost API key in your environment, with the key 'SPARKPOST_API_KEY'.  You can override this 
-setting by identifying a different key in the initializer (`config/initializers/sparkpost_rails.rb`):
+By default, the gem will look for your SparkPost API key in your environment, with the key `SPARKPOST_API_KEY`.  You can override this setting by identifying a different key in the initializer (`config/initializers/sparkpost_rails.rb`):
 
-```
+```ruby
 SparkPostRails.configure do |c|
   c.api_key = 'YOUR API KEY'
 end
 ```
+Note that an initializer file is not required to use this gem. If an initializer is not provided, default values will be used. See ["Additional Configuration"](#additional-configuration) below for a list of all the default settings.
 
 In each environment configuration file from which you want to send emails via Sparkpost, (i.e. `config/environments/production.rb`) add
 
-```
+```ruby
 config.action_mailer.delivery_method = :sparkpost
 ```
 
 Additional Configuration
 ------------------------
-You can establish values for a number of SparkPost settings in the initializer.  These values will be used for every message sent 
-from your application.  You can override these settings on individual messages.
+You can establish values for a number of SparkPost settings in the initializer. These values will be used for every message sent from your application. You can override these settings on individual messages.
 
-```
+```ruby
 SparkPostRails.configure do |c|
-  c.sandbox = true
-  c.track_opens = true
-  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"
-  c.inline_css = true
-  c.html_content_only = true
-  c.subaccount = "123"
+  c.sandbox = true                                # default: false
+  c.track_opens = true                            # default: false
+  c.track_clicks = true                           # default: false
+  c.return_path = 'BOUNCE-EMAIL@YOUR-DOMAIN.COM'  # default: nil
+  c.campaign_id = 'YOUR-CAMPAIGN'                 # default: nil
+  c.transactional = true                          # default: false
+  c.ip_pool = "MY-POOL"                           # default: nil
+  c.inline_css = true                             # default: false
+  c.html_content_only = true                      # default: false
+  c.subaccount = "123"                            # default: nil
 end
 ```
 
-The default values for these optional configuration settings are:
-
-```
-sandbox = false
-track_opens = false
-track_clicks = false
-return_path = nil
-campaign_id = nil
-transactional = false
-ip_pool = nil
-inline_css = false
-html_content_only = false
-subaccount = nil
-```
-
 Usage
 -----
-When calling the deliver! method on the mail object returned from your mailer, SparkPostRails provides the response data directly back
-from SparkPost as a hash.
+When calling the `deliver!` method on the mail object returned from your mailer, `SparkPostRails` provides the response data directly back from SparkPost as a hash.
 
-```
+```ruby
 result = MyMailer.welcome_message(user).deliver!
 ```
 
 Example:
 
-```
-{"total_rejected_recipients"=>0, "total_accepted_recipients"=>1, "id"=>"00000000000000"}
+```ruby
+{
+  "total_rejected_recipients" => 0, 
+  "total_accepted_recipients" => 1, 
+  "id" => "00000000000000"
+}
 ```
 
-If the SparkPost API reponds with an error condition, SparkPostRails will raise a SparkPostRails::DeliveryException, which will include all the message
-data returned by the API.
+If the SparkPost API reponds with an error condition, SparkPostRails will raise a `SparkPostRails::DeliveryException`, which will include all the message data returned by the API.
 
-SparkPostRails will support multiple recipients, multilple CC, multiple BCC, ReplyTo address, file attachments, inline images, multi-part (HTML and plaintext) messages - 
-all utilizing the standard ActionMailer methodologies.
+SparkPostRails will support multiple recipients, multilple CC, multiple BCC, ReplyTo address, file attachments, inline images, multi-part (HTML and plaintext) messages - all utilizing the standard `ActionMailer` methodologies.
 
 Handling Errors
 ---------------
@@ -95,79 +79,77 @@ If you are using `ActiveJob` and wish to do something special when the SparkPost
 
 `config/initializers/action_mailer.rb`
 
-```
+```ruby
 ActionMailer::DeliveryJob.rescue_from(SparkPostRails::DeliveryException) do |exception|
   # do something special with the error
 end
 ```
 
-SparkPost Specific Features
+SparkPost-Specific Features
 ---------------------------
 
 ### Configuration Settings
-You can specifiy values for any or all of the configuration settings listed above on an individual message.  Simply add a hash of these values
-to the mail message in a field named "sparkpost_data":
-
-```
-data = { track_opens: true,
-         track_clicks: false,
-         campaign_id: "My Campaign",
-         transactional: true,
-         ip_pool = "SPECIAL_POOL",
-         api_key = "MESSAGE_SPECIFIC_API_KEY"
-         subaccount = "123"
-       }
+You can specifiy values for any or all of the configuration settings listed above on an individual message. Simply add a hash of these values to the mail message in a field named `sparkpost_data`:
+
+```ruby
+data = { 
+  track_opens: true,
+  track_clicks: false,
+  campaign_id: "My Campaign",
+  transactional: true,
+  ip_pool = "SPECIAL_POOL",
+  api_key = "MESSAGE_SPECIFIC_API_KEY"
+  subaccount = "123"
+}
 
 mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
 ```
 
-Additionally, return_path can be overriden on a specific email by setting that field on the mail message itself:
+Additionally, `return_path` can be overriden on a specific email by setting that field on the mail message itself:
 
-```
+```ruby
 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:
+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:
 
-```
+```ruby
 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.
+To schedule the generation of messages for a future date and time, specify a start time in the `date` parameter of the mail. The `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.
 
-```
+```ruby
 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.
+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.
 
-```
+```ruby
 data = { description: "My Important Message" }
 
 mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
 ```
 
-By default, content from single-part messages is sent at plain-text.  If you are only intending to send HTML email, with no plain-text part, you can specify this 
-as shown below.  You can also set this in the configuration to ensure that all single-part emails are sent as html.
+By default, content from single-part messages is sent at plain-text. If you are only intending to send HTML email, with no plain-text part, you can specify this as shown below. You can also set this in the configuration to ensure that all single-part emails are sent as HTML.
 
-```
+```ruby
 data = { html_content_only: true }
 
 mail(to: to_email, subject: "Test", body: "<h1>test</h1>", sparkpost_data: data)
 ```
 
 ### Subaccounts
+
 SparkPostRails supports sending messages via subaccounts in two ways. The default API key set in the configuration can be overriden on a message-by-message basis with a subaccount API key.
 
-```
+```ruby
 data = { api_key: "SUBACCOUNT_API_KEY" }
 
 mail(subject: "Test", body: "test", sparkpost_data: data)
@@ -175,42 +157,42 @@ mail(subject: "Test", body: "test", sparkpost_data: data)
 
 Subaccounts can also be leveraged using the subaccount ID with the master API key.
 
-```
+```ruby
 data = { subaccount: "123" }
 
 mail(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:
+SparkPostRails supports using SparkPost stored recipient lists. Simply add the `list_id` to the `sparkpost_data` hash on the mail message:
 
-```
+```ruby
 data = { list_id: "MY-LIST"}
 
 mail(subject: "Test", body: "test", sparkpost_data: data)
 ```
 
-**NOTE**: If you supply a recipient list id, all To:, CC:, and BCC: data specified on the mail message will be ignored.  The SparkPost API does
-not support utilizing both a recipient list and inline recipients.
+**NOTE**: If you supply a recipient `list_id`, all `To:`, `CC:`, and `BCC:` data specified on the mail message will be ignored. The SparkPost API does not support utilizing both a recipient list and inline recipients.
 
 
 ### Substitution Data
-You can leverage SparkPost's substitution engine through the gem as well.  To supply substitution data, simply add your hash of substitution data
-to your sparkpost_data hash, with the key :substitution_data.
+You can leverage SparkPost's substitution engine through the gem as well. To supply substitution data, simply add your hash of substitution data to your `sparkpost_data` hash, with the key `substitution_data`.
 
-```
-sub_data = {first_name: "Sam",
-            last_name: "Test}
+```ruby
+sub_data = {
+  first_name: "Sam",
+  last_name: "Test
+}
 
 data = { substitution_data: sub_data }
 
 mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
 ```
 
-### Recipient-specific Data
-When sending to multiple recipients, you can pass an array of data to complement each recipient. Simply pass an array called recipients containing an array of the additional data (e.g. substitution_data).
+### Recipient-Specific Data
+When sending to multiple recipients, you can pass an array of data to complement each recipient. Simply pass an array called `recipients` containing an array of the additional data (e.g. `substitution_data`).
 
-```
+```ruby
 recipients = ['recipient1@email.com', 'recipient2@email.com']
 sparkpost_data = {
   recipients: [
@@ -223,10 +205,9 @@ mail(to: recipients, sparkpost_data: sparkpost_data)
 
 
 ### Using SparkPost Templates
-If you would rather leverage SparkPost's powerful templates rather than building ActionMailer views, SparkPostRails can support that as well.  Simply
-add your template id to the sparkpost_data hash. By default, ActionMailer finds a template to use within views, a workaround to prevent this default action is to explicitly pass a block with an empty text part:
+You can leverage SparkPost's powerful templates rather than building ActionMailer views using SparkPostRails. Add your `template_id` to the `sparkpost_data` hash. By default, `ActionMailer` finds a template to use within views. A workaround to prevent this default action is to explicitly pass a block with an empty `text` part:
 
-```
+```ruby
 data = { template_id: "MY-TEMPLATE" }
 
 mail(to: to_email, sparkpost_data: data) do |format|
@@ -234,15 +215,14 @@ mail(to: to_email, sparkpost_data: data) do |format|
 end
 ```
 
-**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.
+**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."
+If you need to identify custom mail headers for your messages, use 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.
+
+```ruby
 headers["Priority"] = "urgent"
 headers["Sensitivity"] = "private"
 

data/lib/sparkpost_rails.rb

@@ -1,3 +1,4 @@
+require "sparkpost_rails/data_options"
 require "sparkpost_rails/delivery_method"
 require "sparkpost_rails/exceptions"
 require "sparkpost_rails/railtie"
@@ -7,6 +8,10 @@ module SparkPostRails
     attr_accessor :configuration
   end
 
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)

data/lib/sparkpost_rails/data_options.rb

@@ -0,0 +1,25 @@
+module SparkPostRails
+    module DataOptions
+
+      def self.included(base)
+        base.class_eval do
+          prepend InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+
+        def mail(headers={}, &block)
+          headers = headers.clone
+          sparkpost_data = headers.delete(:sparkpost_data)
+          sparkpost_data ||= {}
+          super(headers, &block).tap do |message|
+            message.singleton_class.class_eval { attr_accessor "sparkpost_data" }
+            message.sparkpost_data = sparkpost_data
+          end
+        end
+
+      end
+
+  end
+end

data/lib/sparkpost_rails/delivery_method.rb

@@ -29,6 +29,7 @@ module SparkPostRails
       end
 
       prepare_substitution_data_from sparkpost_data
+      prepare_metadata_from sparkpost_data
       prepare_description_from sparkpost_data
       prepare_options_from mail, sparkpost_data
       prepare_additional_mail_headers_from mail
@@ -42,11 +43,7 @@ module SparkPostRails
 
   private
     def find_sparkpost_data_from mail
-      if mail[:sparkpost_data]
-        eval(mail[:sparkpost_data].value)
-      else
-        Hash.new
-      end
+      mail.sparkpost_data
     end
 
     def prepare_recipients_from mail, sparkpost_data
@@ -68,14 +65,15 @@ module SparkPostRails
 
     def prepare_addresses emails, names
       emails = [emails] unless emails.is_a?(Array)
-      emails.each_with_index.map {|email, index| prepare_address(email, index, names) }
+      header_to = emails.join(",")
+      emails.each_with_index.map {|email, index| prepare_address(email, index, names, header_to) }
     end
 
-    def prepare_address email, index, names
+    def prepare_address email, index, names, header_to
       if !names[index].nil?
-        { address:  { email: email, name: names[index] } }
+        { address:  { email: email, name: names[index], header_to: header_to } }
       else
-        { address: { email: email } }
+        { address: { email: email, header_to: header_to } }
       end
     end
 
@@ -118,6 +116,12 @@ module SparkPostRails
       end
     end
 
+    def prepare_metadata_from sparkpost_data
+      if sparkpost_data[:metadata]
+        @data[:metadata] = sparkpost_data[:metadata]
+      end
+    end
+
     def prepare_from_address_from mail
       if !mail[:from].display_names.first.nil?
         from = { email: mail.from.first, name: mail[:from].display_names.first }
@@ -147,7 +151,7 @@ module SparkPostRails
           emails << copy[:address][:email]
         end
 
-        @data[:content][:headers] = { cc: emails }
+        @data[:content][:headers] = { cc: emails.join(",") }
       end
     end
 
@@ -178,9 +182,9 @@ module SparkPostRails
       inline_images = Array.new
 
       mail.attachments.each do |attachment|
-        #We decode and reencode here to ensure that attachments are 
+        #We decode and reencode here to ensure that attachments are
         #Base64 encoded without line breaks as required by the API.
-        attachment_data = { name: attachment.inline? ? attachment.url : attachment.filename,
+        attachment_data = { name: attachment.inline? ? attachment.cid : attachment.filename,
                             type: attachment.content_type,
                             data: Base64.strict_encode64(attachment.body.decoded) }
 
@@ -381,7 +385,6 @@ module SparkPostRails
 
       request = Net::HTTP::Post.new(uri.path, @headers)
       request.body = JSON.generate(@data)
-
       http.request(request)
     end
 

data/lib/sparkpost_rails/railtie.rb

@@ -5,5 +5,11 @@ module SparkPostRails
         ActionMailer::Base.add_delivery_method :sparkpost, SparkPostRails::DeliveryMethod, return_response: true
       end
     end
+
+    initializer "sparkpost_rails.extend_with_data_options" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.send :include, SparkPostRails::DataOptions
+      end
+    end
   end
 end

data/lib/sparkpost_rails/version.rb

@@ -1,4 +1,4 @@
 module SparkPostRails
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end
 

data/spec/attachments_spec.rb

@@ -48,7 +48,7 @@ describe SparkPostRails::DeliveryMethod do
       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:.*@.*/)
+      expect(image[:name]).to match(/.*@.*/)
     end
 
   end

data/spec/bcc_recipients_spec.rb

@@ -13,7 +13,8 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email bcc: "bcc@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "bcc@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", header_to: anything}}),
+                                                             {address: {email: "bcc@example.com", header_to: "to@example.com"}}])
         expect(@delivery_method.data[:content]).not_to include(:headers)
       end
 
@@ -21,7 +22,9 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", bcc: "Brock Test <bcc@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", name: "Sam Test", header_to: anything}}),
+                                                             {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
         expect(@delivery_method.data[:content]).not_to include(:headers)
       end
     end
@@ -31,7 +34,10 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email bcc: "bcc1@example.com, bcc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "bcc1@example.com", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", header_to: anything}}),
+                                                             {address: {email: "bcc1@example.com", header_to: "to@example.com"}},
+                                                             {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
+
         expect(@delivery_method.data[:content]).not_to include(:headers)
       end
 
@@ -39,7 +45,9 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>", bcc: "Brock Test <bcc1@example.com>, Brack Test <bcc2@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", name: "Brack Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}}),
+                                                             {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}},
+                                                             {address: {email: "bcc2@example.com", name: "Brack Test", header_to: "to@example.com"}}])
         expect(@delivery_method.data[:content]).not_to include(:headers)
       end
 
@@ -47,7 +55,9 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>", bcc: "Brock Test <bcc1@example.com>, bcc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}}),
+                                                             {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}},
+                                                             {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
         expect(@delivery_method.data[:content]).not_to include(:headers)
       end
     end
@@ -57,24 +67,35 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc@example.com", bcc: "bcc@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc@example.com", header_to: "to1@example.com"}}, {address: {email: "bcc@example.com", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", header_to: "to1@example.com"}},
+                                                             {address: {email: "bcc@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc@example.com>", bcc: "Brock Test <bcc@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}}, {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", name: "Sam Test", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}},
+                                                             {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
 
       it "handles mix of email only and name/email" do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, to2@example.com", cc: "cc1@example.com, Chris Test <cc2@example.com>", bcc: "Brock Test <bcc1@example.com>, bcc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to1@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", header_to: "to1@example.com"}},
+                                                             {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}},
+                                                             {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to1@example.com"}},
+                                                             {address: {email: "bcc2@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
     end
   end

data/spec/cc_recipients_spec.rb

@@ -12,16 +12,18 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email cc: "cc@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "cc@example.com", header_to: "to@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", name: "Carl Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
     end
 
@@ -30,24 +32,30 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email cc: "cc1@example.com, cc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "cc1@example.com", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", header_to: "to@example.com"}},
+                                                             {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc1@example.com>, Chris Test <cc2@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}},
+                                                             {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
 
       it "handles mix of email only and name/email" do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc1@example.com>, cc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}},
+                                                             {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
     end
 
@@ -56,16 +64,20 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc@example.com", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", name: "Sam Test", header_to: anything}}),
+                                                             {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc@example.com"})
       end
     end
 
@@ -74,24 +86,33 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc1@example.com, cc2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", header_to: "to1@example.com"}},
+                                                             {address: {email: "cc2@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc1@example.com>, Chris Test <cc2@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", name: "Sam Test", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to1@example.com"}},
+                                                             {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
 
       it "handles mix of email only and name/email for to recipients" do
         test_email = Mailer.test_email to: "Joe Test <to1@example.com>, to2@example.com", cc: "cc1@example.com, Chris Test <cc2@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
-        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", name: "Joe Test", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}}),
+                                                             {address: {email: "cc1@example.com", header_to: "to1@example.com"}},
+                                                             {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: "cc1@example.com,cc2@example.com"})
       end
     end
   end

data/spec/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "SparkPostRails configuration" do
+  let(:delivery_method) { SparkPostRails::DeliveryMethod.new }
+
+  describe "#configuration" do
+    it "creates a new configuration + defaults if #configure is never called", skip_configure: true do
+      config = SparkPostRails.configuration
+      expect(config).to_not be_nil
+    end
+  end
+end

data/spec/headers_spec.rb

@@ -18,7 +18,7 @@ describe SparkPostRails::DeliveryMethod 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"})
+      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

data/spec/metadata_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+  subject { described_class.new }
+  let(:metadata) { {item_1: 'test data 1', item_2: 'test data 2'} }
+
+  describe 'Metadata' do
+    context 'template-based message' do
+      context 'when metadata is passed' do
+        it 'includes metadata' do
+          test_email = Mailer.test_email sparkpost_data: { template_id: 'test_template', metadata: metadata }
+          subject.deliver!(test_email)
+          expect(subject.data[:metadata]).to eq(metadata)
+        end
+      end
+
+      context "when metadata isn't passed" do
+        it "doesn't include metadata" do
+          test_email = Mailer.test_email sparkpost_data: { template_id: 'test_template' }
+          subject.deliver!(test_email)
+          expect(subject.data).to_not have_key(:metadata)
+        end
+      end
+    end
+
+    context 'inline-content message' do
+      context 'when metadata is passed' do
+        it 'includes metadata' do
+          test_email = Mailer.test_email sparkpost_data: { metadata: metadata }
+          subject.deliver!(test_email)
+          expect(subject.data[:metadata]).to eq(metadata)
+        end
+      end
+
+      context "when metadata isn't passed" do
+        it "doesn't include metadata" do
+          test_email = Mailer.test_email sparkpost_data: { metadata: nil }
+          subject.deliver!(test_email)
+          expect(subject.data).to_not have_key(:metadata)
+        end
+      end
+    end
+  end
+end

data/spec/recipient_specific_data_spec.rb

@@ -21,7 +21,7 @@ describe SparkPostRails::DeliveryMethod do
 
       actual_recipients = @delivery_method.data[:recipients]
       expect(actual_recipients.length).to eq(recipients.length)
-      expect(actual_recipients).to eq(recipients.each_with_index.map { |recipient, index| recipients_data[index].merge(address: {email: recipient}) })
+      expect(actual_recipients).to match(recipients.each_with_index.map { |recipient, index| recipients_data[index].merge(address: {email: recipient, header_to: anything}) })
     end
 
   end

data/spec/recipients_spec.rb

@@ -13,14 +13,14 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", header_to: anything}})])
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Joe Test <to@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to@example.com", name: "Joe Test", header_to: anything}})])
       end
     end
 
@@ -29,21 +29,33 @@ describe SparkPostRails::DeliveryMethod do
         test_email = Mailer.test_email to: "to1@example.com, to2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({address: {email: "to1@example.com", header_to: anything}}),
+                                                             a_hash_including({address: {email: "to2@example.com", header_to: anything}})])
       end
 
       it "handles name and email" do
         test_email = Mailer.test_email to: "Sam Test <to1@example.com>, Joe Test <to2@example.com>"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{:address=>{:email=>"to1@example.com", :name=>"Sam Test"}}, {:address=>{:email=>"to2@example.com", :name=>"Joe Test"}}])
+        expect(@delivery_method.data[:recipients]).to match([a_hash_including({:address=>{:email=>"to1@example.com", :name=>"Sam Test", header_to: anything}}),
+                                                             a_hash_including({:address=>{:email=>"to2@example.com", :name=>"Joe Test", header_to: anything}})])
       end
 
       it "handles mix of email only and name/email" do
         test_email = Mailer.test_email to: "Sam Test <to1@example.com>, to2@example.com"
         @delivery_method.deliver!(test_email)
 
-        expect(@delivery_method.data[:recipients]).to eq([{:address=>{:email=>"to1@example.com", :name=>"Sam Test"}}, {:address=>{:email=>"to2@example.com"}}])
+        expect(@delivery_method.data[:recipients]).to match_array([a_hash_including({:address=>{:email=>"to1@example.com", :name=>"Sam Test", header_to: anything}}),
+                                                                   a_hash_including({:address=>{:email=>"to2@example.com", header_to: anything}})])
+      end
+
+      it "compiles list of email addresses to populate :header_to for each recipient" do
+        expected_header_to = "a@a.com,b@b.com"
+        test_email = Mailer.test_email to: "a <a@a.com>, b@b.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients].first[:address][:header_to]).to eql(expected_header_to)
+        expect(@delivery_method.data[:recipients].second[:address][:header_to]).to eql(expected_header_to)
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,12 +6,18 @@ require "sparkpost_rails"
 RSpec.configure do |config|
 
   config.before(:all) do
-    SparkPostRails.configure do |c|
-      c.api_key = "TESTKEY1234"
-    end
+    ActionMailer::Base.send :include, SparkPostRails::DataOptions
   end
 
-  config.before(:each) do
+  config.before(:each) do |example|
+    if example.metadata[:skip_configure]
+      SparkPostRails.configuration = nil # Reset configuration
+    else
+      SparkPostRails.configure do |c|
+        c.api_key = "TESTKEY1234"
+      end
+    end
+
     stub_request(:any, "https://api.sparkpost.com/api/v1/transmissions").
       to_return(body: "{\"results\":{\"total_rejected_recipients\":0,\"total_accepted_recipients\":1,\"id\":\"00000000000000000\"}}", status: 200)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkpost_rails
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kevin Kimball
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -20,7 +20,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - LICENSE
 - README.md
 - lib/sparkpost_rails.rb
+- lib/sparkpost_rails/data_options.rb
 - lib/sparkpost_rails/delivery_method.rb
 - lib/sparkpost_rails/exceptions.rb
 - lib/sparkpost_rails/railtie.rb
@@ -80,6 +81,7 @@ files:
 - spec/campaign_id_spec.rb
 - spec/cc_recipients_spec.rb
 - spec/click_tracking_spec.rb
+- spec/configuration_spec.rb
 - spec/delivery_schedule_spec.rb
 - spec/description_spec.rb
 - spec/exceptions_spec.rb
@@ -88,6 +90,7 @@ files:
 - spec/inline_content_spec.rb
 - spec/inline_css_spec.rb
 - spec/ip_pool_spec.rb
+- spec/metadata_spec.rb
 - spec/open_tracking_spec.rb
 - spec/recipient_specific_data_spec.rb
 - spec/recipients_list_spec.rb
@@ -127,30 +130,32 @@ signing_key:
 specification_version: 4
 summary: SparkPost for Rails
 test_files:
+- spec/recipients_spec.rb
+- spec/template_spec.rb
+- spec/substitution_data_spec.rb
 - spec/inline_content_spec.rb
+- spec/campaign_id_spec.rb
 - spec/from_spec.rb
-- spec/subaccount_api_spec.rb
-- spec/recipients_spec.rb
-- spec/headers_spec.rb
-- spec/transactional_spec.rb
-- spec/bcc_recipients_spec.rb
-- spec/exceptions_spec.rb
 - spec/ip_pool_spec.rb
-- spec/attachments_spec.rb
-- spec/cc_recipients_spec.rb
 - spec/recipients_list_spec.rb
-- spec/template_spec.rb
-- spec/campaign_id_spec.rb
 - spec/reply_to_spec.rb
-- spec/spec_helper.rb
-- spec/description_spec.rb
 - spec/click_tracking_spec.rb
-- spec/skip_suppression_spec.rb
-- spec/substitution_data_spec.rb
-- spec/inline_css_spec.rb
+- spec/return_path_spec.rb
+- spec/headers_spec.rb
+- spec/spec_helper.rb
+- spec/exceptions_spec.rb
+- spec/metadata_spec.rb
 - spec/response_spec.rb
 - spec/open_tracking_spec.rb
-- spec/sandbox_mode_spec.rb
+- spec/inline_css_spec.rb
 - spec/recipient_specific_data_spec.rb
-- spec/return_path_spec.rb
+- spec/bcc_recipients_spec.rb
 - spec/delivery_schedule_spec.rb
+- spec/sandbox_mode_spec.rb
+- spec/cc_recipients_spec.rb
+- spec/configuration_spec.rb
+- spec/description_spec.rb
+- spec/attachments_spec.rb
+- spec/subaccount_api_spec.rb
+- spec/skip_suppression_spec.rb
+- spec/transactional_spec.rb