letter_opener_web 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in letter_opener_web.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem 'debugger'
+
+gem 'rb-inotify', '~> 0.8.8'
+gem 'guard'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fabio Rehm
+
+MIT License
+
+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,41 @@
+# LetterOpenerWeb
+
+Gives [letter_opener](https://github.com/ryanb/letter_opener) an interface for
+browsing sent emails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'letter_opener_web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install letter_opener_web
+
+## Usage
+
+Add to your routest.rb:
+
+```ruby
+if Rails.env.development?
+  mount LetterOpenerWeb::Engine, at: "/letter_opener"
+end
+```
+
+## Credits
+
+Part of the code was based on [this pull request](https://github.com/ryanb/letter_opener/pull/12)
+by [@alexrothenberg](https://github.com/alexrothenberg).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+
+desc 'Print out all defined routes in match order, with names. Target specific controller with CONTROLLER=x.'
+task :routes do
+  require 'combustion'
+  Bundler.require :default, :development
+
+  Combustion.initialize! :action_controller, :action_view, :sprockets, :action_mailer
+
+  all_routes = LetterOpenerWeb::Engine.routes.routes
+
+  require 'rails/application/route_inspector'
+  inspector = Rails::Application::RouteInspector.new
+  puts inspector.format(all_routes, ENV['CONTROLLER']).join "\n"
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LetterOpenerWeb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError; end

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

@@ -0,0 +1,23 @@
+// 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-1.8.3.min
+//= require_tree .
+
+jQuery(function($) {
+  $('.letter-opener tr').click(function() {
+    var $this = $(this);
+    $('iframe').attr('src', $this.find('a').attr('href'));
+    $this.parent().find('.active').removeClass('active');
+    $this.addClass('active');
+  });
+});

data/app/assets/stylesheets/letter_opener_web/application.css.erb

@@ -0,0 +1,32 @@
+/*
+ *= require bootstrap.min
+ *= require_self
+ *= require_tree .
+ */
+
+.container-fluid {
+  padding-top: 20px;
+}
+
+iframe {
+  width: 100%;
+  min-height: 400px;
+  border: solid 1px #ccc;
+}
+
+.letter-opener .active,
+.letter-opener .active:hover td {
+  background: #ccc;
+}
+
+.letter-opener tr {
+  cursor: pointer;
+}
+
+[class^="icon-"], [class*=" icon-"] {
+  background-image: url(<%=asset_path "glyphicons-halflings.png"%>);
+}
+
+.icon-white {
+  background-image: url(<%=asset_path "glyphicons-halflings-white.png"%>);
+}

data/app/controllers/letter_opener_web/application_controller.rb

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

data/app/controllers/letter_opener_web/letters_controller.rb

@@ -0,0 +1,22 @@
+require_dependency "letter_opener_web/application_controller"
+
+module LetterOpenerWeb
+  class LettersController < ApplicationController
+    def index
+      @letters = Letter.search
+    end
+
+    def show
+      letter = Letter.find(params[:id])
+      text   = letter.send("#{params[:style]}_text").
+        gsub(/"plain\.html"/, "\"#{letter_path(id: letter.id, style: 'plain')}\"").
+        gsub(/"rich\.html"/, "\"#{letter_path(id: letter.id, style: 'rich')}\"")
+      render text: text
+    end
+
+    def clear
+      Letter.destroy_all
+      redirect_to letters_path
+    end
+  end
+end

data/app/helpers/letter_opener_web/application_helper.rb

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

data/app/models/letter_opener_web/letter.rb

@@ -0,0 +1,47 @@
+module LetterOpenerWeb
+  class Letter
+    cattr_accessor :letters_location do
+      Rails.root.join("tmp", "letter_opener")
+    end
+
+    attr_reader :id, :sent_at
+
+    def self.search
+      letters = Dir.glob("#{letters_location}/*").map do |folder|
+        new :id => File.basename(folder), :sent_at => File.mtime(folder)
+      end
+      letters.sort_by(&:sent_at).reverse
+    end
+
+    def self.find(id)
+      new id: id
+    end
+
+    def self.destroy_all
+      FileUtils.rm_rf(letters_location)
+    end
+
+    def initialize(params)
+      @id      = params.fetch(:id)
+      @sent_at = params[:sent_at]
+    end
+
+    def plain_text
+      @plain_text ||= read_file(:plain)
+    end
+
+    def rich_text
+      @rich_text ||= read_file(:rich)
+    end
+
+    def to_param
+      id
+    end
+
+    private
+
+    def read_file(style)
+      File.read("#{letters_location}/#{id}/#{style}.html")
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>LetterOpenerWeb</title>
+  <%= stylesheet_link_tag    "letter_opener_web/application", :media => "all" %>
+  <%= javascript_include_tag "letter_opener_web/application" %>
+  <%= javascript_include_tag 'https://raw.github.com/indirect/jquery-rails/master/vendor/assets/javascripts/jquery_ujs.js' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+  <%= yield %>
+
+</body>
+</html>

data/app/views/letter_opener_web/letters/index.html.erb

@@ -0,0 +1,43 @@
+<div class="container-fluid">
+  <div class="row-fluid">
+    <div class="span5">
+      <h1>
+        Letters
+        <%= link_to clear_letters_path, method: 'delete', confirm: 'Are you sure?', class: 'btn btn-danger pull-right' do %>
+          <i class="icon-trash icon-white"></i>
+          Clear
+        <% end %>
+      </h1>
+      <table class="table table-hover letter-opener">
+        <thead>
+          <tr>
+            <th>ID</th>
+            <th>Sent at</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% if first_letter = @letters.pop %>
+            <tr class="active">
+              <td>
+                <%= link_to(first_letter.id, letter_path(first_letter, style: 'rich'), target: 'mail') %>
+              </td>
+              <td><%= first_letter.sent_at %></td>
+            </tr>
+          <% end %>
+          <% @letters.each do |letter| %>
+            <tr>
+              <td>
+                <%= link_to(letter.id, letter_path(letter, style: 'rich'), target: 'mail') %>
+              </td>
+              <td><%= letter.sent_at %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+    <div class="span7">
+      <h1>Content</h1>
+      <iframe name="mail" id="mail" src="<%= first_letter.present? ? letter_path(first_letter, style: 'rich') : 'about:blank' %>"></iframe>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,5 @@
+LetterOpenerWeb::Engine.routes.draw do
+  delete 'clear'        => 'letters#clear', as: :clear_letters
+  get    '/'            => 'letters#index', as: :letters
+  get    ':id(/:style)' => 'letters#show',  as: :letter
+end

data/config.ru

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+Bundler.require :default, :development
+
+Combustion.initialize! :action_controller, :action_view, :sprockets, :action_mailer
+
+run Combustion::Application

data/letter_opener_web.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'letter_opener_web/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "letter_opener_web"
+  gem.version       = LetterOpenerWeb::VERSION
+  gem.authors       = ["Fabio Rehm"]
+  gem.email         = ["fgrehm@gmail.com"]
+  gem.description   = %q{Gives letter_opener an interface for browsing sent emails}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/fgrehm/letter_opener_web"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails', '~> 3.2'
+  gem.add_dependency 'letter_opener', '~> 1.0'
+
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'shoulda-matchers'
+  gem.add_development_dependency 'combustion', '~> 0.3.1'
+end

data/lib/letter_opener_web/engine.rb

@@ -0,0 +1,7 @@
+require 'letter_opener'
+
+module LetterOpenerWeb
+  class Engine < ::Rails::Engine
+    isolate_namespace LetterOpenerWeb
+  end
+end

data/lib/letter_opener_web/version.rb

@@ -0,0 +1,3 @@
+module LetterOpenerWeb
+  VERSION = "0.0.1"
+end

data/lib/letter_opener_web.rb

@@ -0,0 +1,4 @@
+require "letter_opener_web/engine"
+
+module LetterOpenerWeb
+end

data/lib/tasks/letter_opener_web_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :letter_opener_web do
+#   # Task goes here
+# 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/letter_opener_web/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/controllers/letter_opener_web/letters_controller_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe LetterOpenerWeb::LettersController do
+  describe 'GET index' do
+    before do
+      LetterOpenerWeb::Letter.stub(search: :all_letters)
+      get :index
+    end
+    it { should assign_to(:letters).with(:all_letters) }
+  end
+
+  describe 'GET show' do
+    let(:id)         { 'an-id' }
+    let(:rich_text)  { "rich text href=\"plain.html\"" }
+    let(:plain_text) { "plain text href=\"rich.html\"" }
+    let(:letter)     { mock(:letter, rich_text: rich_text, plain_text: plain_text, id: id) }
+
+    before do
+      LetterOpenerWeb::Letter.stub(find: letter)
+    end
+
+    context 'rich text version' do
+      before { get :show, id: id, style: 'rich' }
+
+      it "returns letter's rich text contents" do
+        response.body.should =~ /^rich text/
+      end
+
+      it 'fixes plain text link' do
+        response.body.should_not =~ /href="plain.html"/
+        response.body.should =~ /href="#{Regexp.escape letter_path(id: letter.id, style: 'plain')}"/
+      end
+    end
+
+    context 'plain text version' do
+      before { get :show, id: id, style: 'plain' }
+
+      it "returns letter's plain text contents" do
+        response.body.should =~ /^plain text/
+      end
+
+      it 'fixes rich text link' do
+        response.body.should_not =~ /href="rich.html"/
+        response.body.should =~ /href="#{Regexp.escape letter_path(id: letter.id, style: 'rich')}"/
+      end
+    end
+  end
+
+  describe 'DELETE clear' do
+    it 'removes all letters' do
+      LetterOpenerWeb::Letter.should_receive(:destroy_all)
+      delete :clear
+    end
+
+    it 'redirects back to index' do
+      delete :clear
+      response.should redirect_to(letters_path)
+    end
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  delete 'clear'        => 'letter_opener_web/letters#clear'
+  get    '/'            => 'letter_opener_web/letters#index', as: :letters
+  get    ':id(/:style)' => 'letter_opener_web/letters#show',  as: :letter
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/models/letter_opener_web/letter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe LetterOpenerWeb::Letter do
+  let(:location) { File.expand_path('../../../tmp', __FILE__) }
+
+  before :each do
+    described_class.stub(:letters_location).and_return(location)
+    described_class.any_instance.stub(:letters_location).and_return(location)
+
+    ['1111_1111', '2222_2222'].each do |folder|
+      FileUtils.mkdir_p("#{location}/#{folder}")
+      File.open("#{location}/#{folder}/plain.html", 'w') {|f| f.write("Plain text for #{folder}") }
+      File.open("#{location}/#{folder}/rich.html", 'w')  {|f| f.write("Rich text for #{folder}") }
+      FileUtils.mkdir_p("#{Rails.root.join('tmp', 'letter_opener')}/#{folder}")
+      File.open("#{Rails.root.join('tmp', 'letter_opener')}/#{folder}/rich.html", 'w')  {|f| f.write("Rich text for #{folder}") }
+    end
+  end
+
+  after :each do
+    FileUtils.rm_rf(location)
+  end
+
+  it 'loads rich version' do
+    described_class.new(id: '1111_1111').rich_text.should == 'Rich text for 1111_1111'
+  end
+
+  it 'loads plain text version' do
+    described_class.new(id: '2222_2222').plain_text.should == 'Plain text for 2222_2222'
+  end
+
+  describe '.search' do
+    let(:search_results) { described_class.search }
+    let(:first_letter)   { search_results.first }
+    let(:last_letter)    { search_results.last }
+
+    before do
+      File.stub(:mtime).with("#{location}/1111_1111").and_return(Date.today - 1.day)
+      File.stub(:mtime).with("#{location}/2222_2222").and_return(Date.today)
+    end
+
+    it 'returns a list of ordered letters' do
+      first_letter.sent_at.should > last_letter.sent_at
+    end
+  end
+
+  describe '.find' do
+    let(:id)     { 'an-id' }
+    let(:letter) { described_class.find(id) }
+
+    it 'returns a letter with id set' do
+      letter.id.should == id
+    end
+  end
+
+  describe '.destroy_all' do
+    it 'removes all letters' do
+      described_class.destroy_all
+      Dir["#{location}/**/*"].should be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+Bundler.require :default, :test
+
+Combustion.initialize! :action_controller, :action_view, :sprockets, :action_mailer
+
+require 'rspec/rails'
+require 'shoulda-matchers'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end