mailtime 0.1.0 → 0.4.0

checksums.yaml

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

data/README.md

@@ -38,7 +38,24 @@ Mailtime aims to be highly flexible and tries not to dictate your setup. For exa
 
 ## Usage
 
-Should "just work", but...
+Using Mailtime is simple. Just add `acts_as_mailtime_loggable` to each class you want to associate a `Mailtime::MailLog` to.
+
+#### acts_as_mailtime_loggable options
+
+```Ruby
+class User < ActiveRecord::Base
+  acts_as_mailtime_loggable :email_address, :fields => [:to, :cc]
+```
+
+will tell `Mailtime::MailLog` to find a `User` that matches an `ActionMailer#mail`'s `#to` or `#cc` attributes.
+
+#### Configuration
+
+The default initializer that's installed when you run `rails g mailtime:install` is self-documented.
+
+## Additional Setup
+
+#### MailTemplate
 
 You'll want somewhere to view your logs and manage your templates. Basic scaffolding will do just fine.
 
@@ -64,25 +81,25 @@ Here's an example using `SimpleForm`:
 
 `MailTemplate.mail_actions` is an array of mailer classes and their public instance methods, e.g. `['UserMailer' => ['password_reset_email']]`
 
+#### MailLog
+
+A `MailLog` stores the `MailTemplate`, `action` (from the mailer), `klass` (from the mailer), `field` (such as `to`, `cc`, `bcc), `loggable` (from `acts_as_mailtime_loggable`), `headers` (from `ActionMailer#mail`), and `scope` (the instance variables defined in the action)
+
+You'll probably want somewhere to look at these.
+
 ## Todo
 
-* Better loading of mailers
-* Allow config to specify the user class
-* Fallbacks
-* Import existing mailers
+* Import existing mailers with a rake task
 * Layouts
 * Tests
-* BCC, CC
+* BCC, CC for templates
 * Configure overrides for subject
-* Custom user finder
 
 ## Maybe todo
 
-* WYSIWIG?
-* Sync?
+* Dump for production?
 * Versioning for templates?
 * Specify multiple formats?
-* A/B testing?
 
 ## Contributing
 

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

@@ -16,8 +16,11 @@ class MailtimeMigration < ActiveRecord::Migration
       t.string :template
       t.string :action
       t.string :klass
-      t.integer :user_id
-      t.json :headers
+      t.string :field
+      t.integer :loggable_id
+      t.string :loggable_type
+      t.jsonb :headers
+      t.jsonb :scope
 
       t.timestamps null: false
     end
@@ -25,6 +28,9 @@ class MailtimeMigration < ActiveRecord::Migration
     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
+    add_index :mailtime_mail_logs, [:loggable_id, :loggable_type]
+    add_index :mailtime_mail_logs, :field
+    add_index :mailtime_mail_logs, :headers, using: :gin
+    add_index :mailtime_mail_logs, :scope, using: :gin
   end
 end

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

@@ -2,14 +2,12 @@ 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
+  # Unfortunately, Rails doesn't autoload all mailers in development.
+  # Want to preload all your mailers? Uncomment below.
+  # config.preload_mailers!
 
-  # 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'
+  # Have a mailer that doesn't exist in app/mailers? Add it below.
+  # config.mailer << 'Devise::Mail'
 
   # == Rendering
   #
@@ -25,21 +23,25 @@ Mailtime.configure do |config|
   # 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
+  # config.renderer_method = :render
 
   # == Logging
   #
-  # Log the mail to the database
+  # Log the mail to the database. Set to `false` if you don't want to log anything.
   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'
+  # Perform lookups on the following fields and associate the logs to them
+  # Valid options are :to, :cc, and :bcc
+  # config.log_fields = [:to]
+
+  # Sometimes, a mail action gets polluted with instance variables we don't care about.
+  # Because we log all instance variables, you can remove any named instance variables here.
+  # Defaults to Devise::Mail's ['devise_mapping', 'scope_name']
+  # config.reject_scope_keys = ['devise_mapping', 'scope_name']
 
   # == 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
+  # Falls back to the mail's body if the template doesn't exist in the database
+  # If set to false, raises a `TemplateNotFound` error if the template doesn't exist
+  config.fallback = true
 
 end

data/lib/mailtime/action_mailer/base.rb

@@ -25,10 +25,14 @@ module Mailtime
         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.instance_variable_set(:@template_path, self.headers[:template_path] || mailer_klass)
+        self.message.instance_variable_set(:@template_name, self.headers[:template_name] || mailer_action)
 
         self.message.class.send(:attr_reader, :mailer_klass)
         self.message.class.send(:attr_reader, :mailer_action)
         self.message.class.send(:attr_reader, :action_variables)
+        self.message.class.send(:attr_reader, :template_path)
+        self.message.class.send(:attr_reader, :template_name)
       end
 
     end

data/lib/mailtime/{mail_log_concern.rb → active_record/models/concerns/mail_log_concern.rb}

@@ -4,11 +4,9 @@ module Mailtime
   module MailLogConcern
 
     extend ::ActiveSupport::Concern
-
     included do
       self.table_name = 'mailtime_mail_logs'
-      belongs_to :user, :class_name => 'User',
-                 :foreign_key => :user_id
+      belongs_to :loggable, :polymorphic => true
     end
 
   end

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

@@ -1,4 +1,4 @@
-require 'mailtime/mail_log_concern'
+require 'mailtime/active_record/models/concerns/mail_log_concern'
 
 module Mailtime
   class MailLog < ActiveRecord::Base

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

@@ -1,4 +1,4 @@
-require 'mailtime/mail_template_concern'
+require 'mailtime/active_record/models/concerns/mail_template_concern'
 
 module Mailtime
   class MailTemplate < ActiveRecord::Base

data/lib/mailtime/acts_as_mailtime_loggable.rb

@@ -0,0 +1,11 @@
+module Mailtime
+  module ActsAsMailtimeLoggable
+
+    def acts_as_mailtime_loggable(attr = 'email', opts = {})
+      require 'mailtime/loggable'
+      include Mailtime::Loggable
+      Mailtime.configuration.loggable_lookups << { self.to_s => {:attribute => attr, :fields => opts[:fields]} }
+    end
+
+  end
+end

data/lib/mailtime/configuration.rb

@@ -0,0 +1,57 @@
+module Mailtime
+
+  class Configuration
+    attr_accessor :mailers, :render, :log, :log_fields, :fallback, :renderer, :renderer_method, :lazy_load_mailers,
+                  :user_class, :reject_scope_keys, :loggable_lookups
+
+    def initialize
+      @mailers = load_mailers
+      @render = true
+      @log = true
+      @log_fields = [:to]
+      @fallback = true
+      @renderer = 'Mailtime::Renderers::ErbRenderer'
+      @renderer_method = :render
+      @user_class = 'User'
+      @user_finder = nil
+      @reject_scope_keys = ['devise_mapping', 'scope_name']
+      @loggable_lookups = []
+    end
+
+    def mailer(klass)
+      @mailers << klass
+    end
+
+    def loggables
+      @loggable_lookups.each_with_object({}) do |k,h|
+        key = k.keys.first
+        h[key] = k[key]
+      end
+    end
+
+    def self.loggable_lookups
+      @loggable_lookups ||= []
+    end
+
+    def self.loggable_lookups=(val)
+      @loggable_lookups
+    end
+
+    def preload_mailers!
+      preload_mailers
+    end
+
+    def preload_mailers
+      Dir.glob(Rails.root.join("app/mailers/**/*_mailer.rb"))
+          .each { |klass| require klass }
+    end
+
+    protected
+
+    def load_mailers
+      ObjectSpace.each_object(Class).select { |klass| klass < ::ActionMailer::Base }
+    end
+
+  end
+
+end

data/lib/mailtime/loggable.rb

@@ -0,0 +1,11 @@
+module Mailtime
+  module Loggable
+
+    def self.included(base)
+      base.class_eval do
+        has_many :mail_logs, :as => :loggable, :class_name => 'Mailtime::MailLog'
+      end
+    end
+
+  end
+end

data/lib/mailtime/processor/mail_log_service.rb

@@ -0,0 +1,66 @@
+module Mailtime
+  class MailLogService
+
+    attr_accessor :field, :loggable
+    def initialize(mail, loggable_class, options)
+      @mail = mail
+      @loggable_class = loggable_class
+      @loggable = nil
+      @options = options
+      @fields = []
+    end
+
+    def execute
+      log
+    end
+
+    def log
+      return unless loggable?
+      create_mail_log
+    end
+
+    def loggable?
+      @mail.action_variables.detect { |_, var| class_is_loggable?(var) && attribute_is_loggable?(var) } && @fields.any?
+    end
+
+    def class_is_loggable?(var)
+      if var.class.to_s == @loggable_class
+        @loggable = var
+      end
+    end
+
+    def attribute_is_loggable?(var)
+      fields = @options[:fields] || Mailtime.configuration.log_fields || [:to, :cc, :bcc]
+      fields.each do |field|
+        if @mail.send(field).include?(var.send(@options[:attribute]))
+          @fields << field
+        end
+      end
+    end
+
+    def create_mail_log
+      @fields.each do |field|
+        ::Mailtime::MailLog.create(
+            :loggable => @loggable,
+            :mailtime_mail_template_id => @template.try(:id),
+            :action => @mail.mailer_action,
+            :klass => @mail.mailer_klass,
+            :headers => extract_headers,
+            :scope => extract_scope,
+            :field => field
+        )
+      end
+    end
+
+    def extract_headers
+      headers = {}
+      @mail.header_fields.map { |k| headers[k.name] = k.value }
+      headers
+    end
+
+    def extract_scope
+      @mail.action_variables.as_json.except(*Mailtime.configuration.reject_scope_keys)
+    end
+
+  end
+end

data/lib/mailtime/processor/processor.rb

@@ -0,0 +1,49 @@
+require 'mailtime/models'
+require 'mailtime/renderers/base_renderer'
+require 'mailtime/renderers/erb_renderer'
+require 'mailtime/processor/mail_log_service'
+require 'mailtime/processor/processor'
+module Mailtime
+
+  class Processor
+
+    def initialize(mail)
+      @mail = mail
+    end
+
+    def execute
+      process_mail
+    end
+
+    protected
+
+    def process_mail
+      log_mail
+      render_mail
+      @mail
+    end
+
+    private
+
+    def log_mail
+      return unless Mailtime.configuration.log
+      log_for_recipients
+    end
+
+    def render_mail
+      return @mail unless Mailtime.configuration.render
+      renderer = Mailtime.configuration.renderer.to_s.constantize.new(@mail)
+      @mail.body = renderer.send(Mailtime.configuration.renderer_method)
+      @mail
+    end
+
+    def log_for_recipients
+      Mailtime.configuration.loggables.each do |loggable, options|
+        svc = MailLogService.new(@mail, loggable, options)
+        svc.log
+      end
+    end
+
+
+  end
+end

data/lib/mailtime/railtie.rb

@@ -1,7 +1,18 @@
+require 'rails'
+require 'mailtime'
 class Railtie < Rails::Railtie
   initializer "Include your code in the controller" do
     ActiveSupport.on_load(:action_controller) do
       include Mailtime
     end
   end
+
+  rake_tasks do
+    namespace :mailtime do
+      desc 'Create a bunch of MailTemplate(s) based on existing mailers'
+      task :sync_mailers do
+        puts "Todo."
+      end
+    end
+  end
 end

data/lib/mailtime/renderers/base_renderer.rb

@@ -2,6 +2,8 @@ module Mailtime
   module Renderers
     class BaseRenderer
 
+      class TemplateNotFound < StandardError; end
+
       # we inject mail with the instance variables from your ActionMailer action.
       # access them via mail.action_variables
       def initialize(mail)
@@ -15,8 +17,17 @@ module Mailtime
 
       protected
 
+      # find the template. If one doesn't exist, and we want to fallback,
+      # pretend like we have a template with an OpenStruct
       def template
-        ::Mailtime::MailTemplate.find_by(:klass => @mail.mailer_klass, :action => @mail.mailer_action)
+        _template = ::Mailtime::MailTemplate.find_by(:klass => @mail.mailer_klass, :action => @mail.mailer_action)
+        if _template.nil?
+          unless Mailtime.configuration.fallback
+            raise TemplateNotFound, "Template doesn't exist for klass #{@mail.mailer_klass} and action #{@mail.mailer_action}"
+          end
+          _template = OpenStruct.new(:content => @mail.body.raw_source)
+        end
+        _template
       end
 
     end

data/lib/mailtime/renderers/erb_renderer.rb

@@ -0,0 +1,23 @@
+require 'erb'
+require 'mailtime/renderers/erb_renderer'
+
+module Mailtime
+  module Renderers
+    class ErbRenderer < BaseRenderer
+
+      def render
+        set_instance_variables_from_mailer
+        ERB.new(@template.content).result(binding)
+      end
+
+      protected
+
+      def set_instance_variables_from_mailer
+        @mail.action_variables.each do |k, v|
+          instance_variable_set("@#{k}", v) rescue NameError
+        end
+      end
+
+    end
+  end
+end

data/lib/mailtime/version.rb

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

data/lib/mailtime.rb

@@ -2,11 +2,13 @@ begin
   require 'rails/engine'
   require 'mailtime/engine'
 rescue LoadError
-
 end
 
+
 module Mailtime
 
+  require 'mailtime/configuration'
+
   class << self
     attr_accessor :configuration
   end
@@ -16,54 +18,16 @@ module Mailtime
     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)
+  if defined?(ActiveRecord::Base)
+    require 'mailtime/acts_as_mailtime_loggable'
+    ActiveRecord::Base.extend Mailtime::ActsAsMailtimeLoggable
   end
 
 end
 
 require 'mailtime/action_mailer/base'
 require 'mailtime/action_mailer/interceptor'
-require 'mailtime/processor'
+require 'mailtime/processor/processor'
 require 'mailtime/railtie'
-require 'mailtime/mail_log_concern'
-require 'mailtime/mail_template_concern'
+require 'mailtime/active_record/models/concerns/mail_log_concern'
+require 'mailtime/active_record/models/concerns/mail_template_concern'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtime
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -45,15 +45,20 @@ files:
 - lib/mailtime.rb
 - lib/mailtime/action_mailer/base.rb
 - lib/mailtime/action_mailer/interceptor.rb
+- lib/mailtime/active_record/models/concerns/mail_log_concern.rb
+- lib/mailtime/active_record/models/concerns/mail_template_concern.rb
 - lib/mailtime/active_record/models/mail_log.rb
 - lib/mailtime/active_record/models/mail_template.rb
+- lib/mailtime/acts_as_mailtime_loggable.rb
+- lib/mailtime/configuration.rb
 - lib/mailtime/engine.rb
-- lib/mailtime/mail_log_concern.rb
-- lib/mailtime/mail_template_concern.rb
+- lib/mailtime/loggable.rb
 - lib/mailtime/models.rb
-- lib/mailtime/processor.rb
+- lib/mailtime/processor/mail_log_service.rb
+- lib/mailtime/processor/processor.rb
 - lib/mailtime/railtie.rb
 - lib/mailtime/renderers/base_renderer.rb
+- lib/mailtime/renderers/erb_renderer.rb
 - lib/mailtime/version.rb
 - mailtime.gemspec
 homepage: https://github.com/joshmn/mailtime

data/lib/mailtime/processor.rb

@@ -1,39 +0,0 @@
-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