padrino-mailer 0.9.10 → 0.9.11

data/lib/padrino-mailer/helpers.rb

@@ -0,0 +1,125 @@
+module Padrino
+  module Mailer
+    module Helpers
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      ##
+      # Delivers an email with the given mail attributes (to, from, subject, cc, bcc, body, et.al)
+      #
+      # ==== Examples
+      #
+      #   email do
+      #     to      @user.email
+      #     from    "awesomeness@example.com",
+      #     subject "Welcome to Awesomeness!"
+      #     locals  :a => a, :b => b
+      #     render  'path/to/my/template'
+      #   end
+      #
+      def email(mail_attributes={}, &block)
+        settings.email(mail_attributes, &block)
+      end
+
+      ##
+      # Delivers a mailer message email with the given attributes
+      #
+      # ==== Examples
+      #
+      #   deliver(:sample, :birthday, "Joey", 21)
+      #   deliver(:example, :message, "John")
+      #
+      def deliver(mailer_name, message_name, *attributes)
+        settings.deliver(mailer_name, message_name, *attributes)
+      end
+
+      module ClassMethods
+        def inherited(subclass) #:nodoc:
+          @_registered_mailers ||= {}
+          super(subclass)
+        end
+
+        ##
+        # Returns all registered mailers for this application
+        #
+        def registered_mailers
+          @_registered_mailers ||= {}
+        end
+
+        ##
+        # Defines a mailer object allowing the definition of various email messages that can be delivered
+        #
+        # ==== Examples
+        #
+        #   mailer :sample do
+        #     email :birthday do |name, age|
+        #       subject 'Happy Birthday!'
+        #       to      'john@fake.com'
+        #       from    'noreply@birthday.com'
+        #       locals  :name => name, :age => age
+        #       render  'sample/birthday'
+        #     end
+        #   end
+        #
+        def mailer(name, &block)
+          mailer                   = Padrino::Mailer::Base.new(self, name, &block)
+          mailer.delivery_settings = delivery_settings
+          registered_mailers[name] = mailer
+          mailer
+        end
+        alias :mailers :mailer
+
+        ##
+        # Delivers a mailer message email with the given attributes
+        #
+        # ==== Examples
+        #
+        #   deliver(:sample, :birthday, "Joey", 21)
+        #   deliver(:example, :message, "John")
+        #
+        def deliver(mailer_name, message_name, *attributes)
+          registered_mailers[mailer_name].messages[message_name].call(*attributes).deliver
+        end
+
+        ##
+        # Delivers an email with the given mail attributes (to, from, subject, cc, bcc, body, et.al) using settings of
+        # the given app.
+        #
+        # ==== Examples
+        #
+        #   MyApp.email(:to => 'to@ma.il', :from => 'from@ma.il', :subject => 'Welcome!', :body => 'Welcome Here!')
+        #
+        #   # or if you prefer blocks
+        #
+        #   MyApp.email do
+        #     to @user.email
+        #     from "awesomeness@example.com",
+        #     subject "Welcome to Awesomeness!"
+        #     body 'path/to/my/template', :locals => { :a => a, :b => b }
+        #   end
+        #
+        def email(mail_attributes={}, &block)
+          message = Mail::Message.new(self)
+          message.delivery_method(*delivery_settings)
+          message.instance_eval(&block) if block_given?
+          mail_attributes.each_pair { |k, v| message.method(k).call(v) }
+          message.deliver
+        end
+
+        private
+          ##
+          # Return the parsed delivery method
+          #
+          def delivery_settings
+            @_delivery_setting ||= begin
+              return [:sendmail, { :location => `which sendmail`.chomp }] unless respond_to?(:delivery_method)
+              return [delivery_method.keys[0], delivery_method.values[0]] if delivery_method.is_a?(Hash)
+              return [delivery_method, {}] if delivery_method.is_a?(Symbol)
+              [nil, {}]
+            end
+          end
+      end
+    end # Helpers
+  end # Mailer
+end # Padrino

data/lib/padrino-mailer/mime.rb

@@ -0,0 +1,42 @@
+module Padrino
+  module Mailer
+    module Mime
+
+      ##
+      # Returns Symbol with mime type if found, otherwise use +fallback+.
+      # +mime+ should be the content type like "text/plain"
+      # +fallback+ may be any symbol
+      #
+      # Also see the documentation for MIME_TYPES
+      #
+      # ==== Examples
+      #
+      #   => :plain
+      #   Padrino::Mailer::Mime.mime_type('text/plain')
+      #   => :html
+      #   Padrino::Mailer::Mime.mime_type('text/html')
+      #
+      # This is a shortcut for:
+      #
+      #   Padrino::Mailer::Mime::MIME_TYPES.fetch('text/plain', :plain)
+      #
+      def self.mime_type(mime, fallback=:plain)
+        MIME_TYPES.fetch(mime.to_s.downcase, fallback)
+      end
+
+      # List of most common mime-types, selected various sources
+      # according to their usefulness in a emailg scope for Ruby
+      # users.
+      #
+      # You can add your own mime types like:
+      #
+      #   Padrino::Mailer::MIME_TYPES.merge!("text/xml" => :xml)
+      #
+      MIME_TYPES = {
+        "text/html"  => :html,
+        "text/plain" => :plain,
+        "text/xml"   => :xml
+      }
+    end # Mime
+  end # Mailer
+end # Padrino

data/padrino-mailer.gemspec

@@ -1,77 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+require File.expand_path("../../padrino-core/lib/padrino-core/version.rb", __FILE__)
+require 'rubygems'
+require 'bundler'
 
 Gem::Specification.new do |s|
   s.name = %q{padrino-mailer}
-  s.version = "0.9.10"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = %q{padrino-mailer}
   s.authors = ["Padrino Team", "Nathan Esquenazi", "Davide D'Agostino", "Arthur Chiu"]
-  s.date = %q{2010-04-22}
-  s.description = %q{Mailer system for padrino allowing easy delivery of application emails}
   s.email = %q{padrinorb@gmail.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "lib/padrino-mailer.rb",
-     "lib/padrino-mailer/base.rb",
-     "lib/padrino-mailer/delivery.rb",
-     "lib/padrino-mailer/mail_object.rb",
-     "padrino-mailer.gemspec",
-     "test/fixtures/mailer_app/app.rb",
-     "test/fixtures/mailer_app/views/demo_mailer/sample_mail.erb",
-     "test/fixtures/mailer_app/views/sample_mailer/anniversary_message.erb",
-     "test/fixtures/mailer_app/views/sample_mailer/birthday_message.erb",
-     "test/fixtures/mailer_app/views/sample_mailer/foo_message.erb",
-     "test/helper.rb",
-     "test/test_base.rb",
-     "test/test_mail_object.rb",
-     "test/test_padrino_mailer.rb"
-  ]
+  s.summary = %q{Mailer system for padrino}
   s.homepage = %q{http://github.com/padrino/padrino-framework/tree/master/padrino-mailer}
+  s.description = %q{Mailer system for padrino allowing easy delivery of application emails}
+  s.required_rubygems_version = ">= 1.3.6"
+  s.version = Padrino.version
+  s.date = Time.now.strftime("%Y-%m-%d")
+  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.files = %w(.document .gitignore LICENSE README.rdoc Rakefile padrino-mailer.gemspec) + Dir.glob("{bin,lib,test}/**/*")
   s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{padrino-mailer}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Mailer system for padrino}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<padrino-core>, ["= 0.9.10"])
-      s.add_runtime_dependency(%q<tmail>, [">= 1.2"])
-      s.add_development_dependency(%q<shoulda>, [">= 2.10.3"])
-      s.add_development_dependency(%q<haml>, [">= 2.2.1"])
-      s.add_development_dependency(%q<mocha>, [">= 0.9.7"])
-      s.add_development_dependency(%q<rack-test>, [">= 0.5.0"])
-      s.add_development_dependency(%q<webrat>, [">= 0.5.1"])
-    else
-      s.add_dependency(%q<padrino-core>, ["= 0.9.10"])
-      s.add_dependency(%q<tmail>, [">= 1.2"])
-      s.add_dependency(%q<shoulda>, [">= 2.10.3"])
-      s.add_dependency(%q<haml>, [">= 2.2.1"])
-      s.add_dependency(%q<mocha>, [">= 0.9.7"])
-      s.add_dependency(%q<rack-test>, [">= 0.5.0"])
-      s.add_dependency(%q<webrat>, [">= 0.5.1"])
-    end
-  else
-    s.add_dependency(%q<padrino-core>, ["= 0.9.10"])
-    s.add_dependency(%q<tmail>, [">= 1.2"])
-    s.add_dependency(%q<shoulda>, [">= 2.10.3"])
-    s.add_dependency(%q<haml>, [">= 2.2.1"])
-    s.add_dependency(%q<mocha>, [">= 0.9.7"])
-    s.add_dependency(%q<rack-test>, [">= 0.5.0"])
-    s.add_dependency(%q<webrat>, [">= 0.5.1"])
-  end
-end
-
+  s.require_path = 'lib'
+  s.add_runtime_dependency(%q<padrino-core>, ["= #{Padrino.version}"])
+  s.add_bundler_dependencies :mailer, :development
+end

data/test/fixtures/basic.erb

@@ -0,0 +1 @@
+This is a body of text from a template

data/test/fixtures/layout.erb

@@ -0,0 +1 @@
+Layout Basic <%= yield %>

data/test/fixtures/padrino_app/app.rb

