mailing 0.9.0

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailing.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Piotr Macuk
+
+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,70 @@
+# Mailing
+
+Tool for sending fast mailings
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailing'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mailing
+
+## Step by step usage
+
+    require 'mailing'
+    require 'logger'
+
+    # create channel
+    config = {
+      :address => 'localhost',
+      :port    => 25,
+      :domain  => 'localhost.localdomain'
+    }
+    channel = Mailing::SmtpChannel.new(config)
+
+    # create sender with channel, envelope_from and logger
+    logger = Logger.new('/tmp/mailing.log')
+    sender = Mailing::Sender.new(channel, 'sender@domain.com', logger)
+
+    # 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
+    mailing.send(sender)
+
+## Quick usage
+
+    require 'mailing'
+    require 'logger'
+
+    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'
+    }
+    mailing.send_by_smtp(config, 'sender@domain.com')
+
+## Rails usage
+
+    mailing = Mailing::Mailing.new('from@domain.com', 'Subject', 'Body')
+    mailing.recipients = User.pluck(:email)
+    mailing.send_by_smtp(ActionMailer::Base.smtp_settings,
+                         'sender@domain.com', Rails.logger)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mailing/mailing.rb

@@ -0,0 +1,29 @@
+module Mailing
+  class Mailing
+    require 'mail'
+
+    attr_accessor :from, :subject, :body, :recipients
+
+    def initialize(from, subject, body, recipients=[])
+      @from, @subject, @body = from, subject, body
+      @recipients = recipients
+    end
+
+    def send(sender)
+      sender.send(self)
+    end
+
+    def send_by_smtp(config, envelope_from, logger=nil)
+      channel = SmtpChannel.new(config)
+      sender = Sender.new(channel, envelope_from, logger)
+      send(sender)
+    end
+
+    def mail(builder=Mail)
+      mail = builder.new(:from => @from, :subject => @subject, :body => @body)
+      mail.charset = 'UTF-8'
+      mail.content_transfer_encoding = "8bit"
+      mail
+    end
+  end
+end

data/lib/mailing/sender.rb

@@ -0,0 +1,41 @@
+module Mailing
+  class Sender
+    attr_accessor :channel, :envelope_from, :logger, :delay
+
+    def initialize(channel, envelope_from, logger=nil, delay=0.5)
+      @channel = channel
+      @envelope_from = envelope_from
+      @logger = logger
+      @delay = delay
+    end
+
+    def send(mailing)
+      @mailing = mailing
+      @mail = @mailing.mail
+      info "Start mailing: #{Time.now}"
+      info @mail.encoded
+      info "Recipients count: #{@mailing.recipients.size}"
+      deliver
+    end
+
+    protected
+      def deliver
+        info "Start sending: #{Time.now}"
+        channel.start
+        @mailing.recipients.each do |recipient|
+          @mail.to = recipient
+          info channel.deliver(@mail.encoded, @envelope_from, recipient)
+          sleep @delay
+        end
+        channel.finish
+        info "Finish sending: #{Time.now}"
+        info "---" * 20
+        info "\n"
+      end
+
+      def info(msg)
+        return unless @logger
+        @logger.info msg
+      end
+  end
+end

data/lib/mailing/smtp_channel.rb

@@ -0,0 +1,45 @@
+module Mailing
+  class SmtpChannel
+    require 'net/smtp'
+
+    attr_accessor :config
+
+    # config: hash with smtp configuration
+    # {
+    #   :address              => "host.domain.com",
+    #   :port                 => 25,
+    #   :domain               => 'domain.com',
+    #   :user_name            => 'user@domain.com',
+    #   :password             => 'password',
+    #   :authentication       => :login,
+    #   :enable_starttls_auto => true,
+    #   :openssl_verify_mode  => 'none'
+    # }
+    def initialize(config)
+      @config = config
+      @smtp = nil
+    end
+
+    def start
+      @smtp = Net::SMTP.new(@config[:address], @config[:port])
+      @smtp.enable_starttls_auto if @config[:enable_starttls_auto]
+      @smtp.start(@config[:domain], @config[:user_name],
+                 @config[:password], @config[:authentication])
+    end
+
+    def deliver(mail, envelope_from, recipient)
+      begin
+        @smtp.sendmail(mail, envelope_from, recipient)
+        "Sent to #{recipient}"
+      rescue Exception => e
+        finish
+        start
+        "Error for #{recipient}: #{e}".strip
+      end
+    end
+
+    def finish
+      @smtp.finish
+    end
+  end
+end

data/lib/mailing/version.rb

