aerogel-mailer 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d2ded2ae8256f5f9459d757c4365d4ec7ac6063
-  data.tar.gz: 16cd2ad084083d218f9b4e9def41ad5685e63dcd
+  metadata.gz: 338b48b0e5fe4f6a72c29fcfe8ae28cc9b5c51a5
+  data.tar.gz: f25e3c711d479d5cd373ebcbb5f543b2a7ec6262
 SHA512:
-  metadata.gz: a3e154ffcc6f1f6d47e7505b251f24435b9a92b888c7b5224720baba5890d265efcd960398d97f4593a291e68ce85ba22713acd17a4b9b3ab52dd587f53a2eb5
-  data.tar.gz: 43e997ca8c98234f571ea11763df72f2f4acf2f7c5d965bc1d821969d454124ef89ba22bc40d6342a70aae498b5e4e66234d3cea651af2bc53402a21e40af47b
+  metadata.gz: 753dcaeb9a141af26c6ac8c2b452577965bc46231decaa45a133a3ed596bbf42687c185a07613e41b4e8ee353d1f7a626f5344ca7b39a955560e6257a270b4d4
+  data.tar.gz: 97926b451efa64b7171325b16ed8c22761b17ac7b677abf186bcda3b49d9805c166fba10194111320c9f48f4e8358d3b51bad2ce37943d11f34574978358c46e

data/README.md

@@ -4,22 +4,33 @@ A mail delivery module for aerogel applications.
 
 ## Usage
 
-
-In your application's config.ru:
 ```ruby
+# config.ru
 require 'aerogel/core'
-require 'aerogel/mailer' #
+require 'aerogel/mailer'
 
-# define a new mailer named :test
-Aerogel.mailer :test do |f, t|
-  from f
-  to t
-  subject 'test'
-  body 'hello'
-end
+run Aerogel::Application.load
+```
 
-# then send email message using this mailer:
-Aerogel.email :test, 'from@domain.org', 'to@another.org'
+```ruby
+# app/mailers/my-test-mailer.rb
+# define mailer:
+class Aerogel::Application
+    mailer :test do |f, t|
+      from f
+      to t
+      subject 'test'
+      body 'hello'
+    end
+end
+```
 
-run Aerogel::Application.load
+```ruby
+# app/routes/my-test-route.rb
+# send mail from route handler:
+class Aerogel::Application
+    get "/test-mail" do
+        email :test, 'from@domain.org', 'to@another.org'
+    end
+end
 ```

data/aerogel-mailer.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alex@kukushk.in"]
   spec.description   = %q{Mail sending for aerogel applications}
   spec.summary       = %q{Mail sending for aerogel applications}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/kukushkin/aerogel-mailer"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/app/helpers/email.rb

@@ -1,7 +1,7 @@
 module Aerogel::Helpers
 
   def email( *args )
-    Aerogel.email( *args )
+    Aerogel::Application.email( *args )
   end
 
 end # module Aerogel::Helpers

data/config/mailer.conf

@@ -1,3 +1,4 @@
 mailer {
   delivery_method :test
+  default_from 'noreply'
 }

data/lib/aerogel/mailer.rb

@@ -2,6 +2,8 @@ require 'aerogel/core'
 require 'aerogel/mailer/version'
 require 'aerogel/mailer/core'
 require 'aerogel/mailer/definition'
+require 'aerogel/mailer/error'
+
 
 module Aerogel
 
@@ -10,12 +12,8 @@ module Aerogel
 
   # configure module
   on_load do |app|
-    Mailer.configure
+    app.register Aerogel::Mailer
   end
 
-  # Extend Aerogel
-  #
-  extend Aerogel::Mailer
-
 end
 

data/lib/aerogel/mailer/core.rb

@@ -2,21 +2,17 @@ require 'mail'
 
 module Aerogel::Mailer
 
-  def self.configure
+  # Configures module Aerogel::Mailer
+  #
+  def self.registered(app)
     aerogel_delivery_method = Aerogel.config.mailer.delivery_method
     aerogel_delivery_options = Aerogel.config.mailer.delivery_options.raw || {}
     Mail.defaults do
       delivery_method aerogel_delivery_method, aerogel_delivery_options
     end
-  end
-
-  def self.register_mailer( mailer )
-    @mailers ||= {}
-    @mailers[mailer.name] = mailer
-  end
 
-  def self.mailers
-    @mailers || {}
+    # load mailers
+    Aerogel::require_resources( :app, "mailers/**/*.rb" )
   end
 
   # Registers new mailer
@@ -25,24 +21,37 @@ module Aerogel::Mailer
     Definition.new name, block
   end
 
+  # Deliver email using mailer specified by +name+
+  #
   def email( name, *args )
-    unless Aerogel::Mailer.mailers[name]
+    mailer = Aerogel::Mailer::Definition.mailers[name.to_sym]
+    unless mailer
       raise ArgumentError.new "Mailer '#{name}' is not defined"
     end
-    params = Aerogel::Mailer.mailers[name].eval( *args )
+    params = mailer.compile( *args )
     puts "** sending mail: #{params}"
     begin
-      Mail.deliver do
+      message = Mail.new do
         from params[:from]
         to params[:to]
         subject params[:subject]
-        body params[:body]
+        text_part do
+          content_type 'text/plain; charset=UTF-8'
+          body params[:body][:text]
+        end if params[:body][:text]
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body params[:body][:html]
+        end if params[:body][:html]
       end
-    rescue => e
-      raise "Mailer '#{name}' failed to deliver email: #{e}"
+      message.charset = "UTF-8"
+      message.deliver
+    rescue StandardError => e
+      raise Aerogel::Mailer::Error.new "Mailer '#{name}' failed to deliver email: #{e}"
     end
-    # params,
+    true
   end
 
 
+
 end # module Aerogel::Mailer

data/lib/aerogel/mailer/definition.rb

@@ -1,14 +1,18 @@
 module Aerogel::Mailer
 class Definition
 
+  include Aerogel::Render::Scope
+
   attr_accessor :name, :blk, :params
 
+  DEFAULT_LAYOUT = "mailer"
+
   def initialize( name, blk )
     self.name = name.to_sym
     self.params = {}
     self.blk = blk
 
-    Aerogel::Mailer.register_mailer( self )
+    self.class.register_mailer( self )
   end
 
   def from( str )
@@ -23,18 +27,128 @@ class Definition
     params[:subject] = str
   end
 
-  def body( str )
-    params[:body] = str
+  # Sets layout name for text/plain and text/html layouts
+  # or disables layout for message body templates.
+  #
+  # Example
+  #   layout false # disables layout for text and html message templates
+  #   layout 'mailer-admin' # sets layouts to 'views/layouts/mailer-admin.text.erb'
+  #                        # and 'views/layouts/mailer-admin.html.erb'
+  #
+  def layout( name )
+    params[:layout] = name
+  end
+
+  # Sets message body. Multiple calls to #body are allowed,
+  # e.g. for setting  plain text part and html part separately.
+  #
+  # If message body is set via call to #body, existing mailer templates
+  # and layout will be ignored.
+  #
+  # +args+ can be a String, which sets the text/plain message body
+  # or a Hash.
+  #
+  # Example:
+  #   body "This is a plain text message"
+  #   body html: "This is a HTML only message"
+  #   body text: "This is a plain text", html: "and <b>HTML</b> message"
+  #
+  def body( args )
+    params[:body] ||= {}
+    if args.is_a? String
+      params[:body][:text] = args
+    elsif args.is_a? Hash
+      params[:body][:html] = args[:html] if args.include? :html
+      params[:body][:text] = args[:text] if args.include? :text
+    else
+      raise ArgumentError.new "Invalid argument #{args.class} to #body"
+    end
+  end
+
+  # Sets local variables to be passed to template. Multiple calls to #locals
+  # are allowed, variables passed this way will be merged into one set before
+  # passing to a template.
+  #
+  # Example:
+  #   locals user: current_user, url: url
+  #   locals order: order
+  #
+  def locals( args )
+    params[:locals] ||= {}
+    params[:locals].merge! args
   end
 