@@ -0,0 +1,69 @@
+ENV['PADRINO_ENV'] = 'test'
+PADRINO_ROOT = File.dirname(__FILE__) unless defined? PADRINO_ROOT
+
+class PadrinoApp < Padrino::Application
+  register Padrino::Mailer
+
+  set :delivery_method, :smtp => {
+    :address              => "smtp.gmail.com",
+    :port                 => 587,
+    :domain               => 'your.host.name',
+    :user_name            => '<username>',
+    :password             => '<password>',
+    :authentication       => 'plain',
+    :enable_starttls_auto => true
+  }
+
+  mailer :sample do
+    email :birthday do |name, age|
+      subject "Happy Birthday!"
+      to      'john@fake.com'
+      from    'noreply@birthday.com'
+      locals  :name => name, :age => age
+      via     :test
+      render  'sample/birthday'
+    end
+
+    email :anniversary do |names, years_married|
+      subject "Happy anniversary!"
+      to   'julie@fake.com'
+      from 'noreply@anniversary.com'
+      content_type :html
+      via     :test
+      locals  :names => names, :years_married => years_married
+      render  'sample/anniversary'
+    end
+
+    message :welcome do |name|
+      subject "Welcome Message!"
+      to      'john@fake.com'
+      from    'noreply@custom.com'
+      locals  :name => name
+      via     :test
+      render  'sample/foo_message'
+    end
+  end
+
+  post "/deliver/inline" do
+    result = email(:to => "john@apple.com", :from => "joe@smith.com", :subject => "Test Email", :body => "Test Body", :via => :test)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/plain" do
+    result = deliver(:sample, :birthday, "Joey", 21)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/html" do
+    result = deliver(:sample, :anniversary, "Joey & Charlotte", 16)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/custom" do
+    result = deliver(:sample, :welcome, "Bobby")
+    result ? "mail delivered" : 'mail not delivered'
+  end
+end
+
+Padrino.mount_core("PadrinoApp")
+Padrino.load!

data/test/fixtures/sinatra_app/app.rb

@@ -0,0 +1,67 @@
+require 'sinatra/base'
+require 'haml'
+
+class SinatraApp < Sinatra::Base
+  register Padrino::Mailer
+
+  set :root, File.dirname(__FILE__)
+  set :delivery_method, :smtp => {
+    :address              => "smtp.gmail.com",
+    :port                 => 587,
+    :domain               => 'your.host.name',
+    :user_name            => '<username>',
+    :password             => '<password>',
+    :authentication       => 'plain',
+    :enable_starttls_auto => true
+  }
+
+  mailer :sample do
+    email :birthday do |name, age|
+      subject "Happy Birthday!"
+      to      'john@fake.com'
+      from    'noreply@birthday.com'
+      locals  :name => name, :age => age
+      via     :test
+      render  'sample/birthday'
+    end
+
+    email :anniversary do |names, years_married|
+      subject "Happy anniversary!"
+      to   'julie@fake.com'
+      from 'noreply@anniversary.com'
+      locals :names => names, :years_married => years_married
+      content_type :html
+      via  :test
+      render 'sample/anniversary'
+    end
+
+    message :welcome do |name|
+      subject "Welcome Message!"
+      to      'john@fake.com'
+      from    'noreply@custom.com'
+      locals  :name => name
+      via     :test
+      render  'sample/foo_message'
+    end
+  end
+
+  post "/deliver/inline" do
+    result = email(:to => "john@apple.com", :from => "joe@smith.com", :subject => "Test Email", :body => "Test Body", :via => :test)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/plain" do
+    result = deliver(:sample, :birthday, "Joey", 21)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/html" do
+    result = deliver(:sample, :anniversary, "Joey & Charlotte", 16)
+    result ? "mail delivered" : 'mail not delivered'
+  end
+
+  post "/deliver/custom" do
+    result = deliver(:sample, :welcome, "Bobby")
+    result ? "mail delivered" : 'mail not delivered'
+  end
+end

data/test/fixtures/sinatra_app/views/mailers/demo/sample_mail.erb

@@ -0,0 +1 @@
+This is a sample message

data/test/fixtures/sinatra_app/views/mailers/sample/anniversary.erb

@@ -0,0 +1,2 @@
+<p>Yay <%= names %>!</p>
+<p>You have been married <%= years_married %> years</p>

data/test/fixtures/sinatra_app/views/mailers/sample/birthday.erb

@@ -0,0 +1,2 @@
+Happy Birthday <%= name %>!
+You are turning <%= age %>

data/test/fixtures/sinatra_app/views/mailers/sample/foo_message.erb

@@ -0,0 +1 @@
+Hello to <%= name %>

data/test/fixtures/views/mailers/alternate/foo.erb

@@ -0,0 +1 @@
+This is a foo message in mailers/alternate dir

data/test/fixtures/views/mailers/bar.erb

@@ -0,0 +1 @@
+This is a bar message in mailers dir

data/test/fixtures/views/mailers/i18n/hello.en.erb

@@ -0,0 +1 @@
+Hello World

data/test/fixtures/views/mailers/i18n/hello.it.erb

@@ -0,0 +1 @@
+Salve Mondo

data/test/fixtures/views/mailers/layouts/sample.erb

@@ -0,0 +1 @@
+Layout Sample <%= yield %>