bulkmail 0.1

data/CHANGELOG

@@ -0,0 +1,25 @@
+*0.1*
+
+* Add INT trap.
+
+* Changed reporting of success/error.
+
+* Tweaks to binary script.
+
+* Basically functional.
+
+* Rewrote everything.
+
+* Wrote preliminary bulkmail.rb.
+
+* Wrote preliminary spec.
+
+* Fixed Rakefile for spec to work.
+
+* Created lib and spec directories.
+
+* Wrote Rakefile.
+
+* Preliminary content.
+
+* Created basic project structure.

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2006 Sharon Rosner
+
+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 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

@@ -0,0 +1,42 @@
+= about bulkmail
+
+Bulkmail is a simple bulk mailing utility in Ruby. It takes a content file and a recipients file, and sends the content to each address listed in the recipients file. I wrote it to be as simple as possible, and as a basic alternative to commercial bulk-mailers. The free ones suck.
+
+== Usage
+
+=== From the Command Line
+
+  bulkmail <options>
+
+where the options are:
+  [--recipients, -r] recipients file name
+  [--content, -c] content file name
+  [--subject, -s] subject
+  [--from, -f] from
+  [--host, -h] smtp hostname (if none is specified localhost is presumed)
+  [--user, -u] user name (if authentication is needed)
+  [--password, -p] password (if authentication is needed)
+  [--auth, -a] authentication type
+  [--mime, -m] message mime type.
+
+You can also include headers in the content file, provided they are followed by a blank line. For example:
+
+  Subject: Baroque Concert this Thursday
+
+  Hello Baroque Lovers,
+    A special concert is about to take place this Thursday at...
+
+=== From Ruby
+
+BulkMail.send(options)
+
+Valid options are:
+  [:recipients_file] recipients file name
+  [:content_file] content file name
+  [:subject] subject
+  [:from] from
+  [:additional_headers] additional headers
+
+You can set server settings in the same fashion as ActionMailer by using the convenience method:
+
+  BulkMail.server_settings[:address] = 'mail.example.com'

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'fileutils'
+include FileUtils
+
+NAME = "bulkmail"
+VERS = "0.1"
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "Bulkmail Documentation",
+  "--opname", "index.html",
+  "--line-numbers", 
+  "--main", "README",
+  "--inline-source"]
+
+desc "Packages up bulkmail."
+task :default => [:package]
+task :package => [:clean]
+
+task :doc => [:rdoc]
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.options += RDOC_OPTS
+  rdoc.main = "README"
+  rdoc.title = "Bulkmail Documentation"
+  rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/*.rb']
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERS
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
+  s.rdoc_options += RDOC_OPTS + 
+    ['--exclude', '^(examples|extras)\/', '--exclude', 'lib/*.rb']
+  s.summary = "Ruby bulk-mailer."
+  s.description = s.summary
+  s.author = "Sharon Rosner"
+  s.email = 'ciconia@gmail.com'
+  s.homepage = 'http://code.google.com/p/bulkmail/'
+  s.executables = ['bulkmail']
+
+  s.add_dependency('actionmailer')
+  s.required_ruby_version = '>= 1.8.2'
+
+  s.files = %w(COPYING README Rakefile) + Dir.glob("{bin,doc,lib}/**/*") 
+      
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERS}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+task :doc_rforge do
+  sh %{rake doc}
+  sh %{scp -r doc/rdoc/* ciconia@rubyforge.org:/var/www/gforge-projects/bulkmail}
+end
+
+##############################################################################
+# SVN
+##############################################################################
+
+desc "Add new files to subversion"
+task :svn_add do
+   system "svn status | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\ /g' | xargs svn add"
+end
+

data/bin/bulkmail

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+
+config = {
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: bulkmail <options>"
+  opts.define_head "Simple bulk-mailer."
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-h", "--host HOSTNAME", "SMPT host name. Default is localhost.") do |v|
+    config[:host] = v
+  end
+  
+  opts.on("-r", "--recipients filename", "Recipients file name") do |v|
+    config[:recipients_file] = v
+  end
+  
+  opts.on("-c", "--content filename", "Content file name") do |v|
+    config[:content_file] = v
+  end
+  
+  opts.on("-s", "--subject subject", "Subject line") do |v|
+    config[:subject] = v
+  end
+  
+  opts.on("-f", "--from from", "From address") do |v|
+    config[:from] = v
+  end
+  
+  opts.on("-u", "--user username", "User name (for authentication)") do |v|
+    config[:user] = v
+  end
+  
+  opts.on("-p", "--password password", "Password (for authentication)") do |v|
+    config[:password] = v
+  end
+  
+  opts.on("-a", "--authentication type", "Authentication type") do |v|
+    config[:authentication] = v
+  end
+  
+  opts.on("-m", "--mime type", "MIME type") do |v|
+    config[:content_type] = v
+  end
+
+  # No argument, shows at tail.  This will print an options summary.
+  # Try it and see!
+  opts.on_tail("-?", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  # Another typical switch to print the version.
+  opts.on_tail("-v", "--version", "Show version") do
+    class << Gem; attr_accessor :loaded_specs; end
+    specs = Gem.loaded_specs['bulkmail']
+    puts "bulkmail #{specs.version} (#{specs.date.strftime '%Y-%m-%d'})"
+    exit
+  end
+end
+
+begin
+  opts.parse! ARGV
+rescue => e
+  puts e.message
+  exit
+end
+
+unless config[:recipients_file] && config[:content_file]
+  puts opts
+  exit
+end
+
+require 'bulkmail'
+
+BulkMail.server_settings[:address] = config[:host] if config[:host]
+BulkMail.server_settings[:user_name] = config[:user] if config[:user]
+BulkMail.server_settings[:password] = config[:password] if config[:password]
+BulkMail.server_settings[:authentication] = config[:authentication].to_sym if config[:authentication]
+
+p BulkMail.server_settings
+
+job = BulkMail.send(config)
+trap('INT') {job.thread.exit;}
+job.thread.join
+puts "Message sent to #{job.delivered} of #{job.total} recipients."

data/lib/bulkmail.rb

@@ -0,0 +1,75 @@
+require 'action_mailer'
+
+# The BulkMail module contains the Job class, which does the actual
+# bulk-mailing, and a convenience method to start a job.
+module BulkMail
+  class Mailer < ActionMailer::Base #:nodoc
+    def msg(addr, sub, content, from_addr, c_type, additional_headers)
+      recipients addr
+      subject sub if sub
+      body content
+      from from_addr if from_addr
+      content_type c_type if c_type
+      headers additional_headers if additional_headers
+    end
+  end
+
+  # The Job class performs the bulk-mailing work. Each instance starts a thread
+  # That goes over the list of recipients and sends each one an email. A job
+  # can also be queried for its progress, returning a number between 0 and 1.
+  class Job
+    attr_accessor :progress, :errors, :thread, :delivered, :total
+    
+    def initialize(opts)
+      @recipients = IO.readlines(opts[:recipients_file])
+      @subject = opts[:subject]
+      @from = opts[:from]
+      @content_type = opts[:content_type]
+      @content = load_content(opts[:content_file])
+      @progress = 0
+      @delivered = 0
+      @total = @recipients.size
+      @errors = []
+      @thread = Thread.new {process}
+    end
+
+    def load_content(fn)
+      content = IO.readlines(fn)
+      while line = content.shift
+        break if line.empty?
+        if line =~ /^(.+):\s?(.*)$/
+          @headers ||= {}
+          @headers[$1] = $2
+        else
+          content.unshift(line)
+          break
+        end
+      end
+      content.join
+    end
+    
+    def process
+      @recipients.each_with_index do |addr, idx|
+        begin
+          Mailer.deliver_msg(addr, @subject, @content, @from, @content_type, @headers)
+          @progress = idx / @recipients.size
+          @delivered += 1
+          puts "Sent email to #{addr}"
+        rescue => e
+          puts e.message
+          @errors << e
+        end
+      end
+      @progress = 1
+    end
+  end
+  
+  def self.send(opts)
+    Job.new(opts)
+  end
+  
+  def self.server_settings
+    ActionMailer::Base.server_settings
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: bulkmail
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-10-18 00:00:00 +02:00
+summary: Ruby bulk-mailer.
+require_paths: 
+- lib
+email: ciconia@gmail.com
+homepage: http://code.google.com/p/bulkmail/
+rubyforge_project: 
+description: Ruby bulk-mailer.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Sharon Rosner
+files: 
+- COPYING
+- README
+- Rakefile
+- bin/bulkmail
+- lib/bulkmail.rb
+- CHANGELOG
+test_files: []
+
+rdoc_options: 
+- --quiet
+- --title
+- Bulkmail Documentation
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)\/
+- --exclude
+- lib/*.rb
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- COPYING
+executables: 
+- bulkmail
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: