launch_control 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21eb9c590a1ca3178bd2aaf43dd87ae47d72d04c
+  data.tar.gz: 89e70a81ac91e1987f59fb39b397d7fba2ea4bab
+SHA512:
+  metadata.gz: d6bb6fd748e01b0b88f3919eaedbbdf0a5a303a80e7010c9344c598cd5e18d4e9a7db9ca1a613deea0d463e8c8e12ba3be694a5fd65dafd249beeeb4ebe2b8ac
+  data.tar.gz: 96d3b5e7c730749a5c3da5e2b3d18ba3b4aaf7376902ec2e4191adde50f6bb4b9c558c80efc6f8659b533c9c277d85d86b4ad86c91386acb9fcc2bcef958ea9b

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Teague
+
+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,74 @@
+# LaunchControl
+
+LaunchControl eases and helps improve the integrity of mail delivered via Mandrill templates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'launch_control'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install launch_control
+
+Within your application (for a Rails app, typically /config/initializers/launch_control.rb), setup your Mandrill API key you wish to use:
+
+    LaunchControl.configure do |config|
+      config.mandrill_api_key = 'your_key_here'
+    end
+
+## Usage
+
+To start using Launch Control, you first need to create a contract class:
+
+    class ThankyouEmail < LaunchControl::MandrillContract
+      def template
+        'thank-you'
+      end
+
+      def validations
+        {
+          first_name: 'string',
+          last_name:  'string'
+        }
+      end
+    end
+
+Here we define which Mandrill template id we are going to use, and which global merge variables we require to use this template safely. Validations use the [Hash Validator](https://github.com/jamesbrooks/hash_validator) gem, check it out for an idea of what's possible.
+
+Now to send an email, we can use our MandrillContract subclass and simply push in all the details required as a hash:
+
+    mailer = ThankyouEmail.new
+    mailer.deliver(to: 'team@lotus.com', subject: 'Bring it home safely', first_name: 'Pastor', last_name: 'Maldonado')
+       => true
+
+Now if you try and deliver this without the appropriate content, you'll be pulled up on it:
+
+    mailer.deliver(to: 'team@ferarri.com', subject: 'I know what I\'m doing', first_name: 'Kimi')
+      => false
+
+    mailer.errors
+      => {:last_name=>"string required"}
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/launch_control.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "launch_control"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/launch_control.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'launch_control/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "launch_control"
+  spec.version       = LaunchControl::VERSION
+  spec.authors       = ["Chris Teague"]
+  spec.email         = ["chris@cteague.com.au"]
+
+  spec.summary       = %q{Ensure that emails delivered to Mandrill meet a specified contract.}
+  spec.homepage      = "https://flybeacon.com/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mandrill-api", '~> 1.0', ">= 1.0.53"
+  spec.add_dependency "hash_validator", '~> 0.4', ">= 0.4.0"
+  spec.add_dependency "activesupport", ">= 3.2.13"
+
+  spec.add_development_dependency "bundler", ">= 1.10"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", '~> 3.2', ">= 3.2.0"
+  spec.add_development_dependency "pry", '~> 0.9', ">= 0.9.12"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov", '~> 0.10', ">= 0.10.0"
+end

data/lib/launch_control/mandrill_contract.rb

@@ -0,0 +1,70 @@
+module LaunchControl
+
+  require 'hash_validator'
+
+  class MandrillContract
+
+    attr_accessor :errors
+
+    #
+    # Override this with any custom validations you wish
+    # to perform on your mail object before delivering.
+    #
+    def validations
+      {}
+    end
+
+    #
+    # Override this with your template id from Mandrill.
+    #
+    def template
+      raise 'You must define a Mandrill template to use'
+    end
+
+    #
+    # Override these to control how your validations and
+    # merge variables get integrated with Launch Control
+    # defaults. For example:
+    #
+    #     def merged_options(options)
+    #       options.merge(to_json)
+    #     end
+    #
+    # This allows you to wrap any custom merge vars into
+    # a to_json method for a cleaner interaction.
+    #
+    def merged_contract
+      default_email_contract.merge!(validations)
+    end
+
+    def merged_options(options)
+      options
+    end
+
+
+    def deliver(options)
+      options = merged_options(options)
+      launch = LaunchControl::Mailer.new(template, options)
+      valid?(options) && launch.valid? && launch.deliver
+    end
+
+    def default_email_contract
+      {
+        to:      lambda { |to| [Array,String,Hash].include?(to.class) },
+        subject: 'string'
+      }
+    end
+
+    def valid?(options)
+      validator = HashValidator.validate(options, merged_contract)
+      if validator.valid?
+        true
+      else
+        @errors = validator.errors
+        false
+      end
+    end
+
+  end
+
+end

data/lib/launch_control/version.rb

@@ -0,0 +1,3 @@
+module LaunchControl
+  VERSION = "0.1.0"
+end

data/lib/launch_control.rb

@@ -0,0 +1,165 @@
+require "launch_control/version"
+require "launch_control/mandrill_contract"
+require 'mandrill'
+require 'pry'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+
+module LaunchControl
+
+  #
+  # To start using Launch Control, you first need to create a contract class, i.e.:
+  #
+  #     class ThankyouEmail < LaunchControl::MandrillContract
+  #
+  #       def template
+  #         'thank-you'
+  #       end
+  #
+  #       def validations
+  #         {
+  #           first_name: 'string',
+  #           last_name:  'string'
+  #         }
+  #       end
+  #     end
+  #
+  # Define global merge vars to integrate with your Mandrill template:
+  #
+  #     mailer = ThankyouEmail.new
+  #     mailer.deliver(to: 'team@lotus.com', subject: 'Bring it home safely', first_name: 'Pastor', last_name: 'Maldonado')
+  #      => true
+  #
+  # Now if you try and deliver this without the appropriate content, you'll be pulled up on it:
+  #
+  #     mailer.deliver(to: 'team@ferarri.com', subject: 'I know what I\'m doing', first_name: 'Kimi')
+  #      => false
+  #     mailer.errors
+  #      => {:last_name=>"string required"}
+  #
+  #
+  class Mailer
+
+    attr_accessor :template_id, :cc, :bcc, :to, :from_name, :from_email,
+                  :reply_to, :subject, :merge_vars
+
+    def initialize(template_id, options)
+      options = options.dup
+
+      raise 'Please configure your Mandrill API key before trying to deliver emails.' if LaunchControl.configuration.mandrill_api_key.nil?
+
+      @template_id = template_id
+      @to          = options.delete(:to)
+      @cc          = options.delete(:cc)
+      @bcc         = options.delete(:bcc)
+      @from_name   = options.delete(:from_name)
+      @from_email  = options.delete(:from_email)
+      @reply_to    = options.delete(:reply_to)
+      @subject     = options.delete(:subject)
+      @merge_vars  = options
+    end
+
+    def mandrill
+      @mandrill ||= Mandrill::API.new(LaunchControl.configuration.mandrill_api_key)
+    end
+
+    def deliver
+      if valid?
+        response = mandrill.messages.send_template(@template_id, [], message, false)
+        response[0]["status"] == "sent"
+      end
+    end
+
+    def valid?
+      !!(@to && @subject && @template_id)
+    end
+
+    private
+
+      def message
+        {
+          "headers" => {
+            "Reply-To"        => @reply_to
+          },
+          "merge_language"    => "handlebars",
+          "to"                => build_addresses,
+          "subject"           => @subject,
+          "from_name"         => @from_name,
+          "from_email"        => @from_email,
+          "global_merge_vars" => build_merge_vars
+        }
+      end
+
+      def build_addresses
+        [build_to, build_cc, build_bcc].reject(&:nil?).flatten
+      end
+
+      #
+      # Defines build_to, build_cc & build_bcc methods.
+      #
+      # These can accept either singular or array collections
+      # of Strings or Hashes.
+      #
+      # Some examples of possible to, cc & bcc values:
+      #
+      #     'test@test.com'
+      #     { email: 'test@test.com', name: 'Test' }
+      #     ['test@test.com', 'another@email.com']
+      #
+      [:to, :cc, :bcc].each do |i|
+        define_method("build_#{i}") do |address=nil|
+          current_address = address || instance_variable_get("@#{i}")
+          case current_address
+          when Array
+            current_address.collect do |addr|
+              send("build_#{i}".to_sym, addr)
+            end.flatten
+          when Hash
+            [current_address.stringify_keys.merge({"type" => i.to_s })]
+          when String
+            [{ "email" => "#{current_address}", "type" => i.to_s }]
+          end
+        end
+      end
+
+
+      def build_merge_vars
+        unless @merge_vars.empty?
+          @merge_vars.collect { |key, value| { 'name' => key.to_s, 'content' => value } }
+        else
+          []
+        end
+      end
+
+  end
+
+  #
+  # Allow external configuration of Mandrill API Key &
+  # potentially more in future.
+  #
+  # e.g.
+  #
+  #     LaunchControl.configure do |config|
+  #       config.mandrill_api_key = 'your_key_here'
+  #     end
+  #
+  # Reference: https://robots.thoughtbot.com/mygem-configure-block
+  #
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :mandrill_api_key
+
+    def initialize
+      @mandrill_api_key = nil
+    end
+  end
+
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: launch_control
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Teague
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mandrill-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.53
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.53
+- !ruby/object:Gem::Dependency
+  name: hash_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: 
+email:
+- chris@cteague.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- launch_control.gemspec
+- lib/launch_control.rb
+- lib/launch_control/mandrill_contract.rb
+- lib/launch_control/version.rb
+homepage: https://flybeacon.com/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ensure that emails delivered to Mandrill meet a specified contract.
+test_files: []