sparkpost_rails 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 925047803a24a8f98ba5f888f81c4a1ad472f9fc
-  data.tar.gz: 171842fb600f86f2e65143102ccdba962ac80d17
+  metadata.gz: 1824c8a4ed0368d9063eadf820ff0e53b8469af7
+  data.tar.gz: b7ba7d9806925dfcc2e6f859a484a85cd43e24f2
 SHA512:
-  metadata.gz: a783aaf00991597cc6f3b5558db1b43f285e9196cc9cebf22e21f87ba54c5b5cc7cfcc20158cfa1ef9309c70f9ff2da7e6f0fb30f1a6f6f1ae0606bcfa8187ea
-  data.tar.gz: 6ef6d2888ebf9d6b1864ab77df43aaae54d59abd28ab173621b173b9e3d52877931f6415b27efbda4b9454b730026b1b6804e0f665d9543a084f65caa6ee0d54
+  metadata.gz: de4ea6d3e24d6414ec768867816d1ddb3f17a4dbe01994b05fa5ba43a3d53663ca315b5202c0d8d0b918c3d1b0f6b12b86738536f62049f12c2fcd813a0ca8e6
+  data.tar.gz: c4431d3186b89221cc0f8270a04b7c698f31a1594d1de39bb8cf3068a2b4f6e999369b22c3244714fc28f2e51359f45d63adbb84a89a8638b73fe210efc3ef51

data/README.md

@@ -89,6 +89,17 @@ 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.
 
+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`
+
+```
+ActionMailer::DeliveryJob.rescue_from(SparkPostRails::DeliveryException) do |exception|
+  # do something special with the error
+end
+```
 
 SparkPost Specific Features
 ---------------------------
@@ -196,14 +207,31 @@ 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).
+
+```
+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
 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:
+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:
 
 ```
 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 

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
@@ -95,6 +96,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]
 

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/version.rb

@@ -1,4 +1,4 @@
 module SparkPostRails
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 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/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 eq(recipients.each_with_index.map { |recipient, index| recipients_data[index].merge(address: {email: recipient}) })
+    end
+
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -23,7 +23,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!"
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkpost_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 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: 2016-05-17 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: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -76,12 +82,14 @@ files:
 - spec/click_tracking_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/open_tracking_spec.rb
+- spec/recipient_specific_data_spec.rb
 - spec/recipients_list_spec.rb
 - spec/recipients_spec.rb
 - spec/reply_to_spec.rb
@@ -126,6 +134,7 @@ test_files:
 - 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
@@ -142,5 +151,6 @@ test_files:
 - spec/response_spec.rb
 - spec/open_tracking_spec.rb
 - spec/sandbox_mode_spec.rb
+- spec/recipient_specific_data_spec.rb
 - spec/return_path_spec.rb
 - spec/delivery_schedule_spec.rb