kusor-sinatra_mailer 0.9.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nicolás Sanguinetti
+
+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.markdown

@@ -0,0 +1,87 @@
+Sinatra::Mailer
+===============
+
+Adds an `email` method to your email handlers, that receives a hash of values
+to create your email.
+
+For example:
+
+    post "/signup" do
+      # sign up the user, and then:
+      email :to      => @user.email, 
+            :from    => "awesomeness@example.com", 
+            :subject => "Welcome to Awesomeness!",
+            :body    => haml(:some_template)
+    end
+
+Usage
+=====
+
+
+Classic top-level Sinatra style applications
+--------------------------------------------
+
+	require 'sinatra/mailer'
+
+Modular Sinatra style applications
+--------------------------------------------
+
+	require 'sinatra/mailer'
+
+	class MyModularApp < Sinatra::Base
+	  register Sinatra::Mailer
+	end
+
+Configuration
+=============
+
+This plugin is very dirty yet :) Since it's just a port to Sinatra of
+[Merb::Mailer][merb-mailer]. So the configuration is not Sinatra-y, yet.
+But we'll get to that. 
+
+Using SMTP
+----------
+
+    Sinatra::Mailer.config = {
+      :host   => 'smtp.yourserver.com',
+      :port   => '25',
+      :user   => 'user',
+      :pass   => 'pass',
+      :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
+      :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
+    }
+
+Using Gmail SMTP
+----------------
+
+You need [smtp-tls][], a gem that improves `net/smtp` to add support for secure
+servers such as Gmail.
+
+    require "smtp-tls"
+    
+    Sinatra::Mailer.config = {
+      :host => 'smtp.gmail.com',
+      :port => '587',
+      :user => 'user@gmail.com',
+      :pass => 'pass',
+      :auth => :plain
+    }
+    
+Make sure that when you call your `email` method you pass the `:text` option 
+and not `:body`.
+
+Using sendmail
+--------------
+
+    Sinatra::Mailer.config = {:sendmail_path => '/somewhere/odd', :arguments => '-i -t'}
+    Sinatra::Mailer.delivery_method = :sendmail
+
+Credits
+=======
+
+This has been blatantly adapted from [Merb::Mailer][merb-mailer], so all credit
+is theirs, I just ported it to [Sinatra][Sinatra].
+
+[merb-mailer]: http://github.com/wycats/merb-more/tree/master/merb-mailer
+[smtp-tls]: http://github.com/ambethia/smtp-tls/tree/master
+[Sinatra]: http://sinatrarb.com

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+
+$spec = eval(File.read('sinatra_mailer.gemspec'))
+
+Rake::GemPackageTask.new($spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new('test') do |t|
+  t.libs = [File.expand_path('lib')]
+  t.pattern = 'test/test_*.rb'
+  t.warning = true
+end
+
+Rake::Task['test'].comment = 'Run tests for sinatra_mailer'

data/lib/sinatra/mailer.rb

@@ -0,0 +1,123 @@
+# Shamelssly stolen from Merb::Mailer
+# http://merbivore.com
+
+require 'net/smtp'
+require 'rubygems'
+require 'mailfactory'
+
+class MailFactory
+  attr_reader :html, :text
+end
+
+module Sinatra
+  # You'll need a simple config like this in your configure block if you want
+  # to actually send mail:
+  #
+  #   Sinatra::Mailer.config = {
+  #     :host   => 'smtp.yourserver.com',
+  #     :port   => '25',              
+  #     :user   => 'user',
+  #     :pass   => 'pass',
+  #     :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
+  #     :domain => "localhost.localdomain" # the HELO domain provided by the client to the server 
+  #   }
+  # 
+ 	#   or 
+ 	# 
+ 	#   Sinatra::Mailer.config = {:sendmail_path => '/somewhere/odd'}
+  #   Sinatra::Mailer.delivery_method = :sendmail
+  #
+  # From your event handlers then, you can just call the 'email' method to deliver an email:
+  # 
+  #   email :to => 'foo@bar.com',
+  #         :from => 'bar@foo.com',
+  #         :subject => 'Welcome to whatever!',
+  #         :body => haml(:sometemplate)
+  #
+  module Mailer
+    class << self
+      attr_accessor :config, :delivery_method
+
+      @@deliveries = []
+
+      def deliveries
+        @@deliveries
+      end
+    end
+
+    module Helpers
+      def email(mail_options={})
+        Email.new(mail_options).deliver!
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Sinatra::Mailer::Helpers
+    end
+
+    class Email
+      attr_accessor :mail, :config
+
+      # Sends the mail using sendmail.
+      def sendmail
+        sendmail_arguments = config[:sendmail_arguments] || "#{@mail.to}"
+        sendmail = IO.popen("#{config[:sendmail_path]} #{sendmail_arguments}", 'w+') 
+        sendmail.puts @mail.to_s
+        sendmail.close
+      end
+
+      # Sends the mail using SMTP.
+      def net_smtp
+        Net::SMTP.start(config[:host], config[:port].to_i, config[:domain], 
+                        config[:user], config[:pass], config[:auth]) { |smtp|
+          smtp.send_message(@mail.to_s, @mail.from.first, @mail.to.to_s.split(/[,;]/))
+        }
+      end
+
+      # Delivers the mail with the specified delivery method, defaulting to
+      # net_smtp.
+      def deliver!
+        send(Mailer.delivery_method || :net_smtp)
+      end
+
+      # ==== Parameters
+      # file_or_files<File, Array[File]>:: File(s) to attach.
+      # filename<String>::
+      # type<~to_s>::
+      #   The attachment MIME type. If left out, it will be determined from
+      #   file_or_files.
+      # headers<String, Array>:: Additional attachment headers.
+      #
+      # ==== Raises
+      # ArgumentError::
+      #   file_or_files was not a File or an Array of File instances.
+      def attach(file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil, 
+        type = nil, headers = nil)
+        if file_or_files.is_a?(Array)
+          file_or_files.each {|k,v| @mail.add_attachment_as k, *v}
+        else
+          raise ArgumentError, "You did not pass in a file. Instead, you sent a #{file_or_files.class}" if !file_or_files.is_a?(File)
+          @mail.add_attachment_as(file_or_files, filename, type, headers)
+        end
+      end
+
+      # ==== Parameters
+      # o<Hash{~to_s => Object}>:: Configuration commands to send to MailFactory.
+      def initialize(o={})
+        self.config = Mailer.config || {:sendmail_path => '/usr/sbin/sendmail'}
+        o[:rawhtml] = o.delete(:html)
+        m = MailFactory.new()
+        o.each { |k,v| m.send "#{k}=", v }
+        @mail = m
+      end
+
+      # Tests mail sending by adding the mail to deliveries.
+      def test_send
+        Sinatra::Mailer.deliveries << @mail
+      end
+
+    end
+  end
+  
+  register Mailer
+end

data/sinatra_mailer.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name     = "sinatra_mailer"
+  s.version  = "0.9.3"
+  s.date     = "2009-05-26"
+  s.summary  = "Send emails from Sinatra like Merb::Mailer"
+  s.email    = "kusorbox@gmail.com"
+  s.homepage = "http://github.com/kusor/sinatra-mailer/tree/master"
+  s.description = "Sinatra::Mailer extension extracted from Merb::Mailer by Nicolás Sanguinetti."
+  s.authors  = ["Nicolás Sanguinetti", "Pedro P. Candel"]
+
+  s.has_rdoc = false
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["README.markdown"]
+
+  s.files = %w[
+    LICENSE
+    README.markdown
+    sinatra_mailer.gemspec
+    Rakefile
+    lib/sinatra/mailer.rb
+  ]
+  s.test_files = %w[
+    test/test_classic_application.rb
+    test/test_modular_application.rb
+  ]
+
+  s.add_dependency 'sinatra', '>= 0.9.2'
+  s.add_dependency 'mailfactory', '>= 1.4.0'
+  s.add_development_dependency 'rack-test', '>= 0.3.0'
+end

data/test/test_classic_application.rb

@@ -0,0 +1,66 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+gem 'sinatra', '>= 0.9.1'
+require 'sinatra'
+
+require 'sinatra/mailer'
+
+set :environment, :test
+
+configure do
+  Sinatra::Mailer.config = {:sendmail_path => '/usr/sbin/sendmail'}
+  Sinatra::Mailer.delivery_method = :test_send
+end
+
+get '/' do
+  'Classic sample application'
+end
+
+get '/defined' do
+  sent = email(
+    :to => 'foo@example.com',
+    :from => 'bar@example.com',
+    :subject => 'Test Mail',
+    :body => 'Plain text mail'
+  )
+  'Email sent!'
+end
+
+
+require "test/unit"
+require "rack/test"
+
+begin
+  require "redgreen"
+rescue LoadError
+end
+
+class TestClassicApplication < Test::Unit::TestCase
+
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def teardown
+    Sinatra::Mailer.deliveries.clear
+  end
+
+  def test_home_ok
+    get '/'
+    assert_equal 200, last_response.status
+    assert last_response.body.length > 0
+  end
+
+  def test_helper_method
+    assert defined?(:email)
+    get '/defined'
+    assert_equal 200, last_response.status
+    assert_equal 1, Sinatra::Mailer.deliveries.size
+    delivery = Sinatra::Mailer.deliveries.last
+    assert delivery.kind_of?(MailFactory)
+    assert_equal ['foo@example.com'], delivery.get_header('to')
+  end
+end

data/test/test_modular_application.rb

@@ -0,0 +1,68 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+gem 'sinatra', '>= 0.9.1'
+require 'sinatra/base'
+
+require 'sinatra/mailer'
+
+class ModularAppSample < Sinatra::Base
+
+  register Sinatra::Mailer
+
+  configure do
+    Sinatra::Mailer.config = {:sendmail_path => '/usr/sbin/sendmail'}
+    Sinatra::Mailer.delivery_method = :test_send
+  end
+
+  get '/' do
+    'Modular sample application'
+  end
+
+  get '/defined' do
+    sent = email(
+      :to => 'foo@example.com',
+      :from => 'bar@example.com',
+      :subject => 'Test Mail',
+      :body => 'Plain text mail'
+    )
+    'Email sent!'
+  end  
+end
+
+require "test/unit"
+require "rack/test"
+
+begin
+  require "redgreen"
+rescue LoadError
+end
+
+class TestModularApplication < Test::Unit::TestCase
+
+  include Rack::Test::Methods
+
+  def app
+    ModularAppSample.new
+  end
+
+  def teardown
+    Sinatra::Mailer.deliveries.clear
+  end
+
+  def test_home_ok
+    get '/'
+    assert_equal 200, last_response.status
+    assert last_response.body.length > 0
+  end
+
+  def test_helper_method
+    assert defined?(:email)
+    get '/defined'
+    assert_equal 200, last_response.status
+    assert_equal 1, Sinatra::Mailer.deliveries.size
+    delivery = Sinatra::Mailer.deliveries.last
+    assert delivery.kind_of?(MailFactory)
+    assert_equal ['foo@example.com'], delivery.get_header('to')
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: kusor-sinatra_mailer
+version: !ruby/object:Gem::Version 
+  version: 0.9.3
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+- Pedro P. Candel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mailfactory
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: "Sinatra::Mailer extension extracted from Merb::Mailer by Nicol\xC3\xA1s Sanguinetti."
+email: kusorbox@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- sinatra_mailer.gemspec
+- Rakefile
+- lib/sinatra/mailer.rb
+has_rdoc: false
+homepage: http://github.com/kusor/sinatra-mailer/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Send emails from Sinatra like Merb::Mailer
+test_files: 
+- test/test_classic_application.rb
+- test/test_modular_application.rb