lipwig 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60476fb310740f79d87ecfbfd2c0771ccf0dc14b
-  data.tar.gz: c40710bce00094743adf3d4736d7ebc87213d51e
+  metadata.gz: b7edc14564c6463b4e40b18ecc6833aadbfc1e3c
+  data.tar.gz: 2f4b269b1116a5ca9fe849d2ae182cd391724d4a
 SHA512:
-  metadata.gz: 7e4b52545bbc618fd20f9b115ec5845d74148f591f5fed2b4b884df314c673890596809c2d954c79e9bb94ba49c07e679b44a230cca6225fee2be6b594d94eb2
-  data.tar.gz: 8f62d0675fabed1fead520851049a68ca28eabf8e51ee4dc0ae4e11cc223039c0e9ba820f95b3d98760de920941d8d21b5fdc9c5406d440672d08102f544d0d7
+  metadata.gz: 93d2fcf69d63fd149ff11650a011bc16491f95aaef75fb110d02d630e93399b266851b33a83d3c075341212e55e28c8d11a37dbe043376a5a6c3e80bfe08879f
+  data.tar.gz: 049cdea1040d2484d90c0bf7de82426d63ade663bafeec0d6d89c3d676b34218548aefffa75410f403e369a1f6358ec13f53ab9af998d265637c469c90e7a6c9

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "mail",     "~> 2.6"
+gem "postmark", "~> 1.9"

data/README.markdown

@@ -8,12 +8,18 @@ I have a habit of inviting friends to various events and shows, but I don't like
 
 So, I'd been writing Ruby scripts to send neatly formatted emails, but Lipwig wraps up that logic and makes it a bit more re-usable.
 
-It currently uses Postmark's API, because that's what I use. I'm open to patches that allow for SMTP settings or other provider APIs as well.
-
 ## Installation
 
     $ gem install lipwig
 
+Also, you'll need either the `postmark` gem or the `mail` gem, depending on whether you want to send via Postmark's API or by SMTP.
+
+    $ gem install postmark
+    # or
+    $ gem install mail
+
+Lipwig is known to work with Postmark >= 1.9 and Mail >= 2.6.4.
+
 ## Usage
 
 Similar to Jekyll, Lipwig expects email files to be a mixture of YAML and Markdown. Here's an example:
@@ -32,9 +38,23 @@ Similar to Jekyll, Lipwig expects email files to be a mixture of YAML and Markdo
 
 As you can see, the recipients value expects an array, and it can contain arrays to send a single email to more than one person. Everything that follows after the `---` is Markdown, and will be rendered as HTML in the resulting email.
 
+### Sending Configuration
+
+If you're using Postmark's API, then all you need to set is the `LIPWIG_POSTMARK_API_KEY` environment variable.
+
+For SMTP, there's a handful of required environment variables:
+
+* LIPWIG_SMTP_ADDRESS
+* LIPWIG_SMTP_PORT
+* LIPWIG_SMTP_USERNAME
+* LIPWIG_SMTP_PASSWORD
+* LIPWIG_SMTP_DOMAIN
+
+If you're using SMTP and sending many emails, it's recommended you use the persistent connection approach if your provider supports it, by setting `LIPWIG_SMTP_CONNECTION=true`.
+
 ### Options
 
-The environment variable `LIPWIG_POSTMARK_API_KEY` is expected to be set with your API key. You can use `LIPWIG_FROM` for your default _From_ setting - though anything specified in your email file will override this. `LIPWIG_RECIPIENTS`, on the otherhand, will override your email file's recipients - useful for a quick test before you fill up everyone's inboxes.
+You can use `LIPWIG_FROM` for your default _From_ setting - though anything specified in your email file will override this. `LIPWIG_RECIPIENTS`, on the otherhand, will override your email file's recipients - useful for a quick test before you fill up everyone's inboxes.
 
 ### Commands
 
@@ -52,7 +72,7 @@ And you can send the emails:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lipwig. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pat/lipwig. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Licence
 

data/lib/lipwig.rb

@@ -1,4 +1,3 @@
-require 'postmark'
 require 'redcarpet'
 require 'yaml'
 
@@ -10,4 +9,4 @@ require 'lipwig/cli'
 require 'lipwig/email'
 require 'lipwig/parser'
 require 'lipwig/preview'
-require 'lipwig/sender'
+require 'lipwig/senders'

data/lib/lipwig/cli.rb

@@ -10,7 +10,7 @@ class Lipwig::CLI
   def call
     case command
     when 'send'
-      Lipwig::Sender.call email
+      Lipwig::Senders.call email
     when 'preview'
       Lipwig::Preview.call email
     when 'clear'

data/lib/lipwig/senders.rb

@@ -0,0 +1,20 @@
+module Lipwig::Senders
+  UnknownSenderError = Class.new(StandardError)
+
+  def self.call(email)
+    if ENV['LIPWIG_POSTMARK_API_KEY']
+      require 'lipwig/senders/postmark'
+      Lipwig::Senders::Postmark.call email
+    elsif ENV['LIPWIG_SMTP_CONNECTION'] == 'true'
+      require 'lipwig/senders/smtp_connection'
+      Lipwig::Senders::SMTPConnection.call email
+    elsif ENV['LIPWIG_SMTP_ADDRESS']
+      require 'lipwig/senders/smtp'
+      Lipwig::Senders::SMTP.call email
+    else
+      raise UnknownSenderError, "Sending protocol could not be determined"
+    end
+  end
+end
+
+require 'lipwig/senders/abstract'

