lipwig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60476fb310740f79d87ecfbfd2c0771ccf0dc14b
+  data.tar.gz: c40710bce00094743adf3d4736d7ebc87213d51e
+SHA512:
+  metadata.gz: 7e4b52545bbc618fd20f9b115ec5845d74148f591f5fed2b4b884df314c673890596809c2d954c79e9bb94ba49c07e679b44a230cca6225fee2be6b594d94eb2
+  data.tar.gz: 8f62d0675fabed1fead520851049a68ca28eabf8e51ee4dc0ae4e11cc223039c0e9ba820f95b3d98760de920941d8d21b5fdc9c5406d440672d08102f544d0d7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+sudo: false
+language: ruby
+rvm: 2.3.2
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pat@freelancing-gods.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,60 @@
+# Lipwig
+
+Lipwig is a small tool that for sending bulk emails in a slightly more friendly vibe than BCC'ing everyone.
+
+## Why?
+
+I have a habit of inviting friends to various events and shows, but I don't like putting everyone's email address in the _To_ field (it's not nice to disclose so many peoples' email addresses). I also don't like putting everyone in the _BCC_ field (it's nice to keep couples' email addresses together, and make the email feel at least a little more personal).
+
+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
+
+## Usage
+
+Similar to Jekyll, Lipwig expects email files to be a mixture of YAML and Markdown. Here's an example:
+
+    from: "Pat Allan <pat@obfuscated.email.com>"
+    subject: "Party time"
+    recipients:
+     - "rey@obfuscated.email.com",
+     - - "finn@obfuscated.email.com"
+       - "poe@obfuscated.email.com"
+     - "Kylo Ren <ben@obfuscated.email.com>"
+    ---
+    Hi everyone,
+
+    It's time for a **party**. How about next week? Shall I cook pancakes?
+
+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.
+
+### 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.
+
+### Commands
+
+You can review the HTML of the email in your browser (currently built with macOS in mind):
+
+    $ lipwig preview my-email.markdown
+
+You can clear out the generated preview files:
+
+    $ lipwig clear
+
+And you can send the emails:
+
+    $ lipwig send my-email.markdown
+
+## 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.
+
+## Licence
+
+Copyright (c) 2016, Lipwig is developed and maintained by Pat Allan, and is
+released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lipwig"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lipwig

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'lipwig'
+
+Lipwig::CLI.call ARGV[0], ARGV[1]

data/lib/lipwig/cli.rb

@@ -0,0 +1,44 @@
+class Lipwig::CLI
+  def self.call(command = '', source = '')
+    new(command, source).call
+  end
+
+  def initialize(command, source)
+    @command, @source = command, source
+  end
+
+  def call
+    case command
+    when 'send'
+      Lipwig::Sender.call email
+    when 'preview'
+      Lipwig::Preview.call email
+    when 'clear'
+      Dir['lipwig-preview-*.html'].each { |file| File.delete file }
+    else
+      puts "Unknown command #{command}." unless command == 'help'
+      puts <<-MESSAGE
+Commands are:
+  send:    Send the email to the specified recipients.
+  preview: Open the HTML for the email in your browser.
+  clear:   Remove temporary preview files.
+
+Example Usage:
+  $ lipwig send email.markdown
+  $ lipwig preview email.markdown
+
+Sending emails requires LIPWIG_POSTMARK_API_KEY to be set. Recipients are
+whatever is set in the email's frontmatter, but can be overridden by
+LIPWIG_RECIPIENTS.
+      MESSAGE
+    end
+  end
+
+  private
+
+  attr_reader :command, :source
+
+  def email
+    @email ||= Lipwig::Parser.call File.read(source)
+  end
+end

data/lib/lipwig/email.rb

@@ -0,0 +1,3 @@
+class Lipwig::Email
+  attr_accessor :from, :subject, :body, :recipients
+end

data/lib/lipwig/parser.rb

@@ -0,0 +1,49 @@
+class Lipwig::Parser
+  MARKER = /---\s*/
+
+  def self.call(input)
+    new(input).call
+  end
+
+  def initialize(input)
+    @input = input
+  end
+
+  def call
+    email = Lipwig::Email.new
+    email.from       = frontmatter['from']
+    email.subject    = frontmatter['subject']
+    email.recipients = frontmatter['recipients']
+    email.body       = html
+    email
+  end
+
+  private
+
+  attr_reader :input
+
+  def frontmatter
+    @frontmatter ||= YAML.load input.split(MARKER).first.strip
+  end
+
+  def html
+    <<-HTML
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  </head>
+  <body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;">
+    #{ renderer.render(markdown).strip }
+  </body>
+</html>
+    HTML
+  end
+
+  def markdown
+    @markdown ||= input.split(MARKER).last.strip
+  end
+
+  def renderer
+    @renderer ||= Redcarpet::Markdown.new Redcarpet::Render::HTML.new
+  end
+end

data/lib/lipwig/preview.rb

@@ -0,0 +1,23 @@
+class Lipwig::Preview
+  def self.call(email)
+    new(email).call
+  end
+
+  def initialize(email)
+    @email = email
+  end
+
+  def call
+    File.write filename, email.body
+
+    `open #{filename}`
+  end
+
+  private
+
+  attr_reader :email
+
+  def filename
+    @filename ||= "#{Dir.pwd}/lipwig-preview-#{Time.now.to_i}.html"
+  end
+end

data/lib/lipwig/sender.rb

@@ -0,0 +1,46 @@
+class Lipwig::Sender
+  def self.call(email)
+    new(email).call
+  end
+
+  def initialize(email)
+    @email = email
+  end
+
+  def call
+    client.deliver_in_batches(messages).each do |response|
+      puts "Delivery To:     #{Array(response[:to]).join(', ')}"
+      puts "Delivery Status: #{response[:message]}"
+      puts ""
+    end
+  end
+
+  private
+
+  attr_reader :email
+
+  def client
+    @client ||= Postmark::ApiClient.new ENV['LIPWIG_POSTMARK_API_KEY']
+  end
+
+  def from
+    email.from || ENV['LIPWIG_FROM']
+  end
+
+  def messages
+    recipients.collect do |recipient|
+      {
+        :from      => from,
+        :to        => recipient,
+        :subject   => email.subject,
+        :html_body => email.body
+      }
+    end
+  end
+
+  def recipients
+    return [ENV['LIPWIG_RECIPIENTS']] if ENV['LIPWIG_RECIPIENTS']
+
+    email.recipients
+  end
+end

data/lib/lipwig.rb

@@ -0,0 +1,13 @@
+require 'postmark'
+require 'redcarpet'
+require 'yaml'
+
+module Lipwig
+  #
+end
+
+require 'lipwig/cli'
+require 'lipwig/email'
+require 'lipwig/parser'
+require 'lipwig/preview'
+require 'lipwig/sender'

data/lipwig.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "lipwig"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Pat Allan"]
+  spec.email         = ["pat@freelancing-gods.com"]
+
+  spec.summary       = %q{Write group emails in Markdown, send via Postmark.}
+  spec.homepage      = "https://github.com/pat/lipwig"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: lipwig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-19 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- pat@freelancing-gods.com
+executables:
+- lipwig
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lipwig
+- lib/lipwig.rb
+- lib/lipwig/cli.rb
+- lib/lipwig/email.rb
+- lib/lipwig/parser.rb
+- lib/lipwig/preview.rb
+- lib/lipwig/sender.rb
+- lipwig.gemspec
+homepage: https://github.com/pat/lipwig
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Write group emails in Markdown, send via Postmark.
+test_files: []