sendgrid_actionmailer_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fc00b2f351543df7b2292bceca96e549c3a03e0
+  data.tar.gz: a9ae4a0cb08a0442c7fbe92ded4c108f44f53cd1
+SHA512:
+  metadata.gz: b63e0b130b073189f16856705932d12116ca4d59c80c280d127f8a27ebad53826269ed9bbc9fd5bdcca7c20454739805464b6bd4420c3d0d9cf05dabe7fee278
+  data.tar.gz: 1ef8d805710cd759e8df2437a5e2ba5e336141a79c47fb69f2bd0b06d51fda99bdbf1cfdc7bc161afcbfca23f9795d4125a562a27fd4ac6881172d3e3a0e7c4a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ryu39
+
+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/lib/sendgrid_actionmailer_adapter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sendgrid_actionmailer_adapter/version'
+require 'sendgrid_actionmailer_adapter/configuration'
+require 'sendgrid_actionmailer_adapter/delivery_method'
+
+module SendGridActionMailerAdapter
+  def self.configure(&block)
+    ::SendGridActionMailerAdapter::Configuration.configure(&block)
+  end
+end

data/lib/sendgrid_actionmailer_adapter/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SendGridActionMailerAdapter
+  class Configuration
+    DEFAULT_RETRY_MAX_COUNT = 0
+    DEFAULT_RETRY_WAIT_SECONDS = 1.0
+
+    class << self
+      attr_accessor :api_key, :host, :request_headers, :version, :retry_max_count,
+                    :retry_wait_seconds
+
+      # Set your configuration with block.
+      def configure
+        yield(self)
+      end
+
+      # Returns configuration hash.
+      #
+      # @return [Hash]
+      def settings
+        @settings ||= {
+          sendgrid: {
+            api_key: api_key || '',
+            host: host,
+            request_headers: request_headers,
+            version: version
+          },
+          retry: {
+            max_count: retry_max_count || DEFAULT_RETRY_MAX_COUNT,
+            wait_seconds: retry_wait_seconds || DEFAULT_RETRY_WAIT_SECONDS
+          }
+        }.freeze
+      end
+
+      # Reset settings for test.
+      def reset!
+        self.api_key = nil
+        self.host = nil
+        self.request_headers = nil
+        self.version = nil
+        self.retry_max_count = nil
+        self.retry_wait_seconds = nil
+        @settings = nil
+      end
+    end
+  end
+end

data/lib/sendgrid_actionmailer_adapter/converter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'mail'
+require 'sendgrid-ruby'
+require_relative 'errors'
+
+module SendGridActionMailerAdapter
+  class Converter
+    VALIDATORS = [
+      ->(mail) { "'from' is required." if mail.from_addrs.empty? },
+      ->(mail) { "'to_addrs' must not be empty." if mail.to_addrs.empty? },
+      ->(mail) { "'subject' is required." if mail.subject.nil? || mail.subject.empty? }
+    ].freeze
+
+    CONVERTERS = {
+      from: ->(mail) {
+        addr = mail[:from].addrs.first
+        ::SendGrid::Email.new(email: addr.address, name: addr.display_name)
+      },
+      subject: ->(mail) { mail.subject },
+      personalizations: ->(mail) {
+        # Separate emails per each To address.
+        # Cc and Bcc addresses are shared with each emails.
+        mail[:to].addrs.map do |to_addr|
+          ::SendGrid::Personalization.new.tap do |p|
+            p.to = ::SendGrid::Email.new(email: to_addr.address, name: to_addr.display_name)
+            Array(mail[:cc]&.addrs).each do |addr|
+              p.cc = ::SendGrid::Email.new(email: addr.address, name: addr.display_name)
+            end
+            Array(mail[:bcc]&.addrs).each do |addr|
+              p.bcc = ::SendGrid::Email.new(email: addr.address, name: addr.display_name)
+            end
+          end
+        end
+      },
+      contents: ->(mail) {
+        ::SendGrid::Content.new(type: mail.mime_type, value: mail.body.to_s)
+      },
+      attachments: ->(mail) {
+        mail.attachments.map do |attachment|
+          ::SendGrid::Attachment.new.tap do |sendgrid_attachment|
+            sendgrid_attachment.type = attachment.mime_type
+            sendgrid_attachment.content = ::Base64.encode64(attachment.body.raw_source)
+            sendgrid_attachment.filename = ::Mail::Encodings.decode_encode(
+              attachment.content_type_parameters['filename'], :decode
+            )
+            sendgrid_attachment.content_id = attachment.cid
+          end
+        end
+      },
+      categories: ->(mail) {
+        return nil if mail['categories'].nil?
+        # FIXME: Separator ', ' is dependant on Mail::UnstructuredField implementation,
+        # this may occur unexpected behaviour on 'mail' gem update.
+        mail['categories'].value.split(', ').map { |c| ::SendGrid::Category.new(name: c) }
+      },
+      send_at: ->(mail) { mail['send_at'].value.to_i if mail['send_at'] },
+      reply_to: ->(mail) {
+        addr = mail[:reply_to]&.addrs&.first
+        ::SendGrid::Email.new(email: addr.address, name: addr.display_name) if addr
+      }
+    }.freeze
+
+    class << self
+      # Convert Mail::Message to SendGrid::Mail.
+      #
+      # @param [Message::Mail] mail
+      # @return [SendGrid::Mail]
+      # @raise [SendGridActionMailerAdapter::ValidationError]
+      def to_sendgrid_mail(mail)
+        validate!(mail)
+        convert(mail)
+      end
+
+      private
+
+      def validate!(mail)
+        error_messages = VALIDATORS.map { |validator| validator.call(mail) }.compact
+        unless error_messages.empty?
+          raise SendGridActionMailerAdapter::ValidationError, "Validation error, #{error_messages}"
+        end
+      end
+
+      def convert(mail)
+        sendgrid_mail = ::SendGrid::Mail.new
+        CONVERTERS.each do |attr_name, converter|
+          Array(converter.call(mail)).each do |attr_val|
+            sendgrid_mail.send("#{attr_name}=", attr_val)
+          end
+        end
+        sendgrid_mail
+      end
+    end
+  end
+end

