sparkpost_rails5 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '096f85ad1ce7d3ac1416becabde60f53e41a92f8'
+  data.tar.gz: b60b66f21836678e80a7ac65880ff0432e881ebe
+SHA512:
+  metadata.gz: ca16f1e8e67e0b00ada0d5f862857011b100a14c2b4bffff27c65d066dbc351b4c16c81cd182dd6a60283c0a4a4512a75b81188fc55ca7f82fa6cdf6c1483fc0
+  data.tar.gz: e127708c6031b9040a65a4098e860bd748e898bb0e404f324575f39a980160d2f57d22ec8bc6742e70abb87c02bd81fadd53491df0d59e18fcc6256c6d757fee

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sparkpost_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,65 @@
+# Sparkpost-Rails
+
+Simple ActionMailer provider for sending mail through Sparkpost API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sparkpost_rails5'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sparkpost_rails5
+
+## Usage
+
+Add this to corresponding environment configuration file (`config/environments/*.rb`):
+```ruby
+config.action_mailer.delivery_method = :sparkpost_rails
+```
+
+And make sure `ENV['SPARKPOST_API_KEY']` is set.
+
+You can also provide custom options through `sparkpost_payload` method. The value will be merged with request payload:
+```ruby
+class UserMailer < ApplicationMailer
+
+  def confirmation_email(email)
+    sparkpost_payload(
+      options: {
+        open_tracking: true
+      },
+      campaign_id: "Your campaign ID"
+      description: "Confirmation email",
+      content: {
+        headers: {
+          "X-Custom-Header" => "custom header value"
+        }
+      }
+    )
+    mail(to: email, subject: "Confirm Your Account!!!")
+  end
+
+end
+```
+See [https://developers.sparkpost.com/api/transmissions.html#transmissions-create](https://developers.sparkpost.com/api/transmissions.html#transmissions-create)
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/muhlisbc/sparkpost_rails5. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sparkpost_rails/custom_payload.rb

@@ -0,0 +1,17 @@
+module Mail
+  class Message
+
+    attr_accessor :sparkpost_payload
+
+  end
+end
+
+module ActionMailer
+  class Base
+
+    def sparkpost_payload(payload)
+      message.sparkpost_payload = payload
+    end
+
+  end
+end

data/lib/sparkpost_rails/mailer.rb

@@ -0,0 +1,84 @@
+require "base64"
+require "action_mailer"
+require "simple_spark"
+
+module SparkpostRails
+
+  # SparkpostRails::Mailer is an ActionMailer provider for sending mail through Sparkpost.
+  class Mailer
+
+    def initialize(config={})
+      @sp_client = SimpleSpark::Client.new(config)
+    end
+
+    def deliver!(mail)
+      properties  = SparkpostRails.transform_mail(mail)
+      response    = @sp_client.transmissions.create(properties)
+      mail.message_id = response["id"]
+      response
+    end
+  end
+
+  module_function
+
+  # Transform Mail::Message object to Hash that will be send as request payload
+  #
+  # @param [Mail::Message] mail
+  #
+  # @return [Hash]
+  def transform_mail(mail)
+    content   = {}
+    sp_object = {}
+
+    sp_object[:recipients]  = mail[:to].address_list.addresses.map { |recipient| {address: fetch_email_and_name(recipient)} } if mail.to
+    sp_object[:return_path] = mail[:return_path].address_list.addresses[0].raw if mail.return_path
+    content[:from]          = fetch_email_and_name(mail[:from].address_list.addresses[0]) if mail.from && mail.from[0]
+    content[:subject]       = mail.subject if mail.subject
+    content[:reply_to]      = mail[:reply_to].address_list.addresses[0].raw if mail.reply_to && mail.reply_to[0]
+    content[:attachments]   = transform_attachments(mail.attachments) if !mail.attachments.empty?
+
+    ["html", "text"].each do |part|
+      mail_part = mail.send("#{part}_part")
+      content[part] = mail_part.decoded if mail_part
+    end
+
+    [:cc, :bcc].each do |rcpt_type|
+      content[:headers] ||= {}
+      rcpt_type_val = mail.send(rcpt_type)
+      content[:headers][rcpt_type] = mail.send(rcpt_type).join(",") if rcpt_type_val
+    end
+
+    sp_object[:content] = content
+    sp_object.deep_merge!(mail.sparkpost_payload) if mail.sparkpost_payload
+    sp_object
+  end
+
+  # Transform array of Mail::Attachment object to array of Hash with base64 encoded
+  # attachment content
+  #
+  # @param [Array<Mail::Attachment>] attachments
+  #
+  # @return [Array<Hash>]
+  def transform_attachments(attachments)
+    attachments.map do |attachment|
+      {
+        name: attachment.filename,
+        type: attachment.content_type,
+        data: Base64.encode64(attachment.decoded)
+      }
+    end
+  end
+
+  # Fetch email address and name from Mail::Address object.
+  #
+  # @param [Mail::Address] address
+  #
+  # @return [Hash]
+  def fetch_email_and_name(address)
+    hash = {}
+    hash[:email] = address.address if address.address
+    hash[:name]  = address.name if address.name
+    hash
+  end
+
+end

data/lib/sparkpost_rails/railtie.rb

@@ -0,0 +1,10 @@
+require "rails"
+require "sparkpost_rails/mailer"
+
+module SparkpostRails
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      ActionMailer::Base.add_delivery_method :sparkpost_rails, SparkpostRails::Mailer
+    end
+  end
+end

data/lib/sparkpost_rails/version.rb

@@ -0,0 +1,3 @@
+module SparkpostRails
+  VERSION = "0.1.0"
+end

data/lib/sparkpost_rails.rb

@@ -0,0 +1,4 @@
+require "sparkpost_rails/version"
+require "sparkpost_rails/railtie"
+require "sparkpost_rails/mailer"
+require "sparkpost_rails/custom_payload"

data/sparkpost_rails5.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sparkpost_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sparkpost_rails5"
+  spec.version       = SparkpostRails::VERSION
+  spec.authors       = ["Muhlis BC"]
+  spec.email         = ["muhlisbc@gmail.com"]
+
+  spec.summary       = "ActionMailer provider for sending mail through Sparkpost API."
+  spec.description   = "Send mail through Sparkpost API from Rails 5 app."
+  spec.homepage      = "https://github.com/muhlisbc/sparkpost_rails5"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|bin)/})
+  end
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "rails", "~> 5.0"
+  spec.add_dependency "simple_spark", "~> 1.0.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: sparkpost_rails5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhlis BC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simple_spark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Send mail through Sparkpost API from Rails 5 app.
+email:
+- muhlisbc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sparkpost_rails.rb
+- lib/sparkpost_rails/custom_payload.rb
+- lib/sparkpost_rails/mailer.rb
+- lib/sparkpost_rails/railtie.rb
+- lib/sparkpost_rails/version.rb
+- sparkpost_rails5.gemspec
+homepage: https://github.com/muhlisbc/sparkpost_rails5
+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.5.2
+signing_key: 
+specification_version: 4
+summary: ActionMailer provider for sending mail through Sparkpost API.
+test_files: []