mailtime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6796e6fba8e145db97279c3bfc86388553a9733
+  data.tar.gz: 0f3bf01438f14798f016290245047cf4ace18e17
+SHA512:
+  metadata.gz: 728b353305727c26f8f16c24583051f98771efe706722381c1e62e5b09630afdac8d304a63d849ff9851e7775371b047bf072cc60cf653973a51b011181d7066
+  data.tar.gz: d0ec9ee59c341e33f48bad171db20753c501441e87456bc9157015a113955ddd2dd3521e7ce7d096b71797f8d061ee55ca89f88471f5d3a27e1f8f6cab3abdd5

data/.gitignore

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

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
+
+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,90 @@
+# Mailtime
+
+Make sending mail great again.
+
+## Goal
+
+For most projects, you want to know when you mailed a user, and what you mailed to them. Additionally, you don't want to have to do a push every time you want to change something in your mailer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailtime'
+```
+
+Bundle.
+
+    $ bundle
+
+And copy over the initializer and migration:
+
+    $ rails g mailtime:install
+
+Migrate it.
+
+    $ rake db:migrate
+
+## How it works
+
+Mailtime hooks into `ActionMailer#mail`. It injects a some methods in order to extract metadata, such as the mailer class (like `UserMailer`) and the action
+(like `password_reset`). Once it knows what it's working with, it looks to the database for the corresponding `MailTemplate`.
+If it finds the `MailTemplate`, it renders the template against the mail and merges the result with some of the mail's attributes (like `body`).
+
+It then logs the mail and sends it away.
+
+Mailtime aims to be highly flexible and tries not to dictate your setup. For example, you can render a `MailTemplate`'s contents however you want. Just specify in the initializer what `renderer` you want to use. And because Mailtime simply hooks into `ActionMailer`, it doesn't care how you're delivering mail (via `config.action_mailer.delivery_method`).
+
+## Usage
+
+Should "just work", but...
+
+You'll want somewhere to view your logs and manage your templates. Basic scaffolding will do just fine.
+
+```Ruby
+def index
+  @mail_templates = Mailtime::MailTemplate.all
+end
+```
+
+For `MailTemplate`, you'll want to permit the params `klass`, `action`, `subject`, and `content`
+
+Here's an example using `SimpleForm`:
+
+```Ruby
+  simple_form_for @mail_template do |f| 
+    f.input :action, :as => :select, :collection => MailTemplate.mail_actions, :onchange => '$("#mail_template_klass").val($("#mail_template_action option:selected").closest("optgroup").attr("label"));'
+    f.input :klass, :as => :hidden
+    f.input :subject
+    f.input :content, :as => :text
+    f.submit 
+  end
+```
+
+`MailTemplate.mail_actions` is an array of mailer classes and their public instance methods, e.g. `['UserMailer' => ['password_reset_email']]`
+
+## Todo
+
+* Better loading of mailers
+* Allow config to specify the user class
+* Fallbacks
+* Import existing mailers
+* Layouts
+* Tests
+* BCC, CC
+* Configure overrides for subject
+* Custom user finder
+
+## Maybe todo
+
+* WYSIWIG?
+* Sync?
+* Versioning for templates?
+* Specify multiple formats?
+* A/B testing?
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/mailtime
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+task :default => :spec
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mailtime"
+
+# 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/generators/mailtime/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Copies migrations and installs an initializer
+
+Example:
+    rails generate mailtime:install
+
+    This will create:
+        config/initializers/mailtime.rb
+    
+      and add a migration of:
+        1_active_admin_mail_migration.rb

data/lib/generators/mailtime/install_generator.rb

@@ -0,0 +1,18 @@
+module Mailtime
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Installs an initializer and copies over a migration"
+
+      def copy_initializer_file
+        copy_file "default_initializer.rb", "config/initializers/mailtime.rb"
+      end
+
+      def copy_migration_file
+        copy_file "db/migrate/1_mailtime_migration.rb", "db/migrate/1_mailtime_migration.rb"
+      end
+    end
+  end
+
+end