@@ -0,0 +1,3 @@
+module Mailing
+  VERSION = "0.9.0"
+end

data/lib/mailing.rb

@@ -0,0 +1,4 @@
+require 'mailing/version'
+require 'mailing/mailing'
+require 'mailing/sender'
+require 'mailing/smtp_channel'

data/mailing.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+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.summary        = %q{Fast mailings}
+  gem.homepage       = ""
+
+  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.name           = "mailing"
+  gem.require_paths  = ["lib"]
+  gem.version        = Mailing::VERSION
+  gem.add_dependency 'mail', ["~> 2.4.4"]
+end

data/test/mailing_test.rb

@@ -0,0 +1,50 @@
+require 'minitest/autorun'
+require 'mailing/mailing'
+
+class MailingTest < MiniTest::Unit::TestCase
+  def setup
+    @mailing = Mailing::Mailing.new('from', 'subject', 'body')
+  end
+
+  def test_init
+    assert_equal 'from', @mailing.from
+    assert_equal 'subject', @mailing.subject
+    assert_equal 'body', @mailing.body
+    assert_empty @mailing.recipients
+  end
+
+  def test_init_with_recipients
+    @mailing = Mailing::Mailing.new('from', 'subject', 'body', [1, 2, 3])
+    assert_equal [1, 2, 3], @mailing.recipients
+  end
+
+  def test_accessors
+    @mailing.from = 'test'
+    assert_equal 'test', @mailing.from
+    @mailing.subject = 'test'
+    assert_equal 'test', @mailing.subject
+    @mailing.body = 'test'
+    assert_equal 'test', @mailing.body
+  end
+
+  def test_recipient_accessor
+    @mailing.recipients = [1, 2, 3]
+    assert_equal 3, @mailing.recipients.size
+    @mailing.recipients << 4
+    assert_equal 4, @mailing.recipients.size
+  end
+
+  def test_mail
+    mail = @mailing.mail.encoded
+    assert_match /From: from/, mail
+    assert_match /Subject: subject/, mail
+    assert_match /body/, mail
+  end
+
+  def test_send
+    sender = MiniTest::Mock.new
+    sender.expect(:send, nil, [@mailing])
+    @mailing.send(sender)
+    sender.verify
+  end
+end

data/test/sender_test.rb

@@ -0,0 +1,53 @@
+require 'minitest/autorun'
+require 'mailing/sender'
+
+class SenderTest < MiniTest::Unit::TestCase
+  def setup
+    @channel = MiniTest::Mock.new
+    @channel.expect(:start, nil)
+    @channel.expect(:deliver, 'delivered', [String, String, String])
+    @channel.expect(:finish, nil)
+
+    @sender = Mailing::Sender.new(@channel, 'me@host.com')
+
+    @mail = MiniTest::Mock.new
+    @mail.expect(:encoded, 'mail')
+    @mailing = MiniTest::Mock.new
+    @mailing.expect(:mail, @mail)
+  end
+
+  def test_init
+    assert_equal 'me@host.com', @sender.envelope_from
+    assert_nil @sender.logger
+    assert_equal 0.5, @sender.delay
+  end
+
+  def test_accessors
+    @sender.envelope_from = 'test@test.com'
+    assert_equal 'test@test.com', @sender.envelope_from
+    @sender.logger = []
+    assert_equal [], @sender.logger
+    @sender.delay = 1
+    assert_equal 1, @sender.delay
+  end
+
+  def test_send_with_no_recipients
+    @mailing.expect(:recipients, [])
+    @sender.send(@mailing)
+    @mail.verify
+    @mailing.verify
+  end
+
+  def test_send_with_recipients
+    @sender.delay = 0
+    @mailing.expect(:recipients, [1, 2])
+    @mail.expect(:'to=', nil, [1])
+    @mail.expect(:'to=', nil, [2])
+    @channel.expect(:deliver, 'delivered', [String, 'me@host.com', 1])
+    @channel.expect(:deliver, 'delivered', [String, 'me@host.com', 2])
+    @sender.send(@mailing)
+    @mail.verify
+    @mailing.verify
+    @channel.verify
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: mailing
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Macuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+description: Tool for sending fast mailings
+email:
+- piotr@macuk.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mailing.rb
+- lib/mailing/mailing.rb
+- lib/mailing/sender.rb
+- lib/mailing/smtp_channel.rb
+- lib/mailing/version.rb
+- mailing.gemspec
+- test/mailing_test.rb
+- test/sender_test.rb
+homepage: ''
+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.21
+signing_key: 
+specification_version: 3
+summary: Fast mailings
+test_files:
+- test/mailing_test.rb
+- test/sender_test.rb