notes_mailer 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+== Version 0.0.1 - 2010-11-06 <goesser3@gmail.com>
+* initial public release 
+
+== Version 0.0.0 - 2010-10-27 <goesser3@gmail.com>
+* attaching files via add_file 
+
+== Version 0.0.0 - 2010-06-18 <goesser3@gmail.com>
+* initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009, 2010 Elias Kugler
+
+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.rdoc

@@ -0,0 +1,65 @@
+= NotesMailer
+
+Small gem that uses IBM Lotus Notes to deliver your e-mails. 
+
+== Installation
+
+  # gem install notes_mailer
+
+== Usage
+  require 'rubygems'
+  require 'notes_mailer'
+  
+  Mail.defaults do
+      delivery_method Mail::NotesMailer, { 
+         :address       => "",     # your Notes-Server adress
+                                        # "" or default if you are using a local database
+         :user_name   => '<username>',
+         :password     => '<password>',
+         :db              => '<database>'}
+    end
+  
+  Mail.deliver do
+      to 'mikel@test.lindsaar.net'
+      subject 'testing notes_mailer'
+      body 'testing notes_mailer'
+      add_file 'c:/path/to/file.txt'
+  end
+
+== Prerequisites
+
+ 1. Ruby 1.8.6 or later
+ 2. IBM Lotus Notes 
+
+== Supported Platforms
+
+This library is supported on Windows 2000 or later.
+
+==Used libs: 
+* win32ole 
+* mail
+* log4r
+...
+
+== Licence/Copyright
+
+Copyright (c) 2010 Elias Kugler
+
+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/lib/notes_mailer.rb