data/lib/generators/mailtime/templates/db/migrate/1_mailtime_migration.rb

@@ -0,0 +1,30 @@
+class MailtimeMigration < ActiveRecord::Migration
+  def change
+    create_table :mailtime_mail_templates do |t|
+      t.string :klass
+      t.string :action
+      t.text :content
+      t.text :subject
+
+      t.timestamps null: false
+    end
+    add_index :mailtime_mail_templates, :klass
+    add_index :mailtime_mail_templates, :action
+
+    create_table :mailtime_mail_logs do |t|
+      t.integer :mailtime_mail_template_id
+      t.string :template
+      t.string :action
+      t.string :klass
+      t.integer :user_id
+      t.json :headers
+
+      t.timestamps null: false
+    end
+    add_index :mailtime_mail_logs, :mailtime_mail_template_id
+    add_index :mailtime_mail_logs, :template
+    add_index :mailtime_mail_logs, :action
+    add_index :mailtime_mail_logs, :klass
+    add_index :mailtime_mail_logs, :user_id
+  end
+end

data/lib/generators/mailtime/templates/default_initializer.rb

@@ -0,0 +1,45 @@
+Mailtime.configure do |config|
+
+  # == Mailers
+  #
+  # Unfortunately, Rails doesn't autoload mailers in development
+  # If you don't mind restarting your Rails server every time you add a new mailer,
+  # you can set this to false.
+  config.lazy_load_mailers = false
+
+  # If you're wondering why Devise's mailers aren't getting picked up (or something similar)
+  # you can specify additional mailers below.
+  #config.mailers << 'Devise::Mailer'
+
+  # == Rendering
+  #
+  # If you do not want to have Mailtime handle the `body` of the mail itself,
+  # you should set this to false
+  config.render = true
+
+  # But if you do (and you should), and you want to use your own renderer, specify
+  # it here. It's just a PORO that parse the template's (from the database) content
+  # and assign the mail's body to it.
+  # config.renderer = 'LiquidRenderer'
+
+  # If for some reason, calling #render on your renderer is not okay, you can specify
+  # the method below. (ps. the method should output the contents of the template + mail context)
+  # so that it can be assigned to the `body` of the mail
+  #config.renderer_method = :render
+
+  # == Logging
+  #
+  # Log the mail to the database
+  config.log = true
+
+  # If your user class is not `User`, you can tell Mailtime what it is and for each mail that gets logged
+  # to associate it to the instance variable that has this class.
+  # todo
+  # config.user_class = 'User'
+
+  # == Fallbacks
+  # falls back to ERB if the template doesn't exist in the database
+  # raises an error if the template doesn't exist in ERB
+  config.fallback_to_erb = false
+
+end

data/lib/mailtime/action_mailer/base.rb

@@ -0,0 +1,38 @@
+module Mailtime
+  module ActionMailer
+    module Metadata
+
+      def self.included(base)
+        base.include AbstractController::Callbacks
+        base.after_action :inject_metadata
+      end
+
+      protected
+
+      def instance_variables_map
+        self.instance_variables.select { |variable| !variable.to_s.start_with?("@_") }.each_with_object({}) do |v, h|
+          h[v.to_s.gsub('@', '')] = instance_variable_get(v)
+        end
+      end
+
+      private
+
+      def inject_metadata
+        mailer_klass = self.class.to_s
+        mailer_action = self.action_name
+        action_variables  = self.instance_variables_map
+
+        self.message.instance_variable_set(:@mailer_klass, mailer_klass)
+        self.message.instance_variable_set(:@mailer_action, mailer_action)
+        self.message.instance_variable_set(:@action_variables, action_variables)
+
+        self.message.class.send(:attr_reader, :mailer_klass)
+        self.message.class.send(:attr_reader, :mailer_action)
+        self.message.class.send(:attr_reader, :action_variables)
+      end
+
+    end
+  end
+end
+
+::ActionMailer::Base.send(:include, Mailtime::ActionMailer::Metadata)

data/lib/mailtime/action_mailer/interceptor.rb

@@ -0,0 +1,16 @@
+module Mailtime
+  class SetupMailtimeMailer
+
+    class << self
+
+      def delivering_email(mail)
+        processor = Mailtime::Processor.new(mail)
+        mail = processor.execute
+        mail
+      end
+
+    end
+  end
+end
+
+ActionMailer::Base.register_interceptor(Mailtime::SetupMailtimeMailer)

data/lib/mailtime/active_record/models/mail_log.rb

@@ -0,0 +1,9 @@
+require 'mailtime/mail_log_concern'
+
+module Mailtime
+  class MailLog < ActiveRecord::Base
+
+    include Mailtime::MailLogConcern
+
+  end
+end

data/lib/mailtime/active_record/models/mail_template.rb

@@ -0,0 +1,9 @@
+require 'mailtime/mail_template_concern'
+
+module Mailtime
+  class MailTemplate < ActiveRecord::Base
+
+    include Mailtime::MailTemplateConcern
+
+  end
+end

data/lib/mailtime/engine.rb

@@ -0,0 +1,19 @@
+module Mailtime
+  module Rails
+    class Engine < ::Rails::Engine
+
+      isolate_namespace Mailtime
+
+      paths["app/models"] << "lib/mailtime/active_record/models"
+
+      initializer :append_migrations do |app|
+        unless app.root.to_s.match root.to_s
+          config.paths["db/migrate"].expanded.each do |expanded_path|
+            app.config.paths["db/migrate"] << expanded_path
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/mailtime/mail_log_concern.rb

@@ -0,0 +1,15 @@
+module Mailtime
+  # Functionality exists in a module for the same reasons as
+  # outlined in mail_template_concern.rb
+  module MailLogConcern
+
+    extend ::ActiveSupport::Concern
+
+    included do
+      self.table_name = 'mailtime_mail_logs'
+      belongs_to :user, :class_name => 'User',
+                 :foreign_key => :user_id
+    end
+
+  end
+end

data/lib/mailtime/mail_template_concern.rb

@@ -0,0 +1,30 @@
+module Mailtime
+  # moving the functionality to this module, you can include
+  # this concern instead of sub-classing the `MailTemplate` model.
+  module MailTemplateConcern
+
+    extend ::ActiveSupport::Concern
+
+    included do
+      self.table_name = 'mailtime_mail_templates'
+
+      validates_presence_of :klass, :in => -> { mailers }
+      validates_uniqueness_of :action, :scope => :klass
+
+      def self.mailers
+        Mailtime.configuration.mailers
+      end
+
+      def self.mail_actions
+        mailers.collect { |mailer| [mailer, mailer.constantize.public_instance_methods(false)] }
+      end
+    end
+
+    def additional_headers
+      headers = {}
+      headers[:subject] = self.subject if self.subject.present?
+      headers
+    end
+
+  end
+end

data/lib/mailtime/models.rb

@@ -0,0 +1,2 @@
+require 'mailtime/active_record/models/mail_log'
+require 'mailtime/active_record/models/mail_template'

data/lib/mailtime/processor.rb

@@ -0,0 +1,39 @@
+require 'mailtime/models'
+require 'mailtime/renderers/base_renderer'
+
+module Mailtime
+  class Processor
+
+    def initialize(mail)
+      @mail = mail
+    end
+
+    def execute
+      create_mail_log if Mailtime.configuration.log
+      if Mailtime.configuration.render
+        renderer = Mailtime.configuration.renderer.to_s.constantize.new(@mail)
+        @mail.body = renderer.send(Mailtime.configuration.renderer_method)
+      end
+      @mail
+    end
+
+    protected
+
+    def create_mail_log
+      ::Mailtime::MailLog.create(
+          :user => User.find_by(:email =>@mail.to.first),
+          :mailtime_mail_template_id => @template.try(:id),
+          :action => @mail.mailer_action,
+          :klass => @mail.mailer_klass,
+          :headers => extract_headers
+      )
+    end
+
+    def extract_headers
+      headers = {}
+      @mail.header_fields.map { |k| headers[k.name] = k.value }
+      headers
+    end
+
+  end
+end

