email_preview 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Sonnek
+
+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

@@ -0,0 +1,65 @@
+= email_preview
+
+preview emails within your web browser
+
+= Features
+* preview HTML emails from within your web browser
+* emails are reloaded with each view so you can tweak/save/refresh for instant verification
+* convenient form to send any email preview directly to your *real* inbox
+* only exposes routes in development mode to prevent leaking into production mode
+
+= Installation
+
+gem 'email_preview'
+
+= Usage
+
+config/initializers/email_preview.rb
+  EmailPreview.register 'simple example email' do
+    Mail.new do
+      to 'tom@example.com'
+      from 'me@foo.com'
+      body 'check this out'
+    end
+  end
+
+  EmailPreview.register 'multipart email (html + text)' do
+    Mail.new do
+      from 'mikel@test.lindsaar.net'
+      to 'you@test.lindsaar.net'
+      subject 'This is a test email'
+
+      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
+
+  EmailPreview.register 'user activation email' do
+    u = User.new :email => 'foo@example.com'
+    UserNotifier.activation
+  end
+
+by default, email_preview is only available in development mode.  to turn on globally use:
+  EmailPreview.allowed_environments << 'production'
+
+browse the list of registered emails and preview them in your browser at:
+http://localhost:3000/email_preview
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ryan Sonnek. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "email_preview"
+    gem.summary = %Q{preview emails within your webbrowser}
+    gem.description = %Q{render and send sample html and plain text emails to see what they will *really* look like}
+    gem.email = "ryan@socialcast.com"
+    gem.homepage = "http://github.com/wireframe/email_preview"
+    gem.authors = ["Ryan Sonnek"]
+    gem.add_runtime_dependency "mail", ">= 2.2.3"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "email_preview #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/app/controllers/email_preview_controller.rb

@@ -0,0 +1,18 @@
+class EmailPreviewController < ApplicationController
+  unloadable
+  before_filter :enforce_allowed_environments
+  before_filter :build_email, :only => [:show, :deliver]
+
+  def deliver
+    @mail.to params[:to]
+    @mail.deliver
+    redirect_to email_preview_path(params[:id])
+  end
+  private
+  def enforce_allowed_environments
+    raise "'#{Rails.env}' is not in the supported list of environments from EmailPreview.allowed_environments: #{EmailPreview.allowed_environments.inspect}" unless EmailPreview.allowed_environments.include?(Rails.env)
+  end
+  def build_email
+    @mail = EmailPreview.preview params[:id]
+  end
+end

data/app/views/email_preview/index.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Email Preview</title>
+</head>
+<body>
+  <frameset cols="20%,*">
+    <frame src="<%= list_email_previews_path %>" name="listing" />
+    <frame name="render" />
+  </frameset>
+</body>
+</html>

data/app/views/email_preview/list.html.erb

@@ -0,0 +1,5 @@
+<ul>
+<% EmailPreview.emails.keys.each do |key| %>
+  <li><%= link_to key, email_preview_path(key), :target => 'render' %>
+<% end%>
+</ul>

data/app/views/email_preview/show.html.erb

@@ -0,0 +1,33 @@
+<div>
+  To: <%= @mail.to %>
+</div>
+<div>
+  From: <%= @mail.from %>
+</div>
+<div>
+  Subject: <%= @mail.subject %>
+</div>
+
+<% form_tag deliver_email_preview_path(params[:id]) do %>
+  <p>Send this email to your inbox:</p>
+  <%= text_field_tag :to %>
+  <button type="submit">Send</button>
+<% end %>
+
+<!--
+<h3>Debug output</h3>
+<pre>
+  <%= @mail.to_s %>
+</pre>
+-->
+
+<h3>Body</h3>
+<% parts = @mail.multipart? ? @mail.parts : [@mail] %>
+<% parts.each do |part| %>
+  <h4><%= part.content_type %></h4>
+  <% if part.content_type.include?('text/plain') %>
+  <pre><%= part.body %></pre>
+  <% elsif part.content_type.include?('text/html') %>
+    <%= part.body.to_s.html_safe %>
+  <% end %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do |map|
+  resources :email_preview, :controller => 'email_preview', :only => [:index, :show] do
+    collection do
+      get :list
+    end
+    member do
+      post :deliver
+    end
+  end
+end

data/email_preview.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{email_preview}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Sonnek"]
+  s.date = %q{2010-06-09}
+  s.description = %q{render and send sample html and plain text emails to see what they will *really* look like}
+  s.email = %q{ryan@socialcast.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/email_preview_controller.rb",
+     "app/views/email_preview/index.html.erb",
+     "app/views/email_preview/list.html.erb",
+     "app/views/email_preview/show.html.erb",
+     "config/routes.rb",
+     "email_preview.gemspec",
+     "lib/email_preview.rb",
+     "lib/engine.rb",
+     "test/helper.rb",
+     "test/test_email_preview.rb"
+  ]
+  s.homepage = %q{http://github.com/wireframe/email_preview}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{preview emails within your webbrowser}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_email_preview.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mail>, [">= 2.2.3"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<mail>, [">= 2.2.3"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mail>, [">= 2.2.3"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/email_preview.rb

@@ -0,0 +1,23 @@
+require 'engine' if defined?(Rails)
+
+module EmailPreview
+
+  class << self
+    attr_accessor :emails
+    attr_accessor :allowed_environments
+
+    def allowed_environments
+      @allowed_environments ||= ['development', 'test']
+      @allowed_environments
+    end
+    def register(key, &block)
+      self.emails ||= {}
+      self.emails[key] = block
+    end
+    def preview(key)
+      puts self.emails[key]
+      block = self.emails[key]
+      block.call
+    end
+  end
+end

data/lib/engine.rb

@@ -0,0 +1,2 @@
+class EmailPreviewEngine < Rails::Engine
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'email_preview'
+
+class Test::Unit::TestCase
+end

data/test/test_email_preview.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestEmailPreview < Test::Unit::TestCase
+  context "with one registered email" do
+    setup do
+      EmailPreview.register "basic email" do
+        Mail.new do
+          from 'mikel@test.lindsaar.net'
+          to 'you@test.lindsaar.net'
+          subject 'This is a test email'
+          body 'i like testing'
+        end
+      end
+    end
+    should "have one entry in the configuration" do
+      assert_equal 1, EmailPreview.emails.keys.length
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: email_preview
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ryan Sonnek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: render and send sample html and plain text emails to see what they will *really* look like
+email: ryan@socialcast.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/controllers/email_preview_controller.rb
+- app/views/email_preview/index.html.erb
+- app/views/email_preview/list.html.erb
+- app/views/email_preview/show.html.erb
+- config/routes.rb
+- email_preview.gemspec
+- lib/email_preview.rb
+- lib/engine.rb
+- test/helper.rb
+- test/test_email_preview.rb
+has_rdoc: true
+homepage: http://github.com/wireframe/email_preview
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: preview emails within your webbrowser
+test_files: 
+- test/helper.rb
+- test/test_email_preview.rb