ruport-util 0.1.0 → 0.2.0

data/Rakefile

@@ -18,7 +18,7 @@ end
 
 spec = Gem::Specification.new do |spec|
   spec.name = "ruport-util"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "A set of tools and helper libs for Ruby Reports"
   spec.files =  Dir.glob("{example,lib,test,bin}/**/**/*") +
@@ -34,6 +34,7 @@ spec = Gem::Specification.new do |spec|
                       # '--main'  << 'README' << '-q'
   spec.add_dependency('ruport', ">=0.9.3")
   spec.add_dependency('scruffy', ">=0.2.2")
+  spec.add_dependency('mailfactory',">=1.2.3")
   spec.author = "Gregory Brown"
   spec.email = "  gregory.t.brown@gmail.com"
   spec.rubyforge_project = "ruport"
@@ -45,8 +46,7 @@ END_DESC
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_files.include( "README",
-                           "TODO", #"CHANGELOG",
+  rdoc.rdoc_files.include( "TODO", #"CHANGELOG",
                            "AUTHORS", "COPYING",
                            "LICENSE", "lib/" )
   rdoc.main     = "README"

data/example/mailer.rb

@@ -0,0 +1,29 @@
+require "ruport"
+require "ruport/util/mailer"
+require "fileutils"
+class MyReport < Ruport::Report
+  def prepare
+    mailer :default,
+      :host => "mail.adelphia.net",
+      :address => "gregory.t.brown@gmail.com"
+   end
+
+  def generate
+    Table(%w[a b c]) { |t| t << [1,2,3] << [4,5,6] }.to_pdf
+  end
+
+  def cleanup
+    FileUtils.rm("foo.pdf")
+  end
+end
+
+MyReport.run do |res|
+ res.write "foo.pdf";
+ res.send_to("gregory.t.brown@gmail.com") do |mail|
+   mail.subject = "Sample report"
+   mail.attach "foo.pdf"
+   mail.text = <<-EOS
+     this is a sample of sending an emailed report from within Ruport.
+   EOS
+ end
+end

data/lib/ruport/util/mailer.rb

@@ -0,0 +1,179 @@
+# mailer.rb
+#  Created by Gregory Brown on 2005-08-16
+#  Copyright 2005 (Gregory Brown) All Rights Reserved.
+#  This product is free software, you may distribute it as such
+#  under your choice of the Ruby license or the GNU GPL
+#  See LICENSE for details
+require "net/smtp"
+require "forwardable"
+
+module Ruport
+  
+  #
+  # === Overview
+  #
+  # This class uses SMTP to provide a simple mail sending mechanism.
+  # It also uses MailFactory to provide attachment and HTML email support. 
+  #
+  # === Example
+  #
+  # Here is a simple example of a message which attaches a README file:
+  #
+  #   require "ruport"
+  #     
+  #   Ruport.configure do |config| 
+  #     config.mailer :default, 
+  #                   :host    => "mail.adelphia.net", 
+  #                   :address => "gregory.t.brown@gmail.com"
+  #   end
+  #
+  #   mailer = Ruport::Mailer.new
+  #
+  #   mailer.attach "README"
+  #
+  #   mailer.deliver :to      => "gregory.t.brown@gmail.com",
+  #                  :from    => "gregory.t.brown@gmail.com",
+  #                  :subject => "Hey there",               
+  #                  :text    => "This is what you asked for"
+  #
+  class Mailer
+    extend Forwardable
+   
+    #
+    # Creates a new Mailer object. Optionally, you can select a mailer 
+    # specified by Ruport::Config.
+    #
+    # Example:
+    #
+    #   a = Mailer.new        # uses the :default mailer
+    #   a = Mailer.new :foo   # uses :foo mail config from Ruport::Config
+    #
+    def initialize( mailer_label=:default )
+      select_mailer(mailer_label); 
+      mail_object.from = @mailer.address if mail_object.from.to_s.empty?
+      rescue
+        raise "you need to specify a mailer to use"
+    end
+   
+    def_delegators( :@mail, :to, :to=, :from, :from=, 
+                           :subject, :subject=, :attach, 
+                           :text, :text=, :html, :html= )
+   
+    # 
+    # Sends the message.
+    #
+    # Example:
+    #
+    #   mailer.deliver :from => "gregory.t.brown@gmail.com",
+    #                  :to   => "greg7224@gmail.com"
+    #
+    def deliver(options={})
+      options.each { |k,v| send("#{k}=",v) if respond_to? "#{k}=" }
+      
+      Net::SMTP.start(@host,@port,@host,@user,@password,@auth) do |smtp|
+        smtp.send_message((options[:mail_object] || mail_object).to_s, options[:from], options[:to] )
+      end
+    end
+
+    private
+
+    def select_mailer(label)
+      @mailer      = Ruport::Config.mailers[label]
+      @host       = @mailer.host
+      @user       = @mailer.user
+      @password   = @mailer.password
+      @address    = @mailer.address
+      @port       = @mailer.port       || 25
+      @auth       = @mailer.auth_type  || :plain
+      @mail_klass = @mailer.mail_klass
+    end
+
+    def mail_object
+      return @mail if @mail
+      return @mail ||= @mail_klass.new if @mail_klass
+      require "mailfactory"
+      @mail ||= MailFactory.new
+    end
+    
+  end
+
+  class Report
+    # Creates a new Mailer and sets the <tt>to</tt> attribute to the addresses
+    # specified. Yields a Mailer object, which can be modified before delivery.
+    #
+    def send_to(adds)
+      use_mailer(:default) unless @mailer
+      m = Mailer.new
+      m.to = adds
+      yield(m)
+      m.send(:select_mailer,@mailer)
+      m.deliver :from => m.from, :to => m.to
+    end
+
+    # Sets the active mailer to the Ruport::Config source requested by <tt>label</tt>.
+    def use_mailer(label)
+      @mailer = label
+    end
+
+    def_delegator Ruport::Config, :mailer
+ 
+  end
+
+  module Config
+    module_function
+    # Verifies that you have provided a host for your mailer.
+    def check_mailer(settings, label) # :nodoc:
+      unless settings.host
+        Ruport.log(
+          "Missing host for mailer #{label}",
+          :status => :fatal, :level => :log_only,
+          :raises => ArgumentError
+        )
+      end
+    end
+
+    # :call-seq:
+    #   mailer(mailer_name, options)
+    #
+    # Creates or retrieves a mailer configuration. Available options:
+    # <b><tt>:host</tt></b>::         The SMTP host to use.
+    # <b><tt>:address</tt></b>::      Address the email is being sent from.
+    # <b><tt>:user</tt></b>::         The username to use on the SMTP server
+    # <b><tt>:password</tt></b>::     The password to use on the SMTP server. 
+    #                                 Optional.
+    # <b><tt>:port</tt></b>::         The SMTP port to use. Optional, defaults
+    #                                 to 25.
+    # <b><tt>:auth_type</tt></b>::    SMTP authorization method. Optional, 
+    #                                 defaults to <tt>:plain</tt>.
+    # <b><tt>:mail_klass</tt></b>::   If you don't want to use the default 
+    #                                 <tt>MailFactory</tt> object, you can 
+    #                                 pass another mailer to use here.
+    #                               
+    # Example (creating a mailer config):
+    #   mailer :alternate, :host => "mail.test.com", 
+    #                      :address => "test@test.com",
+    #                      :user => "test", 
+    #                      :password => "blinky"
+    #                      :auth_type => :cram_md5
+    #
+    # Example (retreiving a mailer config):
+    #   mail_conf = mailer(:alternate)  #=> <OpenStruct ..>
+    #   mail_conf.address               #=> test@test.com
+    #
+    def mailer(*args)
+      return mailers[args.first] if args.length == 1
+      mailers[args.first] = OpenStruct.new(*args[1..-1])
+      check_mailer(mailers[args.first],args.first)
+    end
+
+    # Alias for <tt>mailers[:default]</tt>.
+    def default_mailer
+      mailers[:default]
+    end
+
+    # Returns all the <tt>mailer</tt>s defined in this <tt>Config</tt>.
+    def mailers; @mailers ||= {}; end
+  end
+
+
+end

data/test/samples/data.csv

@@ -0,0 +1,3 @@
+"col1","col2","col3"
+"a","b","c"
+"d",,"e"

data/test/test_mailer.rb

@@ -0,0 +1,205 @@
+require "test/unit"
+begin; require "rubygems"; rescue LoadError; nil end
+require "ruport"
+require "ruport/util/mailer"
+begin
+  require 'mocha'
+  require 'stubba'
+  require 'net/smtp'
+rescue LoadError
+  $stderr.puts "Warning: Mocha not found -- skipping some Mailer tests"
+end
+
+class TestMailer < Test::Unit::TestCase
+
+  def setup
+    @default_opts = {
+      :host => "mail.example.com", 
+      :address => "sue@example.com", 
+      :user => "inky",
+      :password => "chunky"
+    }
+
+    @other_opts = {
+      :host => "moremail.example.com",
+      :address => "clyde@example.com",
+      :user => "blinky",
+      :password => "bacon"
+    }
+
+    Ruport::Config.mailer :default, @default_opts
+    Ruport::Config.mailer :other, @other_opts
+
+    @default_mailer = Ruport::Mailer.new
+    @other_mailer = Ruport::Mailer.new :other 
+  end
+    
+  def assert_mailer_equal(expected, mailer)
+    assert_equal expected[:host], mailer.instance_variable_get(:@host)
+    assert_equal expected[:address], mailer.instance_variable_get(:@address)
+    assert_equal expected[:user], mailer.instance_variable_get(:@user)
+    assert_equal expected[:password], mailer.instance_variable_get(:@password)
+  end
+
+  def test_send_to
+     return unless Object.const_defined? :Mocha
+     setup_mock_report_mailer
+     @report = Ruport::Report.new
+     assert_equal "250 ok", @report.send_to("clyde@example.com") { |mail|
+       mail.subject = "Test Report"
+       mail.text = "Test"
+     }
+   end
+
+  def test_mail_defaults
+    assert_equal( Ruport::Config.mailers[:default], 
+                  Ruport::Config.default_mailer)
+  end
+
+
+  
+  def test_default_constructor    
+    assert_mailer_equal @default_opts, @default_mailer
+  end
+  
+  def test_constructor_with_mailer_label
+    assert_mailer_equal @other_opts, @other_mailer
+  end
+
+  def test_constructor_without_mailer
+    Ruport::Config.mailers[:default] = nil
+    assert_raise(RuntimeError) { Ruport::Mailer.new }
+  end
+ 
+  def test_select_mailer
+    mailer = Ruport::Mailer.new :default
+    assert_mailer_equal @default_opts, mailer
+
+    mailer.send(:select_mailer, :other)
+    assert_mailer_equal @other_opts, mailer
+  end
+
+  def test_mailer_config_errors
+    assert_raise(ArgumentError) {
+      Ruport::Config.mailer :bar, :user => :foo, :address => "foo@bar.com"
+    }
+    assert_nothing_raised { Ruport::Config.mailer :bar, :host => "localhost" }
+  end
+
+
+
+  def test_to
+    @default_mailer.instance_eval "@mail.to = ['foo@bar.com']"
+    assert_equal ['foo@bar.com'], @default_mailer.to
+  end
+
+  def test_to_equals
+    @default_mailer.to = ['foo@bar.com']
+    assert_equal ['foo@bar.com'], @default_mailer.to    
+  end
+
+  def test_from
+    @default_mailer.instance_eval "@mail.from = ['foo@bar.com']"
+    assert_equal ['foo@bar.com'], @default_mailer.from
+  end
+
+  def test_from_equals
+    @default_mailer.from = ['foo@bar.com']
+    assert_equal ['foo@bar.com'], @default_mailer.from
+  end
+
+  def test_subject
+    @default_mailer.instance_eval "@mail.subject = ['RuportDay!']"
+    assert_equal ['RuportDay!'], @default_mailer.subject
+  end
+
+  def test_subject_equals
+    @default_mailer.subject = ['RuportDay!']
+    assert_equal ['RuportDay!'], @default_mailer.subject
+  end
+
+  def test_send_mail_with_default
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
+  end
+
+  def test_send_mail_with_other
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1, @other_mailer)
+    assert_equal "250 ok",
+      @other_mailer.deliver(:to      => "sue@example.com",
+                            :from    => "clyde@example.com",
+                            :subject => "Hello",
+                            :text    => "This is a test.")
+  end
+
+  def test_send_mail_without_to
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_raise(Net::SMTPSyntaxError) {
+      @default_mailer.deliver(:from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
+    }
+  end
+
+  def test_send_html_mail
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :html    => "<p>This is a test.</p>")
+  end
+
+  def test_send_mail_with_attachment
+    return unless Object.const_defined? :Mocha
+    setup_mock_mailer(1)
+    @default_mailer.attach 'test/samples/data.csv'
+    assert_equal "250 ok",
+      @default_mailer.deliver(:to      => "clyde@example.com",
+                              :from    => "sue@example.com",
+                              :subject => "Hello",
+                              :text    => "This is a test.")
+  end
+  
+  private
+  
+  def setup_mock_mailer(count, mailer=@default_mailer)
+    host      = mailer.instance_variable_get(:@host)
+    port      = mailer.instance_variable_get(:@port)
+    user      = mailer.instance_variable_get(:@user)
+    password  = mailer.instance_variable_get(:@password)
+    auth      = mailer.instance_variable_get(:@auth)
+    
+    @smtp     = mock('smtp')
+    
+    Net::SMTP.expects(:start).
+      with(host,port,host,user,password,auth).
+      yields(@smtp).
+      returns("250 ok").times(count)
+    @smtp.stubs(:send_message).
+      with {|*params| !params[2].nil? }.
+      returns("250 ok")
+    @smtp.stubs(:send_message).
+      with {|*params| params[2].nil? }.
+      raises(Net::SMTPSyntaxError)
+  end
+  
+  def setup_mock_report_mailer
+     @smtp     = mock('smtp')
+ 
+     Net::SMTP.expects(:start).
+       yields(@smtp).
+       returns("250 ok").at_least_once
+     @smtp.stubs(:send_message).
+       returns("250 ok")
+   end
+end
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ruport-util
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-04-04 00:00:00 -04:00
+  version: 0.2.0
+date: 2007-04-10 00:00:00 -04:00
 summary: A set of tools and helper libs for Ruby Reports
 require_paths: 
 - lib
@@ -29,24 +29,31 @@ post_install_message:
 authors: 
 - Gregory Brown
 files: 
-- example/graph_report.rb
+- example/mailed_report.rb
 - example/invoice_report.rb
 - example/managed_report.rb
+- example/mailer.rb
+- example/graph_report.rb
 - lib/ruport
 - lib/ruport/util
 - lib/ruport/util.rb
 - lib/ruport/util/graph.rb
-- lib/ruport/util/invoice.rb
 - lib/ruport/util/report_manager.rb
+- lib/ruport/util/mailer.rb
+- lib/ruport/util/invoice.rb
+- test/samples
 - test/init.rb
+- test/test_report_manager.rb
 - test/test_graph_renderer.rb
+- test/test_mailer.rb
 - test/test_invoice.rb
-- test/test_report_manager.rb
+- test/samples/data.csv
 - Rakefile
 test_files: 
+- test/test_report_manager.rb
 - test/test_graph_renderer.rb
+- test/test_mailer.rb
 - test/test_invoice.rb
-- test/test_report_manager.rb
 rdoc_options: 
 - --title
 - Ruport Documentation
@@ -77,3 +84,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.2.2
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mailfactory
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: