action_mailer_kafka 0.1.0

data/example/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  root to: 'users#index', via: :get
+  resources :users
+end

data/example/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 593bb8c4bce047d42fd6180cad2572c047c2f930ece6a2f462c96c39cda20f7b71cc73588f91b5750e8194e2ce8a16f00bc7e44a3e4922db4e4dc6c9ad250f96
+
+test:
+  secret_key_base: f6ae07449275c2603fac9202afbe52f532f4a3d5131b58ba0d10408534979773d9fbfad12d5aa806d5c5e889527fac708725084563a12e72d750732765dad34c
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/example/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/example/db/migrate/20141111080045_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/example/db/migrate/20141115060216_create_delayed_jobs.rb

@@ -0,0 +1,22 @@
+class CreateDelayedJobs < ActiveRecord::Migration[5.0]
+  def self.up
+    create_table :delayed_jobs, :force => true do |table|
+      table.integer :priority, :default => 0, :null => false # Allows some jobs to jump to the front of the queue
+      table.integer :attempts, :default => 0, :null => false # Provides for retries, but still fail eventually.
+      table.text :handler, :null => false                    # YAML-encoded string of the object that will do work
+      table.text :last_error                                 # reason for last failure (See Note below)
+      table.datetime :run_at                                 # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+      table.datetime :locked_at                              # Set when a client is working on this object
+      table.datetime :failed_at                              # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string :locked_by                                # Who is working on this object (if locked)
+      table.string :queue                                    # The name of the queue this job is in
+      table.timestamps
+    end
+
+    add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  end
+
+  def self.down
+    drop_table :delayed_jobs
+  end
+end

data/example/db/schema.rb

@@ -0,0 +1,40 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2014_11_15_060216) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "delayed_jobs", id: :serial, force: :cascade do |t|
+    t.integer "priority", default: 0, null: false
+    t.integer "attempts", default: 0, null: false
+    t.text "handler", null: false
+    t.text "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string "locked_by"
+    t.string "queue"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["priority", "run_at"], name: "delayed_jobs_priority"
+  end
+
+  create_table "users", id: :serial, force: :cascade do |t|
+    t.string "name"
+    t.string "email"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

data/example/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
+#   Mayor.create(name: 'Emanuel', city: cities.first)

data/example/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/example/public/422.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/example/public/500.html

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/example/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-agent: *
+# Disallow: /

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/mail_2_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mail", "~> 2.5.2"
+
+gemspec path: "../"

data/gemfiles/mail_2_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mail", "~> 2.6.0"
+
+gemspec path: "../"

data/gemfiles/mail_2_7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mail", "~> 2.7.0"
+
+gemspec path: "../"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0"
+
+gemspec path: "../"

data/lib/action_mailer_kafka/delivery_method.rb

