sparkpost_rails 1.3.0 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 925047803a24a8f98ba5f888f81c4a1ad472f9fc
-  data.tar.gz: 171842fb600f86f2e65143102ccdba962ac80d17
+SHA256:
+  metadata.gz: bd9cf39367215bffb11029280b7526e52553b8484767d2823fc59448b9352c80
+  data.tar.gz: 662a03effd5a0332400c843e9a047f65dc34e823baabfa63ce3366867a3f4b69
 SHA512:
-  metadata.gz: a783aaf00991597cc6f3b5558db1b43f285e9196cc9cebf22e21f87ba54c5b5cc7cfcc20158cfa1ef9309c70f9ff2da7e6f0fb30f1a6f6f1ae0606bcfa8187ea
-  data.tar.gz: 6ef6d2888ebf9d6b1864ab77df43aaae54d59abd28ab173621b173b9e3d52877931f6415b27efbda4b9454b730026b1b6804e0f665d9543a084f65caa6ee0d54
+  metadata.gz: 5c62bb17ff1685deb530b442e4c022bf4eb88208d8ea988ad6b7baa4c9ee79d0e24180ae099db14d3635e9973367de9ce402dbd3f93418ba1c085a2732e828f4
+  data.tar.gz: 202997cc9e44bc84bfc4412b1d5f2f0e6b09246089cf3372506fe3606ce3ea383aec09ae99fbc7db31af27e96cd314f6555894cef2d19317d7cf0ad668519b4d

data/README.md

@@ -4,159 +4,154 @@
 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.api_endpoint = "https://api.eu.sparkpost.com/api/" # default: "https://api.sparkpost.com/api/"
+  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:
 
+```ruby
+{
+  "total_rejected_recipients" => 0,
+  "total_accepted_recipients" => 1,
+  "id" => "00000000000000"
+}
 ```
-{"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 responds 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, multiple 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
+---------------
+If you are using `ActiveJob` and wish to do something special when the SparkPost API responds with an error condition you can do so by rescuing these exceptions via `ActionMailer::DeliveryJob`. Simply add an initializer:
 
+`config/initializers/action_mailer.rb`
 
-SparkPost Specific Features
+```ruby
+ActionMailer::DeliveryJob.rescue_from(SparkPostRails::DeliveryException) do |exception|
+  # do something special with the error
+  # do something special with the error
+end
+```
+
+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 specify 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 overridden 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.
 
-```
-start_time = DateTime.now + 4.hours 
+```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)
@@ -164,57 +159,72 @@ 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:
 
-```
-data = { list_id: "MY-LIST"}
+```ruby
+data = { recipient_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)
 ```
 
-### 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:
+### 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: [
+    { substitution_data: { name: 'Recipient1' } },
+    { substitution_data: { name: 'Recipient2' } }
+  ]
+}
+mail(to: recipients, sparkpost_data: sparkpost_data)
 ```
+
+
+### Using SparkPost Templates
+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)
+mail(to: to_email, sparkpost_data: data) do |format|
+  format.text { render text: "" }
+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 appropriate 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)
@@ -14,6 +19,7 @@ module SparkPostRails
 
   class Configuration
     attr_accessor :api_key
+    attr_accessor :api_endpoint
     attr_accessor :sandbox
 
     attr_accessor :track_opens
@@ -40,6 +46,8 @@ module SparkPostRails
         @api_key = ""
       end
 
+      @api_endpoint = "https://api.sparkpost.com/api/"
+
       @sandbox = false
 
       @track_opens = false

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

@@ -14,6 +14,7 @@ module SparkPostRails
       sparkpost_data = find_sparkpost_data_from mail
 
       prepare_recipients_from mail, sparkpost_data
+      prepare_recipients_data_from sparkpost_data
 
       if sparkpost_data.has_key?(:template_id)
         prepare_template_content_from sparkpost_data
@@ -28,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
@@ -41,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
@@ -67,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
 
@@ -95,6 +94,17 @@ module SparkPostRails
       end
     end
 
