maildis 0.0.1

data/lib/maildis.rb

@@ -0,0 +1,118 @@
+require "thor"
+require "logger"
+require "yaml"
+
+Dir[File.join(File.dirname(__FILE__), 'maildis', '*')].each { |file| require file }
+
+module Maildis
+  class CLI < Thor
+
+    @@log_file_name = Dir.home + '/.maildis.log'
+
+    desc 'validate mailer', 'Validates mailer configuration file'
+    method_option :verbose, aliases: '-v', desc: 'Verbose', default: false
+    def validate(mailer_path)
+      init_logger options[:verbose]
+      begin
+        raise ValidationError, "File not found: #{mailer_path}" unless File.exists?(File.expand_path(mailer_path))
+        load_config mailer_path
+        $stdout.puts 'Ok'
+        exit
+      rescue ValidationError => e
+        error "Validation Error: #{e.message}"
+      rescue => e
+        fatal "Error: #{e.message}"
+      end
+    end
+
+    desc 'ping mailer', 'Attempts to connect to the SMTP server specified in the mailer configuration'
+    method_option :verbose, aliases: '-v', desc: 'Verbose', default: false
+    def ping(mailer_path)
+      init_logger options[:verbose]
+      begin
+        config = load_config mailer_path
+        $stdout.puts "SMTP server reachable" if ServerUtils.server_reachable? config['smtp']['host'], config['smtp']['port']
+        exit
+      rescue ValidationError => e
+        error "Validation Error: #{e.message}"
+      rescue => e
+        fatal "Error: #{e.message}"
+      end
+    end
+
+    desc 'dispatch mailer', 'Dispatches the mailer through the SMTP server specified in the mailer configuration.'
+    method_option :verbose, aliases: '-v', desc: 'Verbose', default: false
+    def dispatch(mailer_path)
+      init_logger options[:verbose]
+      begin
+        config = load_config mailer_path
+        subject = config['mailer']['subject']
+        recipients = load_recipients config['mailer']['recipients']
+        sender = load_sender config['mailer']['sender']
+        templates = load_templates config['mailer']['templates']
+        server = load_server config['smtp']
+        info "Dispatching to #{recipients.size} recipients"
+        result = Dispatcher.dispatch({subject: subject,
+                                      recipients: recipients,
+                                      sender: sender,
+                                      templates: templates,
+                                      server: server,
+                                      logger: @@logger})
+        info "Dispatch complete with errors" if result[:not_sent].size > 0
+        info "Dispatch complete without errors" if result[:not_sent].size == 0
+        exit
+      rescue => e
+        fatal e.message
+      end
+    end
+
+    private
+
+    def init_logger(verbose)
+      if verbose
+        @@logger = Logger.new(MultiIO.new(STDOUT, File.open(@@log_file_name,'w+')))
+      else
+        @@logger = Logger.new(@@log_file_name)
+      end
+      @@logger.formatter = proc {|severity, datetime, progname, msg| "#{datetime} #{severity}: #{msg}\n"}
+    end
+
+    def info(msg); @@logger.info msg; end
+    def error(msg); @@logger.error msg; abort msg; end
+    def fatal(msg); @@logger.fatal msg; abort msg; end
+
+    def load_config(mailer_path)
+      info "Load #{File.expand_path(mailer_path)}"
+      config = YAML.load(File.open(File.expand_path(mailer_path)))
+      info "Validate configuration"
+      Validator.validate_config config
+      config
+    end
+
+    def load_recipients(hash)
+      info "Validate recipients csv"
+      Validator.validate_recipients hash
+      info "Extract recipients from csv"
+      RecipientParser.extract_recipients hash['csv']
+    end
+
+    def load_sender(hash)
+      info "Validate sender"
+      Validator.validate_sender hash
+      Sender.new hash['name'], hash['email']
+    end
+
+    def load_templates(hash)
+      info "Validate templates"
+      Validator.validate_templates hash
+      {html: TemplateLoader.load(hash['html']), plain: TemplateLoader.load(hash['plain'])}
+    end
+
+    def load_server(hash)
+      info "Validate SMTP server #{hash['host']}"
+      Validator.validate_smtp hash
+      SmtpServer.new hash['host'], hash['port'], hash['username'], hash['password']
+    end
+
+  end
+end

