active_admin_mail 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c190a664c47a7c4795e365642d6a995b8d67ec85
+  data.tar.gz: d12ea2c424ce7b7367c9417297ec379996818dee
+SHA512:
+  metadata.gz: 6093a2d18316de77a443318257e562df084cdffa5139e4e3f482c10e1885958fd91afcb87373ac5ef630e104b8458fe3d7fd2594c0be5c6524e5577f2982f1ae
+  data.tar.gz: 36d3c1b94369b679faef009ea4e5a6c77790ca9a5b183a99b0dc98a83cb9ad6c1eb9f0d0aea07a892710e98273b8ecb432e17dda32f1dd128015e60606b08f95

data/.gitignore

@@ -0,0 +1,51 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'liquid', '~> 3.0.0'

data/README.md

@@ -0,0 +1,36 @@
+# active_admin_mail
+Manage the emails you send and your ActionMailer mailers with ActiveAdmin 
+
+# Installation
+
+# Usage
+
+```
+class UserMailer < ActionMailer::Base
+
+  def new_partnership(user)
+    @user = user
+    active_admin_mail(to: @user.email)
+  end
+
+end
+```
+
+active_admin_mail internally...
+
+* Looks up the mail template in the database via `find_by(:klass => 'UserMailer', :action => 'new_partnership')`
+* Parses that mail template into liquid to render
+* Parses the instance variables in the action that don't start with @_ to a mapped liquid hash like `{ 'user' => { 'id' => 1 }`
+* Sends the email using ActionMailer#mail
+* Logs the email 
+
+# Todo
+
+* Mail layouts
+* Filters for active_admin
+* txt and html 
+* Wysiwyg?
+* Preview?
+* Fallback?
+* CC, BCC per mailer?
+* callbacks?

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/active_admin_mail.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_admin_mail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_admin_mail"
+  spec.version       = ActiveAdminMail::VERSION
+  spec.authors       = ["Josh Brody"]
+  spec.email         = ["josh@josh.mn"]
+
+  spec.summary       = %q{Manage your ActionMailer mail templates from ActiveAdmin, and log them.}
+  spec.description   = %q{Manage your ActionMailer mail templates from ActiveAdmin, and log them.}
+  spec.homepage      = "https://github.com/joshmn/active_admin_mail"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'liquid', '~> 3.0.0'
+  spec.add_runtime_dependency 'activeadmin', '~> 1.0.0'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+end

data/bin/console

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

@@ -0,0 +1,52 @@
+require 'active_admin_mail/mail_builder'
+require 'active_admin_mail/mail_template'
+require 'active_admin_mail/mail_log'
+
+begin
+  require 'rails/engine'
+  require 'active_admin_mail/engine'
+rescue LoadError
+
+end
+
+module ActiveAdminMail
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :mail_classes
+
+    def initialize
+      @mail_classes = []
+    end
+  end
+
+  protected
+  def self.find_user_by(attr = :email, value = nil)
+    User.find_by(attr => value)
+  end
+
+  def self.create_mail_log(from, mail_result)
+    ActiveAdminMail::MailLog.create(
+        :user => from.instance_variable_get(:@user).nil? ? ActiveAdminMail.find_user_by(:email, mail_result.to.first) : from.instance_variable_get(:@user),
+        :active_admin_mail_template_id => from.instance_variable_get(:@_mail_template).id,
+        :action => from.action_name,
+        :klass => from.class.to_s,
+        :headers => self.parsed_headers(mail_result).to_json
+    )
+  end
+
+  def self.parsed_headers(mail_result)
+    headers = {}
+    mail_result.header_fields.map { |k| headers[k.name] = k.value }
+    headers
+  end
+
+end

data/lib/active_admin_mail/engine.rb

@@ -0,0 +1,14 @@
+module ActiveAdminMail
+  class Engine < Rails::Engine
+    isolate_namespace ActiveAdminMail
+
+    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

data/lib/active_admin_mail/mail_builder.rb

@@ -0,0 +1,35 @@
+module ActiveAdminMail
+  class MailBuilder
+
+    def initialize(source, template)
+      @source = source
+      @template = template
+    end
+
+    def render
+      @render ||= parsed_mailer.render(liquid_variables_map)
+    end
+
+    protected
+
+    # creates a hash for liquid templating within your mailer
+    # removes the @instance_variable @ to build it into a standard hash for liquid
+    # like { 'user' => { 'id' => 1 }
+    def liquid_variables_map
+      liquid_variables = {}
+      permitted_instance_variables.each do |v|
+        liquid_variables[v.to_s[1 .. -1]] = @source.instance_variable_get(v)
+      end
+      liquid_variables.as_json
+    end
+
+    def parsed_mailer
+      @parsed_mailer ||= Liquid::Template.parse(@template.content)
+    end
+
+    def permitted_instance_variables
+      @source.instance_variables.select { |v| !v.to_s.start_with?("@_") }
+    end
+
+  end
+end

data/lib/active_admin_mail/mail_log.rb

@@ -0,0 +1,6 @@
+module ActiveAdminMail
+  class MailLog < ActiveRecord::Base
+    self.table_name = 'active_admin_mail_logs'
+    belongs_to :user
+  end
+end

data/lib/active_admin_mail/mail_template.rb

@@ -0,0 +1,41 @@
+# == Schema Information
+#
+# Table name: mail_templates
+#
+#  id         :integer          not null, primary key
+#  subject    :string
+#  content    :string
+#  klass      :string
+#  action     :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+module ActiveAdminMail
+  class MailTemplate < ActiveRecord::Base
+
+    self.table_name = 'active_admin_mail_templates'
+
+    validates_presence_of :klass, :in => -> { rails_mailers }
+    validates_uniqueness_of :action, :scope => :klass
+
+    def additional_headers
+      headers = {}
+      headers[:subject] = self.subject if self.subject.present?
+      headers
+    end
+
+    def self.rails_mailers
+      ActiveAdminMail.configuration.mail_classes
+    end
+
+    def self.mail_actions
+      rails_mailers.collect { |mailer| [mailer, mailer.constantize.public_instance_methods(false)] }
+    end
+
+    Kaminari.configure do |config|
+      config.page_method_name = :per_page_kaminari
+    end
+
+  end
+end

data/lib/active_admin_mail/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdminMail
+  VERSION = '0.1'
+end

data/lib/generators/active_admin_mail/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Copies default ActiveAdmin pages for MailTemplate and MailLog to app/your_active_admin_namespace/active_admin_mail
+
+Example:
+    rails generate active_admin_mail:install [admin_path]
+
+    admin_path defaults to admin
+
+    This will create:
+        app/admin/active_admin_mail/mail_log.rb
+        app/admin/active_admin_mail/mail_template.rb
+    
+      and add a migration of:
+        1_active_admin_mail_migration.rb

data/lib/generators/active_admin_mail/install_generator.rb

@@ -0,0 +1,16 @@
+module ActiveAdminMail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Copies default ActiveAdmin pages for MailTemplate and MailLog to app/admin/active_admin_mail."
+
+      argument :admin_namespace, required: false, default: "admin"
+
+      def copy_initializer_file
+        copy_file "mail_log.rb", "app/#{admin_namespace}/active_admin_mail/mail_log.rb"
+        copy_file "mail_template.rb", "app/#{admin_namespace}/active_admin_mail/mail_template.rb"
+        copy_file "db/migrate/1_active_admin_mail_migration.rb", "db/migrate/1_active_admin_mail_migration.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_admin_mail/templates/db/migrate/1_active_admin_mail_migration.rb

@@ -0,0 +1,30 @@
+class ActiveAdminMailMigration < ActiveRecord::Migration
+  def change
+    create_table :active_admin_mail_templates do |t|
+      t.string :klass
+      t.string :action
+      t.text :content
+      t.text :subject
+
+      t.timestamps null: false
+    end
+    add_index :active_admin_mail_templates, :klass
+    add_index :active_admin_mail_templates, :action
+
+    create_table :active_admin_mail_logs do |t|
+      t.integer :active_admin_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 :active_admin_mail_logs, :active_admin_mail_template_id
+    add_index :active_admin_mail_logs, :template
+    add_index :active_admin_mail_logs, :action
+    add_index :active_admin_mail_logs, :klass
+    add_index :active_admin_mail_logs, :user_id
+  end
+end

data/lib/generators/active_admin_mail/templates/mail_log.rb

@@ -0,0 +1,3 @@
+ActiveAdmin.register ActiveAdminMail::MailLog do
+  menu :label => "Log", :parent => "Mail"
+end

data/lib/generators/active_admin_mail/templates/mail_template.rb

@@ -0,0 +1,15 @@
+ActiveAdmin.register ActiveAdminMail::MailTemplate do
+  menu :label => "Templates", :parent => "Mail"
+
+  permit_params :klass, :action, :subject, :content
+
+  form do |f|
+    f.inputs do
+      f.input :klass
+      f.input :action, :collection => ActiveAdminMail::MailTemplate.mail_actions, :input_html => { :onchange => '$("#active_admin_mail_mail_template_klass").val($("#active_admin_mail_mail_template_action option:selected").closest("optgroup").attr("label"));' }
+      f.input :subject
+      f.input :content, :as => :text
+    end
+    actions
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: active_admin_mail
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Manage your ActionMailer mail templates from ActiveAdmin, and log them.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- active_admin_mail.gemspec
+- bin/console
+- bin/setup
+- lib/.DS_Store
+- lib/active_admin_mail.rb
+- lib/active_admin_mail/engine.rb
+- lib/active_admin_mail/mail_builder.rb
+- lib/active_admin_mail/mail_log.rb
+- lib/active_admin_mail/mail_template.rb
+- lib/active_admin_mail/version.rb
+- lib/generators/.DS_Store
+- lib/generators/active_admin_mail/.DS_Store
+- lib/generators/active_admin_mail/USAGE
+- lib/generators/active_admin_mail/install_generator.rb
+- lib/generators/active_admin_mail/templates/.DS_Store
+- lib/generators/active_admin_mail/templates/db/.DS_Store
+- lib/generators/active_admin_mail/templates/db/migrate/1_active_admin_mail_migration.rb
+- lib/generators/active_admin_mail/templates/mail_log.rb
+- lib/generators/active_admin_mail/templates/mail_template.rb
+homepage: https://github.com/joshmn/active_admin_mail
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Manage your ActionMailer mail templates from ActiveAdmin, and log them.
+test_files: []