letter_opener 0.1.0 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.0.0 ##
+
+  * Attachment Support (thanks David Cornu)
+  * Escape HTML in subject and other fields
+  * Raise an exception if the :location option is not present instead of using a default
+  * Open rich version by default (thanks Damir)
+  * Override margin on dt and dd elements in CSS (thanks Edgars Beigarts)
+  * Autolink URLs in plain version (thanks Matt Burke)
+
 ## 0.1.0 ##
 
   * From and To show name and Email when specified

data/LICENSE

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

data/README.rdoc

@@ -22,12 +22,18 @@ If you aren't using Rails, this can be easily set up with the Mail gem. Just set
 
   require "letter_opener"
   Mail.defaults do
-    delivery_method LetterOpener::DeliveryMethod, :location => "tmp/letter_opener"
+    delivery_method LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
   end
 
+Alternatively, if you are using ActionMailer directly (without Rails) you will need to add the delivery method.
+
+  require "letter_opener"
+  ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
+  ActionMailer::Base.delivery_method = :letter_opener
+
 
 == Development & Feedback
 
 Questions or problems? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, fork this repository and run +bundle+ and +rake+ to run the tests. Pull requests appreciated.
 
-Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template. Also thanks to [Vasiliy Ermolovich](https://github.com/nashby) for helping manage this project.
+Special thanks to the {mail_view}[https://github.com/37signals/mail_view/] gem for inspiring this project and for their mail template. Also thanks to {Vasiliy Ermolovich}[https://github.com/nashby] for helping manage this project.

data/lib/letter_opener.rb

@@ -1,6 +1,7 @@
 require "fileutils"
 require "digest/sha1"
 require "cgi"
+require "uri"
 require "launchy"
 
 require "letter_opener/message"

data/lib/letter_opener/delivery_method.rb

@@ -1,16 +1,17 @@
 module LetterOpener
   class DeliveryMethod
-    def initialize(options = {})
-      self.settings = {:location => './letter_opener'}.merge!(options)
-    end
+    class InvalidOption < StandardError; end
 
     attr_accessor :settings
 
+    def initialize(options = {})
+      raise InvalidOption, "A location option is required when using the Letter Opener delivery method" if options[:location].nil?
+      self.settings = options
+    end
+
     def deliver!(mail)
       location = File.join(settings[: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(&:render)
+      messages = Message.rendered_messages(location, mail)
       Launchy.open(URI.parse(URI.escape(messages.first.filepath)))
     end
   end

data/lib/letter_opener/message.html.erb

@@ -19,8 +19,9 @@
   }
 
   #message_headers dt {
-    width: 62px;
+    width: 92px;
     padding: 1px;
+    margin: 0;
     float: left;
     text-align: right;
     font-weight: bold;
@@ -28,7 +29,7 @@
   }
 
   #message_headers dd {
-    margin-left: 72px;
+    margin: 0 0 0 102px;
     padding: 1px;
   }
 
@@ -50,40 +51,49 @@
 <div id="message_headers">
   <dl>
     <dt>From:</dt>
-    <dd><%= from %></dd>
+    <dd><%= h from %></dd>
 
     <% unless reply_to.empty? %>
       <dt>Reply-To:</dt>
-      <dd><%= reply_to %></dd>
+      <dd><%= h reply_to %></dd>
     <% end %>
 
     <dt>Subject:</dt>
-    <dd><strong><%= mail.subject %></strong></dd>
+    <dd><strong><%= h mail.subject %></strong></dd>
 
     <dt>Date:</dt>
     <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
 
     <% unless to.empty? %>
       <dt>To:</dt>
-      <dd><%= to %></dd>
+      <dd><%= h to %></dd>
     <% end %>
 
     <% if mail.cc %>
       <dt>CC:</dt>
-      <dd><%= mail.cc.join(", ") %></dd>
+      <dd><%= h mail.cc.join(", ") %></dd>
     <% end %>
 
     <% if mail.bcc %>
       <dt>BCC:</dt>
-      <dd><%= mail.bcc.join(", ") %></dd>
+      <dd><%= h mail.bcc.join(", ") %></dd>
+    <% end %>
+
+    <% if @attachments.any? %>
+      <dt>Attachments:</dt>
+      <dd>
+      <% @attachments.each do |filename, path| %>
+        <a href="<%= path %>"><%= filename %></a>&nbsp;
+      <% end %>
+      </dd>
     <% end %>
   </dl>
 
   <% if mail.multipart? %>
     <p class="alternate">
-      <% if type == "plain" %>
+      <% if type == "plain" && mail.html_part %>
         <a href="rich.html">View HTML version</a>
-      <% else %>
+      <% elsif type == "rich" && mail.text_part %>
         <a href="plain.html">View plain text version</a>
       <% end %>
     </p>
@@ -91,7 +101,7 @@
 </div>
 
 <% if type == "plain" %>
-  <pre id="message_body"><%= CGI.escapeHTML(body) %></pre>
+  <pre id="message_body"><%= auto_link(h(body)) %></pre>
 <% else %>
   <%= body %>
 <% end %>

data/lib/letter_opener/message.rb

@@ -2,14 +2,39 @@ module LetterOpener
   class Message
     attr_reader :mail
 
+    def self.rendered_messages(location, mail)
+      messages = []
+      messages << new(location, mail, mail.html_part) if mail.html_part
+      messages << new(location, mail, mail.text_part) if mail.text_part
+      messages << new(location, mail) if messages.empty?
+      messages.each(&:render)
+      messages.sort
+    end
+
     def initialize(location, mail, part = nil)
       @location = location
       @mail = mail
       @part = part
+      @attachments = []
     end
 
     def render
       FileUtils.mkdir_p(@location)
+
+      if mail.attachments.any?
+        attachments_dir = File.join(@location, 'attachments')
+        FileUtils.mkdir_p(attachments_dir)
+        mail.attachments.each do |attachment|
+          path = File.join(attachments_dir, attachment.filename)
+
+          unless File.exists?(path) # true if other parts have already been rendered
+            File.open(path, 'wb') { |f| f.write(attachment.body.raw_source) }
+          end
+
+          @attachments << [attachment.filename, "attachments/#{URI.escape(attachment.filename)}"]
+        end
+      end
+
       File.open(filepath, 'w') do |f|
         f.write ERB.new(template).result(binding)
       end
@@ -28,7 +53,15 @@ module LetterOpener
     end
 
     def body
-      @body ||= (@part && @part.body || @mail.body).to_s
+      @body ||= begin
+        body = (@part && @part.body || @mail.body).to_s
+
+        mail.attachments.each do |attachment|
+          body.gsub!(attachment.url, "attachments/#{attachment.filename}")
+        end
+
+        body
+      end
     end
 
     def from
@@ -50,6 +83,20 @@ module LetterOpener
     def encoding
       body.respond_to?(:encoding) ? body.encoding : "utf-8"
     end
+
+    def auto_link(text)
+      text.gsub(URI.regexp(%W[https http])) do
+        "<a href=\"#{$&}\">#{$&}</a>"
+      end
+    end
+
+    def h(content)
+      CGI.escapeHTML(content)
+    end
+
+    def <=>(other)
+      order = %w[rich plain]
+      order.index(type) <=> order.index(other.type)
+    end
   end
 end
-

data/spec/letter_opener/delivery_method_spec.rb

@@ -13,6 +13,11 @@ describe LetterOpener::DeliveryMethod do
     end
   end
 
+  it 'raises an exception if no location passed' do
+    lambda { LetterOpener::DeliveryMethod.new }.should raise_exception(LetterOpener::DeliveryMethod::InvalidOption)
+    lambda { LetterOpener::DeliveryMethod.new(location: "foo") }.should_not raise_exception
+  end
+
   context 'content' do
     let(:plain_file) { Dir["#{location}/*/plain.html"].first }
     let(:plain) { File.read(plain_file) }
@@ -26,7 +31,7 @@ describe LetterOpener::DeliveryMethod do
           reply_to 'No Reply no-reply@example.com'
           to       'Bar bar@example.com'
           subject  'Hello'
-          body     'World!'
+          body     'World! http://example.com'
         end
       end
 
@@ -50,8 +55,8 @@ describe LetterOpener::DeliveryMethod do
         plain.should include("Hello")
       end
 
-      it 'saves Body field' do
-        plain.should include("World!")
+      it 'saves Body with autolink' do
+        plain.should include('World! <a href="http://example.com">http://example.com</a>')
       end
     end
 
@@ -65,7 +70,7 @@ describe LetterOpener::DeliveryMethod do
         Mail.deliver do
           from    'foo@example.com'
           to      'bar@example.com'
-          subject 'Many parts'
+          subject 'Many parts with <html>'
           text_part do
             body 'This is <plain> text'
           end
@@ -95,6 +100,10 @@ describe LetterOpener::DeliveryMethod do
       it 'saves html part' do
         rich.should include("<h1>This is HTML</h1>")
       end
+
+      it 'saves escaped Subject field' do
+        plain.should include("Many parts with &lt;html&gt;")
+      end
     end
   end
 
@@ -157,4 +166,58 @@ describe LetterOpener::DeliveryMethod do
       plain.should include("World!")
     end
   end
+
+  context 'attachments in plain text mail' do
+    before do
+      Mail.deliver do
+        from      'foo@example.com'
+        to        'bar@example.com'
+        subject   'With attachments'
+        text_part do
+          body 'This is <plain> text'
+        end
+        attachments[File.basename(__FILE__)] = File.read(__FILE__)
+      end
+    end
+
+    it 'creates attachments dir with attachment' do
+      attachment = Dir["#{location}/*/attachments/#{File.basename(__FILE__)}"].first
+      File.exists?(attachment).should be_true
+    end
+
+    it 'saves attachment name' do
+      plain = File.read(Dir["#{location}/*/plain.html"].first)
+      plain.should include(File.basename(__FILE__))
+    end
+  end
+
+  context 'attachments in rich mail' do
+    let(:url) { mail.attachments[0].url }
+
+    let!(:mail) do
+      Mail.deliver do
+        from      'foo@example.com'
+        to        'bar@example.com'
+        subject   'With attachments'
+        attachments[File.basename(__FILE__)] = File.read(__FILE__)
+        url = attachments[0].url
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body "Here's an image: <img src='#{url}' />"
+        end
+      end
+    end
+
+    it 'creates attachments dir with attachment' do
+      attachment = Dir["#{location}/*/attachments/#{File.basename(__FILE__)}"].first
+      File.exists?(attachment).should be_true
+    end
+
+    it 'replaces inline attachment urls' do
+      text = File.read(Dir["#{location}/*/rich.html"].first)
+      mail.parts[0].body.should include(url)
+      text.should_not include(url)
+      text.should include("attachments/#{File.basename(__FILE__)}")
+    end
+  end
 end

data/spec/letter_opener/message_spec.rb

@@ -26,4 +26,12 @@ describe LetterOpener::Message do
       message.to.should eq('test1@example.com, test2@example.com')
     end
   end
+
+  describe '#<=>' do
+    it 'sorts rich type before plain type' do
+      plain = described_class.new(location, mock(content_type: 'text/plain'))
+      rich = described_class.new(location, mock(content_type: 'text/html'))
+      [plain, rich].sort.should eq([rich, plain])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letter_opener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy