blitz_smtp 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--debug
+--format progress

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blitz_smtp.gemspec
+gemspec
+gem 'rspec'
+gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Maximilian Schneider
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# BlitzSmtp
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blitz_smtp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blitz_smtp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/blitz_smtp.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blitz_smtp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "blitz_smtp"
+  gem.version       = BlitzSMTP::VERSION
+  gem.authors       = ["Maximilian Schneider"]
+  gem.email         = ["mail@maximilianschneider.net"]
+  gem.description   = %q{BlitzSMTP implements RFC2920 (Command Pipelining) to achieve high message throughput}
+  gem.summary       = %q{BlitzSMTP is no replacement for Net::SMTP, it's just faster}
+  gem.homepage      = "https://github.com/mschneider/blitz_smtp"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/blitz_smtp.rb

@@ -0,0 +1,7 @@
+require "blitz_smtp/version"
+require "blitz_smtp/client"
+require "blitz_smtp/message"
+require "blitz_smtp/mock_server"
+
+module BlitzSMTP
+end

data/lib/blitz_smtp/client.rb

@@ -0,0 +1,87 @@
+module BlitzSMTP
+  class Client
+
+    class AlreadyConnected < StandardError; end
+    class EHLOUnsupported < StandardError; end
+    class PipeliningUnsupported < StandardError; end
+    class NotConnected < StandardError; end
+
+    def initialize(address, port)
+      @server_address, @server_port = address, port
+    end
+
+    def connect
+      raise AlreadyConnected if connected?
+      @socket = TCPSocket.open @server_address, @server_port
+      read_response # ignore actual response FIXME
+      check_features
+    rescue
+      disconnect if connected?
+      raise
+    end
+
+    def disconnect
+      raise NotConnected unless connected?
+      send_command "QUIT"
+      read_response
+      @socket.close
+      @socket = nil
+    end
+
+    def connected?
+      not @socket.nil?
+    end
+
+    def send_message(from, to, message)
+      send_command "MAIL", "FROM:#{format_address(from)}"
+      send_command "RCPT", "TO:#{format_address(to)}"
+      send_command "DATA"
+      3.times { read_response }
+      send_data message
+      read_response
+    end
+
+    protected
+
+    def format_address(address)
+      if address =~ /<.*>/
+        address
+      else
+        "<#{address}>"
+      end
+    end
+
+    def send_data(message)
+      Data.new(message).write_to(@socket)
+    end
+
+    def send_command(*args)
+      command = Command.create(*args)
+      command.write_to(@socket)
+    end
+
+    def read_response
+      Response.new.read_from(@socket)
+    end
+
+    def read_extended_response
+      responses = []
+      loop do
+        responses << read_response
+        break unless responses.last.continued?
+      end
+      responses
+    end
+
+    def check_features
+      send_command "EHLO localhost"
+      responses = read_extended_response
+      unless responses.first.status_code == 250
+        raise(EHLOUnsupported, "the server must implement RFC2920")
+      end
+      unless responses.any? { |r| r.message == "PIPELINING" }
+        raise(PipeliningUnsupported, "the server must implement RFC2920")
+      end
+    end
+  end
+end

data/lib/blitz_smtp/message.rb

@@ -0,0 +1,71 @@
+module BlitzSMTP
+
+  class Message
+
+    class Invalid < StandardError; end
+
+    def initialize(string="")
+      @string = string
+    end
+
+    def to_s
+      @string
+    end
+
+    def terminator
+      "\r\n"
+    end
+
+    def write_to(stream)
+      #puts "#{stream.local_address.ip_port} << #{"#{self}#{terminator}".inspect}"
+      stream.print("#{self}#{terminator}")
+    end
+
+    def read_from(stream)
+      including_terminator = stream.gets(terminator)
+      #puts "#{stream.local_address.ip_port} >> #{(including_terminator).inspect}"
+      excluding_terminator = /^(.*)#{terminator}$/.match(including_terminator).to_a.last
+      @string = excluding_terminator
+      self
+    end
+  end
+
+  class Command < Message
+    def argument
+      @string[5..-1]
+    end
+
+    def name
+      @string[0..3]
+    end
+
+    def self.create(name, argument="")
+      new("#{name} #{argument}")
+    end
+  end
+
+  class Data < Message
+    def terminator
+      "\r\n.\r\n"
+    end
+  end
+
+  class Response < Message
+    def continued?
+      @string[3] == "-"
+    end
+
+    def message
+      @string[4..-1]
+    end
+
+    def status_code
+      @string[0..2].to_i
+    end
+
+    def self.create(status_code, message, continue=false)
+      space = continue ? "-" : " "
+      new("#{status_code}#{space}#{message}")
+    end
+  end
+end

data/lib/blitz_smtp/mock_server.rb

@@ -0,0 +1,105 @@
+require 'ostruct'
+require 'socket'
+
+module BlitzSMTP
+  class MockServer
+
+    attr_accessor :esmtp, :features, :accepted_emails
+
+    def initialize
+      @esmtp = true
+      @features = []
+      @accepted_emails = []
+      @server_socket = TCPServer.new(address, 0)
+      @server_thread = Thread.start do
+        loop do
+          @client_socket = @server_socket.accept
+          mock_smtp
+        end
+      end
+    end
+
+    def address
+      "localhost"
+    end
+
+    def port
+      @server_socket.connect_address.ip_port
+    end
+
+    def connected_to_client?
+      not @client_socket.nil?
+    end
+
+    def shutdown!
+      @server_thread.kill
+      @client_socket.close if connected_to_client?
+      @server_socket.close
+    end
+
+    protected
+
+    def disconnect_client
+      @client_socket.close
+      @client_socket = nil
+    end
+
+    def send_greeting
+      respond 220, self.class.to_s
+    end
+
+    def send_command_unknown(command)
+      respond 554, "received unknown command: #{command}"
+    end
+
+    def respond(*args)
+      response = Response.create(*args)
+      response.write_to(@client_socket)
+    end
+
+    def mock_smtp
+      send_greeting
+      catch(:disconnect) do
+        loop do
+          command = Command.new.read_from(@client_socket)
+          send("received_#{command.name.downcase}", command)
+        end
+      end
+      disconnect_client
+    end
+
+    def received_ehlo(command)
+      return send_command_unknown(command) unless esmtp
+      continued_messages = [address] + features[0..-2]
+      continued_messages.each { |m| respond 250, m, true }
+      respond 250, features.last
+    end
+
+    def received_mail(command)
+      @current_mail = { from: command.argument.to_s.gsub(/^FROM:/, '') }
+      respond 250, "ok"
+    end
+
+    def received_rcpt(command)
+      @current_mail[:to] = command.argument.to_s.gsub(/^TO:/, '')
+      respond 250, "ok"
+    end
+
+    def received_data(_)
+      respond 354, "start mail input"
+      @current_mail[:data] = Data.new.read_from(@client_socket).to_s
+      accepted_emails << OpenStruct.new(@current_mail)
+      respond 250, "ok"
+    end
+
+    def received_quit(_)
+      respond 221, "bye"
+      throw :disconnect
+    end
+
+    def method_missing(method, command, *_)
+      puts "could not identify #{command} [##{method}]"
+      send_command_unknown(command)
+    end
+  end
+end

data/lib/blitz_smtp/version.rb

@@ -0,0 +1,3 @@
+module BlitzSMTP
+  VERSION = "0.0.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe BlitzSMTP::Client do
+
+  before do
+    @server = BlitzSMTP::MockServer.new
+    @server.features = %w[PIPELINING 8BITMIME]
+    @client = BlitzSMTP::Client.new(@server.address, @server.port)
+  end
+
+  after do
+    @server.shutdown!
+  end
+
+  it "should initialize disconnected" do
+    @client.should_not be_connected
+  end
+
+  it "connects to the mock server" do
+    @client.connect
+    @client.should be_connected
+    @server.should be_connected_to_client
+  end
+
+  it "disconnects from the mock server" do
+    @client.connect
+    @client.disconnect
+    @client.should_not be_connected
+    @server.should_not be_connected_to_client
+  end
+
+  it "can't disconnect unless connected" do
+    lambda { @client.disconnect }.should \
+      raise_error(BlitzSMTP::Client::NotConnected)
+  end
+
+  it "can't connect if connected" do
+    @client.connect
+    lambda { @client.connect }.should \
+      raise_error(BlitzSMTP::Client::AlreadyConnected)
+  end
+
+  it "can connect again after disconnecting" do
+    @client.connect
+    @client.disconnect
+    @client.connect
+    @client.should be_connected
+    @server.should be_connected_to_client
+  end
+
+  it "can send an email" do
+    @client.connect
+    @client.send_message "mail@from.com", "mail@to.com", "message text"
+    last_mail = @server.accepted_emails.last
+    last_mail.from.should == "<mail@from.com>"
+    last_mail.to.should == "<mail@to.com>"
+    last_mail.data.should == "message text"
+  end
+
+  it "requires ESMTP" do
+    @server.esmtp = false
+    lambda { @client.connect }.should \
+      raise_error(BlitzSMTP::Client::EHLOUnsupported,
+                  "the server must implement RFC2920")
+    @client.should_not be_connected
+    @server.should_not be_connected_to_client
+  end
+
+  it "requires the feature PIPELINING" do
+    @server.features.delete("PIPELINING")
+    lambda { @client.connect }.should \
+      raise_error(BlitzSMTP::Client::PipeliningUnsupported,
+                  "the server must implement RFC2920")
+    @client.should_not be_connected
+    @server.should_not be_connected_to_client
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'blitz_smtp'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: blitz_smtp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Maximilian Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies: []
+description: BlitzSMTP implements RFC2920 (Command Pipelining) to achieve high message
+  throughput
+email:
+- mail@maximilianschneider.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blitz_smtp.gemspec
+- lib/blitz_smtp.rb
+- lib/blitz_smtp/client.rb
+- lib/blitz_smtp/message.rb
+- lib/blitz_smtp/mock_server.rb
+- lib/blitz_smtp/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mschneider/blitz_smtp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: BlitzSMTP is no replacement for Net::SMTP, it's just faster
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb