devmail 0.0.1 → 0.1.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011 YOURNAME
+Copyright 2012 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,3 +1,3 @@
 = Devmail
 
-This project rocks and uses MIT-LICENSE.
+Captures mails sent in development environment and displays them in a nice way.

data/Rakefile

@@ -1,25 +1,38 @@
-# encoding: UTF-8
-require 'rubygems'
+#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
 
-require 'rake'
-require 'rake/rdoctask'
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-Rake::RDocTask.new(:rdoc) do |rdoc|
+RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Devmail'
-  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

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

@@ -0,0 +1,16 @@
+// 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 bootstrap-tab
+//= require_tree .

data/app/assets/javascripts/devmail/messages.js

@@ -0,0 +1,6 @@
+$(document).ready(function() {
+  $('#format-select a').click(function (e) {
+    e.preventDefault();
+    $(this).tab('show');
+  });
+});

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

@@ -0,0 +1,12 @@
+/*
+*= require 'bootstrap'
+*/
+
+html, body { height: 100%; min-height: 100% }
+
+div#html iframe {
+  border: 1px solid #eee;
+  display: block;
+  width: 99%;
+  height: 300px;
+}

data/app/controllers/devmail/application_controller.rb

@@ -0,0 +1,4 @@
+module Devmail
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/devmail/messages_controller.rb

@@ -0,0 +1,23 @@
+require_dependency "devmail/application_controller"
+
+module Devmail
+  class MessagesController < ApplicationController
+    def index
+      @messages = Devmail.messages
+    end
+
+    def show
+      @message = Devmail.find_message(params[:id])
+    end
+
+    def html_part
+      @message = Devmail.find_message(params[:id])
+      render text: @message.html_part
+    end
+
+    def send_test
+      Sample.test.deliver
+      redirect_to action: :index
+    end
+  end
+end

data/app/helpers/devmail/application_helper.rb

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

data/app/helpers/devmail/messages_helper.rb

@@ -0,0 +1,4 @@
+module Devmail
+  module MessagesHelper
+  end
+end

data/app/mailers/devmail/sample.rb

@@ -0,0 +1,16 @@
+module Devmail
+  class Sample < ActionMailer::Base
+    default from: "from@example.com"
+  
+    # Subject can be set in your I18n file at config/locales/en.yml
+    # with the following lookup:
+    #
+    #   en.sample.test.subject
+    #
+    def test
+      @greeting = "Hi"
+  
+      mail to: "to@example.org"
+    end
+  end
+end

data/app/views/devmail/messages/index.html.erb

@@ -0,0 +1,11 @@
+<div class="row">
+  <div class="span12">
+    <h1>Messages</h1>
+    <ol>
+    <% @messages.each_with_index do |message, index| %>
+      <li><%= link_to message.summary, message_path(index) %></li>
+    <% end %>
+    </ol>
+    <p><%= @messages.inspect %></p>
+  </div>
+</div>

data/app/views/devmail/messages/show.html.erb

@@ -0,0 +1,60 @@
+<table class="table table-condensed">
+  <tr>
+    <th>To</th>
+    <td><%= @message.to.join(", ") %></td>
+  </tr>
+
+  <tr>
+    <th>CC</th>
+    <td><%= @message.cc.join(", ") %></td>
+  </tr>
+
+  <tr>
+    <th>BCC</th>
+    <td><%= @message.bcc.join(", ") %></td>
+  </tr>
+
+  <tr>
+    <th>From</th>
+    <td><%= @message.from.join(", ") %></td>
+  </tr>
+
+  <tr>
+    <th>Reply to</th>
+    <td><%= @message.reply_to %></td>
+  </tr>
+
+  <tr>
+    <th>Subject</th>
+    <td><%= @message.subject %></td>
+  </tr>
+
+<!--   <tr>
+    <th></th>
+    <td><%= %></td>
+  </tr>
+
+  <tr>
+    <th></th>
+    <td><%= %></td>
+  </tr>
+ -->
+</table>
+
+<ul class="nav nav-tabs" id="format-select">
+  <li class="active"><a href="#text" data-toggle="tab">Text</a></li>
+  <% if @message.multipart %>
+    <li><a href="#html" data-toggle="tab">HTML</a></li>
+  <% end %>
+</ul>
+
+<div class="tab-content">
+  <div class="tab-pane active" id="text">
+    <pre><%= @message.text_part %></pre>
+  </div>
+  <% if @message.multipart %>
+  <div class="tab-pane html-part-container" id="html">
+    <iframe src="<%= html_part_message_path(params[:id]) %>">
+  </div>
+  <% end %>
+</div>

data/app/views/devmail/sample/test.html.erb

@@ -0,0 +1,3 @@
+<h1>Test email</h1>
+<p>Sample paragraph</p>
+<pre>pre block</pre>

data/app/views/devmail/sample/test.text.erb

@@ -0,0 +1,3 @@
+Sample#test
+
+<%= @greeting %>, find me in app/views/app/views/devmail/sample/test.text.erb

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

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Devmail</title>
+  <%= stylesheet_link_tag    "devmail/application", :media => "all" %>
+  <%= javascript_include_tag "devmail/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="container">
+    <ul class="nav nav-pills">
+      <li class="<%= 'active' if action = 'index' %>">
+        <%= link_to "Messages", messages_path %>
+      </li>
+
+      <li>
+        <%= link_to "Send test message", send_test_messages_path %>
+      </li>
+    </ul>
+
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -1,6 +1,11 @@
-Rails.application.routes.draw do
-  resources :development_mails, :controller => 'devmail/development_mails', :only => [:index, :show, :destroy] do
-    get 'clear', :on => :collection
-    get 'html_part', :on => :member
+Devmail::Engine.routes.draw do
+  resources :messages do
+    get :send_test, on: :collection
+    get :html_part, on: :member
   end
+  root to: 'messages#index'
+end
+
+Rails.application.routes.draw do
+  mount Devmail::Engine => "/devmail"
 end

data/lib/devmail.rb

@@ -1,3 +1,47 @@
+require "mail"
+require "devmail/interceptor"
+require "devmail/engine"
+require "devmail/storage"
+require "devmail/message"
+
 module Devmail
-  require 'devmail/engine' if defined?(Rails)
+  def self.storage
+    @storage ||= Devmail::Storage.new
+  end
+
+  def self.store_message(message)
+    storage.add(process(message))
+  end
+
+  def self.messages
+    storage.all
+  end
+
+  def self.find_message(index)
+    storage.at(index.to_i)
+  end
+
+  private
+  def self.process(message)
+    dm = Message.new
+    dm.from = message.from.to_a
+    dm.to = message.to.to_a
+    dm.cc = message.cc.to_a
+    dm.bcc = message.bcc.to_a
+    dm.sender = message.sender.to_s
+    dm.reply_to = message.reply_to.to_s
+    dm.subject = message.subject.to_s
+    dm.multipart = message.multipart?
+
+    if message.multipart?
+      dm.text_part = message.text_part.decoded
+      dm.html_part = message.html_part.decoded
+    else
+      dm.text_part = message.decoded
+    end
+
+    dm.mailer_class = message.class.to_s
+
+    dm
+  end
 end

data/lib/devmail/engine.rb

@@ -1,11 +1,9 @@
-require "devmail"
-require "rails"
-require "mongoid"
-
 module Devmail
-  require 'devmail/development_mail_interceptor.rb'
-
-  class Engine < Rails::Engine
+  class Engine < ::Rails::Engine
+    isolate_namespace Devmail
 
+    initializer "devmail_interceptor" do
+      ActionMailer::Base.register_interceptor(Devmail::Interceptor) if Rails.env.development?
+    end
   end
 end

data/lib/devmail/interceptor.rb

@@ -0,0 +1,8 @@
+module Devmail
+  class Interceptor
+    def self.delivering_email(message)
+      Rails.logger.info message.inspect
+      Devmail.store_message(message)
+    end
+  end
+end

data/lib/devmail/message.rb

@@ -0,0 +1,9 @@
+module Devmail
+  class Message < Struct.new(:from, :to, :cc, :bcc, :sender, :reply_to,
+    :subject, :multipart, :text_part, :html_part, :mailer_class)
+
+    def summary
+      "#{from.join(', ')} to #{to.join(', ')}: #{subject}"
+    end
+  end
+end

data/lib/devmail/storage.rb

@@ -0,0 +1,35 @@
+require 'mail'
+require 'pstore'
+
+module Devmail
+  class Storage
+    def initialize
+      @store = PStore.new(File.join(Rails.root, "tmp", "devmail.pstore"))
+      @store.transaction { @store[:messages] = [] }
+    end
+
+    def all
+      @store.transaction { @store[:messages] }
+    end
+
+    def at(index)
+      @store.transaction { @store[:messages][index] }
+    end
+
+    def add(message)
+      @store.transaction { @store[:messages] << message }
+    end
+
+    def index(message)
+      @store.transaction { @store[:messages].index(message) }
+    end
+
+    def remove(message)
+      @store.transaction { @store[:messages].delete(message) }
+    end
+
+    def remove_at(index)
+      @store.transaction { @store[:messages].delete_at(index) }
+    end
+  end
+end

data/lib/devmail/version.rb

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

data/lib/tasks/devmail_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :devmail do
+#   # Task goes here
+# end

data/test/devmail_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class DevmailTest < ActiveSupport::TestCase
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.