data/maildis.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maildis/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "maildis"
+  gem.version       = Maildis::VERSION
+  gem.authors       = ["Johnny Boursiquot"]
+  gem.email         = ["jboursiquot@gmail.com"]
+  gem.description   = %q{Maildis is a command line bulk email dispatching tool. It supports HTML and plain text templates and CSVs for recipients and merge fields.}
+  gem.summary       = %q{Maildis is a command line bulk email dispatching tool. It supports HTML and plain text templates and CSVs for recipients and merge fields. It relies on SMTP information you provide through your own configuration file. Subject, sender, path to CSV and path to the templates are all configurable through YAML.}
+  gem.homepage      = "https://github.com/jboursiquot/maildis"
+
+  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"]
+
+  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency 'pony'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent','~> 0.9.1'
+  gem.add_development_dependency 'fivemat'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-debugger'
+  gem.add_development_dependency 'mailcatcher'
+
+end

data/spec/lib/maildis/dispatcher_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::Dispatcher' do
+
+  before(:all) do
+    @config = YAML.load(File.open('spec/mailer/mailer.yml'))
+
+    mailer = @config['mailer']
+    @subject = mailer['subject']
+    @recipients = [] << Maildis::RecipientParser.extract_recipients(mailer['recipients']['csv']).first
+    @sender = Maildis::Sender.new mailer['sender']['name'], mailer['sender']['email']
+    @templates = {html: Maildis::TemplateLoader.load(mailer['templates']['html']), plain: Maildis::TemplateLoader.load(mailer['templates']['plain'])}
+
+    smtp = @config['smtp']
+    @server = Maildis::SmtpServer.new smtp['host'], smtp['port'], smtp['username'], smtp['password']
+  end
+
+  describe '.dispatch' do
+    it 'should send emails based on the given subject, recipients, sender, templates and server' do
+      result = Maildis::Dispatcher.dispatch({ subject: @subject,
+                                              recipients: @recipients,
+                                              sender: @sender,
+                                              templates: @templates,
+                                              server: @server
+                                            })
+      result.should be_an_instance_of Hash
+      result[:sent].size.should_not == 0
+    end
+  end
+
+end

data/spec/lib/maildis/maildis_spec.rb

@@ -0,0 +1,84 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis' do
+
+  before(:all) do
+    @valid_mailer_path = 'spec/mailer/mailer.yml'
+    @invalid_mailer_path = 'spec/mailer/mailer_invalid.yml'
+  end
+
+  context 'when invoked without any task' do
+    it 'should respond with a task list' do
+      output = `./bin/maildis`
+      output.should include 'validate'
+      output.should include 'ping'
+      output.should include 'dispatch'
+    end
+  end
+
+  context 'when validating a mailer' do
+
+    describe '#validate' do
+
+      it "should respond with 'maildis validate requires at least 1 argument...' when no config file is passed in" do
+        output = `./bin/maildis validate 2>&1`
+        output.should include 'maildis validate requires at least 1 argument'
+      end
+
+      it "should respond with 'File not found' if mailer config does not exist" do
+        output = `./bin/maildis validate no_file 2>&1`
+        output.should include 'File not found'
+      end
+
+      it "should respond with a Validation Error when the mailer config passed in has a problem" do
+        output = `./bin/maildis validate #{@invalid_mailer_path} 2>&1`
+        output.should include 'Validation Error'
+      end
+
+      it "should respond with 'Ok' when all validation checks pass" do
+        output = `./bin/maildis validate #{@valid_mailer_path} 2>&1`
+        output.should include 'Ok'
+      end
+
+    end
+
+  end
+
+  context 'when pinging the SMTP server specified in a mailer config' do
+    describe '#ping' do
+      it "should check the specified SMTP server is reachable" do
+        output = `./bin/maildis ping #{@valid_mailer_path} 2>&1`
+        output.should include 'SMTP server reachable'
+      end
+    end
+  end
+
+  context 'when dispatching a mailer' do
+
+    before(:all) do
+      @config = YAML.load(File.open(@valid_mailer_path))
+
+      mailer = @config['mailer']
+      @subject = mailer['subject']
+      @recipients = Maildis::RecipientParser.extract_recipients mailer['recipients']['csv']
+      @sender = Maildis::Sender.new mailer['sender']['name'], mailer['sender']['email']
+      @templates = {html: Maildis::TemplateLoader.load(mailer['templates']['html']), plain: Maildis::TemplateLoader.load(mailer['templates']['plain'])}
+
+      smtp = @config['smtp']
+      @server = Maildis::SmtpServer.new smtp['host'], smtp['port'], smtp['username'], smtp['password']
+    end
+
+    describe '#dispatch' do
+      it 'should send all emails through the designated SMTP server' do
+        result = Maildis::Dispatcher.dispatch({subject: @subject,
+                                              recipients: @recipients,
+                                              sender: @sender,
+                                              templates: @templates,
+                                              server: @server})
+        result.should be_an_instance_of Hash
+        result[:sent].size.should_not == 0
+      end
+    end
+  end
+
+end