@@ -0,0 +1,189 @@
+require 'mail'
+require 'fileutils'
+require 'log4r'
+
+module Mail
+
+  # == Sending Email with NotesMailer
+  # 
+  # NotesMailer allows you to send emails using IBM Lotus Notes. This is done by wrapping the Lotus Notes-win32ole-api.
+  # The usage is very similar to the SMTP devlivery method in the mail gem.
+  # 
+  # require 'rubygems'
+  # require 'notes_mailer'
+  #
+  # Mail.defaults do
+  #    delivery_method Mail::NotesMailer, { :address              => "",
+  #                              :user_name            => '<username>',
+  #                              :password             => '<password>',
+  #                              :db => '<database>'}
+  # end
+  #
+  # === Delivering the email (from smtp.rb)
+  # 
+  # Once you have the settings right, sending the email is done by:
+  # 
+  #   Mail.deliver do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  # Or by calling deliver on a Mail message
+  # 
+  #   mail = Mail.new do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing sendmail'
+  #     body 'testing sendmail'
+  #   end
+  # 
+  #   mail.deliver!
+  class Message
+    alias old_initialize initialize
+    attr_reader :files_to_attach
+    def initialize(*args, &block)
+      @files_to_attach = []
+      old_initialize(*args, &block)
+    end
+    def add_file(filename)
+      raise "Parameter must be a string" unless filename.is_a?String
+      raise "File '#{filename}' does not exists" unless File.exists?(filename)
+      @files_to_attach << filename
+    end
+  end
+
+  class NotesMailer
+    @@logger = nil
+    # Provides a store of all the emails 
+    def NotesMailer.deliveries
+      @@deliveries ||= []
+    end
+    
+    def NotesMailer.deliveries=(val)
+      @@deliveries = val
+    end
+
+    # NotesMailer supports the following settings:
+    # Mandatory: 
+    #  :user_name  ... Lotus Notes user
+    #  :db             ... Latus Notes database
+    # Optional    
+    #  :password   ... Latus Notes password
+    #  :adress       ... Adress of your Lotus Notes Server, emty if you are using a local database 
+    #  ::mock_win32ole => true     ... test without using Lotus Notes 
+    #  :logger => true,                 ... use logger
+    #  :debug => true                   ... 
+    def initialize(values)
+      self.settings = { :adress       => '', #server is localhost
+                             :password => ''
+                             }.merge(values)
+                             
+     
+      #raise "Notes password missing" unless settings[:password]
+      raise "Notes db missing" unless settings[:db]
+      raise "Notes user_name missing" unless settings[:user_name]
+      
+      if settings[:mock_win32ole] 
+        $LOAD_PATH.unshift File.dirname(__FILE__) + '/../test/mock/win32ole'
+      end
+      require 'win32ole'
+      
+      if settings[:logger] and !@@logger
+        NotesMailer.init_logger(settings[:debug])
+      end
+
+      log_debug "--- settings --- "
+      log_debug settings
+
+      s = WIN32OLE.new 'Lotus.NotesSession'
+      s.Initialize(settings[:password])
+      
+      @notes_db = s.GetDatabase(settings[:adress], settings[:db])
+      raise "Cannot open #{settings[:db]}" unless @notes_db.IsOpen()
+
+    end
+    
+    attr_accessor :settings
+
+    def deliver!(mail)
+      #Mail::NotesMailer.deliveries << mail
+      
+      destinations ||= mail.destinations if mail.respond_to?(:destinations) && mail.destinations
+      if destinations.blank?
+        raise ArgumentError.new('At least one recipient (To, Cc or Bcc) is required to send a message') 
+      end
+      
+      log_debug "--- log mail ---"
+      log_debug "destinations : "
+      log_debug  destinations
+      log_debug "mail to      : "
+      log_debug mail.to
+      log_debug "mail cc      : "
+      log_debug mail.cc
+      log_debug "mail bcc      : "
+      log_debug mail.bcc
+      log_debug "mail subject : "
+      log_debug mail.subject
+      log_debug "mail body    : " 
+      log_debug mail.body.to_s 
+      log_debug "--- end ---"
+      
+      new_mail = @notes_db.CreateDocument
+      new_mail.replaceItemValue("Form",'Memo')
+      new_mail.replaceItemValue("SendTo",mail.to) 
+      new_mail.replaceItemValue("CopyTo",mail.cc) 
+      new_mail.replaceItemValue("BlindCopyTo",mail.bcc) 
+      new_mail.replaceItemValue("Subject",mail.subject)
+      
+      #new_mail.replaceItemValue("Body", mail.body.to_s)
+      rti = new_mail.CreateRichTextItem("Body")
+      rti.AppendText( mail.body.to_s)
+      rti.AddNewLine()
+      rti.AppendText( "\nfrom #{mail.from.to_s}\n") if mail.from.to_s.size > 0
+      log_debug("\nfrom #{mail.from.to_s}\n") if mail.from.to_s.size > 0
+
+      mail.files_to_attach.each do |filename|
+        log_debug "attach: " + filename
+        # EMBED_ATTACHMENT (1454), EMBED_OBJECT (1453), EMBED_OBJECTLINK (1452)
+        rti.EmbedObject(1454,File.basename(filename),filename) # 1454 == EMBED_ATTACHMENT
+      end      
+      new_mail.Send(0) 
+      
+      self
+    end
+    
+    def NotesMailer.init_logger(debug)
+      FileUtils::mkdir_p("#{Dir.pwd}/log")
+      @@logger = Log4r::Logger.new("notes_mailer_logger") 
+      
+      if debug
+        puts "see logfile: #{Dir.pwd}/log/notes_mailer.log"
+        log_level = Log4r::DEBUG
+      else
+        log_level = Log4r::INFO
+      end
+      
+      Log4r::FileOutputter.new('logfile', 
+                         :filename=>"#{Dir.pwd}/log/notes_mailer.log", 
+                         :trunc=>false,
+                         :level=> log_level)
+                         
+      @@logger.add('logfile')
+    
+    end
+    def log_info(*args, &block)
+      if @@logger
+         @@logger.info(*args, &block)
+      end
+    end
+    def log_debug(*args, &block)
+      if @@logger
+         p args
+         @@logger.debug(*args, &block)
+      end
+    end
+  
+  end
+end

data/notes_mailer.gemspec