data/lib/sendgrid_actionmailer_adapter/delivery_method.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'sendgrid/client'
+require_relative 'configuration'
+require_relative 'converter'
+require_relative 'errors'
+
+module SendGridActionMailerAdapter
+  class DeliveryMethod
+    attr_reader :settings
+
+    # Initialize this instance.
+    #
+    # This method is expected to be called from Mail::Message class.
+    #
+    # @params [Hash] settings settings parameters which you want to override.
+    # @options settings [String] :api_key Your SendGrid Web API key.
+    # @options settings [String] :host Base host FQDN of API endpoint.
+    # @options settings [Hash] :request_headers Request headers which you want to override.
+    # @options settings [String] :version API version string, eg: 'v3'.
+    # @options settings [Integer] :retry_max_count Count for retry, Default is 0(Do not retry).
+    # @options settings [Integer, Float] :retry_wait_sec Wait seconds for next retry, Default is 1.
+    def initialize(settings)
+      @settings = ::SendGridActionMailerAdapter::Configuration.settings.merge(settings)
+    end
+
+    # Deliver a mail via SendGrid Web API.
+    #
+    # This method is called from Mail::Message#deliver!.
+    #
+    # @param [Mail::Message] mail Mail::Message object which you want to send.
+    # @raise [SendGridActionMailerAdapter::ValidationError] when validation error occurred.
+    # @raise [SendGridActionMailerAdapter::ApiError] when SendGrid Web API returns error response.
+    def deliver!(mail)
+      sendgrid_mail = ::SendGridActionMailerAdapter::Converter.to_sendgrid_mail(mail)
+      body = sendgrid_mail.to_json
+      client = ::SendGrid::API.new(@settings[:sendgrid]).client.mail._('send')
+
+      with_retry(@settings[:retry]) do
+        response = client.post(request_body: body)
+        handle_response!(response)
+      end
+    end
+
+    private
+
+    def with_retry(max_count:, wait_seconds:)
+      tryable_count = max_count + 1
+      begin
+        tryable_count -= 1
+        yield
+      rescue ::SendGridActionMailerAdapter::ApiClientError => _e
+        raise
+      rescue => _e
+        if tryable_count > 0
+          sleep(wait_seconds)
+          retry
+        end
+        raise
+      end
+    end
+
+    # @see https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/errors.html
+    def handle_response!(response)
+      case response.status_code.to_i
+      when (200..299)
+        response
+      when (400..499)
+        raise ::SendGridActionMailerAdapter::ApiClientError, response
+      else
+        raise ::SendGridActionMailerAdapter::ApiUnexpectedError, response
+      end
+    end
+  end
+end

data/lib/sendgrid_actionmailer_adapter/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SendGridActionMailerAdapter
+  class ValidationError < StandardError; end
+
+  class ApiError < StandardError
+    attr_accessor :response
+
+    def initialize(response)
+      super("SendGrid API returns error, #{response.inspect}")
+      @response = response
+    end
+  end
+  class ApiClientError < ApiError; end
+  class ApiUnexpectedError < ApiError; end
+end

data/lib/sendgrid_actionmailer_adapter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SendGridActionMailerAdapter
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid_actionmailer_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ryu39
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ActionMailer adapter using SendGrid Web API v3.
+email:
+- dev.ryu39@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/sendgrid_actionmailer_adapter.rb
+- lib/sendgrid_actionmailer_adapter/configuration.rb
+- lib/sendgrid_actionmailer_adapter/converter.rb
+- lib/sendgrid_actionmailer_adapter/delivery_method.rb
+- lib/sendgrid_actionmailer_adapter/errors.rb
+- lib/sendgrid_actionmailer_adapter/version.rb
+homepage: https://github.com/ryu39/sendgrid_actionmailer_adapter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A ActionMailer adapter using SendGrid Web API v3
+test_files: []