sg_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2db0fcf74a3885da0b577a1bff7812ad788d4d3
+  data.tar.gz: ad525cef3c2fd30edbfc1c94f526258beb8b671b
+SHA512:
+  metadata.gz: b819209e28731ad1a3105cd3d64e117fb7404cb936365fd96a74f932e0b44250df9f43cbf5182e503ad8fcc4e0941b01515f32f177caf00ef95a077f30d7dcdb
+  data.tar.gz: 04a1a72c3b1b053009185e736795668eb461abbccde6404b0901569d8260ea967dcdec2fc60eb881c5957315c59f7de341363fc6502e34a1e0cdf26ca14f0d01

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gsamokovarov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Genadi Samokovarov
+
+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,162 @@
+# SGMailer
+
+SG Mailer is a mailing framework with similar to Action Mailer interface for SendGrid
+transactional emails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sg_mailer'
+```
+
+## Usage
+
+To start using the framework, you need to configure it first. It requires a
+SendGrid API KEY, which you can setup like this:
+
+```ruby
+SGMailer.configure(api_key: ENV['SENDGRID_API_KEY')
+```
+
+Once setup, you can use SG Mailer alongside or as a replacement to Action
+Mailer. Creating a base mailer (a class like `ApplicationMailer`) is a good
+starting point.
+
+```ruby
+# app/mailers/sendgrid_mailer.rb
+
+class SendGridMailer < SGMailer::Base
+  # you may wanna include helper modules here, as they are not automgically
+  # included like in action mailer.
+end
+```
+
+Having the base mailer around, you may start introducing specific ones.
+
+```ruby
+class SubscriptionMailer < SendGridMailer
+  def successful_subscription_mail(parent, kid)
+    template_id = 'd6c0eb74-b280-4d25-a835-479818a450e8'
+
+    substitutions = {
+      'KIDNAME' => kid.name
+      'PARENTTYPE' => parent.gender
+    }
+
+    mail from: 'charlie@bp.com', to: parent.email,
+         template_id: template_id, substitutions : substitutions
+  end
+end
+```
+
+Working with transaction emails, you are quite likely to use templates for
+them. Since this is so common, there is nice interface for annotating the
+emails with the template id.
+
+```ruby
+class SubscriptionMailer < SendGridMailer
+  template_id 'd6c0eb74-b280-4d25-a835-479818a450e8'
+  def successful_subscription_mail(parent, kid)
+    substitutions = {
+      'KIDNAME' => kid.name
+      'PARENTTYPE' => parent.gender
+    }
+
+    mail from: 'charlie@bp.com', to: parent.email,
+         substitutions : substitutions
+  end
+end
+```
+
+You can also extract the common sender into a default value like so:
+
+```ruby
+class SubscriptionMailer < SendGridMailer
+  default from: { name: 'Charlie Brown', email: 'charlie@bp.com' }
+
+  template_id 'd6c0eb74-b280-4d25-a835-479818a450e8'
+  def successful_subscription_mail(parent, kid)
+    substitutions = {
+      'KIDNAME' => kid.name
+      'PARENTTYPE' => parent.gender
+    }
+
+    mail to: parent.email, substitutions : substitutions
+  end
+end
+```
+
+In fact the base mailer (`SendGridMailer`) is a good place to define such
+defaults.
+
+```ruby
+# app/mailers/sendgrid_mailer.rb
+
+class SendGridMailer < SGMailer::Base
+  default from: { name: 'Charlie Brown', email: 'charlie@bp.com' }
+end
+```
+
+We were able to clean a lot of cruft from the mailers above, however, can we do
+something about the substitutions. They do seem to have noisy API. Let's think
+about Ruby instance variables. The Rails controller to view integration uses
+them as an API and it works pretty well.
+
+
+```ruby
+# app/mailers/sendgrid_mailer.rb
+
+class SendGridMailer < SGMailer::Base
+  default from: { name: 'Charlie Brown', email: 'charlie@bp.com' }
+
+  private
+
+  # This is the hook that processes the options given to `SGMailer::Base#mail`.
+  # Don't forget to call super and return a Hash in here.
+  def normalize_options(options)
+    automatic_substitutions = instance_values.transform_keys do |key|
+      "#{key.to_s.remove('_').upcase}"
+    end
+
+    super.deep_merge(substitutions: automatic_substitutions)
+  end
+end
+```
+
+With the code above the mails can look pretty tidy.
+
+```ruby
+class SubscriptionMailer < SendGridMailer
+  template_id 'd6c0eb74-b280-4d25-a835-479818a450e8'
+  def successful_subscription_mail(parent, kid)
+    @kid_name = kid.name
+    @parent_type = parent.gender
+
+    mail to: parent.email
+  end
+end
+```
+
+We don't conventionalize the substitutions, because their format varies from
+team to team. When you settle on one, you can easily turn your instance
+variables into proper substitutions, should you want to.
+
+Until now, we only defined mails, but how to send them?
+
+```ruby
+# To deliver the mail now.
+SubscriptionMailer.successful_subscription_mail.deliver_now
+
+# To deliver the mail later on, with ActionJob, if installed.
+SubscriptionMailer.successful_subscription_mail.deliver_later
+```
+
+The interface should be pretty familiar to you, if you have used Action Mailer
+before.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sg_mailer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sg_mailer.rb

@@ -0,0 +1,35 @@
+require 'sg_mailer/configuration_error'
+require 'sg_mailer/response_error'
+require 'sg_mailer/mail_builder'
+require 'sg_mailer/client'
+require 'sg_mailer/test_client'
+require 'sg_mailer/base'
+
+module SGMailer extend self
+  attr_accessor :client
+  attr_accessor :delivery_processor
+
+  def configure(delivery_processor: default_delivery_processor,
+                test_client: false, **client_options)
+    self.client = test_client ? TestClient.new : Client.new(**client_options)
+    self.delivery_processor = delivery_processor
+  end
+
+  def send(mail)
+    raise ConfigurationError if client.nil?
+
+    client.send(mail)
+  end
+
+  private
+
+  def default_delivery_processor
+    if defined?(::ActiveJob)
+      require 'sg_mailer/delayed_delivery_processor'
+      DelayedDeliveryProcessor
+    else
+      require 'sg_mailer/immediate_delivery_processor'
+      ImmediateDeliveryProcessor
+    end
+  end
+end

data/lib/sg_mailer/base.rb

@@ -0,0 +1,84 @@
+module SGMailer
+  class Base
+    class << self
+      def default(values = nil)
+        @default ||= {}
+        @default.merge!(values) if values
+        @default
+      end
+
+      def template_id(id)
+        @current_template_id = id
+      end
+
+      def template_ids
+        @template_ids ||= {}
+      end
+
+      private
+
+      def instance
+        @instance ||= new
+      end
+
+      def inherited(klass)
+        klass.instance_variable_set(:@default, default.dup)
+      end
+
+      def method_missing(name, *args, &block)
+        if public_instance_methods.include?(name)
+          SGMailer.delivery_processor.new \
+            instance.public_send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def method_added(method_name)
+        if @current_template_id
+          template_ids[method_name.to_s] = @current_template_id
+        end
+
+        @current_template_id = nil
+      end
+    end
+
+    private
+
+    def mail(**options)
+      # Guess the template id here, so we don't have to account for extra
+      # calls.
+      guessed_template_id =
+        self.class.template_ids[caller_locations.first.base_label]
+
+      normalized = normalize_options({
+        template_id: guessed_template_id
+      }.merge(options))
+
+      MailBuilder.build(normalized)
+    end
+
+    def normalize_options(options)
+      deep_merge(self.class.default, options)
+    end
+
+    # Based on the Active Support Hash#deep_merge! core extension. Inlined
+    # here, so we don't need to explicitly depend on Active Support.
+    def deep_merge(hash, other_hash)
+      merged = hash.dup
+
+      other_hash.each_pair do |current_key, other_value|
+	this_value = merged[current_key]
+
+	merged[current_key] =
+	  if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+	    deep_merge(this_value, other_value)
+	  else
+	    other_value
+	  end
+      end
+
+      merged
+    end
+  end
+end

data/lib/sg_mailer/client.rb

@@ -0,0 +1,42 @@
+require 'json'
+require 'net/http'
+
+module SGMailer
+  class Client
+    attr_reader :api_key
+
+    def initialize(api_key:, api_url: nil)
+      @api_key = api_key
+      @api_url ||= 'https://api.sendgrid.com/v3/mail/send'
+      @api_uri = URI(@api_url)
+    end
+
+    def send(mail)
+      response =
+        Net::HTTP.start(*http_options) do |http|
+          http.request(request(mail.to_json))
+        end
+
+      raise ResponseError, response if response.code.to_i > 299
+
+      response
+    end
+
+    private
+
+    def http_options
+      [@api_uri.host, @api_uri.port, use_ssl: @api_uri.scheme == 'https']
+    end
+
+    def request(body)
+      request = Net::HTTP::Post.new(@api_uri, request_headers)
+      request.body = body
+      request
+    end
+
+    def request_headers
+      { 'Authorization' => "Bearer #{@api_key}",
+        'Content-Type' => 'application/json' }
+    end
+  end
+end

data/lib/sg_mailer/configuration_error.rb

@@ -0,0 +1,3 @@
+module SGMailer
+  ConfigurationError = Class.new(StandardError)
+end

data/lib/sg_mailer/delayed_delivery_processor.rb

@@ -0,0 +1,31 @@
+module SGMailer
+  class DelayedDeliveryProcessor
+    class Job < ActiveJob::Base
+      def perform(mail)
+        SGMailer.send(mail)
+      end
+    end
+
+    def initialize(mail)
+      @mail = mail
+    end
+
+    def deliver_now(**options)
+      return if early_return?
+
+      Job.set(options).perform_now(@mail)
+    end
+
+    def deliver_later(**options)
+      return if early_return?
+
+      Job.set(options).perform_later(@mail)
+    end
+
+    private
+
+    def early_return?
+      @mail.nil? || @mail.empty?
+    end
+  end
+end

data/lib/sg_mailer/immediate_delivery_processor.rb

@@ -0,0 +1,25 @@
+module SGMailer
+  class ImmediateDeliveryProcessor
+    def initialize(mail)
+      @mail = mail
+    end
+
+    def deliver_now(**)
+      return if early_return?
+
+      SGMailer.send(@mail)
+    end
+
+    def deliver_later(**)
+      return if early_return?
+
+      SGMailer.send(@mail)
+    end
+
+    private
+
+    def early_return?
+      @mail.nil? || @mail.empty?
+    end
+  end
+end

data/lib/sg_mailer/mail_builder.rb

@@ -0,0 +1,41 @@
+module SGMailer
+  class MailBuilder
+    def self.build(*args)
+      new(*args).build
+    end
+
+    def initialize(from:, to:, template_id:, substitutions: {})
+      @from = normalize_email(from)
+      @to = Array(to).map { |email| normalize_email(email) }
+      @substitutions = normalize_substitutions(substitutions)
+      @template_id = template_id
+    end
+
+    def build
+      { from: normalize_email(@from),
+        personalizations: [to: @to, substitutions: @substitutions],
+        content: content_for_template,
+        template_id: @template_id }
+    end
+
+    private
+
+    def normalize_email(email)
+      if email.is_a?(String)
+        { email: email }
+      else
+        email
+      end
+    end
+
+    def normalize_substitutions(substitutions)
+      Hash[substitutions.map do |key, value|
+        [key.to_s, value.to_s]
+      end]
+    end
+
+    def content_for_template
+      [type: "text/html", value: "<html><body></body></html>"]
+    end
+  end
+end

data/lib/sg_mailer/response_error.rb

@@ -0,0 +1,19 @@
+module SGMailer
+  class ResponseError < StandardError
+    def initialize(response)
+      @response = response
+
+      super(build_message)
+    end
+
+    def status
+      @response.status
+    end
+
+    private
+
+    def build_message
+      "Error from SendGrid:\n#{@response.body}"
+    end
+  end
+end

data/lib/sg_mailer/test_client.rb

@@ -0,0 +1,13 @@
+module SGMailer
+  class TestClient
+    attr_accessor :mail_requests
+
+    def initialize
+      @mail_requests = []
+    end
+
+    def send(mail)
+      mail_requests << mail.to_json
+    end
+  end
+end

data/lib/sg_mailer/version.rb

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

data/sg_mailer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sg_mailer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sg_mailer'
+  spec.version       = SGMailer::VERSION
+  spec.authors       = ['Genadi Samokovarov']
+  spec.email         = ['gsamokovarov@gmail.com']
+
+  spec.summary       = 'Action Mailer-like framework for SendGrid transactional mails'
+  spec.description   = 'Action Mailer-like framework for SendGrid transactional mails'
+  spec.homepage      = 'https://github.com/gsamokovarov/sg_mailer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sg_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Action Mailer-like framework for SendGrid transactional mails
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sg_mailer.rb
+- lib/sg_mailer/base.rb
+- lib/sg_mailer/client.rb
+- lib/sg_mailer/configuration_error.rb
+- lib/sg_mailer/delayed_delivery_processor.rb
+- lib/sg_mailer/immediate_delivery_processor.rb
+- lib/sg_mailer/mail_builder.rb
+- lib/sg_mailer/response_error.rb
+- lib/sg_mailer/test_client.rb
+- lib/sg_mailer/version.rb
+- sg_mailer.gemspec
+homepage: https://github.com/gsamokovarov/sg_mailer
+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.1
+signing_key: 
+specification_version: 4
+summary: Action Mailer-like framework for SendGrid transactional mails
+test_files: []