data/lib/lipwig/senders/abstract.rb

@@ -0,0 +1,27 @@
+class Lipwig::Senders::Abstract
+  def self.call(email)
+    new(email).call
+  end
+
+  def initialize(email)
+    @email = email
+  end
+
+  def call
+    raise NoMethodError, "Sender must implement this call method"
+  end
+
+  private
+
+  attr_reader :email
+
+  def from
+    email.from || ENV['LIPWIG_FROM']
+  end
+
+  def recipients
+    return [ENV['LIPWIG_RECIPIENTS']] if ENV['LIPWIG_RECIPIENTS']
+
+    email.recipients
+  end
+end

data/lib/lipwig/{sender.rb → senders/postmark.rb}

@@ -1,12 +1,6 @@
-class Lipwig::Sender
-  def self.call(email)
-    new(email).call
-  end
-
-  def initialize(email)
-    @email = email
-  end
+require 'postmark'
 
+class Lipwig::Senders::Postmark < Lipwig::Senders::Abstract
   def call
     client.deliver_in_batches(messages).each do |response|
       puts "Delivery To:     #{Array(response[:to]).join(', ')}"
@@ -23,10 +17,6 @@ class Lipwig::Sender
     @client ||= Postmark::ApiClient.new ENV['LIPWIG_POSTMARK_API_KEY']
   end
 
-  def from
-    email.from || ENV['LIPWIG_FROM']
-  end
-
   def messages
     recipients.collect do |recipient|
       {
@@ -37,10 +27,4 @@ class Lipwig::Sender
       }
     end
   end
-
-  def recipients
-    return [ENV['LIPWIG_RECIPIENTS']] if ENV['LIPWIG_RECIPIENTS']
-
-    email.recipients
-  end
 end

data/lib/lipwig/senders/smtp.rb

@@ -0,0 +1,44 @@
+require 'mail'
+
+class Lipwig::Senders::SMTP < Lipwig::Senders::Abstract
+  def call
+    recipients.each do |recipient|
+      mail = Mail.new
+      mail.delivery_method delivery_method, delivery_method_options
+
+      mail.content_type = 'text/html; charset=UTF-8'
+      mail.from         = from
+      mail.to           = recipient
+      mail.subject      = email.subject
+      mail.body         = email.body
+
+      begin
+        puts "Delivery To:     #{Array(recipient).join(', ')}"
+        mail.deliver!
+        puts "Delivery Status: OK", ""
+      rescue => error
+        puts "Delivery Status: Failed (#{error.message})", ""
+      end
+    end
+  end
+
+  private
+
+  attr_reader :email
+
+  def delivery_method
+    :smtp
+  end
+
+  def delivery_method_options
+    @delivery_method_options ||= {
+      :address              => ENV['LIPWIG_SMTP_ADDRESS'],
+      :port                 => ENV['LIPWIG_SMTP_PORT'],
+      :authentication       => :plain,
+      :user_name            => ENV['LIPWIG_SMTP_USERNAME'],
+      :password             => ENV['LIPWIG_SMTP_PASSWORD'],
+      :domain               => ENV['LIPWIG_SMTP_DOMAIN'],
+      :enable_starttls_auto => true
+    }
+  end
+end

data/lib/lipwig/senders/smtp_connection.rb

@@ -0,0 +1,39 @@
+require 'mail'
+require 'lipwig/senders/smtp'
+
+class Lipwig::Senders::SMTPConnection < Lipwig::Senders::SMTP
+  def call
+    connection.start(
+      ENV['LIPWIG_SMTP_DOMAIN'],
+      ENV['LIPWIG_SMTP_USERNAME'],
+      ENV['LIPWIG_SMTP_PASSWORD'],
+      :plain
+    )
+
+    super
+
+    connection.finish
+  end
+
+  private
+
+  attr_reader :email
+
+  def connection
+    @connection ||= begin
+      smtp = Net::SMTP.new(
+        ENV['LIPWIG_SMTP_ADDRESS'], ENV['LIPWIG_SMTP_PORT']
+      )
+      smtp.enable_starttls_auto
+      smtp
+    end
+  end
+
+  def delivery_method
+    :smtp_connection
+  end
+
+  def delivery_method_options
+    {:connection => connection}
+  end
+end

data/lipwig.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "lipwig"
-  spec.version       = '0.0.1'
+  spec.version       = '0.1.0'
   spec.authors       = ["Pat Allan"]
   spec.email         = ["pat@freelancing-gods.com"]
 
@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "postmark", "~> 1.9"
   spec.add_runtime_dependency "redcarpet", "~> 3.3"
 
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lipwig
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: postmark
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +60,11 @@ files:
 - lib/lipwig/email.rb
 - lib/lipwig/parser.rb
 - lib/lipwig/preview.rb
-- lib/lipwig/sender.rb
+- lib/lipwig/senders.rb
+- lib/lipwig/senders/abstract.rb
+- lib/lipwig/senders/postmark.rb
+- lib/lipwig/senders/smtp.rb
+- lib/lipwig/senders/smtp_connection.rb
 - lipwig.gemspec
 homepage: https://github.com/pat/lipwig
 licenses: []