sparkpost_rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 368eabc1112630441a50e7b6c9b2024905900755
+  data.tar.gz: ed9358eb97aa57d35579b23825d537570b1563de
+SHA512:
+  metadata.gz: 032d4a48dfd4946223695f197872e1abd4e111f85431017a443bbb620352a1f369a9296dfa9b0bc42047587ff474818326e67988ef776fda170ea8080b18f8c4
+  data.tar.gz: ef0a2aaa4f7ab3fdf4a8962195658c0265886ef7c682e2a6f29f5a517695ef29ee480e65868080d831822ec816d179fa17f59e52d4a6837c332067ac5d24d50b

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kevin Kimball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,76 @@
+[![Gem Version](https://badge.fury.io/rb/sparkpost_rails.svg)](https://badge.fury.io/rb/sparkpost_rails)
+[![Build Status](https://travis-ci.org/the-refinery/sparkpost_rails.svg?branch=master)](https://travis-ci.org/the-refinery/sparkpost_rails)
+
+# SparkPost Rails
+
+In `Gemfile` add
+
+```
+gem 'sparkpost_rails'
+```
+
+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`):
+
+```
+SparkPostRails.configure do |c|
+  c.api_key = 'YOUR API KEY'
+end
+```
+
+Additionally, the following configuration options are available to be set in your initializer 
+( `config/initializers/sparkpost_rails.rb`):
+
+```
+SparkPostRails.configure do |c|
+  c.track_opens = true
+  c.track_clicks = true
+  c.return_path = 'BOUNCE-EMAIL@YOUR-DOMAIN.COM'
+  c.campaign_id = 'YOUR-CAMPAIGN'
+end
+```
+
+The default values for these optional configuration settings are:
+
+```
+track_opens = false
+track_clicks = false
+return_path = nil
+campaign_id = nil
+```
+
+In `config/environments/production.rb` add
+
+```
+config.action_mailer.delivery_method = :sparkpost
+```
+
+The deliver! method returns the response data from the SparkPost API call as a hash:
+
+```
+response = UserMailer.welcome_email(user).deliver_now!
+```
+
+Example:
+
+```
+{"total_rejected_recipients"=>0, "total_accepted_recipients"=>1, "id"=>"00000000000000"}
+```
+
+# 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/delivery_method.rb

@@ -0,0 +1,126 @@
+module SparkPostRails
+  class DeliveryMethod
+    require 'net/http'
+
+    attr_accessor :settings, :data, :response
+
+    def initialize(options = {})
+      @settings = options
+    end
+
+    def deliver!(mail)
+      @data = {content: {}}
+
+      prepare_recipients_from mail
+      prepare_from_address_from mail
+      prepare_reply_to_address_from mail
+
+      prepare_subject_from mail
+      prepare_content_from mail
+
+      prepare_options
+      prepare_headers
+
+      result = post_to_api
+
+      process_result result
+    end
+
+  private
+    def prepare_recipients_from mail
+      @data[:recipients] = prepare_addresses(mail.to, mail[:to].display_names)
+    end
+
+    def prepare_addresses emails, names
+      emails = [emails] unless emails.is_a?(Array)
+      emails.each_with_index.map {|email, index| prepare_address(email, index, names) }
+    end
+
+    def prepare_address email, index, names
+      if !names[index].nil?
+        { address:  { email: email, name: names[index] } }
+      else
+        { address: { email: email } }
+      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 }
+      else
+        from = { email: mail.from.first }
+      end
+
+      @data[:content][:from] = from
+    end
+
+    def prepare_reply_to_address_from mail
+      unless mail.reply_to.nil?
+        @data[:content][:reply_to] = mail.reply_to.first
+      end
+    end
+
+    def prepare_subject_from mail
+      @data[:content][:subject] = mail.subject
+    end
+
+    def prepare_content_from mail
+      if mail.multipart?
+        @data[:content][:html] = cleanse_encoding(mail.html_part.body.to_s)
+        @data[:content][:text] = cleanse_encoding(mail.text_part.body.to_s)
+      else
+        @data[:content][:text] = cleanse_encoding(mail.body.to_s)
+      end
+    end
+
+    def cleanse_encoding content
+      ::JSON.parse({c: content}.to_json)["c"]
+    end
+
+    def prepare_options
+      @data[:options] = {
+        :open_tracking => SparkPostRails.configuration.track_opens,
+        :click_tracking => SparkPostRails.configuration.track_clicks
+      }
+
+      unless SparkPostRails.configuration.campaign_id.nil?
+        @data[:campaign_id] = SparkPostRails.configuration.campaign_id
+      end
+
+      unless SparkPostRails.configuration.return_path.nil?
+        @data[:return_path] = SparkPostRails.configuration.return_path
+      end
+    end
+
+    def prepare_headers
+      @headers = {
+        "Authorization" => SparkPostRails.configuration.api_key,
+        "Content-Type"  => "application/json"
+      }
+    end
+
+    def post_to_api
+      url = "https://api.sparkpost.com/api/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
+
+    def process_result result
+      result_data = JSON.parse(result.body)
+
+      if result_data["errors"]
+        @response = result_data["errors"]
+        raise SparkPostRails::DeliveryException, @response
+      else
+        @response = result_data["results"]
+      end
+    end
+  end
+end

data/lib/sparkpost_rails/exceptions.rb

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

data/lib/sparkpost_rails/railtie.rb

@@ -0,0 +1,9 @@
+module SparkPostRails
+  class Railtie < Rails::Railtie
+    initializer "sparkpost_rails.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :sparkpost, SparkPostRails::DeliveryMethod, return_response: true
+      end
+    end
+  end
+end

data/lib/sparkpost_rails/version.rb

@@ -0,0 +1,4 @@
+module SparkPostRails
+  VERSION = "1.0.1"
+end
+

data/lib/sparkpost_rails.rb

@@ -0,0 +1,35 @@
+require "sparkpost_rails/delivery_method"
+require "sparkpost_rails/exceptions"
+require "sparkpost_rails/railtie"
+
+module SparkPostRails
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :track_opens
+    attr_accessor :track_clicks
+    attr_accessor :campaign_id
+    attr_accessor :return_path
+
+    def initialize
+      if ENV.has_key?("SPARKPOST_API_KEY")
+        @api_key = ENV["SPARKPOST_API_KEY"]
+      else
+        @api_key = ""
+      end
+
+      @track_opens = false
+      @track_clicks = false
+      @campaign_id = nil
+      @return_path = nil
+    end
+  end
+end

data/spec/content_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Content" do
+    it "sets the subject" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:subject]).to eq("Test Email")
+    end
+
+    it "handles single part content" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:text]).to eq("Hello, Testing!")
+      expect(@delivery_method.data[:content].has_key?(:html)).to eq(false)
+    end
+
+    it "handles multi-part content" do
+      test_email = Mailer.test_email html_part: "<h1>Hello, Testing!</h1>"
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:text]).to eq("Hello, Testing!")
+      expect(@delivery_method.data[:content][:html]).to eq("<h1>Hello, Testing!</h1>")
+    end
+  end
+end
+

data/spec/from_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "From" do
+    it "handles email only" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:from]).to eq({email: "from@example.com"})
+    end
+
+    it "handles name and email" do
+      test_email = Mailer.test_email from: "Joe Test <from@example.com>"
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:from]).to eq({:email=>"from@example.com", :name=>"Joe Test"})
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Options" do
+
+    it "handles track_opens option" do
+      SparkPostRails.configure do |c|
+        c.track_opens = true
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:open_tracking]).to eq(true)
+    end 
+
+    it "handles track_clicks option" do
+      SparkPostRails.configure do |c|
+        c.track_clicks = true
+      end
+      
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:click_tracking]).to eq(true)
+    end
+
+    it "does not contain unset campaign_id" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:campaign_id)).to eq(false)
+    end
+
+    it "contains supplied campaign_id" do
+      SparkPostRails.configure do |c|
+        c.campaign_id = "ABCD1234"
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:campaign_id]).to eq("ABCD1234")
+    end
+
+    it "does not contain unset return_path" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:return_path)).to eq(false)
+    end
+
+    it "contains supplied return_path" do
+      SparkPostRails.configure do |c|
+        c.return_path = "BOUNCE-EMAIL@EXAMPLE.COM"
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:return_path]).to eq('BOUNCE-EMAIL@EXAMPLE.COM')
+    end
+  end
+end

data/spec/recipients_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Recipients" do
+
+    context "single recipient" do
+      it "handles email only" do
+        test_email = Mailer.test_email
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}])
+      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"}}])
+      end
+    end
+
+    context "multiple recipients" do
+      it "handles email only" 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"}}])
+      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"}}])
+      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"}}])
+      end
+    end
+  end
+end

data/spec/reply_to_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Reply To" do
+    it "handles supplied value" do
+      test_email = Mailer.test_email reply_to: "reply_to@example.com"
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content][:reply_to]).to eq("reply_to@example.com")
+    end
+
+    it "handles no value supplied" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content].has_key?(:reply_to)).to eq(false)
+    end
+  end
+end
+

data/spec/response_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "API Response Handling" do
+    it "returns result data on success" do
+      test_email = Mailer.test_email
+      response = @delivery_method.deliver!(test_email)
+
+      expect(response).to eq({"total_rejected_recipients"=>0, "total_accepted_recipients"=>1, "id"=>"00000000000000000"})
+    end
+
+    it "raises exception on error" do
+      stub_request(:any, "https://api.sparkpost.com/api/v1/transmissions").
+        to_return(body: "{\"errors\":[{\"message\":\"required field is missing\",\"description\":\"recipients or list_id required\",\"code\":\"1400\"}]}", status: 403)
+
+      test_email = Mailer.test_email
+
+      expect {@delivery_method.deliver!(test_email)}.to raise_exception(SparkPostRails::DeliveryException)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'webmock/rspec'
+require 'rails'
+require 'action_mailer'
+require "sparkpost_rails"
+
+RSpec.configure do |config|
+
+  config.before(:all) do
+    SparkPostRails.configure do |c|
+      c.api_key = "TESTKEY1234"
+    end
+  end
+
+  config.before(:each) do
+    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
+
+end
+
+#A default mailer to generate the mail object
+class Mailer < ActionMailer::Base
+  def test_email options = {}
+    data = {
+      from: "from@example.com",
+      to: "to@example.com",
+      subject: "Test Email",
+      text_part: "Hello, Testing!"
+    }
+
+    data.merge! options
+
+    if data.has_key?(:html_part)
+
+      mail(data) do |format|
+        format.text {render text: data[:text_part]}
+        format.html {render text: data[:html_part]}
+      end
+
+    else
+
+      mail(data) do |format|
+        format.text {render text: data[:text_part]}
+      end
+
+    end
+
+
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: sparkpost_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Kevin Kimball
+- Dave Goerlich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-01 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.2
+description: Delivery Method for Rails ActionMailer to send emails using the SparkPost
+  API
+email:
+- kwkimball@gmail.com
+- dave.goerlich@the-refinery.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sparkpost_rails.rb
+- lib/sparkpost_rails/delivery_method.rb
+- lib/sparkpost_rails/exceptions.rb
+- lib/sparkpost_rails/railtie.rb
+- lib/sparkpost_rails/version.rb
+- spec/content_spec.rb
+- spec/from_spec.rb
+- spec/options_spec.rb
+- spec/recipients_spec.rb
+- spec/reply_to_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/the-refinery/sparkpost_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: SparkPost for Rails
+test_files:
+- spec/spec_helper.rb
+- spec/recipients_spec.rb
+- spec/content_spec.rb
+- spec/options_spec.rb
+- spec/response_spec.rb
+- spec/from_spec.rb
+- spec/reply_to_spec.rb