data/spec/lib/maildis/merge_field_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::MergeField' do
+
+  describe '#new' do
+
+    it 'should initialize with field and value' do
+      mf = Maildis::MergeField.new('field', 'value')
+      mf.field.should == 'field'
+      mf.value.should == 'value'
+    end
+
+  end
+
+end

data/spec/lib/maildis/recipient_parser_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::RecipientParser' do
+
+  before(:all) do
+    @valid_csv_path = 'spec/mailer/recipients.csv'
+    @invalid_csv_path = 'spec/mailer/invalid.csv'
+    @empty_csv_path = 'spec/mailer/recipients_empty.csv'
+  end
+
+  describe '.valid_csv?' do
+    it "should return true if CSV has the expected format" do
+      expect(Maildis::RecipientParser.valid_csv?(@valid_csv_path)).to be_true
+    end
+    it "should return false if CSV does not have the expected format" do
+      expect(Maildis::RecipientParser.valid_csv?(@invalid_csv_path)).to be_false
+    end
+  end
+
+  describe '.empty_csv?' do
+    it "should return true if CSV has the right format but is empty" do
+      expect(Maildis::RecipientParser.empty_csv?(@empty_csv_path)).to be_true
+    end
+    it "should return false if CSV has the right format and is not empty" do
+      expect(Maildis::RecipientParser.empty_csv?(@valid_csv_path)).to be_false
+    end
+  end
+
+  describe '.extract_recipients' do
+    it "should extract a list of recipients from the CSV" do
+      recipients = Maildis::RecipientParser.extract_recipients @valid_csv_path
+      recipients.size.should > 0
+      recipients.first.should be_an_instance_of Maildis::Recipient
+      recipients.first.merge_fields.should_not be_nil
+      recipients.first.merge_fields.should_not be_empty
+    end
+  end
+
+end

data/spec/lib/maildis/recipient_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::Recipient' do
+
+  describe '#new' do
+
+    it 'should initialize with name, email and merge fields' do
+      r = Maildis::Recipient.new('John Doe', 'jdoe@email.com', [Maildis::MergeField.new('field', 'value')])
+      r.name.should == 'John Doe'
+      r.email.should == 'jdoe@email.com'
+      r.merge_fields.size.should_not == 0
+    end
+
+  end
+
+end

data/spec/lib/maildis/sender_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::Sender' do
+
+  describe '#new' do
+
+    it 'should initialize with name and email' do
+      r = Maildis::Sender.new('John Doe', 'jdoe@email.com')
+      r.name.should == 'John Doe'
+      r.email.should == 'jdoe@email.com'
+    end
+
+  end
+
+end

data/spec/lib/maildis/smtp_server_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::SmtpServer' do
+
+  describe '#new' do
+
+    it 'should initialize with host, port, username and password' do
+      s = Maildis::SmtpServer.new('localhost',1025,'username','password')
+      s.host.should == 'localhost'
+      s.port.should == 1025
+      s.username.should == 'username'
+      s.password.should == 'password'
+    end
+
+  end
+
+end

data/spec/lib/maildis/template_loader_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::TemplateLoader' do
+
+  before(:all) do
+    @config = YAML.load(File.open('spec/mailer/mailer.yml'))
+    @html_template_path = @config['mailer']['templates']['html']
+    @plain_template_path = @config['mailer']['templates']['plain']
+  end
+
+  describe '.load' do
+
+    it 'should load an html template given the template path' do
+      template = Maildis::TemplateLoader.load @html_template_path
+      template.type.should == Maildis::Template::HTML
+    end
+
+    it 'should load a plain text template given the template path' do
+      template = Maildis::TemplateLoader.load @plain_template_path
+      template.type.should == Maildis::Template::PLAIN
+    end
+
+  end
+
+end

data/spec/lib/maildis/template_renderer_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::TemplateRenderer' do
+
+  before(:all) do
+    @config = YAML.load(File.open('spec/mailer/mailer.yml'))
+    @html_template = @config['mailer']['templates']['html']
+    @plain_template = @config['mailer']['templates']['plain']
+    @merge_fields = [Maildis::MergeField.new('url','http://www.domain.com')]
+  end
+
+  describe '.render' do
+
+    it 'should render an html template given the template and the merge fields' do
+      template = Maildis::TemplateLoader.load @html_template
+      expect(Maildis::TemplateRenderer.render template, @merge_fields).to include @merge_fields.first.value
+    end
+
+    it 'should render a plain text template given the template and the merge fields' do
+      template = Maildis::TemplateLoader.load @plain_template
+      expect(Maildis::TemplateRenderer.render template, @merge_fields).to include @merge_fields.first.value
+    end
+
+  end
+
+end

