sparkpost_rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81fd8507b990b04184b483dd003722b8ca08289f
-  data.tar.gz: 8b1007d2d0ddd41f8391215e873675d9bc58fc55
+  metadata.gz: 925047803a24a8f98ba5f888f81c4a1ad472f9fc
+  data.tar.gz: 171842fb600f86f2e65143102ccdba962ac80d17
 SHA512:
-  metadata.gz: 5fcc12025be8147f289b17ff1dcb56ea568c2018ab3cb98499e77fea53241ca41b077c1bbcbcdb01b7e4bf8fa22169e8731ff9160fa08ad51a993c6a85035181
-  data.tar.gz: c2521eca5c10a02e8d313882653ebfdfb7c4423d5f117d054c29bc5d2f3af6f912be938b45714266267fe29d5bc575eeede28035216cbc678406c1e1934701c3
+  metadata.gz: a783aaf00991597cc6f3b5558db1b43f285e9196cc9cebf22e21f87ba54c5b5cc7cfcc20158cfa1ef9309c70f9ff2da7e6f0fb30f1a6f6f1ae0606bcfa8187ea
+  data.tar.gz: 6ef6d2888ebf9d6b1864ab77df43aaae54d59abd28ab173621b173b9e3d52877931f6415b27efbda4b9454b730026b1b6804e0f665d9543a084f65caa6ee0d54

data/README.md

@@ -47,6 +47,9 @@ SparkPostRails.configure do |c|
   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"
 end
 ```
 
@@ -60,6 +63,9 @@ return_path = nil
 campaign_id = nil
 transactional = false
 ip_pool = nil
+inline_css = false
+html_content_only = false
+subaccount = nil
 ```
 
 Usage
@@ -97,7 +103,8 @@ data = { track_opens: true,
          campaign_id: "My Campaign",
          transactional: true,
          ip_pool = "SPECIAL_POOL",
-         subaccount_api_key = "SUBACCOUNT_API_KEY"
+         api_key = "MESSAGE_SPECIFIC_API_KEY"
+         subaccount = "123"
        }
 
 mail(to: to_email, subject: "Test", body: "test", sparkpost_data: data)
@@ -137,6 +144,32 @@ 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.
+
+```
+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.
+
+```
+data = { api_key: "SUBACCOUNT_API_KEY" }
+
+mail(subject: "Test", body: "test", sparkpost_data: data)
+```
+
+Subaccounts can also be leveraged using the subaccount ID with the master API key.
+
+```
+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:
 
@@ -156,7 +189,7 @@ to your sparkpost_data hash, with the key :substitution_data.
 
 ```
 sub_data = {first_name: "Sam",
-            last_name: "Test"}
+            last_name: "Test}
 
 data = { substitution_data: sub_data }
 
@@ -187,21 +220,3 @@ headers["Sensitivity"] = "private"
 
 mail(to: to_email, subject: "Test", body: "test")
 ```
-
-Update Note!
-============
-
-If you have been using Version 0.0.5 or earlier of this gem, when you upgrade, you'll need to 
-change your initalizer as follows:
-
-```
-SparkpostRails.configure do |c|
-```
-
-becomes: 
-
-```
-SparkPostRails.configure do |c|
-```
-
-We have changed the module name to align with the official SparkPost gem's naming convention.

data/lib/sparkpost_rails.rb

@@ -24,6 +24,8 @@ module SparkPostRails
 
     attr_accessor :transactional
     attr_accessor :ip_pool
+    attr_accessor :inline_css
+    attr_accessor :html_content_only
 
     attr_accessor :subaccount
 
@@ -48,6 +50,8 @@ module SparkPostRails
 
       @transactional = false
       @ip_pool = nil
+      @inline_css = false
+      @html_content_only = false
 
       @subaccount = nil
     end

data/lib/sparkpost_rails/delivery_method.rb

@@ -23,7 +23,7 @@ module SparkPostRails
 
         prepare_subject_from mail
         prepare_cc_headers_from mail, sparkpost_data
-        prepare_inline_content_from mail
+        prepare_inline_content_from mail, sparkpost_data
         prepare_attachments_from mail
       end
 
@@ -139,8 +139,7 @@ module SparkPostRails
       end
     end
 
-
-    def prepare_inline_content_from mail
+    def prepare_inline_content_from mail, sparkpost_data
       if mail.multipart?
         if mail.html_part
           @data[:content][:html] = cleanse_encoding(mail.html_part.body.to_s)
@@ -150,7 +149,11 @@ module SparkPostRails
           @data[:content][:text] = cleanse_encoding(mail.text_part.body.to_s)
         end
       else
-        @data[:content][:text] = cleanse_encoding(mail.body.to_s)
+        if SparkPostRails.configuration.html_content_only || sparkpost_data[:html_content_only]
+          @data[:content][:html] = cleanse_encoding(mail.body.to_s)
+        else
+          @data[:content][:text] = cleanse_encoding(mail.body.to_s)
+        end
       end
     end
 
@@ -196,6 +199,7 @@ module SparkPostRails
       prepare_transactional_from sparkpost_data
       prepare_skip_suppression_from sparkpost_data
       prepare_ip_pool_from sparkpost_data
+      prepare_inline_css_from sparkpost_data
       prepare_delivery_schedule_from mail
     end
 
@@ -286,6 +290,14 @@ module SparkPostRails
       end
     end
 
+    def prepare_inline_css_from sparkpost_data
+      @data[:options][:inline_css] = SparkPostRails.configuration.inline_css
+
+      if sparkpost_data.has_key?(:inline_css)
+        @data[:options][:inline_css] = sparkpost_data[:inline_css]
+      end
+    end
+
     def prepare_delivery_schedule_from mail
       # Format YYYY-MM-DDTHH:MM:SS+-HH:MM or "now". Example: '2015-02-11T08:00:00-04:00'. -From SparkPost API Docs
       if mail.date && (mail.date > DateTime.now) && (mail.date < (DateTime.now + 1.year))

data/lib/sparkpost_rails/exceptions.rb

@@ -1,4 +1,4 @@
 module SparkPostRails
-  class DeliveryException < Exception
+  class DeliveryException < StandardError
   end
 end

data/lib/sparkpost_rails/version.rb

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

data/spec/inline_content_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe SparkPostRails::DeliveryMethod do
 
   before(:each) do
+    SparkPostRails.configuration.set_defaults
     @delivery_method = SparkPostRails::DeliveryMethod.new
   end
 
@@ -30,6 +31,26 @@ describe SparkPostRails::DeliveryMethod do
       expect(@delivery_method.data[:content][:html]).to eq("<h1>Hello, Testing!</h1>")
     end
 
+    it "supports HTML-only content as a configuration setting" do
+      SparkPostRails.configure do |c|
+        c.html_content_only = true
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content].has_key?(:text)).to eq(false)
+      expect(@delivery_method.data[:content][:html]).to eq("Hello, Testing!")
+    end
+
+    it "supports HTML-only content as an option on an individual transmission" do
+      test_email = Mailer.test_email sparkpost_data: {html_content_only: true}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content].has_key?(:text)).to eq(false)
+      expect(@delivery_method.data[:content][:html]).to eq("Hello, Testing!")
+    end
+
     it "should not include template details" do
       test_email = Mailer.test_email
       @delivery_method.deliver!(test_email)

data/spec/inline_css_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sparkpost_rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kevin Kimball
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,6 +79,7 @@ files:
 - 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/recipients_list_spec.rb
@@ -118,27 +119,28 @@ signing_key:
 specification_version: 4
 summary: SparkPost for Rails
 test_files:
-- spec/cc_recipients_spec.rb
-- spec/subaccount_api_spec.rb
-- spec/ip_pool_spec.rb
 - spec/inline_content_spec.rb
-- spec/return_path_spec.rb
-- spec/transactional_spec.rb
-- spec/recipients_list_spec.rb
-- spec/campaign_id_spec.rb
-- spec/description_spec.rb
-- spec/response_spec.rb
-- spec/bcc_recipients_spec.rb
-- spec/sandbox_mode_spec.rb
 - spec/from_spec.rb
+- spec/subaccount_api_spec.rb
 - spec/recipients_spec.rb
-- spec/delivery_schedule_spec.rb
 - spec/headers_spec.rb
-- spec/spec_helper.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/open_tracking_spec.rb
+- spec/campaign_id_spec.rb
 - spec/reply_to_spec.rb
-- spec/attachments_spec.rb
+- spec/spec_helper.rb
+- spec/description_spec.rb
 - spec/click_tracking_spec.rb
-- spec/substitution_data_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/sandbox_mode_spec.rb
+- spec/return_path_spec.rb
+- spec/delivery_schedule_spec.rb