letter_opener 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,24 +1,31 @@
+## 1.1.0 ##
+
+  * Update Launchy dependency to `~> 2.2.0` (thanks [webdevotion](https://github.com/webdevotion))
+  * Handle `sender` field (thanks [sjtipton](https://github.com/sjtipton))
+  * Show subject only if it's present (thanks [jadehyper](https://github.com/jadehyper))
+  * Show subject as title of web page (thanks [statique](https://github.com/statique))
+
 ## 1.0.0 ##
 
-  * Attachment Support (thanks David Cornu)
+  * Attachment Support (thanks [David Cornu](https://github.com/davidcornu))
   * 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)
+  * Open rich version by default (thanks [Damir](https://github.com/sidonath))
+  * Override margin on dt and dd elements in CSS (thanks [Edgars Beigarts](https://github.com/ebeigarts))
+  * Autolink URLs in plain version (thanks [Matt Burke](https://github.com/spraints))
 
 ## 0.1.0 ##
 
   * From and To show name and Email when specified
   * Fix bug when letter_opener couldn't open email in Windows
-  * Handle spaces in the application path (thanks Mike Boone)
-  * As letter_opener doesn't work with Launchy < 2.0.4 let's depend on >= 2.0.4 (thanks Samnang Chhun)
-  * Handle `reply_to` field (thanks Wes Gibbs)
-  * Set the charset in email preview (thanks Bruno Michel)
+  * Handle spaces in the application path (thanks [Mike Boone](https://github.com/boone))
+  * As letter_opener doesn't work with Launchy < 2.0.4 let's depend on >= 2.0.4 (thanks [Samnang Chhun](https://github.com/samnang))
+  * Handle `reply_to` field (thanks [Wes Gibbs](https://github.com/wgibbs))
+  * Set the charset in email preview (thanks [Bruno Michel](https://github.com/nono))
 
 ## 0.0.2 ##
 
-  * Fixing launchy requirement (thanks Bruno Michel)
+  * Fixing launchy requirement (thanks [Bruno Michel](https://github.com/nono))
 
 ## 0.0.1 ##
 

data/README.rdoc

@@ -15,6 +15,9 @@ Then set the delivery method in <tt>config/environments/development.rb</tt>
 
 Now any email will pop up in your browser instead of being sent. The messages are stored in <tt>tmp/letter_opener</tt>.
 
+==== For Rails 2.3.x support
+
+There is a fork that add support for Rails 2.3.x, in order to use that or just check it out you should go to https://github.com/cavi21/letter_opener
 
 == Non Rails Setup
 
@@ -25,6 +28,14 @@ If you aren't using Rails, this can be easily set up with the Mail gem. Just set
     delivery_method LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
   end
 
+The method is similar if you're using the Pony gem:
+
+  require "letter_opener"
+  Pony.options = {
+    :via => LetterOpener::DeliveryMethod,
+    :via_options => {:location => File.expand_path('../tmp/letter_opener', __FILE__)}
+  }
+
 Alternatively, if you are using ActionMailer directly (without Rails) you will need to add the delivery method.
 
   require "letter_opener"
@@ -32,6 +43,13 @@ Alternatively, if you are using ActionMailer directly (without Rails) you will n
   ActionMailer::Base.delivery_method = :letter_opener
 
 
+== Remote Alternatives
+
+Letter Opener uses {Launchy}[https://github.com/copiousfreetime/launchy] to open sent mail in the browser. This assumes the Ruby process is running on the local development machine. If you are using a separate staging server or VM this will not work. In that case consider using {Mailtrap}[http://mailtrap.io/] or {MailCatcher}[http://mailcatcher.me/].
+
+In order to keep this project simple, I don't have plans to turn it into a Rails engine with an interface for browsing the sent mail but there is a work in progress gem being developed at https://github.com/fgrehm/letter_opener_web
+
+
 == 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.

data/lib/letter_opener/delivery_method.rb

@@ -12,7 +12,7 @@ module LetterOpener
     def deliver!(mail)
       location = File.join(settings[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
       messages = Message.rendered_messages(location, mail)
-      Launchy.open(URI.parse(URI.escape(messages.first.filepath)))
+      Launchy.open(URI.escape(messages.first.filepath))
     end
   end
 end

data/lib/letter_opener/message.html.erb

@@ -1,4 +1,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=<%= encoding %>">
+<% if mail.subject %>
+  <title><%= h mail.subject %></title>
+<% end %>
 
 <style type="text/css">
   #message_headers {
@@ -53,13 +56,20 @@
     <dt>From:</dt>
     <dd><%= h from %></dd>
 
+    <% unless sender.empty? %>
+      <dt>Sender:</dt>
+      <dd><%= h sender %></dd>
+    <% end %>
+
     <% unless reply_to.empty? %>
       <dt>Reply-To:</dt>
       <dd><%= h reply_to %></dd>
     <% end %>
 
-    <dt>Subject:</dt>
-    <dd><strong><%= h mail.subject %></strong></dd>
+    <% if mail.subject %>
+      <dt>Subject:</dt>
+      <dd><strong><%= h mail.subject %></strong></dd>
+    <% end %>
 
     <dt>Date:</dt>
     <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>

data/lib/letter_opener/message.rb

@@ -1,3 +1,5 @@
+require "erb"
+
 module LetterOpener
   class Message
     attr_reader :mail
@@ -68,6 +70,10 @@ module LetterOpener
       @from ||= Array(@mail.from).join(", ")
     end
 
+    def sender
+      @sender ||= Array(@mail.sender).join(", ")
+    end
+
     def to
       @to ||= Array(@mail.to).join(", ")
     end

data/spec/letter_opener/delivery_method_spec.rb

@@ -1,7 +1,10 @@
 require "spec_helper"
 
 describe LetterOpener::DeliveryMethod do
-  let(:location) { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+  let(:location)   { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+
+  let(:plain_file) { Dir["#{location}/*/plain.html"].first }
+  let(:plain)      { File.read(plain_file) }
 
   before do
     Launchy.stub(:open)
@@ -19,15 +22,13 @@ describe LetterOpener::DeliveryMethod do
   end
 
   context 'content' do
-    let(:plain_file) { Dir["#{location}/*/plain.html"].first }
-    let(:plain) { File.read(plain_file) }
-
     context 'plain' do
       before do
         Launchy.should_receive(:open)
 
         Mail.deliver do
           from     'Foo foo@example.com'
+          sender   'Baz baz@example.com'
           reply_to 'No Reply no-reply@example.com'
           to       'Bar bar@example.com'
           subject  'Hello'
@@ -43,6 +44,10 @@ describe LetterOpener::DeliveryMethod do
         plain.should include("Foo foo@example.com")
       end
 
+      it 'saves Sender field' do
+        plain.should include("Baz baz@example.com")
+      end
+
       it 'saves Reply-to field' do
         plain.should include("No Reply no-reply@example.com")
       end
@@ -104,13 +109,15 @@ describe LetterOpener::DeliveryMethod do
       it 'saves escaped Subject field' do
         plain.should include("Many parts with <html>")
       end
+
+      it 'shows subject as title' do
+        rich.should include("<title>Many parts with &lt;html&gt;</title>")
+      end
     end
   end
 
   context 'document with spaces in name' do
     let(:location) { File.expand_path('../../../tmp/letter_opener with space', __FILE__) }
-    let(:file)     { Dir["#{location}/*/plain.html"].first }
-    let(:plain)    { File.read(file) }
 
     before do
       Launchy.should_receive(:open)
@@ -124,7 +131,7 @@ describe LetterOpener::DeliveryMethod do
     end
 
     it 'creates plain html document' do
-      File.exist?(file)
+      File.exist?(plain_file)
     end
 
     it 'saves From filed' do
@@ -133,9 +140,6 @@ describe LetterOpener::DeliveryMethod do
   end
 
   context 'using deliver! method' do
-    let(:plain_file) { Dir["#{location}/*/plain.html"].first }
-    let(:plain) { File.read(plain_file) }
-
     before do
       Launchy.should_receive(:open)
       Mail.new do
@@ -220,4 +224,21 @@ describe LetterOpener::DeliveryMethod do
       text.should include("attachments/#{File.basename(__FILE__)}")
     end
   end
+
+  context 'subjectless mail' do
+    before do
+      Launchy.should_receive(:open)
+
+      Mail.deliver do
+        from     'Foo foo@example.com'
+        reply_to 'No Reply no-reply@example.com'
+        to       'Bar bar@example.com'
+        body     'World! http://example.com'
+      end
+    end
+
+    it 'creates plain html document' do
+      File.exist?(plain_file).should be_true
+    end
+  end
 end

data/spec/letter_opener/message_spec.rb

@@ -27,6 +27,18 @@ describe LetterOpener::Message do
     end
   end
 
+  describe '#sender' do
+    it 'handles one email as a string' do
+      message = described_class.new(location, mock(sender: 'sender@example.com'))
+      message.sender.should eq('sender@example.com')
+    end
+
+    it 'handles array of emails' do
+      message = described_class.new(location, mock(sender: ['sender1@example.com', 'sender2@example.com']))
+      message.sender.should eq('sender1@example.com, sender2@example.com')
+    end
+  end
+
   describe '#<=>' do
     it 'sorts rich type before plain type' do
       plain = described_class.new(location, mock(content_type: 'text/plain'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letter_opener
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-10 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.0
 description: When mail is sent from your application, Letter Opener will open a preview
   in the browser instead of sending.
 email: ryan@railscasts.com
@@ -91,6 +91,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4310965530759568709
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.4
 requirements: []
 rubyforge_project: letter_opener
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Preview mail in browser instead of sending.