@@ -0,0 +1,30 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |s|
+  s.name = %q{notes_mailer}
+  s.version = "0.0.1"
+  s.authors = ["Elias Kugler"]
+  s.email = %q{groesser3@gmail.com}
+  s.files =   Dir["lib/**/*"] + Dir["bin/**/*"] + Dir["test/**/*"]+ Dir["*.rb"] + ["MIT-LICENSE","notes_mailer.gemspec"]
+  s.platform    = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc"]
+  s.require_paths = ["lib"]
+  s.summary = %q{Small gem that uses IBM Lotus Notes to deliver your e-mails.}
+  s.description = %q{NotesMailer allows you to send emails using your local IBM Lotus Notes installation. It is implemented by wrapping the Lotus Notes-win32ole-api as a custom delivery method for Mail. The usage is very similar to the SMTP delivery method in the popular Mail-gem.}
+  s.files.reject! { |fn| fn.include? "CVS" }
+  s.require_path = "lib"
+  #s.default_executable = %q{}
+  #s.executables = [""]
+  s.homepage = %q{http://rubyforge.org/projects/notesmailer/}
+  s.rubyforge_project = %q{notesmailer}
+  s.add_dependency("mail", ">= 2.2.1")
+  s.add_dependency("log4r", ">=1.0.5")
+
+end
+
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

data/test/mock/win32ole/win32ole.rb

@@ -0,0 +1,112 @@
+require 'log4r'
+require 'fileutils'
+
+# mock
+class NotesValues
+  def initialize(arr=[])
+    @arr=arr
+  end
+  def Values
+    @arr
+  end
+end
+
+class NotesDocument
+    attr_accessor :uid, :deleted, :notes_values
+    def initialize
+      @deleted = false
+      @notes_values = {}
+    end
+    def UniversalID
+       return @uid
+    end
+    def GetFirstItem(key)
+      @notes_values[key]
+    end
+    def LastModified
+      '2009-12-02T16:01:21+00:00'
+    end
+    def IsDeleted
+      @deleted
+    end
+    def replaceItemValue(key, value)
+      @notes_values[key] = value
+    end
+    def Send(para)
+    
+    end
+    def CreateRichTextItem(name)
+      CreateRichTextItem.new(name)
+    end
+end
+
+class CreateRichTextItem
+  def initialize(name)
+  end
+  def AppendText(text)
+  end
+  def AddNewLine()
+  end
+  def EmbedObject(type, name, filename)
+  end
+end
+
+class NotesView
+  def initialize
+    @cursor = -1
+    @elements = []    
+  end
+  
+  def GetLastDocument
+    if @elements.size == 0
+      return false
+    else
+      @cursor = @elements.size-1
+      return @elements[@cursor]
+    end
+  end
+  def GetPrevDocument(entry)
+    @cursor -= 1
+    if @cursor < 0
+      return false
+    else
+      return @elements[@cursor]
+    end
+  end
+end
+
+class NotesDB
+  def initialize(db)
+  end
+  def GetView(view)
+    NotesView.new
+  end
+  def isOpen
+    true
+  end
+  def CreateDocument
+    NotesDocument.new
+  end
+end
+
+
+class WIN32OLE # NotesSession
+  def initialize(app)
+  end
+  def Initialize(pwd)
+  end
+  def GetDatabase(server, db)
+    NotesDB.new(db)
+  end
+  def WIN32OLE.init_logger
+    FileUtils::mkdir_p("#{Dir.pwd}/log")
+    @@logger = Log4r::Logger.new("win32ole_logger")      
+    Log4r::FileOutputter.new('win32ole_log', 
+                         :filename=>"#{Dir.pwd}/log/win32ole.log", 
+                         :trunc=>false,
+                         :level=>Log4r::INFO)
+    @@logger.add('win32ole_log')
+  end
+  WIN32OLE.init_logger
+
+end

data/test/test_notes_mailer.rb

@@ -0,0 +1,26 @@
+$:.unshift '../lib'
+
+require 'rubygems'
+require 'notes_mailer'
+
+Mail.defaults do
+  delivery_method Mail::NotesMailer, { :adress              => "",  # local database
+                                :db         => 'notes_db.nsf',
+                                :user_name       => 'myname',
+                                :password         => '', 
+                                #:mock_win32ole =>  true,   # test without using Lotus Notes 
+                                #:logger => true,
+                                #:debug => true
+                                }
+
+end
+
+Mail.deliver do
+  to 'user@test.com'
+  from 'you@test.com'
+  subject 'test'
+  body 'hello'
+  add_file File.join(Dir.pwd, 'test_notes_mailer.rb')
+  
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: notes_mailer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Elias Kugler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        - 1
+        version: 2.2.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 5
+        version: 1.0.5
+  type: :runtime
+  version_requirements: *id002
+description: NotesMailer allows you to send emails using your local IBM Lotus Notes installation. It is implemented by wrapping the Lotus Notes-win32ole-api as a custom delivery method for Mail. The usage is very similar to the SMTP delivery method in the popular Mail-gem.
+email: groesser3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+files: 
+- lib/notes_mailer.rb
+- test/mock/win32ole/win32ole.rb
+- test/test_notes_mailer.rb
+- MIT-LICENSE
+- notes_mailer.gemspec
+- README.rdoc
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://rubyforge.org/projects/notesmailer/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: notesmailer
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Small gem that uses IBM Lotus Notes to deliver your e-mails.
+test_files: []
+