mailing 0.9.2 → 0.9.3

data/README.md

@@ -1,6 +1,6 @@
 # Mailing
 
-Tool for sending fast mailings
+Tool for sending fast mailings in one SMTP connection.
 
 ## Installation
 
@@ -16,6 +16,11 @@ Or install it yourself as:
 
     $ gem install mailing
 
+## Sending speed
+
+Default sending speed is low and set to ~ 120 mails per minute.
+You can change that value by setting the delay parameter in sender.
+
 ## Step by step usage
 
     require 'mailing'
@@ -32,6 +37,7 @@ Or install it yourself as:
     # create sender with channel, envelope_from and logger
     logger = Logger.new('/tmp/mailing.log')
     sender = Mailing::Sender.new(channel, 'sender@domain.com', logger)
+    sender.delay = 0.1 # ~ 600 mails per minute
 
     # create mailing with from, subject, body, recipients
     mailing = Mailing::Mailing.new('from@domain.com', 'Subject', 'Body')
@@ -52,7 +58,9 @@ Or install it yourself as:
       :port    => 25,
       :domain  => 'localhost.localdomain'
     }
-    mailing.send_by_smtp(config, 'sender@domain.com')
+    # send with config and envelope_from set to sender@domain.com
+    # without logging and with 0.2 delay (~ 300 mails per minute)
+    mailing.send_by_smtp(config, 'sender@domain.com', nil, 0.2)
 
 ## Rails usage
 

data/Rakefile