data/lib/mailtime/railtie.rb

@@ -0,0 +1,7 @@
+class Railtie < Rails::Railtie
+  initializer "Include your code in the controller" do
+    ActiveSupport.on_load(:action_controller) do
+      include Mailtime
+    end
+  end
+end

data/lib/mailtime/renderers/base_renderer.rb

@@ -0,0 +1,24 @@
+module Mailtime
+  module Renderers
+    class BaseRenderer
+
+      # we inject mail with the instance variables from your ActionMailer action.
+      # access them via mail.action_variables
+      def initialize(mail)
+        @mail = mail
+        @template = template
+      end
+
+      def render
+        @template.content
+      end
+
+      protected
+
+      def template
+        ::Mailtime::MailTemplate.find_by(:klass => @mail.mailer_klass, :action => @mail.mailer_action)
+      end
+
+    end
+  end
+end

data/lib/mailtime/version.rb

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

data/lib/mailtime.rb

@@ -0,0 +1,69 @@
+begin
+  require 'rails/engine'
+  require 'mailtime/engine'
+rescue LoadError
+
+end
+
+module Mailtime
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :mailers, :render, :log, :fallback_to_erb, :renderer, :renderer_method, :lazy_load_mailers,
+                  :user_class
+
+    def initialize
+      @lazy_load_mailers = false 
+      @mailers = load_mailers
+      @render = true
+      @log = true
+      @fallback_to_erb = true
+      @renderer = 'Mailtime::Renderers::BaseRenderer'
+      @renderer_method = :render
+      @user_class = 'User'
+      @user_finder = nil
+    end
+
+    def load_mailers
+      mailers = []
+      unless @lazy_load_mailers
+        mailers = require_and_load_mailers
+      end
+      mailers 
+    end
+
+    protected
+
+    def require_and_load_mailers
+      mailers = []
+      Dir.glob("#{::Rails.root}/app/mailers/**/*_mailer.rb").each do |m|
+        require m rescue nil 
+      end
+      mailers << ::ActionMailer::Base.descendants.map(&:to_s) 
+      mailers
+    end
+
+  end
+
+  protected
+
+  def self.find_user_by(attr = :email, value = nil)
+    ::User.find_by(attr => value)
+  end
+
+end
+
+require 'mailtime/action_mailer/base'
+require 'mailtime/action_mailer/interceptor'
+require 'mailtime/processor'
+require 'mailtime/railtie'
+require 'mailtime/mail_log_concern'
+require 'mailtime/mail_template_concern'

data/mailtime.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailtime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailtime"
+  spec.version       = Mailtime::VERSION
+  spec.authors       = ["Josh Brody"]
+  spec.email         = ["josh@josh.mn"]
+
+  spec.summary       = %q{Manage the mails you send from Rails.}
+  spec.homepage      = "https://github.com/joshmn/mailtime"
+  spec.license       = 'MIT'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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 'minitest', '~> 4.7.3'
+
+  spec.requirements << 'Rails <= 3.2'
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: mailtime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+description: 
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/mailtime/USAGE
+- lib/generators/mailtime/install_generator.rb
+- lib/generators/mailtime/templates/db/migrate/1_mailtime_migration.rb
+- lib/generators/mailtime/templates/default_initializer.rb
+- lib/mailtime.rb
+- lib/mailtime/action_mailer/base.rb
+- lib/mailtime/action_mailer/interceptor.rb
+- lib/mailtime/active_record/models/mail_log.rb
+- lib/mailtime/active_record/models/mail_template.rb
+- lib/mailtime/engine.rb
+- lib/mailtime/mail_log_concern.rb
+- lib/mailtime/mail_template_concern.rb
+- lib/mailtime/models.rb
+- lib/mailtime/processor.rb
+- lib/mailtime/railtie.rb
+- lib/mailtime/renderers/base_renderer.rb
+- lib/mailtime/version.rb
+- mailtime.gemspec
+homepage: https://github.com/joshmn/mailtime
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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:
+- Rails <= 3.2
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Manage the mails you send from Rails.
+test_files: []
+has_rdoc: