inbox 0.0.1 → 0.2.0

data/README.md

@@ -0,0 +1,126 @@
+Inbox
+=====
+
+
+Description
+-----------
+
+* Preview send emails in development and test mode.
+
+* Test them using your standard Capybara matchers or
+any other testing framework that you prefer.
+
+
+Installation
+------------
+
+In your `Gemfile` add:
+
+```ruby
+gem 'inbox'
+```
+
+And run:
+
+```
+bundle install
+```
+
+
+Setup
+-----
+
+Mount engine in `config/routes.rb`
+
+```ruby
+Rails.application.routes.draw do
+  mount Inbox::Engine => "/inbox"
+end
+```
+
+Feel free to mount it under different route
+if this one is already taken in your application
+
+```ruby
+  mount Inbox::Engine => "/mailer"
+```
+
+
+Usage
+-----
+
+### Manual
+
+Navigate to `/inbox/<email>/emails` ex.: `/inbox/robert.pankowecki@gmail.com/emails`
+to see a list of emails that would have been delivered to the user.
+
+Click subject of the email to see its content
+
+### Testing framework
+
+In [capybara](https://github.com/jnicklas/capybara/) or [bbq](https://github.com/drugpl/bbq)
+
+```ruby
+visit("/inbox/robert.pankowecki@gmail.com/emails")
+click_link("Subject of the email")
+has_content?("This should be in email")
+click_link("Some link in the email ex. account activation link")
+```
+
+The nice thing is that this is just HTML page displaying email content so you can use
+your favorite testing framework (`BBQ`, `Capybara`, `Test::Unit`, `Spinach`, `Cucumber`, `RSpec`, whatever)
+for checking the content of page. And you can reuse your matchers.
+
+
+### Sending
+
+Navigate to `/inbox/<email>/emails/new` ex.: `/inbox/robert.pankowecki@gmail.com/emails/new`
+to see an ugly form for sending emails that you can use to play around and see if everything
+works fine.
+
+### Clear send emails
+
+```ruby
+  ActionMailer::Base.deliveries.clear # in :test mode
+  Inbox::FileDelivery.new(ActionMailer::Base.inbox_settings).clear # in :inbox mode
+```
+
+Async (distributed / queue)
+---------------------------
+
+In case you want to have acceptance tests of emails that are
+sent using external process (`resque`, `sidekiq`, ...) just set
+
+```ruby
+config.action_mailer.delivery_method = :inbox
+```
+
+in `config/environments/test.rb` and create `tmp/mails` directory.
+
+
+If you send emails from your Rails models, controllers, services or use-cases you can stick with:
+
+```ruby
+config.action_mailer.delivery_method = :test
+```
+
+
+Look & Feel
+-----------
+
+![Inbox gem look and feel](http://img832.imageshack.us/img832/1333/screenshotinboxgooglech.png)
+
+
+Inspirations
+------------
+
+* [https://github.com/37signals/mail_view](https://github.com/37signals/mail_view)
+* [https://github.com/ryanb/letter_opener](https://github.com/ryanb/letter_opener)
+* [https://github.com/suhrawardi/capybara_email/](https://github.com/suhrawardi/capybara_email/)
+* [https://github.com/pawelpacana/mail_inbox/](https://github.com/pawelpacana/mail_inbox/)
+* [http://api.rubyonrails.org/](http://api.rubyonrails.org/)
+
+License
+-------
+
+MIT-LICENSE

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

@@ -4,6 +4,5 @@
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
 // the compiled file.
 //
-//= require jquery
-//= require jquery_ujs
+
 //= require_tree .

data/app/assets/javascripts/inbox/emails.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/inbox/emails.css

@@ -0,0 +1,59 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+#message_headers {
+    width: 75%;
+    padding: 20px 0 20px 0;
+    margin: 0;
+    background: #fff;
+    font-size: 12px;
+    font-family: "Lucida Grande";
+    border-bottom: 1px solid #dedede;
+    overflow: hidden;
+    float: left;
+}
+
+#message_headers dl {
+    margin: 0;
+    padding: 0;
+}
+
+#message_headers dt {
+    width: 60px;
+    padding: 1px;
+    float: left;
+    text-align: right;
+    font-weight: bold;
+    color: #7f7f7f;
+}
+
+#message_headers dd {
+    margin-left: 70px;
+    padding: 1px;
+}
+
+#message_headers p.alternate {
+    position: absolute;
+    top: 0;
+    right: 15px;
+}
+
+#message_headers p.alternate a {
+    color: #09c;
+}
+
+pre#message_body {
+    padding: 10px;
+    white-space: pre-wrap;
+}
+
+.clear {
+    clear: both;
+    display: block;
+    overflow: hidden;
+    visibility: hidden;
+    width: 0;
+    height: 0;
+}