@@ -1,2 +1,10 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/*_test.rb'
+end
+
+task :default => 'test'

data/lib/mailing.rb

@@ -1,4 +1,7 @@
 require 'mailing/version'
+require 'mailing/delay'
 require 'mailing/mailing'
 require 'mailing/sender'
+require 'mailing/base_channel'
 require 'mailing/smtp_channel'
+require 'mailing/fake_channel'

data/lib/mailing/base_channel.rb

@@ -0,0 +1,19 @@
+module Mailing
+  class BaseChannel
+
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def start
+    end
+
+    def deliver(mail, envelope_from, recipient)
+    end
+
+    def finish
+    end
+  end
+end

data/lib/mailing/delay.rb

@@ -0,0 +1,3 @@
+module Mailing
+  DELAY = 0.5
+end

data/lib/mailing/fake_channel.rb

@@ -0,0 +1,9 @@
+require 'mailing/base_channel'
+
+module Mailing
+  class FakeChannel < BaseChannel
+    def deliver(mail, envelope_from, recipient)
+      "Sent to #{recipient}"
+    end
+  end
+end

data/lib/mailing/mailing.rb

@@ -13,9 +13,9 @@ module Mailing
       sender.send(self)
     end
 
-    def send_by_smtp(config, envelope_from, logger=nil)
+    def send_by_smtp(config, envelope_from, logger=nil, delay=DELAY)
       channel = SmtpChannel.new(config)
-      sender = Sender.new(channel, envelope_from, logger)
+      sender = Sender.new(channel, envelope_from, logger, delay)
       send(sender)
     end
 

data/lib/mailing/sender.rb

@@ -1,8 +1,10 @@
+require 'mailing/delay'
+
 module Mailing
   class Sender
     attr_accessor :channel, :envelope_from, :logger, :delay
 
-    def initialize(channel, envelope_from, logger=nil, delay=0.5)
+    def initialize(channel, envelope_from, logger=nil, delay=DELAY)
       @channel = channel
       @envelope_from = envelope_from
       @logger = logger

data/lib/mailing/smtp_channel.rb

@@ -1,9 +1,9 @@
+require 'mailing/base_channel'
+
 module Mailing
-  class SmtpChannel
+  class SmtpChannel < BaseChannel
     require 'net/smtp'
 
-    attr_accessor :config
-
     # config: hash with smtp configuration
     # {
     #   :address              => "host.domain.com",
@@ -16,7 +16,7 @@ module Mailing
     #   :openssl_verify_mode  => 'none'
     # }
     def initialize(config)
-      @config = config
+      super
       @smtp = nil
     end
 

data/lib/mailing/version.rb

@@ -1,3 +1,3 @@
 module Mailing
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/mailing.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/mailing/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors        = ["Piotr Macuk"]
   gem.email          = ["piotr@macuk.pl"]
-  gem.description    = %q{Tool for sending fast mailings}
+  gem.description    = %q{Tool for sending fast mailings in one SMTP connection}
   gem.summary        = %q{Fast mailings}
   gem.homepage       = "https://github.com/macuk/mailing"
 

data/test/base_channel_test.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'mailing/base_channel'
+
+class BaseChannelTest < MiniTest::Unit::TestCase
+  def setup
+    @channel = Mailing::BaseChannel.new('config')
+  end
+
+  def test_config
+    assert_equal 'config', @channel.config
+    @channel.config = 'test'
+    assert_equal 'test', @channel.config
+  end
+
+  def test_methods
+    assert_nil @channel.start
+    assert_nil @channel.deliver('mail', 'envelope_from', 'recipient')
+    assert_nil @channel.finish
+  end
+end

data/test/fake_channel_test.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'mailing/fake_channel'
+
+class FakeChannelTest < MiniTest::Unit::TestCase
+  def setup
+    @channel = Mailing::FakeChannel.new('config')
+  end
+
+  def test_deliver
+    assert_equal 'Sent to recipient', @channel.deliver('mail', 'envelope_from', 'recipient')
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,55 @@
+require 'minitest/autorun'
+require 'mailing'
+require 'stringio'
+require 'logger'
+require 'benchmark'
+
+class IntegrationTest < MiniTest::Unit::TestCase
+  def test_1
+    # create channel
+    config = {
+      :address => 'localhost',
+      :port    => 25,
+      :domain  => 'localhost.localdomain'
+    }
+    channel = Mailing::SmtpChannel.new(config)
+
+    # create sender with channel, envelope_from and logger
+    log = StringIO.new
+    logger = Logger.new(log)
+    sender = Mailing::Sender.new(channel, 'sender@domain.com', logger)
+    sender.delay = 0.1 # ~ 600 mails per minute
+
+    # create mailing with from, subject, body, recipients
+    mailing = Mailing::Mailing.new('from@domain.com', 'Subject', 'Body')
+    mailing.recipients = %w(john@domain.com paul@domain.com peter@domain.com)
+
+    # send mailing
+    t = Benchmark.realtime { mailing.send(sender) }
+    assert t > 0.3
+    assert t < 0.4
+
+    slog = log.string
+    assert_match /from@domain.com/, slog
+    assert_match /Subject/, slog
+    assert_match /Body/, slog
+    mailing.recipients.each { |r| assert_match %r(r), slog }
+  end
+
+  def test_2
+    mailing = Mailing::Mailing.new('from@domain.com', 'Subject', 'Body')
+    mailing.recipients = %w(john@domain.com paul@domain.com peter@domain.com)
+    config = {
+      :address => 'localhost',
+      :port    => 25,
+      :domain  => 'localhost.localdomain'
+    }
+    # send with config and envelope_from set to sender@domain.com
+    # without logging and with 0.2 delay (~ 300 mails per minute)
+    t = Benchmark.realtime do
+      mailing.send_by_smtp(config, 'sender@domain.com', nil, 0.2)
+    end
+    assert t > 0.6
+    assert t < 0.7
+  end
+end

data/test/sender_test.rb

@@ -50,4 +50,18 @@ class SenderTest < MiniTest::Unit::TestCase
     @mailing.verify
     @channel.verify
   end
+
+  def test_delay
+    require 'benchmark'
+    @mailing.expect(:recipients, (1..5).to_a)
+    @mail.expect(:'to=', nil, [Fixnum])
+    @sender.delay = 0.1
+    t = Benchmark.realtime { @sender.send(@mailing) }
+    assert t > 0.5
+    assert t < 0.6
+    @sender.delay = 0.2
+    t = Benchmark.realtime { @sender.send(@mailing) }
+    assert t > 1.0
+    assert t < 1.1
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailing
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.5
-description: Tool for sending fast mailings
+description: Tool for sending fast mailings in one SMTP connection
 email:
 - piotr@macuk.pl
 executables: []
@@ -40,11 +40,17 @@ files:
 - README.md
 - Rakefile
 - lib/mailing.rb
+- lib/mailing/base_channel.rb
+- lib/mailing/delay.rb
+- lib/mailing/fake_channel.rb
 - lib/mailing/mailing.rb
 - lib/mailing/sender.rb
 - lib/mailing/smtp_channel.rb
 - lib/mailing/version.rb
 - mailing.gemspec
+- test/base_channel_test.rb
+- test/fake_channel_test.rb
+- test/integration_test.rb
 - test/mailing_test.rb
 - test/sender_test.rb
 homepage: https://github.com/macuk/mailing
@@ -72,5 +78,8 @@ signing_key:
 specification_version: 3
 summary: Fast mailings
 test_files:
+- test/base_channel_test.rb
+- test/fake_channel_test.rb
+- test/integration_test.rb
 - test/mailing_test.rb
 - test/sender_test.rb