smitty 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDZhYzc4ZjY5ODBhZTYxZGJjYzA4MTI3Njc2ZDlmZWQ4Y2Q1NzY3YQ==
+  data.tar.gz: !binary |-
+    MzE5NzhlMzE2NzU2ZjNmN2E2ZGM5ZWZhMGNkMDUzZDUwZmNmMjM1Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWQzNjU4YTIyZDc3ODNiZjhkMTJiN2FjNjgzZTE5NzRhZDYyYjAyNmMxMWY3
+    ZWQzNWQ5N2U2ODBkNjQ0ZjJmMzUxODhmNDhmMmMzN2Y3YzAwMmQwNGQxOTJj
+    OWQ0ZmNkZTVkMWFjZjdhZTAwNTQ5NTM0MGJiNDgwMzEwMjFmZWU=
+  data.tar.gz: !binary |-
+    MmUxMmE1ZWI0NDQ5ODJhNWQ0Yzk4NzQ5NTVkOWVhNGM4ZTQ0YzAxOThiZmZj
+    MzU3MDRhNzg1MzBiODY0ZDU3OTA1OGM2NTAwYTE1MDVkY2NiNzgxZjc5NGJm
+    ZjE2NWEzMTYwM2RhODY0MDY5YTQwNWVjYjFjODI2M2JlYTBmODc=

data/.gitignore