data/spec/lib/maildis/template_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::Template' do
+
+  describe '#new' do
+
+    it 'should initialize with type and content' do
+      t = Maildis::Template.new(Maildis::Template::HTML, '<html/>')
+      t.type.should == Maildis::Template::HTML
+      t.content.should == '<html/>'
+    end
+
+  end
+
+end

data/spec/lib/maildis/validator_spec.rb

@@ -0,0 +1,132 @@
+require_relative '../../spec_helper'
+
+describe 'Maildis::Validator' do
+
+  before(:all) do
+    @config = YAML.load(File.open('spec/mailer/mailer.yml'))
+  end
+
+  describe '.validate_config' do
+
+    it 'should raise ValidationError when config does not have smtp settings' do
+      expect{Maildis::Validator.validate_config({'mailer' => {}})}.to raise_error Maildis::ValidationError, 'smtp settings missing'
+    end
+
+    it 'should raise ValidationError when config does not have mailer settings' do
+      expect{Maildis::Validator.validate_config({'smtp' => {}})}.to raise_error Maildis::ValidationError, 'mailer settings missing'
+    end
+
+    it 'should return nil when no ValidationError is raised' do
+      expect(Maildis::Validator.validate_config @config).to be_nil
+    end
+
+  end
+
+  describe '.validate_smtp' do
+
+    context 'when given missing or invalid parameters' do
+
+      it 'should raise ValidationError if smtp host is missing or invalid' do
+        smtp = {'port'=>1025, 'username'=>'', 'password'=>''}
+        expect{Maildis::Validator.validate_smtp smtp}.to raise_error Maildis::ValidationError, 'smtp::host missing or invalid'
+      end
+
+      it 'should raise ValidationError if smtp port is missing or invalid' do
+        smtp = {'host'=>'localhost', 'username'=>'', 'password'=>''}
+        expect{Maildis::Validator.validate_smtp smtp}.to raise_error Maildis::ValidationError, 'smtp::port missing or invalid'
+      end
+
+      it 'should raise ValidationError if smtp username is missing' do
+        smtp = {'host'=>'localhost', 'port'=>1025, 'password'=>''}
+        expect{Maildis::Validator.validate_smtp smtp}.to raise_error Maildis::ValidationError, 'smtp::username missing'
+      end
+
+      it 'should raise ValidationError if smtp password is missing' do
+        smtp = {'host'=>'localhost', 'port'=>1025, 'username'=>''}
+        expect{Maildis::Validator.validate_smtp smtp}.to raise_error Maildis::ValidationError, 'smtp::password missing'
+      end
+
+    end
+
+    context 'when given valid parameters' do
+      it 'should not raise any ValidationError if smtp settings contain all required paramters' do
+        expect(Maildis::Validator.validate_config @config).to be_nil
+        expect(Maildis::Validator.validate_smtp @config['smtp']).to be_nil
+      end
+    end
+
+  end
+
+  describe '.validate_sender' do
+    it 'should raise ValidationError if sender name is missing' do
+      sender = {'email'=>''}
+      expect{Maildis::Validator.validate_sender sender}.to raise_error Maildis::ValidationError, 'sender::name missing'
+    end
+    it 'should verify sender email is missing or invalid' do
+      sender = {'name'=>'', 'email'=>''}
+      expect{Maildis::Validator.validate_sender sender}.to raise_error Maildis::ValidationError, 'sender::email missing or invalid'
+    end
+    it 'should not raise any ValidationError if sender settings contains all required parameters' do
+      expect(Maildis::Validator.validate_sender @config['mailer']['sender']).to be_nil
+    end
+  end
+
+  describe '.validate_subject' do
+    it 'should raise ValidationError if subject is blank' do
+      expect {Maildis::Validator.validate_subject ''}.to raise_error Maildis::ValidationError, 'mailer::subject invalid'
+    end
+    it 'should raise ValidationError if subject is nil' do
+      expect {Maildis::Validator.validate_subject nil}.to raise_error Maildis::ValidationError, 'mailer::subject invalid'
+    end
+    it 'should not raise any ValidationError if subject is valid' do
+      expect(Maildis::Validator.validate_subject @config['mailer']['subject']).to be_nil
+    end
+  end
+
+  describe '.validate_recipients' do
+
+    it 'should raise ValidationError if csv is missing' do
+      expect {Maildis::Validator.validate_recipients Hash.new}.to raise_error Maildis::ValidationError, 'recipients::csv missing'
+    end
+    it 'should raise ValidationError if csv is invalid file' do
+      recipients = {'csv'=>'invalid filename'}
+      expect {Maildis::Validator.validate_recipients recipients}.to raise_error Maildis::ValidationError, 'recipients::csv invalid file path'
+    end
+    it 'should raise ValidationError if csv does not have minimum expected columns (name, email)' do
+      recipients = {'csv'=>'spec/mailer/invalid.csv'}
+      expect {Maildis::Validator.validate_recipients recipients}.to raise_error Maildis::ValidationError, 'recipients::csv invalid column headers'
+    end
+    it 'should not raise ValidationError if csv has minimum expected columns (name, email)' do
+      recipients = {'csv'=>'spec/mailer/recipients.csv'}
+      expect(Maildis::Validator.validate_recipients recipients).to be_nil
+    end
+    it 'should raise ValidationError if csv has no recipients' do
+      recipients = {'csv'=>'spec/mailer/recipients_empty.csv'}
+      expect {Maildis::Validator.validate_recipients recipients}.to raise_error Maildis::ValidationError, 'recipients::csv empty'
+    end
+  end
+
+  describe '.validate_templates' do
+    it 'should raise ValidationError if html template parameter is not specified' do
+      templates = {'plain'=>''}
+      expect {Maildis::Validator.validate_templates templates}.to raise_error Maildis::ValidationError, 'templates::html not specified'
+    end
+    it 'should raise ValidationError if plain template parameter is not specified' do
+      templates = {'html'=>''}
+      expect {Maildis::Validator.validate_templates templates}.to raise_error Maildis::ValidationError, 'templates::plain not specified'
+    end
+    it 'should raise ValidationError if html template is not found' do
+      templates = {'html'=>'bad_file_path', 'plain'=>'spec/mailer/template.txt'}
+      expect {Maildis::Validator.validate_templates templates}.to raise_error Maildis::ValidationError, 'templates::html not found'
+    end
+    it 'should raise ValidationError if plain template is not found' do
+      templates = {'html'=>'spec/mailer/template.html', 'plain'=>'bad_file_path'}
+      expect {Maildis::Validator.validate_templates templates}.to raise_error Maildis::ValidationError, 'templates::plain not found'
+    end
+    it 'should not raise ValidationError if html and plain templates are valid' do
+      templates = {'html'=>'spec/mailer/template.html', 'plain'=>'spec/mailer/template.txt'}
+      expect(Maildis::Validator.validate_templates templates).to be_nil
+    end
+  end
+
+end