data/app/assets/stylesheets/inbox/panel.css.erb

@@ -0,0 +1,229 @@
+/* Panel (begin) */
+.panel
+{
+    float: left;
+    width: 25%;
+    height: 1000px;
+    top: 0;
+    left: 0;
+    background: #FFF;
+    font-family: "Helvetica Neue", "Arial", sans-serif;
+}
+
+/* Header with search box (begin) */
+.panel .header
+{
+    width: 100%;
+    height: 29px;
+    border-bottom: 1px solid #666;
+    position: relative;
+    left: 0; top: 0;
+    background: #e8e8e8;
+}
+
+.panel .header div
+{
+    margin: 0 7px;
+}
+.panel .header table
+{
+    height: 29px;
+    width: 100%;
+}
+
+.panel .header table td
+{
+    vertical-align: middle;
+    text-align: middle;
+}
+
+.panel .header label
+{
+    position: absolute;
+    font-size: 12px;
+    line-height: 29px;
+    margin-left: 3px;
+    color: #777;
+    cursor: text;
+}
+
+.panel .header table input
+{
+    width: 100%;
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    -webkit-box-sizing: border-box;
+    display: inline-block;
+    -webkit-appearance: searchfield;
+    height: 22px;
+    //height: auto;
+}
+
+/* Header with search box (end) */
+
+
+/* Results (begin) */
+.panel .result
+{
+
+    height: 1000px;
+    bottom: 0;
+    left: 0;
+    width: 100%;
+    
+    overflow-y: scroll;
+    overflow-x: hidden;
+    -overflow-y: hidden;
+    background: #EEE url(<%= image_path("inbox/results_bg.png") %>);
+    z-index: 2;
+    //zoom:1;
+}
+
+.panel .result ul
+{
+    font-size: 0.8em;
+    width: 100%;
+    background: #EEE url(<%= image_path("inbox/results_bg.png") %>);
+    //zoom:1;
+}
+
+.panel .result ul li
+{
+    height: 46px;
+    overflow: hidden;
+    padding: 4px 10px 0 10px;
+    cursor: pointer;
+}
+
+.panel .result ul li h1
+{
+    font-size: 13px;
+    font-weight: normal;
+    color: #333;
+    margin-bottom: 2px;
+    white-space: nowrap;
+}
+
+.panel .result ul li p
+{
+    font-size: 11px;
+    color: #333;
+    margin-bottom: 2px;
+    white-space: nowrap;
+}
+
+.panel .result ul li h1 i,
+.panel .result ul li p.snippet
+{
+    color: #777;
+}
+
+.panel .result ul li b
+{
+    color: #000;
+}
+
+.panel .result ul li.current
+{
+    background: #C52F24;
+}
+
+.panel .result ul li.current h1,
+.panel .result ul li.current p
+{
+    color: #D9D9D9;
+}
+
+.panel .result ul li.current h1 i,
+.panel .result ul li.current p.snippet
+{
+    color: #ACACAC;
+}
+
+.panel .result ul li.current b
+{
+    color: #FFF;
+}
+
+
+.panel .result ul li:hover,
+.panel .result ul li.selected
+{
+    background: #d0d0d0;
+}
+
+.panel .result ul li.current:hover
+{
+    background: #C52F24;
+}
+
+.panel .result ul li .badge
+{
+    margin-right: 0.4em;
+    margin-left: -0.2em;
+    padding: 0 0.2em;
+    color: #000;
+    border-radius: 3px;
+}
+
+.panel .result ul li .badge_1
+{
+    background: #ACDBF4;
+}
+
+.panel .result ul li.current .badge_1
+{
+    background: #97BFD7;
+}
+
+.panel .result ul li .badge_2
+{
+    background: #ACF3C3;
+}
+
+.panel .result ul li.current .badge_2
+{
+    background: #98D7AC;
+}
+
+.panel .result ul li .badge_3
+{
+    background: #E0F3AC;
+}
+
+.panel .result ul li.current .badge_3
+{
+    background: #C4D798;
+}
+
+.panel .result ul li .badge_4
+{
+    background: #D7CA98;
+}
+
+.panel .result ul li.current .badge_4
+{
+    background: #A6B0AC;
+}
+
+.panel .result ul li .badge_5
+{
+    background: #F3C8AC;
+}
+
+.panel .result ul li.current .badge_5
+{
+    background: #D7B198;
+}
+
+.panel .result ul li .badge_6
+{
+    background: #F3ACC3;
+}
+
+.panel .result ul li.current .badge_6
+{
+    background: #D798AB;
+}
+
+/* Panel (end) */

data/app/assets/stylesheets/inbox/reset.css

@@ -0,0 +1,53 @@
+/* http://meyerweb.com/eric/tools/css/reset/ */
+/* v1.0 | 20080212 */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+
+/* remember to define focus styles! */
+:focus {
+	outline: 0;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+	text-decoration: none;
+}
+del {
+	text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}

data/app/controllers/inbox/application_controller.rb

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

data/app/controllers/inbox/emails_controller.rb

@@ -0,0 +1,52 @@
+require 'mail'
+require 'pathname'
+
+module Inbox
+  class EmailsController < ApplicationController
+
+    layout 'inbox/inbox'
+    before_filter do
+      @mail = params[:mail]
+      mailer = case ActionMailer::Base.delivery_method
+      when :test
+        Mail::TestMailer
+      when :inbox
+        Inbox::FileDelivery.new ActionMailer::Base.inbox_settings
+      else
+        raise "ArgumentError"
+      end
+
+      @emails = mailer.deliveries.select{|e| Array.wrap(e.to).any?{|m| m.include?(@mail) } }.reverse
+    end
+
+    def index
+
+    end
+
+    def show
+      @email = @emails.find{|e| e.message_id == params[:id] }
+      @body_part = @email
+
+      if @email.multipart?
+        format = "." + (params[:format] || :html).to_s
+        content_type = Rack::Mime.mime_type(format)
+        @body_part = @email.parts.find { |part| part.content_type.match(content_type) } || @email.parts.first
+      end
+    end
+
+    def new
+      @email = Email.new()
+    end
+
+    def create
+      @email = Email.new(params[:email])
+      if @email.valid?
+        @email.deliver
+        redirect_to :action => :index
+      else
+        render :new
+      end
+    end
+
+  end
+end

data/app/helpers/inbox/emails_helper.rb

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

data/app/mailers/inbox/email_mailer.rb

@@ -0,0 +1,11 @@
+module Inbox
+  class EmailMailer < ActionMailer::Base
+#    default from: "from@example.com"
+
+    def normal(headers, body)
+      mail(headers) do |format|
+        format.html { render :text => body }
+      end
+    end
+  end
+end

data/app/models/inbox/email.rb

@@ -0,0 +1,51 @@
+module Inbox
+  class Email
+    extend   ::ActiveModel::Naming
+    extend   ::ActiveModel::Callbacks
+    extend   ::ActiveModel::Translation
+
+    include  ::ActiveModel::Conversion
+    include  ::ActiveModel::Validations
+    include  ::ActiveModel::Validations::Callbacks
+    include  ::ActiveModel::MassAssignmentSecurity
+#    include  ::ActiveModel::Warnings
+
+    PopularHeaders = [:from, :to, :cc, :bcc, :subject, :body, :reply_to]
+
+    attr_accessible *PopularHeaders
+
+    def initialize(attributes = {})
+      self.attributes = attributes
+    end
+
+    def attributes=(values)
+      values.stringify_keys!
+      @attributes = attributes.merge sanitize_for_mass_assignment(values)
+    end
+
+    def attributes
+      @attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+      @attributes.clone
+    end
+
+    PopularHeaders.each do |header|
+      define_method(header) do
+        attributes[header]
+      end
+
+      define_method(:"#{header}=") do |value|
+        attributes[header]= value
+      end
+    end
+
+    def persisted?
+      false
+    end
+
+    def deliver
+      body = attributes.delete('body')
+      EmailMailer.normal(attributes, body).deliver
+    end
+
+  end
+end

data/app/views/inbox/emails/new.html.erb

@@ -0,0 +1,9 @@
+<%= form_for(@email) do |f| %>
+  <%= f.text_field :from %>
+  <%= f.text_field :to %>
+  <%= f.text_field :cc %>
+  <%= f.text_field :bcc %>
+  <%= f.text_field :subject %>
+  <%= f.text_area :body %>
+  <%= f.submit %>
+<% end %>

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

@@ -0,0 +1,48 @@
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=<%= @body_part.charset %>" />
+</head>
+<div id="message_headers">
+  <dl>
+    <dt>From:</dt>
+    <dd><%= Array.wrap(@email.from).join(", ") %> &nbsp;</dd>
+
+    <dt>Subject:</dt>
+    <dd><strong><%= @email.subject %></strong> &nbsp;</dd>
+
+    <dt>Date:</dt>
+    <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %> &nbsp;</dd>
+
+    <dt>To:</dt>
+    <dd><%= Array.wrap(@email.to).join(", ") %> &nbsp;</dd>
+
+    <% if @email.cc.present? %>
+      <dt>Cc:</dt>
+      <dd><%= Array.wrap(@email.cc).join(", ") %> &nbsp;</dd>
+    <% end %>
+
+    <% if @email.bcc.present? %>
+      <dt>Bcc:</dt>
+      <dd><%= Array.wrap(@email.bcc).join(", ") %> &nbsp;</dd>
+    <% end %>
+  </dl>
+
+  <% if @email.multipart? %>
+    <p class="alternate">
+      <% if @body_part.content_type && @body_part.content_type.match(/text\/html/) %>
+        <a href="<%= :x %>.txt">View plain text version</a>
+      <% else %>
+        <a href="<%= :y %>.html">View HTML version</a>
+      <% end %>
+    </p>
+  <% end %>
+</div>
+
+<div id="message_body">
+  <% if @body_part.content_type && @body_part.content_type.match(/text\/html/) %>
+    <%= raw @body_part.body %>
+  <% else %>
+    <pre id="message_body">
+      <%= auto_link @body_part.body %>
+    </pre>
+  <% end %>
+</div>

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

@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Inbox</title>
-  <%= stylesheet_link_tag    "inbox/application" %>
-  <%= javascript_include_tag "inbox/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Inbox</title>
+    <%= stylesheet_link_tag    "inbox/application" %>
+    <%= javascript_include_tag "inbox/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
 
-<%= yield %>
+    <%= tmp = yield :application %>
+    <%= yield if tmp.blank? %>
 
-</body>
+  </body>
 </html>