@@ -0,0 +1,23 @@
+*.css
+*.gem
+.DS_Store
+*.hbs
+*.html
+*.txt
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Steele
+
+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,62 @@
+# Smitty
+
+Smitty is a mail client that allows you to use handlebars like HTML templates. It supports all the things you would expect out a mail client. Internally it uses [mail](https://github.com/mikel/mail) for creation and [premailer](https://github.com/alexdunae/premailer/) for inline css. Generation for Multi-Part messages is all done for you.
+
+Smitty doesn't use everything that is available in handlebars, it only does replacement for variables. What this allows you to do is create nice looking HTML templates in a proper editor, and then do quick search and replace. 
+
+For example, say you wanted to loop over a set of emails and names, inserting a different name for the corresponding email. In your template, you would put {{name}} in the place where you wanted replacement to occur, write your names and email addresses in 'names.txt' and 'emails.txt' respectively, and call smitty like so. Assume your template is in template.hbs.
+
+    ./smitty from@someplace.io emails.txt 'YO {{name}}' template.hbs --vars 'name=names.txt' 
+    
+Smitty would then loop over each email address in emails.txt, replacing {{name}} with the corresponding name from names.txt. As you can see, variable names in the subject is also supported.
+
+## Installation
+
+Download the latest gem [here](https://github.com/tomsteele/smitty/releases/download/v0.0.2/smitty-0.0.2.gem) and install with gem:
+
+    $ gem install smitty
+
+Or build and install it yourself as:
+
+    $ gem build smitty.gemspec
+    $ gem install smitty
+
+## Usage
+
+    Smitty 0.0.2
+
+    Usage:
+      ./smitty [options] <from_address> <to_file> <subject> <template>
+      ./smitty -h | --help
+      ./smitty -v | --version
+
+    Required Arguments:
+      from_address:                    Address to send mail from.
+      to_file:                         Newline separated file containing recipient addresses.
+      subject:                         Mail subject, can have handlebar replacements.
+      template:                        Handlebars like HTML template.
+
+    Options:
+      -h --help                        Show this usage.
+      -v --version                     Show version.
+      --vars key=value,key=value       Variables for template and subject line, should be a comma separated
+                                       list of key value pairs. Key should be the variable name in your
+                                       template, and value may be a constant or a newline separated file.
+                                       Value file and to_file must have the same amount of lines.
+      -a files                         Attach comma separated list of files.
+      --server SERVER                  SMTP Server, default is localhost.
+      --port PORT                      SMTP Port, default is 25.
+      --ssl                            Use SSL, default is false.
+      --username USER                  SMTP user.
+      --password PASSWORD              SMTP password.
+      --cc address                     Add a cc address.
+      --bcc address                    Add a bcc address.
+      --dry-run                        Output messages and don't send.
+
+## 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/bin/smitty

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+$:.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+require 'mail'
+require 'docopt'
+require 'nokogiri'
+require 'premailer'
+require 'smitty'
+
+# Parse arguments
+begin
+  args = Docopt::docopt(Smitty::USAGE, {version: Smitty::VERSION})
+rescue Docopt::Exit => e
+  puts e.message
+  exit(0)
+end
+
+# Create SMTP connection and set Mail default
+smtp_conn = Smitty.smtp_connect(args['--server'], args['--port'], args['--ssl'], args['--username'], args['--password'])
+Mail.defaults do
+  delivery_method :smtp_connection, { :connection => smtp_conn }
+end
+
+attachments = args['-a'].split(',') if args['-a']
+from_address = args['<from_address>']
+subject = args['<subject>']
+
+# Read to_file into list of addresses
+begin
+  to_addresses = File.readlines(args['<to_file>']).map(&:chomp)
+rescue Errno::ENOENT => e
+  Smitty.croak("Count not open #{args['<to_file>']}", e.message)
+end
+
+# Read in template
+begin
+  template = Premailer.new(args['<template>'])
+rescue Errno::ENOENT => e
+  Smitty.croak("Could not open #{args['<to_file>']}", e.message)
+end
+
+# Parse replacement variables, exiting if length is not equal to to_file
+variables = []
+variables = args['--vars'].split(',').map { |var| Smitty.variable_parser(var, to_addresses.length) } unless args['--vars'].nil?
+
+# Loop over each receipient, create a temporary template,
+# replace variables, and send the message
+to_addresses.each do |to_address|
+  template_copy = String.new(template.to_inline_css)
+  subject_copy = String.new(subject)
+  # Replace each variable in the template
+  variables.each do |variable|
+    if variable[:with].kind_of?(Array)
+      sub_text = variable[:with].shift()
+    else
+      sub_text = variable[:with]
+    end
+    template_copy.gsub!("{{#{variable[:replace_string]}}}", sub_text)
+    subject_copy.gsub!("{{#{variable[:replace_string]}}}", sub_text)
+  end
+  Smitty.croak('A marker was found in the template that did not have a matching key') if template_copy =~ /\{\{\w+\}\}/
+  Smitty.croak('A marker was found in the subject that did not have a matching key') if subject_copy =~ /\{\{\w+\}\}/
+  # Create the new mail object
+  mail = Mail.new()
+  mail.from = from_address
+  mail.to = to_address
+  mail.bcc = args['--bcc'] unless args['--bcc'].nil?
+  mail.cc = args['--cc'] unless args['--cc'].nil?
+  mail.subject = subject_copy
+  mail.text_part do
+    body Nokogiri::HTML(template_copy).text
+  end
+  mail.html_part do
+    content_type 'text/html; charset=UTF-8'
+    body template_copy
+  end
+  # Attach each file to the message
+  begin
+    attachments.each { |file| mail.add_file(file) } unless attachments.nil?
+  rescue Exception => e
+    Smitty.croak('Could not attach file', e.message)
+  end
+  if args['--dry-run']
+    puts mail.to_s
+  else
+    puts "Message delivered to #{to_address}"
+    mail.deliver!
+  end
+end

data/lib/smitty/croak.rb

@@ -0,0 +1,7 @@
+module Smitty
+  # Prints variable amount of messages and exits
+  def self.croak(*messages)
+    messages.each { |message| puts "Error: #{message}"}
+    exit(1)
+  end
+end

data/lib/smitty/smtp_connect.rb

@@ -0,0 +1,21 @@
+require 'net/smtp'
+
+module Smitty
+  def self.smtp_connect(server, port, ssl, username, password)
+    begin
+      smtp_server = server.nil? ? 'localhost' : server
+      smtp_port = port.nil? ? 25 : port.to_i
+      smtp_conn = Net::SMTP.new(smtp_server, smtp_port)
+      smtp_conn.enable_tls() if ssl
+      if username
+        Smitty.croak('No password provided') if password.nil?
+        smtp_conn.start(smtp_server, username, password, :plain)
+      else
+        smtp_conn.start()
+      end
+      smtp_conn
+    rescue Exception => e
+      Smitty.croak("Could not connect to SMTP server #{smtp_server}:#{smtp_port}", e.message)
+    end
+  end
+end

data/lib/smitty/usage.rb

@@ -0,0 +1,34 @@
+module Smitty
+  USAGE = <<DOC
+Smitty #{Smitty::VERSION}
+
+Usage:
+  #{$0} [options] <from_address> <to_file> <subject> <template>
+  #{$0} -h | --help
+  #{$0} -v | --version
+
+Required Arguments:
+  from_address:                    Address to send mail from.
+  to_file:                         Newline separated file containing recipient addresses.
+  subject:                         Mail subject, can have handlebar replacements.
+  template:                        Handlebars like HTML template.
+
+Options:
+  -h --help                        Show this usage.
+  -v --version                     Show version.
+  --vars key=value,key=value       Variables for template and subject line, should be a comma separated
+                                   list of key value pairs. Key should be the variable name in your
+                                   template, and value may be a constant or a newline separated file.
+                                   Value file and to_file must have the same amount of lines.
+  -a files                         Attach comma separated list of files.
+  --server SERVER                  SMTP Server, default is localhost.
+  --port PORT                      SMTP Port, default is 25.
+  --ssl                            Use SSL, default is false.
+  --username USER                  SMTP user.
+  --password PASSWORD              SMTP password.
+  --cc address                     Add a cc address.
+  --bcc address                    Add a bcc address.
+  --dry-run                        Output messages and don't send.
+
+DOC
+end

data/lib/smitty/variable_parser.rb

@@ -0,0 +1,15 @@
+module Smitty
+  def self.variable_parser(variable_string, mail_length)
+    pairs = variable_string.split('=')
+    # content is a file
+    begin
+      with_content = File.readlines(pairs[1]).map(&:chomp)
+      Smitty.croak("#{pairs[0]} != recipient length") if with_content.length != mail_length
+    rescue Errno::ENOENT
+      with_content = pairs[1]
+    rescue
+      croak("Could not parse key value pair #{variable_string}")
+    end
+    {replace_string: pairs[0], with: with_content }
+  end
+end

data/lib/smitty/version.rb

@@ -0,0 +1,3 @@
+module Smitty
+  VERSION = '0.0.2'
+end

data/lib/smitty.rb

@@ -0,0 +1,5 @@
+require 'smitty/version'
+require 'smitty/usage'
+require 'smitty/croak'
+require 'smitty/variable_parser'
+require 'smitty/smtp_connect'

data/smitty.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smitty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smitty"
+  spec.version       = Smitty::VERSION
+  spec.authors       = ["Tom Steele"]
+  spec.email         = ["thomasjsteele@gmail.com"]
+  spec.description   = %q{Send mail with handlebars like templates}
+  spec.summary       = %q{Send mail with handlebars like templates}
+  spec.homepage      = "https://github.com/tomsteele/smitty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "docopt", ">= 0.5.0"
+  spec.add_dependency "nokogiri", ">= 1.6.0"
+  spec.add_dependency "mail", ">= 2.5.4"
+  spec.add_dependency "premailer", ">= 1.7.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: smitty
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tom Steele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: premailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send mail with handlebars like templates
+email:
+- thomasjsteele@gmail.com
+executables:
+- smitty
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/smitty
+- lib/smitty.rb
+- lib/smitty/croak.rb
+- lib/smitty/smtp_connect.rb
+- lib/smitty/usage.rb
+- lib/smitty/variable_parser.rb
+- lib/smitty/version.rb
+- smitty.gemspec
+homepage: https://github.com/tomsteele/smitty
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Send mail with handlebars like templates
+test_files: []