letter_opener 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 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)
+
+## 0.0.2 ##
+
+  * Fixing launchy requirement (thanks Bruno Michel)
+
+## 0.0.1 ##
+
+  * Initial relase

data/Gemfile

@@ -1,2 +1,4 @@
 source "http://rubygems.org"
 gemspec
+
+gem "rake"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Bates
+
+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.rdoc

@@ -1,4 +1,4 @@
-= Letter Opener
+= Letter Opener {<img src="https://secure.travis-ci.org/ryanb/letter_opener.png" />}[http://travis-ci.org/ryanb/letter_opener]
 
 Preview email in the browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
 
@@ -28,6 +28,6 @@ If you aren't using Rails, this can be easily set up with the Mail gem. Just set
 
 == 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.
+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.
+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/delivery_method.rb

@@ -1,15 +1,17 @@
 module LetterOpener
   class DeliveryMethod
     def initialize(options = {})
-      @options = {:location => './letter_opener'}.merge!(options)
+      self.settings = {:location => './letter_opener'}.merge!(options)
     end
 
+    attr_accessor :settings
+
     def deliver!(mail)
-      location = File.join(@options[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
+      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 { |message| message.render }
-      Launchy.open("file://#{messages.first.filepath}")
+      messages.each(&:render)
+      Launchy.open(URI.parse(URI.escape(messages.first.filepath)))
     end
   end
 end

data/lib/letter_opener/message.html.erb

@@ -1,26 +1,25 @@
+<meta http-equiv="Content-Type" content="text/html; charset=<%= encoding %>">
+
 <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;
+    overflow: auto;
   }
 
   #message_headers dl {
-    margin: 0;
+    float: left;
+    margin: 0 0 10px 0;
     padding: 0;
   }
 
   #message_headers dt {
-    width: 60px;
+    width: 62px;
     padding: 1px;
     float: left;
     text-align: right;
@@ -29,14 +28,13 @@
   }
 
   #message_headers dd {
-    margin-left: 70px;
+    margin-left: 72px;
     padding: 1px;
   }
 
   #message_headers p.alternate {
-    position: absolute;
-    top: 0;
-    right: 15px;
+    float: right;
+    margin: 0;
   }
 
   #message_headers p.alternate a {
@@ -47,16 +45,17 @@
     padding: 10px;
     word-wrap: break-word;
   }
-
-  body {
-    margin-top: 96px;
-  }
 </style>
 
 <div id="message_headers">
   <dl>
     <dt>From:</dt>
-    <dd><%= mail.from.join(", ") %></dd>
+    <dd><%= from %></dd>
+
+    <% unless reply_to.empty? %>
+      <dt>Reply-To:</dt>
+      <dd><%= reply_to %></dd>
+    <% end %>
 
     <dt>Subject:</dt>
     <dd><strong><%= mail.subject %></strong></dd>
@@ -64,8 +63,20 @@
     <dt>Date:</dt>
     <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
 
-    <dt>To:</dt>
-    <dd><%= mail.to.join(", ") %></dd>
+    <% unless to.empty? %>
+      <dt>To:</dt>
+      <dd><%= to %></dd>
+    <% end %>
+
+    <% if mail.cc %>
+      <dt>CC:</dt>
+      <dd><%= mail.cc.join(", ") %></dd>
+    <% end %>
+
+    <% if mail.bcc %>
+      <dt>BCC:</dt>
+      <dd><%= mail.bcc.join(", ") %></dd>
+    <% end %>
   </dl>
 
   <% if mail.multipart? %>
@@ -84,3 +95,4 @@
 <% else %>
   <%= body %>
 <% end %>
+

data/lib/letter_opener/message.rb

@@ -28,11 +28,28 @@ module LetterOpener
     end
 
     def body
-      (@part && @part.body || @mail.body).to_s
+      @body ||= (@part && @part.body || @mail.body).to_s
+    end
+
+    def from
+      @from ||= Array(@mail.from).join(", ")
+    end
+
+    def to
+      @to ||= Array(@mail.to).join(", ")
+    end
+
+    def reply_to
+      @reply_to ||= Array(@mail.reply_to).join(", ")
     end
 
     def type
       content_type =~ /html/ ? "rich" : "plain"
     end
+
+    def encoding
+      body.respond_to?(:encoding) ? body.encoding : "utf-8"
+    end
   end
 end
+

data/spec/letter_opener/delivery_method_spec.rb

@@ -1,49 +1,160 @@
 require "spec_helper"
 
 describe LetterOpener::DeliveryMethod do
