maildis 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format Fivemat

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Johnny Boursiquot
+
+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,134 @@
+# Maildis 
+
+[![Code
+Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jboursiquot/maildis) [![Dependency
+Status](https://gemnasium.com/jboursiquot/maildis.png)](https://gemnasium.com/jboursiquot/maildis) 
+
+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.
+
+## Installation
+
+    $ gem install maildis
+
+## Usage
+
+### Maildis Commands:
+
+    maildis dispatch mailer  # Dispatches the mailer through the SMTP server specified in the mailer configuration.
+    maildis ping mailer      # Attempts to connect to the SMTP server specified in the mailer configuration
+    maildis validate mailer  # Validates mailer configuration file
+
+In the above task listing, _mailer_ refers to a YAML configuration file
+for your mailer. You may get additional help on any of the available tasks, for example:
+
+    $ maildis help dispath
+
+    Usage:
+      maildis ping mailer
+
+    Options:
+      -v, [--verbose=VERBOSE]  # Verbose
+
+## Creating and Dispatching Mailers
+
+### 1. Create a mailer configuration (e.g. mailer.yml)
+
+    mailer:
+      subject: "Test Mailer"
+      sender:
+        name: "Developer"
+        email: "developer@company.com"
+      recipients:
+        csv: "/path/to/recipients.csv"
+      templates:
+        html: "/path/to/template.html"
+        plain: "/path/to/template.txt"
+    smtp:
+      host: "my.mail.host"
+      port: 25
+      username: "username"
+      password: "password"
+
+### 2. Set up html and plain text templates, for example:
+
+**HTML**
+
+    <!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>
+      </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>
+
+**Plain**
+
+    This is a test mailer.
+
+    The following merge field should be replaced with an actual URL: %url%
+
+    Organization | Address | Unsubscribe Link
+
+Note the _%url%_ markers in the template files. This %{string}%
+mechanism allows you to specify merge fields which are replaced by their
+equivalent columns from your recipients CSV. In this case, the CSV example below,
+lists a _url_ column that will be used as a merge field.
+
+### 3. Prepare your recipients CSV, for example:
+
+    name,email,url
+    Johnny Boursiquot,jboursiquot@gmail.com,https://github.com/jboursiquot
+    Johnny Boursiquot,jboursiquot@maark.com,http://www.maark.com
+
+### 4. Validate your configuration
+
+    $ maildis validate /path/to/your/mailer.yml
+
+This will go through the settings in your mailer configuration and check
+
+- sender email validity
+- template path validity
+- recipients CSV path and format validity
+- SMTP server reachability
+
+You can test the reachability of the SMTP server defined in your mailer configuration on its own by issueing the following command:
+
+    $ maildis ping /path/to/your/mailer.yml
+
+### 5. Invoke the maildis command while passing in the path to your
+mailer configuration to its dispatch task
+
+    $ maildis dispath /path/to/your/mailer.yml -v
+
+When _maildis_ processes your _dispatch_ request, a logfile (.maildis.log) is written in the user's home directory. In the above command, the _dispatch_ task is invoked with the _verbose_ flag which will output to STDOUT as well as ~/.maildis.log. Example output based on the recipients.csv above might look like this:
+
+    2012-12-11 20:18:10 -0500 INFO: Load /path/to/your/mailer.yml
+    2012-12-11 20:18:10 -0500 INFO: Validate configuration
+    2012-12-11 20:18:10 -0500 INFO: Validate recipients csv
+    2012-12-11 20:18:10 -0500 INFO: Extract recipients from csv
+    2012-12-11 20:18:10 -0500 INFO: Validate sender
+    2012-12-11 20:18:10 -0500 INFO: Validate templates
+    2012-12-11 20:18:10 -0500 INFO: Validate SMTP server localhost
+    2012-12-11 20:18:10 -0500 INFO: Dispatching to 2 recipients
+    2012-12-11 20:18:10 -0500 INFO: Sent: Johnny Boursiquot <jboursiquot@gmail.com>
+    2012-12-11 20:18:10 -0500 INFO: Sent: Johnny Boursiquot <jboursiquot@maark.com>
+    2012-12-11 20:18:11 -0500 INFO: Dispatch complete without errors
+
+## Local SMTP Server For Testing
+
+I recommend you use the _mailcatcher_ gem to get a local SMTP server up
+and running while you test. This will speed up your testing and even
+require network access. See http://mailcatcher.me for more details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes with tests (`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,11 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc 'Runs all specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = ["--format Fivemat", "--color"]
+end

data/bin/maildis

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/maildis'
+
+Maildis::CLI.start

data/lib/maildis/dispatcher.rb

@@ -0,0 +1,43 @@
+require "pony"
+require "logger"
+
+module Maildis
+
+  class Dispatcher
+
+    class << self
+
+      def dispatch(options = {})
+        result = {sent: [], not_sent: []}
+        options[:recipients].each do |recipient|
+          begin
+            html_body = TemplateRenderer.render(options[:templates][:html], recipient.merge_fields)
+            plain_body = TemplateRenderer.render(options[:templates][:plain], recipient.merge_fields)
+            Pony.mail({
+              to: recipient.to_email,
+              from: options[:sender].to_email,
+              subject: options[:subject],
+              html_body: html_body,
+              body: plain_body,
+              via: :smtp,
+              via_options: {address: options[:server].host,
+                            port: options[:server].port,
+                            user_name: options[:server].username,
+                            password: options[:server].password}
+            })
+            options[:logger].info "Sent: #{recipient.to_email}" if options[:logger]
+            result[:sent] << recipient
+          rescue => e
+            options[:logger].error "Error: #{recipient.to_email} | #{e.message}" if options[:logger]
+            result[:not_sent] << {recipient: recipient, reason: e.message}
+          end
+        end
+        result
+      end
+
+    end
+
+  end
+
+
+end

data/lib/maildis/merge_field.rb

@@ -0,0 +1,9 @@
+module Maildis
+  class MergeField
+    attr_reader :field, :value
+    def initialize(field, value)
+      @field = field
+      @value = value || ""
+    end
+  end
+end

data/lib/maildis/multi_io.rb

@@ -0,0 +1,15 @@
+class MultiIO
+
+  def initialize(*targets)
+    @targets = targets
+  end
+
+  def write(*args)
+    @targets.each {|t| t.write(*args)}
+  end
+
+  def close
+    @targets.each {|t| t.close}
+  end
+
+end

data/lib/maildis/recipient.rb

@@ -0,0 +1,22 @@
+module Maildis
+  class Recipient
+    attr_reader :name, :email
+    attr_accessor :merge_fields
+
+    def initialize(name, email, merge_fields=[])
+      @name = name
+      @email = email
+      @merge_fields = merge_fields
+    end
+
+    def to_email
+      return "#{@name} <#{@email}>" if @name
+      @email
+    end
+
+    def to_s
+      "<Recipient #{name} | #{email}>"
+    end
+
+  end
+end

data/lib/maildis/recipient_parser.rb

@@ -0,0 +1,87 @@
+require_relative 'validation_error'
+require_relative 'recipient'
+require 'csv'
+
+module Maildis
+
+  class RecipientParser
+
+    class << self
+
+      @@expected_columns = [:name, :email]
+
+      def valid_csv?(file_path)
+        csv = extract_data file_path
+        begin
+          validate_headers(normalize_headers(csv.headers), @@expected_columns)
+          true
+        rescue ValidationError => e
+          false
+        end
+      end
+
+      def empty_csv?(file_path)
+        csv = extract_data file_path
+        csv.empty?
+      end
+
+      def extract_recipients(file_path)
+        validate_file_path file_path
+        csv = extract_data file_path
+        validate_headers(normalize_headers(csv.headers), @@expected_columns)
+        parse_csv(csv)
+      end
+
+      def extract_data(file_path)
+        begin
+          CSV.read(file_path, {headers: true})
+        rescue ArgumentError => e
+          begin
+            # Force UTF-8
+            data = IO.read(file_path).force_encoding("ISO-8859-1").encode("utf-8", replace: nil)
+            CSV.parse(data, {headers: true})
+          rescue => e
+            raise "Failed to parse CSV. Unable to force UTF-8 conversion."+ " " + e.message
+          end
+        end
+      end
+
+      def parse_csv(csv)
+        result = []
+        csv.each do |r|
+          row = {}
+          r.to_hash.each_pair {|k,v| row.merge!({k.downcase => v})}
+          result << recipient_instance(row)
+        end
+        result
+      end
+
+      def recipient_instance(row)
+        recipient = Recipient.new row['name'], row['email']
+        row.each do |key, value|
+          recipient.merge_fields << MergeField.new(key, value) unless %w{name email}.include? key
+        end
+        recipient
+      end
+
+      def parse_file(file_path)
+        IO.read(file_path).force_encoding("ISO-8859-1").encode("utf-8", replace: nil)
+      end
+
+      def normalize_headers(headers)
+        headers.map(&:downcase)
+      end
+
+      def validate_file_path(file_path)
+        raise ValidationError, "File not found: #{file_path}" unless File.exists?(file_path)
+      end
+
+      def validate_headers(headers, expected)
+        expected.each do |header|
+          raise ValidationError, "Missing '#{header.to_s}' column" unless headers.include? header.to_s
+        end
+      end
+    end
+  end
+
+end

data/lib/maildis/sender.rb

@@ -0,0 +1,17 @@
+module Maildis
+
+  class Sender
+    attr_reader :name, :email
+
+    def initialize(name, email)
+      @name = name
+      @email = email
+    end
+
+    def to_email
+      return "#{@name} <#{@email}>" if @name
+      @email
+    end
+  end
+
+end

data/lib/maildis/server_utils.rb

@@ -0,0 +1,20 @@
+require 'socket'
+
+class ServerUtils
+
+  class << self
+
+    def server_reachable?(host, port=25)
+      begin
+        TCPSocket.new(host, port).close
+        true
+      rescue Errno::ECONNREFUSED
+        false
+      rescue => e
+        $stderr.puts "Error during mail server status check: " + e.message
+      end
+    end
+
+  end
+
+end

data/lib/maildis/smtp_server.rb

@@ -0,0 +1,13 @@
+module Maildis
+
+  class SmtpServer
+    attr_reader :host, :port, :username, :password
+    def initialize(host, port, username, password)
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+    end
+  end
+
+end

data/lib/maildis/template.rb

@@ -0,0 +1,17 @@
+module Maildis
+  class Template
+
+    HTML = "html"
+    HTML_EXT = ".html"
+    PLAIN = "plain"
+    PLAIN_EXT = ".txt"
+
+    attr_reader :type, :content
+
+    def initialize(type, content)
+      @type = type
+      @content = content
+    end
+
+  end
+end

data/lib/maildis/template_loader.rb

@@ -0,0 +1,18 @@
+module Maildis
+
+  class TemplateLoader
+
+    class << self
+
+      def load(template_path)
+        path = File.expand_path(template_path)
+        type = File.extname(path) == Template::PLAIN_EXT ? Template::PLAIN : Template::HTML 
+        content = File.read path
+        Template.new type, content
+      end
+
+    end
+
+  end
+
+end

data/lib/maildis/template_renderer.rb

@@ -0,0 +1,20 @@
+module Maildis
+
+  class TemplateRenderer
+
+    class << self
+
+      def render(template, merge_fields)
+        result = String.new(template.content)
+        merge_fields.each do |mf|
+          token = /#{Regexp.quote('%' + mf.field + '%')}/
+          result.gsub!(token, mf.value)
+        end
+        result
+      end
+
+    end
+
+  end
+
+end

data/lib/maildis/validation_error.rb

@@ -0,0 +1,3 @@
+module Maildis 
+  class ValidationError < StandardError; end
+end

data/lib/maildis/validation_utils.rb

@@ -0,0 +1,19 @@
+class ValidationUtils
+
+  class << self
+
+    def valid_hostname?(hostname)
+      return false unless hostname
+      return false if hostname.length > 255 || hostname.scan('..').any?
+      return true if hostname == 'localhost'
+      hostname = hostname[0 ... -1] if hostname.index('.', -1)
+      return hostname.split('.').collect { |i| i.size <= 63 && !(i.rindex('-', 0) || i.index('-', -1) || i.scan(/[^a-z\d-]/i).any?)}.all?
+    end
+
+    def valid_email?(email)
+      !email.match(/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$/i).nil?
+    end
+
+  end
+
+end

data/lib/maildis/validator.rb

@@ -0,0 +1,50 @@
+require_relative 'validation_utils'
+require_relative 'validation_error'
+require_relative 'recipient_parser'
+
+module Maildis
+
+  class Validator
+
+    class << self
+
+      def validate_config(hash)
+        raise ValidationError, "mailer settings missing" unless hash.has_key? 'mailer'
+        raise ValidationError, "smtp settings missing" unless hash.has_key? 'smtp'
+      end
+
+      def validate_subject(subject)
+        raise ValidationError, "mailer::subject invalid" unless !subject.nil? && !subject.empty?
+      end
+
+      def validate_smtp(hash)
+        raise ValidationError, "smtp::host missing or invalid" unless hash.has_key?('host') && ValidationUtils.valid_hostname?(hash['host'])
+        raise ValidationError, "smtp::port missing or invalid" unless hash.has_key?('port') && (hash['port'].to_i != 0)
+        raise ValidationError, "smtp::username missing" unless hash.has_key? 'username'
+        raise ValidationError, "smtp::password missing" unless hash.has_key? 'password'
+      end
+
+      def validate_sender(hash)
+        raise ValidationError, "sender::name missing" unless hash.has_key? 'name'
+        raise ValidationError, "sender::email missing or invalid" unless hash.has_key?('email') && ValidationUtils.valid_email?(hash['email'])
+      end
+
+      def validate_recipients(hash)
+        raise ValidationError, "recipients::csv missing" unless hash.has_key? 'csv'
+        raise ValidationError, "recipients::csv invalid file path" unless File.exist?(File.expand_path(hash['csv']))
+        raise ValidationError, "recipients::csv empty" if RecipientParser.empty_csv? hash['csv']
+        raise ValidationError, "recipients::csv invalid column headers" unless RecipientParser.valid_csv? hash['csv']
+      end
+
+      def validate_templates(hash)
+        raise ValidationError, "templates::html not specified" unless hash.has_key? 'html'
+        raise ValidationError, "templates::plain not specified" unless hash.has_key? 'plain'
+        raise ValidationError, "templates::html not found" unless File.exist?(File.expand_path(hash['html']))
+        raise ValidationError, "templates::plain not found" unless File.exist?(File.expand_path(hash['plain']))
+      end
+
+   end
+
+  end
+
+end

data/lib/maildis/version.rb

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