maily 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle/
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    maily (0.0.1)
+      rails (~> 3.2.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    columnize (0.3.6)
+    debugger (1.6.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.2)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    multi_json (1.8.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  maily!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,44 @@
+Maily
+==============
+
+**[IN PROGRESS: working, but not ready for first release]**
+
+Rails Engine to preview, follow up, test and edit application emails.
+
+## Installation
+Add this line to you Gemfile:
+
+```
+gem 'maily'
+```
+
+Run generator:
+
+```
+rails g maily:install
+```
+
+This installator mounts the engine:
+```
+mount Maily::Engine, at: 'maily'
+```
+
+And adds an initializer to customize some settings and define hooks.
+
+## Hooks
+Hooks are used to collect data for emails:
+
+```ruby
+user = User.new(email: 'user@example.com')
+comment = Comment.new(body: 'Lorem ipsum')
+service = Service.new(price: '100USD')
+
+Maily.hooks_for('Notifier') do |mailer|
+  mailer.register_hook(:welcome, user)
+  mailer.register_hook(:new_comment, user, comment)
+end
+
+Maily.hooks_for('PaymentNotifier') do |mailer|
+  mailer.register_hook(:invoice, user, service)
+end
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/maily/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/maily/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/maily/application_controller.rb

@@ -0,0 +1,14 @@
+module Maily
+  class ApplicationController < Maily.base_controller.constantize
+
+    before_filter :maily_enabled?
+
+    layout 'maily/application'
+
+    private
+
+    def maily_enabled?
+      Maily.enabled || raise('Maily: engine disabled!')
+    end
+  end
+end

data/app/controllers/maily/emails_controller.rb

@@ -0,0 +1,67 @@
+module Maily
+  class EmailsController < ApplicationController
+
+    before_filter :allowed_action?, only: [:edit, :update, :deliver]
+    before_filter :load_mailer_and_email, except: [:index, :edit, :update]
+    around_filter :perform_with_locale, only: [:show, :raw, :deliver]
+
+    def index
+      @mailers = Maily::Mailer.all
+    end
+
+    def show
+    end
+
+    def raw
+      content = if @email.parts.present?
+        params[:part] == 'text' ? @email.text_part.body : @email.html_part.body
+      else
+        @email.body
+      end
+
+      render text: content, layout: false
+    end
+
+    def attachment
+      attachment = @email.attachments.find { |elem| elem.filename == params[:attachment] }
+      send_data attachment.body, filename: attachment.filename, type: attachment.content_type
+    end
+
+    def edit
+      @email = File.read("#{Rails.root}/app/views/#{params[:mailer]}/#{params[:method]}.html.erb")
+    end
+
+    def update
+      @email = File.open("#{Rails.root}/app/views/#{params[:mailer]}/#{params[:method]}.html.erb", 'w') do |f|
+        f.write(params[:body])
+      end
+
+      redirect_to maily_email_path(mailer: params[:mailer], method: params[:method])
+    end
+
+    def deliver
+      @email.to = params[:to]
+
+      @email.deliver
+
+      redirect_to maily_email_path(mailer: params[:mailer], method: params[:method])
+    end
+
+    private
+
+    def allowed_action?
+      Maily.allowed_action?(action_name) || raise("Maily: action #{action_name} not allowed!")
+    end
+
+    def load_mailer_and_email
+      @mailer = Maily::Mailer.find(params[:mailer])
+      @email = @mailer.find_email(params[:method]).call
+    end
+
+    def perform_with_locale
+      I18n.with_locale(params[:locale]) do
+        yield
+      end
+    end
+  end
+end

data/app/helpers/maily/application_helper.rb

@@ -0,0 +1,4 @@
+module Maily
+  module ApplicationHelper
+  end
+end

data/app/helpers/maily/emails_helper.rb

@@ -0,0 +1,4 @@
+module Maily
+  module EmailsHelper
+  end
+end

data/app/views/layouts/maily/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Maily</title>
+  <%= stylesheet_link_tag    "maily/application", :media => "all" %>
+  <%= javascript_include_tag "maily/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+<hr/>
+<%= link_to "Maily v#{Maily::VERSION}", 'https://github.com/markets/maily' %>
+
+</body>
+</html>

data/app/views/maily/emails/edit.html.erb

@@ -0,0 +1,12 @@
+<h1><%= "Editing: #{params[:mailer].humanize} > #{params[:method].humanize}" %></h1>
+
+<p>
+  <%= link_to 'Return to list', root_path %> |
+  <%= link_to 'Show', maily_email_path(mailer: params[:mailer], method: params[:method]) %>
+</p>
+
+<h2>Body</h2>
+<%= form_tag(update_maily_email_path(mailer: params[:mailer], method: params[:method]), method: :put) do %>
+  <%= text_area_tag :body, @email, cols: 80, rows: 30 %>
+  <p><%= submit_tag 'Update' %></p>
+<% end %>

data/app/views/maily/emails/index.html.erb

@@ -0,0 +1,10 @@
+<h1>Emails list</h1>
+
+<ul>
+  <% @mailers.each do |mailer| %>
+  <h2><%= mailer.name.humanize %></h2>
+    <% mailer.emails.each do |email| %>
+      <li><%= link_to email.name.humanize, maily_email_path(mailer: mailer.name, method: email.name) %></li>
+    <% end %>
+  <% end %>
+</ul>

data/app/views/maily/emails/show.html.erb

@@ -0,0 +1,43 @@
+<h1><%= "#{params[:mailer].humanize} > #{params[:method].humanize}" %></h1>
+
+<p>
+  <%= link_to 'Return to list', root_path %> |
+  <%= link_to 'Edit', edit_maily_email_path(mailer: params[:mailer], method: params[:method]) %>
+</p>
+
+<h2>Send</h2>
+<%= form_tag(deliver_maily_email_path(mailer: params[:mailer], method: params[:method], locale: params[:locale]), method: :post) do %>
+  <%= label_tag 'To:' %>
+  <%= email_field_tag :to %>
+  <%= submit_tag 'Send' %>
+<% end %>
+
+<h2>Languages</h2>
+<p>
+  <% Maily.available_locales.each do |locale| %>
+    <%= link_to locale, url_for(params.merge(locale: locale)) %>
+  <% end %>
+</p>
+
+<h2>Details</h2>
+<ul>
+  <li>Subject: <%= @email.subject %></li>
+  <li>From: <%= @email.from %></li>
+  <li>To: <%= @email.to %></li>
+  <li>Cc: <%= @email.cc %></li>
+  <li>Bcc: <%= @email.bcc %></li>
+</ul>
+
+<p>
+  <%= link_to 'HTML', url_for(params.merge(part: 'html')) if @email.html_part %>
+  <%= link_to 'TEXT', url_for(params.merge(part: 'text')) if @email.text_part %>
+  <% if @email.attachments.present? %>
+    <% @email.attachments.each do |attachment| %>
+      <%= link_to attachment.filename, attachment_maily_email_path(mailer: params[:mailer], method: params[:method], attachment: attachment.filename) %>
+    <% end %>
+  <% end %>
+</p>
+
+<% if @email.html_part || @email.text_part || @email.body.present? %>
+  <iframe src="<%= raw_maily_email_path(mailer: params[:mailer], method: params[:method], locale: params[:locale], part: params[:part]) %>" frameborder="1" height="100%" width="100%"></iframe>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Maily::Engine.routes.draw do
+  get  ':mailer/:method'            => 'emails#show',       as: :maily_email
+  get  ':mailer/:method/raw'        => 'emails#raw',        as: :raw_maily_email
+  get  ':mailer/:method/edit'       => 'emails#edit',       as: :edit_maily_email
+  put  ':mailer/:method'            => 'emails#update',     as: :update_maily_email
+  post ':mailer/:method/deliver'    => 'emails#deliver',    as: :deliver_maily_email
+  get  ':mailer/:method/attachment' => 'emails#attachment', as: :attachment_maily_email
+
+  root :to => 'emails#index'
+end

data/lib/generators/maily/install_generator.rb

@@ -0,0 +1,43 @@
+module Maily
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Maily installation: route and initializer'
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def install
+        generate_routing
+        build_initializer
+      end
+
+      private
+
+      def generate_routing
+        route "mount Maily::Engine, at: 'maily'"
+      end
+
+      def build_initializer
+        template 'initializer.rb', 'config/initializers/maily.rb'
+
+        hooks = []
+        fixtures = []
+
+        Maily::Mailer.all.each do |mailer|
+          hooks << "# Maily.hooks_for('#{mailer.name.classify}') do |mailer|"
+          mailer.emails.each do |email|
+            if email.require_hook?
+              fixtures << email.required_arguments
+              hooks << "#   mailer.register_hook(:#{email.name}, #{email.required_arguments.join(', ')})"
+            end
+          end
+          hooks << "# end\n"
+        end
+
+        inject_into_file "config/initializers/maily.rb", after: "end\n" do
+          "\n" + fixtures.flatten.uniq.map{ |f| f = "# #{f.to_s} = ''" }.join("\n") +
+          "\n" + hooks.join("\n")
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,18 @@
+Maily.init!
+
+# Maily.setup do |config|
+  # On/off engine. True by default
+  # config.enabled           = Rails.env.production? ? false : true
+
+  # Allow views edition. True by default
+  # config.allow_edition     = Rails.env.production? ? false : true
+
+  # Allow deliveries. True by default
+  # config.allow_delivery    = Rails.env.production? ? false : true
+
+  # I18n.available_locales by default
+  # config.available_locales = [:en, :es, :pt, :fr]
+
+  # 'ActionController::Base' by default
+  # config.base_controller   = 'FooController'
+# end

data/lib/maily.rb

@@ -0,0 +1,45 @@
+require 'maily/engine'
+require 'maily/version'
+require 'maily/mailer'
+require 'maily/email'
+
+module Maily
+  class << self
+
+    attr_accessor :enabled, :allow_edition, :allow_delivery, :available_locales, :base_controller
+
+    def init!
+      self.enabled           = true
+      self.allow_edition     = true
+      self.allow_delivery    = true
+      self.available_locales = I18n.available_locales
+      self.base_controller   = 'ActionController::Base'
+    end
+
+    def build_emails
+      Dir[Rails.root + 'app/mailers/*.rb'].each do |mailer|
+        klass   = File.basename(mailer, '.rb')
+        methods = klass.camelize.constantize.send(:instance_methods, false)
+        Maily::Mailer.new(klass, methods)
+      end
+    end
+
+    def hooks_for(mailer_name)
+      mailer = Maily::Mailer.find(mailer_name.underscore)
+      yield(mailer) if block_given?
+    end
+
+    def setup
+      yield(self)
+    end
+
+    def allowed_action?(action)
+      case action.to_sym
+      when :edit, :update
+        allow_edition
+      when :deliver
+        allow_delivery
+      end
+    end
+  end
+end

data/lib/maily/email.rb

@@ -0,0 +1,36 @@
+module Maily
+  class Email
+
+    attr_accessor :name, :mailer, :arguments
+
+    def initialize(name, mailer)
+      self.name      = name.to_s
+      self.mailer    = mailer
+      self.arguments = nil
+    end
+
+    def require_hook?
+      mailer_klass.instance_method(name).parameters.any?
+    end
+
+    def required_arguments
+      mailer_klass.instance_method(name).parameters.map(&:last)
+    end
+
+    def register_hook(*args)
+      self.arguments = args.flatten
+    end
+
+    def mailer_klass_name
+      mailer.camelize
+    end
+
+    def mailer_klass
+      mailer_klass_name.constantize
+    end
+
+    def call
+      mailer_klass.send(name, *arguments)
+    end
+  end
+end

data/lib/maily/engine.rb

@@ -0,0 +1,6 @@
+module Maily
+  class Engine < ::Rails::Engine
+    isolate_namespace Maily
+    load_generators
+  end
+end

data/lib/maily/mailer.rb

@@ -0,0 +1,38 @@
+module Maily
+  class Mailer
+
+    cattr_accessor :collection
+    attr_accessor :name, :emails
+
+    def initialize(name, methods)
+      self.collection ||= []
+      self.name       = name
+      self.emails     = self.class.build_emails(methods, name)
+      self.collection << self
+    end
+
+    def self.all
+      Maily.build_emails if collection.nil?
+      collection
+    end
+
+    def self.find(mailer_name)
+      all.find { |mailer| mailer.name == mailer_name }
+    end
+
+    def self.build_emails(methods, mailer)
+      methods.map do |email|
+        Maily::Email.new(email, mailer)
+      end
+    end
+
+    def register_hook(email_name, *args)
+      email = find_email(email_name)
+      email.register_hook(args)
+    end
+
+    def find_email(email_name)
+      emails.find { |email| email.name == email_name.to_s }
+    end
+  end
+end

data/lib/maily/version.rb

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

data/maily.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "maily/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "maily"
+  s.version       = Maily::VERSION
+  s.authors       = ["markets"]
+  s.email         = ["srmarc.ai@gmail.com"]
+  s.homepage      = "https://github.com/markets/maily"
+  s.summary       = "Rails Engine to follow up application emails."
+  s.description   = "Rails Engine to follow up application emails."
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", ">= 3.0.0"
+
+  s.add_development_dependency 'debugger'
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/maily/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: maily
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- markets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails Engine to follow up application emails.
+email:
+- srmarc.ai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/images/maily/.gitkeep
+- app/assets/javascripts/maily/application.js
+- app/assets/stylesheets/maily/application.css
+- app/controllers/maily/application_controller.rb
+- app/controllers/maily/emails_controller.rb
+- app/helpers/maily/application_helper.rb
+- app/helpers/maily/emails_helper.rb
+- app/views/layouts/maily/application.html.erb
+- app/views/maily/emails/edit.html.erb
+- app/views/maily/emails/index.html.erb
+- app/views/maily/emails/show.html.erb
+- config/routes.rb
+- lib/generators/maily/install_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/maily.rb
+- lib/maily/email.rb
+- lib/maily/engine.rb
+- lib/maily/mailer.rb
+- lib/maily/version.rb
+- maily.gemspec
+- script/rails
+homepage: https://github.com/markets/maily
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rails Engine to follow up application emails.
+test_files: []