-  before(:each) do
+  let(:location) { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+
+  before do
     Launchy.stub(:open)
-    location = File.expand_path('../../../tmp/letter_opener', __FILE__)
     FileUtils.rm_rf(location)
+    context = self
+
     Mail.defaults do
-      delivery_method LetterOpener::DeliveryMethod, :location => location
+      delivery_method LetterOpener::DeliveryMethod, :location => context.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!")
+  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'
+          reply_to 'No Reply no-reply@example.com'
+          to       'Bar bar@example.com'
+          subject  'Hello'
+          body     'World!'
+        end
+      end
+
+      it 'creates plain html document' do
+        File.exist?(plain_file).should be_true
+      end
+
+      it 'saves From field' do
+        plain.should include("Foo foo@example.com")
+      end
+
+      it 'saves Reply-to field' do
+        plain.should include("No Reply no-reply@example.com")
+      end
+
+      it 'saves To field' do
+        plain.should include("Bar bar@example.com")
+      end
+
+      it 'saves Subject field' do
+        plain.should include("Hello")
+      end
+
+      it 'saves Body field' do
+        plain.should include("World!")
+      end
+    end
+
+    context 'multipart' do
+      let(:rich_file) { Dir["#{location}/*/rich.html"].first }
+      let(:rich) { File.read(rich_file) }
+
+      before do
+        Launchy.should_receive(:open)
+
+        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
+      end
+
+      it 'creates plain html document' do
+        File.exist?(plain_file).should be_true
+      end
+
+      it 'creates rich html document' do
+        File.exist?(rich_file).should be_true
+      end
+
+      it 'shows link to rich html version' do
+        plain.should include("View HTML version")
+      end
+
+      it 'saves text part' do
+        plain.should include("This is &lt;plain&gt; text")
+      end
+
+      it 'saves html part' do
+        rich.should include("<h1>This is HTML</h1>")
+      end
+    end
   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>")
+  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)
+
+      Mail.deliver do
+        from     'Foo foo@example.com'
+        to       'bar@example.com'
+        subject  'Hello'
+        body     'World!'
+      end
+    end
+
+    it 'creates plain html document' do
+      File.exist?(file)
+    end
+
+    it 'saves From filed' do
+      plain.should include("Foo foo@example.com")
+    end
+  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
+        from    'foo@example.com'
+        to      'bar@example.com'
+        subject 'Hello'
+        body    'World!'
+      end.deliver!
+    end
+
+    it 'creates plain html document' do
+      File.exist?(plain_file).should be_true
+    end
+
+    it 'saves From field' do
+      plain.should include("foo@example.com")
+    end
+
+    it 'saves To field' do
+      plain.should include("bar@example.com")
+    end
+
+    it 'saves Subject field' do
+      plain.should include("Hello")
+    end
+
+    it 'saves Body field' do
+      plain.should include("World!")
+    end
   end
 end

data/spec/letter_opener/message_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe LetterOpener::Message do
+  let(:location) { File.expand_path('../../../tmp/letter_opener', __FILE__) }
+
+  describe '#reply_to' do
+    it 'handles one email as a string' do
+      message = described_class.new(location, mock(reply_to: 'test@example.com'))
+      message.reply_to.should eq('test@example.com')
+    end
+
+    it 'handles array of emails' do
+      message = described_class.new(location, mock(reply_to: ['test1@example.com', 'test2@example.com']))
+      message.reply_to.should eq('test1@example.com, test2@example.com')
+    end
+  end
+
+  describe '#to' do
+    it 'handles one email as a string' do
+      message = described_class.new(location, mock(to: 'test@example.com'))
+      message.to.should eq('test@example.com')
+    end
+
+    it 'handles array of emails' do
+      message = described_class.new(location, mock(to: ['test1@example.com', 'test2@example.com']))
+      message.to.should eq('test1@example.com, test2@example.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,7 +3,9 @@ require 'bundler/setup'
 Bundler.require(:default)
 
 require "mail"
-require "launchy"
 
 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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letter_opener
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,23 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-07 00:00:00.000000000 -07:00
-default_executable: 
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
-  requirement: &2152659820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152659820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152659300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +37,15 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2152659300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &2152658800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +53,12 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2152658800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.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
@@ -58,11 +72,13 @@ files:
 - lib/letter_opener/railtie.rb
 - lib/letter_opener.rb
 - spec/letter_opener/delivery_method_spec.rb
+- spec/letter_opener/message_spec.rb
 - spec/spec_helper.rb
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - Rakefile
 - README.rdoc
-has_rdoc: true
 homepage: http://github.com/ryanb/letter_opener
 licenses: []
 post_install_message: 
@@ -83,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.4
 requirements: []
 rubyforge_project: letter_opener
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Preview mail in browser instead of sending.