+    # See https://developers.sparkpost.com/api/#/introduction/substitutions-reference/links-and-substitution-expressions-within-substitution-values
+    def prepare_recipients_data_from sparkpost_data
+      if (recipients_data = sparkpost_data[:recipients])
+        @data[:recipients].each_with_index do |recipient, index|
+          if (recipient_data = recipients_data[index])
+            recipient.merge!(recipient_data)
+          end
+        end
+      end
+    end
+
     def prepare_template_content_from sparkpost_data
       @data[:content][:template_id] = sparkpost_data[:template_id]
 
@@ -106,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 }
@@ -135,7 +151,7 @@ module SparkPostRails
           emails << copy[:address][:email]
         end
 
-        @data[:content][:headers] = { cc: emails }
+        @data[:content][:headers] = { cc: emails.join(",") }
       end
     end
 
@@ -166,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) }
 
@@ -361,15 +377,13 @@ module SparkPostRails
     end
 
     def post_to_api
-      url = "https://api.sparkpost.com/api/v1/transmissions"
+      uri = URI.join(SparkPostRails.configuration.api_endpoint, 'v1/transmissions')
 
-      uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
       request = Net::HTTP::Post.new(uri.path, @headers)
       request.body = JSON.generate(@data)
-
       http.request(request)
     end
 

data/lib/sparkpost_rails/exceptions.rb

@@ -1,4 +1,17 @@
 module SparkPostRails
   class DeliveryException < StandardError
+    attr_reader :service_message, :service_description, :service_code
+
+    def initialize(message)
+      errors = [*message].first
+
+      if errors.is_a?(Hash)
+        @service_message     = errors['message']
+        @service_description = errors['description']
+        @service_code        = errors['code']
+      end
+
+      super(message)
+    end
   end
 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.3.0"
+  VERSION = "1.5.3"
 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/exceptions_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryException do
+  subject { SparkPostRails::DeliveryException.new(error) }
+
+  describe 'string' do
+    let(:error) { 'Some delivery error' }
+
+    it 'preserves original message' do
+      begin
+        raise subject
+      rescue SparkPostRails::DeliveryException => err
+        expect(error).to eq(err.message)
+      end
+    end
+  end
+
+  describe 'array with error details' do
+    let(:error) { [{ 'message' => 'Message generation rejected', 'description' => 'recipient address suppressed due to customer policy', 'code' => '1902' }] }
+
+    it 'assigns message' do
+      expect(subject.service_message).to eq('Message generation rejected')
+    end
+
+    it 'assigns description' do
+      expect(subject.service_description).to eq('recipient address suppressed due to customer policy')
+    end
+
+    it 'assigns code' do
+      expect(subject.service_code).to eq('1902')
+    end
+
+    it 'preserves original message' do
+      begin
+        raise subject
+      rescue SparkPostRails::DeliveryException => err
+        expect(error.to_s).to eq(err.message)
+      end
+    end
+  end
+
+  describe 'array with partial details' do
+    let(:error) { [{ 'message' => 'end of world' }] }
+
+    it 'assigns message' do
+      expect(subject.service_message).to eq('end of world')
+    end
+
+    it 'assigns description' do
+      expect(subject.service_description).to be nil
+    end
+
+    it 'assigns code' do
+      expect(subject.service_code).to be nil
+    end
+
+    it 'preserves original message' do
+      begin
+        raise subject
+      rescue SparkPostRails::DeliveryException => err
+        expect(error.to_s).to eq(err.message)
+      end
+    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

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Recipient Data" do
+
+    it "accepts data matching all recipients" do
+      recipients = ['recipient1@email.com', 'recipient2@email.com']
+      recipients_data = [
+        {substitution_data: {name: "Recipient1"}}, 
+        {substitution_data: {name: "Recipient2"}} 
+      ]
+
+      test_email = Mailer.test_email to: recipients, sparkpost_data: {recipients: recipients_data}
+
+      @delivery_method.deliver!(test_email)
+
+      actual_recipients = @delivery_method.data[:recipients]
+      expect(actual_recipients.length).to eq(recipients.length)
+      expect(actual_recipients).to match(recipients.each_with_index.map { |recipient, index| recipients_data[index].merge(address: {email: recipient, header_to: anything}) })
+    end
+
+  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/response_spec.rb

@@ -15,7 +15,8 @@ describe SparkPostRails::DeliveryMethod do
     end
 
     it "raises exception on error" do
-      stub_request(:any, "https://api.sparkpost.com/api/v1/transmissions").
+      uri = URI.join(SparkPostRails.configuration.api_endpoint, 'v1/transmissions')
+      stub_request(:any, uri.to_s).
         to_return(body: "{\"errors\":[{\"message\":\"required field is missing\",\"description\":\"recipients or list_id required\",\"code\":\"1400\"}]}", status: 403)
 
       test_email = Mailer.test_email

data/spec/spec_helper.rb

@@ -6,13 +6,19 @@ 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
-    stub_request(:any, "https://api.sparkpost.com/api/v1/transmissions").
+  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
+    uri = URI.join(SparkPostRails.configuration.api_endpoint, 'v1/transmissions')
+    stub_request(:any, uri.to_s).
       to_return(body: "{\"results\":{\"total_rejected_recipients\":0,\"total_accepted_recipients\":1,\"id\":\"00000000000000000\"}}", status: 200)
   end
 
@@ -23,7 +29,7 @@ class Mailer < ActionMailer::Base
   def test_email options = {}
     data = {
       from: "from@example.com",
-      to: "to@example.com",
+      to: options[:to] || "to@example.com",
       subject: "Test Email",
       text_part: "Hello, Testing!"
     }
@@ -65,14 +71,14 @@ class Mailer < ActionMailer::Base
     if data.has_key?(:html_part)
 
       mail(data) do |format|
-        format.text {render text: data[:text_part]}
-        format.html {render text: data[:html_part]}
+        format.text {render plain: data[:text_part]}
+        format.html {render plain: data[:html_part]}
       end
 
     else
 
       mail(data) do |format|
-        format.text {render text: data[:text_part]}
+        format.text {render plain: data[:text_part]}
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkpost_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.3
 platform: ruby
 authors:
 - Kevin Kimball
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -65,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
@@ -74,14 +81,18 @@ 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
 - spec/from_spec.rb
 - spec/headers_spec.rb
 - 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
 - spec/recipients_spec.rb
 - spec/reply_to_spec.rb
@@ -113,34 +124,37 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: SparkPost for Rails
 test_files:
-- spec/inline_content_spec.rb
+- spec/reply_to_spec.rb
+- spec/open_tracking_spec.rb
+- spec/recipient_specific_data_spec.rb
+- spec/response_spec.rb
+- spec/click_tracking_spec.rb
+- spec/substitution_data_spec.rb
+- spec/spec_helper.rb
 - spec/from_spec.rb
+- spec/ip_pool_spec.rb
+- spec/metadata_spec.rb
 - spec/subaccount_api_spec.rb
+- spec/return_path_spec.rb
+- spec/campaign_id_spec.rb
+- spec/inline_content_spec.rb
+- spec/skip_suppression_spec.rb
 - spec/recipients_spec.rb
+- spec/description_spec.rb
+- spec/inline_css_spec.rb
+- spec/exceptions_spec.rb
+- spec/delivery_schedule_spec.rb
+- spec/attachments_spec.rb
 - spec/headers_spec.rb
-- spec/transactional_spec.rb
 - spec/bcc_recipients_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/response_spec.rb
-- spec/open_tracking_spec.rb
+- spec/transactional_spec.rb
+- spec/cc_recipients_spec.rb
 - spec/sandbox_mode_spec.rb
-- spec/return_path_spec.rb
-- spec/delivery_schedule_spec.rb
+- spec/template_spec.rb
+- spec/configuration_spec.rb