letter_opener 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.rdoc

@@ -0,0 +1,32 @@
+= Letter Opener
+
+Preview mail in your browser instead of sending it. When using the included delivery method, any sent mail will open automatically into the browser.
+
+== Rails Setup
+
+First add the gem to your development environment and run the +bundle+ command to install it.
+
+  gem "letter_opener", :group => :development
+
+Then set the delivery method in <tt>config/environments/development.rb</tt>
+
+  config.action_mailer.delivery_method = :letter_opener
+
+Now any delivered mail will pop up in your browser. The messages are stored in <tt>tmp/letter_opener</tt>.
+
+
+== Other Setup
+
+This can be used with anything that uses the Mail gem. Simply set the delivery method when configuring Mail and specify a location.
+
+  require "letter_opener"
+  Mail.defaults do
+    delivery_method LetterOpener::DeliveryMethod, :location => "tmp/letter_opener"
+  end
+
+
+== Development & Feedback
+
+Questions or comments? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, clone this repository and run +bundle+ and +rake+ to run the tests.
+
+Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+task :default => :spec

data/lib/letter_opener.rb

@@ -0,0 +1,7 @@
+require "fileutils"
+require "digest/sha1"
+require "cgi"
+
+require "letter_opener/message"
+require "letter_opener/delivery_method"
+require "letter_opener/railtie" if defined? Rails

data/lib/letter_opener/delivery_method.rb

@@ -0,0 +1,15 @@
+module LetterOpener
+  class DeliveryMethod
+    def initialize(options = {})
+      @options = {:location => './letter_opener'}.merge!(options)
+    end
+
+    def deliver!(mail)
+      location = File.join(@options[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
+      messages = mail.parts.map { |part| Message.new(location, mail, part) }
+      messages << Message.new(location, mail) if messages.empty?
+      messages.each { |message| message.render }
+      Launchy.open("file://#{messages.first.filepath}")
+    end
+  end
+end

data/lib/letter_opener/message.html.erb

@@ -0,0 +1,86 @@
+<style type="text/css">
+  #message_headers {
+    position: absolute;
+    top: 0px;
+    left: 0;
+    width: 100%;
+    height: 85px;
+    padding: 10px 0 0 0;
+    margin: 0;
+    background: #fff;
+    font-size: 12px;
+    font-family: "Lucida Grande";
+    border-bottom: 1px solid #dedede;
+    overflow: hidden;
+  }
+
+  #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;
+    word-wrap: break-word;
+  }
+
+  body {
+    margin-top: 96px;
+  }
+</style>
+
+<div id="message_headers">
+  <dl>
+    <dt>From:</dt>
+    <dd><%= mail.from.join(", ") %></dd>
+
+    <dt>Subject:</dt>
+    <dd><strong><%= mail.subject %></strong></dd>
+
+    <dt>Date:</dt>
+    <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
+
+    <dt>To:</dt>
+    <dd><%= mail.to.join(", ") %></dd>
+  </dl>
+
+  <% if mail.multipart? %>
+    <p class="alternate">
+      <% if type == "plain" %>
+        <a href="rich.html">View HTML version</a>
+      <% else %>
+        <a href="plain.html">View plain text version</a>
+      <% end %>
+    </p>
+  <% end %>
+</div>
+
+<% if type == "plain" %>
+  <pre id="message_body"><%= CGI.escapeHTML(body) %></pre>
+<% else %>
+  <%= body %>
+<% end %>

data/lib/letter_opener/message.rb

@@ -0,0 +1,38 @@
+module LetterOpener
+  class Message
+    attr_reader :mail
+
+    def initialize(location, mail, part = nil)
+      @location = location
+      @mail = mail
+      @part = part
+    end
+
+    def render
+      FileUtils.mkdir_p(@location)
+      File.open(filepath, 'w') do |f|
+        f.write ERB.new(template).result(binding)
+      end
+    end
+
+    def template
+      File.read(File.expand_path("../message.html.erb", __FILE__))
+    end
+
+    def filepath
+      File.join(@location, "#{type}.html")
+    end
+
+    def content_type
+      @part && @part.content_type || @mail.content_type
+    end
+
+    def body
+      (@part && @part.body || @mail.body).to_s
+    end
+
+    def type
+      content_type =~ /html/ ? "rich" : "plain"
+    end
+  end
+end

data/lib/letter_opener/railtie.rb

@@ -0,0 +1,7 @@
+module LetterOpener
+  class Railtie < Rails::Railtie
+    initializer "letter_opener.add_delivery_method" do
+      ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => Rails.root.join("tmp", "letter_opener")
+    end
+  end
+end

data/spec/letter_opener/delivery_method_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe LetterOpener::DeliveryMethod do
+  before(:each) do
+    Launchy.stub(:open)
+    location = File.expand_path('../../../tmp/letter_opener', __FILE__)
+    FileUtils.rm_rf(location)
+    Mail.defaults do
+      delivery_method LetterOpener::DeliveryMethod, :location => location
+    end
+    @location = location
+  end
+
+  it "saves text into html document" do
+    Launchy.should_receive(:open)
+    mail = Mail.deliver do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'Hello'
+      body    'World!'
+    end
+    text = File.read(Dir["#{@location}/*/plain.html"].first)
+    text.should include("foo@example.com")
+    text.should include("bar@example.com")
+    text.should include("Hello")
+    text.should include("World!")
+  end
+
+  it "saves multipart email into html document" do
+    mail = Mail.deliver do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'Many parts'
+      text_part do
+        body 'This is <plain> text'
+      end
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body '<h1>This is HTML</h1>'
+      end
+    end
+    text = File.read(Dir["#{@location}/*/plain.html"].first)
+    text.should include("View HTML version")
+    text.should include("This is &lt;plain&gt; text")
+    html = File.read(Dir["#{@location}/*/rich.html"].first)
+    html.should include("View plain text version")
+    html.should include("<h1>This is HTML</h1>")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+require "mail"
+require "launchy"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: letter_opener
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-07 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: &2161172040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161172040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161171520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2161171520
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &2161171020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2161171020
+description: When mail is sent from your application, Letter Opener will open a preview
+  in the browser instead of sending.
+email: ryan@railscasts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/letter_opener/delivery_method.rb
+- lib/letter_opener/message.html.erb
+- lib/letter_opener/message.rb
+- lib/letter_opener/railtie.rb
+- lib/letter_opener.rb
+- spec/letter_opener/delivery_method_spec.rb
+- spec/spec_helper.rb
+- Gemfile
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ryanb/letter_opener
+licenses: []
+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: 1.3.4
+requirements: []
+rubyforge_project: letter_opener
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Preview mail in browser instead of sending.
+test_files: []