data/spec/mailer/invalid.csv

@@ -0,0 +1 @@
+name_,email_,url_

data/spec/mailer/mailer.yml

@@ -0,0 +1,15 @@
+mailer:
+  subject: "Test Mailer"
+  sender:
+    name: "Developer"
+    email: "developer@maark.com"
+  recipients:
+    csv: "spec/mailer/recipients.csv"
+  templates:
+    html: "spec/mailer/template.html"
+    plain: "spec/mailer/template.txt"
+smtp:
+  host: "localhost"
+  port: 1025
+  username:
+  password:

data/spec/mailer/mailer_invalid.yml

@@ -0,0 +1 @@
+invalid:

data/spec/mailer/recipients.csv

@@ -0,0 +1 @@
+name,email,url

data/spec/mailer/recipients_empty.csv

@@ -0,0 +1 @@
+name,email,url

data/spec/mailer/template.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+          "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+  <head>
+    <title>Test Mailer</title>
+    <style></style>
+  </head>
+  <body>
+    <p>This is a test mailer</p>
+    <p>The following merge field should be replaced with an actual URL: <a href="%url%">%url%</a></p>
+    <p>Organization | Address | Unsubscribe Link</p>
+  </body>
+</html>

data/spec/mailer/template.txt

@@ -0,0 +1,5 @@
+This is a test mailer.
+
+The following merge field should be replaced with an actual URL: %url%
+
+Organization | Address | Unsubscribe Link

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+%w{yaml pry}.each{ |lib| require lib}
+Dir[File.join(File.dirname(__FILE__), '../lib/maildis', '*')].each { |file| require file }