@@ -0,0 +1,139 @@
+module ActionMailerKafka
+  class DeliveryMethod
+    SUPPORTED_MULTIPART_MIME_TYPES = ['multipart/alternative', 'multipart/mixed', 'multipart/related'].freeze
+    attr_accessor :settings
+    attr_reader :mailer_topic_name, :kafka_client, :kafka_publish_proc
+
+    # settings params allow you to pass in
+    # 1. Your Kafka publish proc
+    # With this option, you should config as below:
+    # config.action_mailer.action_mailer_kafka_settings = {
+    #   kafka_mail_topic: 'YourKafkaTopic',
+    #   kafka_publish_proc: proc do |message_data, default_message_topic|
+    #                           YourKafkaClientInstance.publish(message_data,
+    #                                                           default_message_topic)
+    #                         end
+    # }
+    #
+    # and the data would go through your publish process
+    #
+    # 2. Your kafka client info
+    # With this option, the library will generate a kafka instance for you:
+    # config.action_mailer.action_mailer_kafka_settings = {
+    #   kafka_mail_topic: 'YourKafkaTopic',
+    #   kafka_client_info: {
+    #     seed_brokers: ['localhost:9090'],
+    #     logger: logger,
+    #     ssl_ca_cert: '/path/to/cert'
+    #     # For more option on what to pass here, see https://github.com/zendesk/ruby-kafka/blob/master/lib/kafka/client.rb#L20
+    #   }
+    # }
+    #
+    # Other settings params:
+    #   - raise_on_delivery_error
+    #   - logger
+    #   - fallback
+    #     + fallback_delivery_method
+    #     + fallback_delivery_method_settings
+    #   }
+
+    def initialize(**params)
+      @settings = params
+      @service_name = params[:service_name] || ''
+      @mailer_topic_name = @settings.fetch(:kafka_mail_topic)
+      if @settings[:fallback]
+        @fallback_delivery_method = Mail::Configuration.instance.lookup_delivery_method(
+          @settings[:fallback].fetch(:fallback_delivery_method)
+        ).new(
+          @settings[:fallback].fetch(:fallback_delivery_method_settings)
+        )
+      end
+      if @settings[:kafka_publish_proc]
+        @kafka_publish_proc = @settings[:kafka_publish_proc]
+      else
+        @kafka_client = ::Kafka.new(@settings.fetch(:kafka_client_info))
+        @kafka_publish_proc = proc { |data, topic|
+          kafka_client.deliver_message(data, topic: topic)
+        }
+      end
+    rescue KeyError => e
+      raise RequiredParamsError.new(params, e.message)
+    end
+
+    def logger
+      @settings[:logger] || Logger.new(STDOUT)
+    end
+
+    def deliver!(mail)
+      mail_data = construct_mail_data mail
+      kafka_publish_proc.call(mail_data, mailer_topic_name)
+    rescue Kafka::Error => e
+      error_msg = "Fail to send email into Kafka due to: #{e.message}. Delivered using fallback method"
+      logger.error(error_msg)
+      @fallback_delivery_method.deliver!(mail) if @settings[:fallback]
+      raise KafkaOperationError, error_msg if @settings[:raise_on_delivery_error]
+    rescue StandardError => e
+      error_msg = "Fail to send email due to: #{e.message}"
+      logger.error(error_msg)
+      raise ParsingOperationError, error_msg if @settings[:raise_on_delivery_error]
+    end
+
+    private
+
+    def construct_mail_data(mail)
+      general_data = {
+        subject: mail.subject,
+        from: mail.from,
+        to: mail.to,
+        cc: mail.cc,
+        bcc: mail.bcc,
+        mime_type: mail.mime_type,
+        author: @service_name
+      }
+      general_data.merge! construct_mail_body(mail)
+      general_data.merge! construct_custom_mail_header(mail)
+      general_data[:attachments] = construct_attachments mail
+      general_data.to_json
+    end
+
+    def construct_custom_mail_header(mail)
+      result = { custom_headers: {} }
+      mail.header_fields.each do |h|
+        header_name = h.name
+        # header_value = h.unparsed_value
+        # Ideally header values should not be parsed and sent directly to the mail service
+        # However, Field #unparsed_value is not available on Mail Gem version 2.5 and before
+        # here header.value got its value parsed, so a string should be expected
+        # even if you create a custom header with a hash
+        header_value = h.value
+        if h.field.is_a?(::Mail::OptionalField) && header_name.start_with?('X-')
+          result[:custom_headers][header_name] = header_value
+        end
+      end
+      result
+    end
+
+    def construct_attachments(mail)
+      mail.attachments.map { |part| convert_attachment part }
+    end
+
+    def convert_attachment(part)
+      {
+        content: Base64.strict_encode64(part.body.decoded),
+        type: part.mime_type,
+        filename: part.filename
+      }
+    end
+
+    def construct_mail_body(mail)
+      if SUPPORTED_MULTIPART_MIME_TYPES.include?(mail.mime_type)
+        {
+          text_part: mail.text_part&.decoded,
+          html_part: mail.html_part&.decoded
+        }
+      else
+        { body: mail.body&.decoded }
+      end
+    end
+  end
+end