powermta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 380695bb8cb1afe88b0a05c41c7014ea06080235
+  data.tar.gz: 056c48364f4e79cb90fe20971f2eca22379bb1a9
+SHA512:
+  metadata.gz: 5a3fe948076523edcfb9c3d3ba66e483dfe33570858665cb1031d21b4f02f5e5e005373b84bf5ef361c4666547feda0bace17222b1bea2feacc687560a39f3cb
+  data.tar.gz: a5beb8839b817dbe111200e80be36baf2d550c573cdf51f98e338dda8ee5a06e44e3f33a3a7454389d0f5c6845a93c813743343d01a3728e54597a6a1a673272

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ian Warshak
+
+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,66 @@
+= powermta
+
+This is an extension to Ruby's net/smtp library that lets you take advantage
+of PowerMTA's (port25.com) native mailmerge and XACK features. 
+
+If you are doing any kind of mass mailing and you want the message to be unique 
+to each user, and not one email with 50000000 people bcc'ed on it, this 
+extension is for you.
+
+I extracted this library from schoolsout.com, which literally sends hundreds of thousands of 
+time-sensitive emails a day.
+
+Example usage:
+
+  require 'pmta_extension'
+
+  users = User.find(:all)
+
+  email_text =<<-EOF 
+    From: "your friendly social network" <support@nosebook.com>
+    To: [*to]
+    Subject: Howdy [firstname]
+    
+    Dear [firstname],
+    
+    Did you know that you have [friend_count] friends? You must be one popular [gender]!!!
+    
+    Sincerely,
+    Your friends at NoseBook
+    EOF
+
+  addresses = []
+  users.each do |user|
+    addresses << {:address => user.email, 
+                  :variables => {"firstname" => user.firstname, "friend_count" => user.friends.size, "gender" => user.gender == "m" ? 'dude' : 'gal'}}
+  end
+
+  Net::PowerMTA.start('your.powermta.mailserver.com', 25) do |smtp|
+    smtp.disable_xack  # if you want to ignore ACK on RCPT TO and XDFN commands
+    smtp.send_merge_message(email_text, 'support@nosebook.com', true, addresses)
+  end
+
+That's it. Now instead of having to compose and send User.size custom emails
+(which can take forever), you can send 1 mailmerge message to the PowerMTA server
+(the mail server) and have it do all of the merging for you. 
+
+Feel free to email me with any questions. Ian Warshak <iwarshak@stripey.net>
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Compatibility
+
+Compatible for ruby >= 1.8.7 and <= 2.1.2
+
+== Copyright
+
+Copyright (c) 2010 Ian Warshak. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "powermta"
+    gem.summary = %Q{Do mail-merging with PowerMTA. Compatible with Ruby 1.8.7 & 1.9.X, but NOT 1.8.6}
+    gem.description = %Q{This is an extension to Ruby's net/smtp library that lets you take advantage
+    of PowerMTA's (port25.com) native mailmerge feature.}
+    gem.email = "iwarshak@stripey.net"
+    gem.homepage = "http://github.com/iwarshak/powermta"
+    gem.authors = ["Ian Warshak"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "powermta #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pmta_extension.rb

@@ -0,0 +1,101 @@
+require 'net/smtp'
+
+module Net
+  class PowerMTA < Net::SMTP
+    def initialize(address, port = nil)
+      super(address, port)
+      @xack = true
+    end
+
+    # only a merging 1 part
+    def send_merge_message( msgstr, from_addr, verp = true,  to_addrs_with_variables = [])      
+      raise IOError, 'closed session' unless @socket
+
+      xmrg_from from_addr, verp
+
+      to_addrs_with_variables.each do |addr|
+        xmrg_to addr[:address], addr[:variables]
+      end
+
+      # With mail merge, we don't send DATA command, we send XPRT command
+      res = critical {
+        check_continue get_response('XPRT 1 LAST')
+        @socket.write_message msgstr
+        recv_response()
+      }
+      check_response res
+      res
+    end
+    
+    # Enable/Disable XACK to ignore ACKs from SMTP Server on multiple RCPT TO calls
+    def enable_xack
+      getok('XACK ON')
+      @xack = true
+    end
+    
+    def disable_xack
+      getok('XACK OFF')
+      @xack = false
+    end
+    
+    private
+    
+    def expect_ack?(command)
+      @xack || !command.match(/^(RCPT TO:|XDFN)/)
+    end
+
+    def xmrg_from(fromaddr, verp)
+      if $SAFE > 0
+        raise SecurityError, 'tainted from_addr' if from_addr.tainted?
+      end
+      if verp
+        getok("XMRG FROM:<#{fromaddr}> VERP")
+      else
+        getok("XMRG FROM:<#{fromaddr}>")
+      end
+    end
+    
+    def xmrg_to(to_addr, variables = {})
+      return unless to_addr
+      variables ||= {}
+      variables.merge!("*parts" => "1") unless variables["*parts"]
+      variables.each do |key,value|
+        getok("XDFN #{key.to_s}=\"#{value.to_s}\"")
+      end   
+      begin
+        rcptto(to_addr)
+      rescue
+        #puts "Bad address: #{to}. #{$!}"
+      end
+    end
+    
+    def getok(reqline)
+      logging "<< #{reqline}"
+      res = critical {
+        @socket.writeline reqline
+        recv_response() if expect_ack?( reqline )
+      }
+
+      return nil unless expect_ack?( reqline )
+      check_response res
+      res
+    end
+    
+    def recv_response
+      buf = ''
+      while true
+        line = @socket.readline
+        buf << line << "\n"
+        break unless line[3,1] == '-'   # "210-PIPELINING"
+      end
+      logging ">> #{buf}"
+      Response.parse(buf)
+    end
+    
+    def get_response(reqline)
+      logging "<< #{reqline}"
+      @socket.writeline reqline
+      recv_response()
+    end
+  end
+end

data/lib/powermta.rb

@@ -0,0 +1 @@
+require 'pmta_extension'

data/powermta.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{powermta}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ian Warshak"]
+  s.date = %q{2010-08-06}
+  s.description = %q{This is an extension to Ruby's net/smtp library that lets you take advantage
+    of PowerMTA's (port25.com) native mailmerge feature.}
+  s.email = %q{iwarshak@stripey.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pmta_extension.rb",
+     "lib/powermta.rb",
+     "powermta.gemspec",
+     "test/helper.rb",
+     "test/test_powermta.rb"
+  ]
+  s.homepage = %q{http://github.com/iwarshak/powermta}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Do mail-merging with PowerMTA. Compatible with Ruby 1.8.7 & 1.9.X, but NOT 1.8.6}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_powermta.rb"
+  ]
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'powermta'
+
+class Test::Unit::TestCase
+end

data/test/test_powermta.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPowermta < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: powermta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Warshak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-08-06 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  This is an extension to Ruby's net/smtp library that lets you take advantage
+      of PowerMTA's (port25.com) native mailmerge feature.
+email: iwarshak@stripey.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pmta_extension.rb
+- lib/powermta.rb
+- powermta.gemspec
+- test/helper.rb
+- test/test_powermta.rb
+homepage: http://github.com/iwarshak/powermta
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 3
+summary: Do mail-merging with PowerMTA. Compatible with Ruby 1.8.7 & 1.9.X, but NOT
+  1.8.6
+test_files:
+- test/helper.rb
+- test/test_powermta.rb