padrino-mailer 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,6 +1,96 @@
 = padrino-mailer
 
-Description goes here.
+This component uses an enhanced version of the excellent <tt>pony</tt> library (vendored) for a powerful but simple
+mailer system within Sinatra. There is full support for using an html content type as well as for file attachments.
+The MailerPlugin has many similarities to ActionMailer but is much lighterweight and (arguably) easier to use.
+
+== Installation
+
+To install the 'full-stack' padrino framework, simply grab the latest version from gemcutter:
+
+  $ sudo gem install padrino --source http://gemcutter.org
+  
+This will install the necessary padrino gems to get you started.
+Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
+
+You can also install only the padrino-mailer gem for more fine-grained use:
+
+  $ sudo gem install padrino-mailer --source http://gemcutter.org
+  
+== Usage
+
+Let's take a look at using the MailerPlugin in an application. By default, MailerPlugin uses the built-in sendmail
+functionality on the server. However, smtp is also supported using the following configuration:
+
+    SinatraMore::MailerBase.smtp_settings = {
+      :host   => 'smtp.gmail.com',
+      :port   => '587',
+      :tls    => true,
+      :user   => 'user',
+      :pass   => 'pass',
+      :auth   => :plain
+   }
+
+Once those have been defined, the default will become smtp delivery unless overwritten in an individual mail definition.
+Next, we should define a custom mailer extended from <tt>SinatraMore::MailerBase</tt>.
+
+  # app/mailers/sample_mailer.rb
+  class SampleMailer < SinatraMore::MailerBase
+    def registration_email(name, user_email_address)
+      from 'admin@site.com'
+      to user_email_address
+      subject 'Welcome to the site!'
+      body    :name => name
+      type    'html'                # optional, defaults to plain/text
+      charset 'windows-1252'        # optional, defaults to utf-8
+      via     :sendmail             # optional, to smtp if defined otherwise sendmail
+    end
+  end
+
+This defines a mail called '<tt>registration_mail</tt>' with the specified attributes for delivery. The <tt>body</tt> method
+is passing the <tt>name</tt> attribute to the body message template which should be defined in
+<tt>[views_path]/sample_mailer/registration_email.erb</tt> as shown below:
+
+  # ./views/sample_mailer/registration_email.erb
+  This is the body of the email and can access the <%= name %> that was passed in from the mailer definition
+  That's all there is to defining the body of the email which can be plain text or html
+
+Once the mailer definition has been completed and the template has been defined, the email can be sent using:
+
+  SampleMailer.deliver(:registration_email, "Bob", "bob@bobby.com")
+
+or if you like the method_missing approach:
+
+  SampleMailer.deliver_registration_email "Bob", 'bob@bobby.com'
+
+And that will then deliver the email according the the configured options. This is really all you need to send emails.
+A few variations are shown below for completeness.
+
+If we want to attach files to our email:
+
+  # app/mailers/sample_mailer.rb
+  class SampleMailer < SinatraMore::MailerBase
+    def attachment_email(name, user_email_address)
+      from 'admin@site.com'
+      to user_email_address
+      # ...
+      attachments { "foo.zip" => File.read("path/to/foo.zip"), "file.txt" => "this is a text file!" }
+    end
+  end
+
+or perhaps we want to have a short body without the need for a template file:
+
+  # app/mailers/sample_mailer.rb
+  class SampleMailer < SinatraMore::MailerBase
+    def short_email(name, user_email_address)
+      from 'admin@site.com'
+      to user_email_address
+      subject 'Welcome to the site!'
+      body    "This is a short body defined right in the mailer itself"
+    end
+  end
+
+See the wiki article for additional information: <...WIKI...>
 
 == Copyright
 

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/padrino/padrino-mailer"
     gem.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
     gem.add_runtime_dependency     "sinatra",       ">= 0.9.2"
+    gem.add_runtime_dependency     "padrino-core",  ">= 0.1.1"
     gem.add_runtime_dependency     "tilt",          ">= 0.2"
     gem.add_development_dependency "shoulda", ">= 0"
     gem.add_development_dependency "haml",          ">= 2.2.1"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/padrino-mailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{padrino-mailer}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-18}
   s.description = %q{Mailer system for padrino allowing easy delivery of application emails}
   s.email = %q{nesquena@gmail.com}
   s.extra_rdoc_files = [
@@ -52,6 +52,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 0.9.2"])
+      s.add_runtime_dependency(%q<padrino-core>, [">= 0.1.1"])
       s.add_runtime_dependency(%q<tilt>, [">= 0.2"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<haml>, [">= 2.2.1"])
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<webrat>, [">= 0.5.1"])
     else
       s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+      s.add_dependency(%q<padrino-core>, [">= 0.1.1"])
       s.add_dependency(%q<tilt>, [">= 0.2"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<haml>, [">= 2.2.1"])
@@ -69,6 +71,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<sinatra>, [">= 0.9.2"])
+    s.add_dependency(%q<padrino-core>, [">= 0.1.1"])
     s.add_dependency(%q<tilt>, [">= 0.2"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<haml>, [">= 2.2.1"])

data/test/fixtures/mailer_app/app.rb

@@ -11,12 +11,13 @@ class MailerDemo < Sinatra::Base
       :user   => 'user',
       :pass   => 'pass',
       :auth   => :plain
-   }
+    }
   end
-  
+
   register Padrino::Mailer
-  
-  class SampleMailer < Padrino::Mailer::Base    
+
+  class SampleMailer < Padrino::Mailer::Base
+    
     def birthday_message(name, age)
       subject "Happy Birthday!"
       to   'john@fake.com'
@@ -24,7 +25,7 @@ class MailerDemo < Sinatra::Base
       body 'name' => name, 'age' => age
       via  :smtp
     end
-    
+
     def anniversary_message(names, years_married)
       subject "Happy anniversary!"
       to   'julie@fake.com'
@@ -33,12 +34,12 @@ class MailerDemo < Sinatra::Base
       type 'html'
     end
   end
-  
+
   post "/deliver/plain" do
     result = SampleMailer.deliver_birthday_message("Joey", 21)
     result ? "mail delivered" : 'mail not delivered'
   end
-  
+
   post "/deliver/html" do
     result = SampleMailer.deliver_anniversary_message("Joey & Charlotte", 16)
     result ? "mail delivered" : 'mail not delivered'
@@ -46,5 +47,5 @@ class MailerDemo < Sinatra::Base
 end
 
 class MailerUser
-  
-end
+
+end

data/test/test_padrino_mailer.rb

@@ -7,7 +7,10 @@ class TestPadrinoMailer < Test::Unit::TestCase
   end
 
   context 'for mail delivery in sample application' do
-    setup { MailerDemo::SampleMailer.smtp_settings = MailerDemo.smtp_settings }
+    setup { 
+      Padrino::Mailer::Base::views_path = MailerDemo.views
+      MailerDemo::SampleMailer.smtp_settings = MailerDemo.smtp_settings 
+    }
 
     should 'be able to deliver plain text emails' do
       assert_email_sent(:to => 'john@fake.com', :from => 'noreply@birthday.com', :via => :smtp,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: padrino-mailer
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Padrino Team
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -08:00
+date: 2009-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +25,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.2
     version: 
+- !ruby/object:Gem::Dependency 
+  name: padrino-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: tilt
   type: :runtime