-  def eval( *args )
+  def compile( *args )
     unless args.size == blk.arity
-      raise ArgumentError.new("wrong number of arguments for mailer '#{name}': #{args.size} for #{blk.arity}")
+      raise Aerogel::Mailer::Error.new("wrong number of arguments for mailer '#{name}': #{args.size} for #{blk.arity}")
+    end
+    @self_before_instance_eval = eval "self", blk.binding
+    params.clear
+    instance_exec( *args, &blk )
+    params[:from] ||= config.mailer.default_from
+    if params[:from].nil?
+      raise Aerogel::Mailer::Error.new("'from' address is not set for mailer '#{name}'")
     end
-    self.instance_exec( *args, &blk )
+    render_body
     params
   end
 
+  def method_missing( method, *args, &block )
+    @self_before_instance_eval.send method, *args, &block
+  end
+
+  def self.register_mailer( mailer )
+    @mailers ||= {}
+    @mailers[mailer.name] = mailer
+  end
+
+  def self.mailers
+    @mailers || {}
+  end
+
+private
+
+  # Returns template file name, use cached file name if possible.
+  #
+  def fetch_template_name( filename )
+    @template_name_cache ||= {} # reset if reload templates is used
+    return @template_name_cache[filename] unless @template_name_cache[filename].nil?
+    if Aerogel.get_resource( :views, filename+".erb" )
+      @template_name_cache[filename] = filename.to_sym
+    else
+      @template_name_cache[filename] = false # template not found
+    end
+    @template_name_cache[filename]
+  end
+
+  # Renders message body using filled params.
+  # Stores rendered body (text and html parts) into params[:body] hash.
+  #
+  def render_body
+    params[:body] ||= {}
+    return unless params[:body].blank? # body set in the mailer definition block
+    if params[:layout] == false
+      layout_text = false
+      layout_html = false
+    else
+      layout_name = params[:layout] || DEFAULT_LAYOUT
+      layout_text = fetch_template_name( "layouts/#{layout_name}.text" )
+      layout_html = fetch_template_name( "layouts/#{layout_name}.html" )
+    end
+    body_text = fetch_template_name( "mailers/#{name}.text" )
+    body_html = fetch_template_name( "mailers/#{name}.html" )
+    if !body_text && !body_html
+      raise Aerogel::Mailer::Error.new "No body templates found for mailer '#{name}'"
+    end
+    if body_text
+      params[:body][:text] = erb body_text, layout: layout_text, locals: params[:locals]
+    end
+    if body_html
+      params[:body][:html] = erb body_html, layout: layout_html, locals: params[:locals]
+    end
+    true
+  end
+
 end # class Definition
 end # module Aerogel::Mailer
 

data/lib/aerogel/mailer/error.rb

@@ -0,0 +1,5 @@
+module Aerogel::Mailer
+  class Error < StandardError
+
+  end # class Error
+end # module Aerogel::Mailer

data/lib/aerogel/mailer/version.rb

@@ -1,5 +1,5 @@
 module Aerogel
   module Mailer
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aerogel-mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aerogel-core
@@ -80,16 +80,15 @@ files:
 - Rakefile
 - aerogel-mailer.gemspec
 - app/helpers/email.rb
-- config/README.md
 - config/development/mailer.conf
 - config/mailer.conf
 - config/production/mailer.conf
 - lib/aerogel/mailer.rb
 - lib/aerogel/mailer/core.rb
 - lib/aerogel/mailer/definition.rb
+- lib/aerogel/mailer/error.rb
 - lib/aerogel/mailer/version.rb
-- views/README.md
-homepage: ''
+homepage: https://github.com/kukushkin/aerogel-mailer
 licenses:
 - MIT
 metadata: {}

data/config/README.md

@@ -1,3 +0,0 @@
-A place for your ```*.conf``` files.
-
-Environment specific configs go into folders 'production' or 'development'.

data/views/README.md

@@ -1 +0,0 @@
-A place for module views.