kapost_deploy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 874289c8439280011dfee2c03331c8ae4d840743
+  data.tar.gz: 26db5e6fcbaf0844b68a1dd5e6ca78fc9cc0c6ea
+SHA512:
+  metadata.gz: e5eee4543078317ce1e784a4665214b1881cc96cf0669d6c8d6ba84f4af6dfedc86f697fab6a925b6194d2e4443e71075aa2be8417d3afb6f04d53c24d9fccbe
+  data.tar.gz: d21e42e8e46b8431fbb2949818157eb4cb08328b2b0c8245835ed71d294756def0e07c7bd8652b3d56f85e01d75c32486a8a84f90f98f5e835ea95a93fe676c2

data/README.md

@@ -0,0 +1,134 @@
+# KapostDeploy
+
+[![Gem Version](https://badge.fury.io/rb/kapost_deploy.svg)](http://badge.fury.io/rb/kapost_deploy)
+[![Code Climate GPA](https://codeclimate.com/github/kapost/kapost_deploy.svg)](https://codeclimate.com/github/kapost/kapost_deploy)
+[![Code Climate Coverage](https://codeclimate.com/github/kapost/kapost_deploy/coverage.svg)](https://codeclimate.com/github/kapost/kapost_deploy)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+`KapostDeploy::Task.new` creates the following rake tasks to aid in the pipeline promotion deployment of Heroku applications
+
+    [promote]
+      Promotes a source environment to production
+
+    [promote:before_promote]
+      Executes application-defined before promotion code as defined in task config (See below)
+
+    [promote:after_promote]
+      Executes application-defined after promotion code as defined in task config (See below)
+
+Simple Example:
+
+    require 'kapost_deploy/task'
+
+    KapostDeploy::Task.new do |config|
+      config.app = 'cabbage-democ'
+      config.to = 'cabbage-prodc'
+
+      config.after do
+        puts "It's Miller time"
+      end
+    end
+
+A slightly more complex example which will create 6 rake tasks: stage:before_stage, stage,
+stage:after_stage, promote:before_promote, promote, promote:after_promote
+
+    KapostDeploy::Task.new(:stage) do |config|
+      config.app = 'cabbage-stagingc'
+      config.to = %w[cabbage-sandboxc cabbage-democ]
+
+      config.after do
+        sleep 60*2 wait for dynos to restart
+        slack.notify "The eagle has landed. [Go validate](https://testbed.sandbox.com/dashboard)!"
+        Launchy.open("https://testbed.sandbox.com/dashboard")
+      end
+    end
+
+    KapostDeploy::Task.new(:promote) do |config|
+      config.app = 'cabbage-sandbox1c'
+      config.to = 'cabbage-prodc'
+
+      config.before do
+        puts 'Are you sure you did x, y, and z? yes/no: '
+        confirm = gets.strip
+        exit(1) unless confirm.downcase == 'yes'
+      end
+    end
+
+# Requirements
+
+0. [MRI 2.3.0](https://www.ruby-lang.org)
+0. [Heroku Toolbelt](https://github.com/heroku/heroku) installed
+
+# Configuration Options
+
+* `app`: The application to be promoted
+* `to`: The downstream application(s) to receive the promotion. For multiple environments, use an array.
+* `slack_config`: An options hash containing the following keys:
+  * `webhook_url`: The webhook URL you added to your slack integrations
+  * `username`: The apparent username of the notifier *defaults to "webhooks bot"*
+  * `channel`: The channel name to post the notification to *defaults to "#general"*
+  * `icon_url`: A URL for the icon image *optional*
+  * `icon_emoji`: Emoji name to use instead of an icon *optional*
+
+# Setup
+
+To install, type the following:
+
+    gem install kapost_deploy
+
+Add the following to your Gemfile:
+
+    gem "kapost_deploy"
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Contributions
+
+Fork the project.
+Make your feature addition or bug fix.
+Do not bump the version number.
+Send me a pull request. Bonus points for topic branches.
+
+# License
+
+MIT
+
+Copyright (c) 2016 [Kapost](http://engineering.kapost.com).
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Brandon Croft](http://brandoncroft.com) at [brandon@kapost.com](mailto:brandon@kapost.com).

data/lib/kapost_deploy.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "kapost_deploy/identity"
+require "kapost_deploy/task"

data/lib/kapost_deploy/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KapostDeploy
+  # Gem identity information.
+  module Identity
+    def self.name
+      "kapost_deploy"
+    end
+
+    def self.label
+      "KapostDeploy"
+    end
+
+    def self.version
+      "0.1.0"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

data/lib/kapost_deploy/task.rb

@@ -0,0 +1,149 @@
+require "rake"
+require "rake/tasklib"
+require "slack-notify"
+
+module KapostDeploy
+  ##
+  # Simple Example:
+  #
+  #   require 'kapost_deploy/task'
+  #
+  #   KapostDeploy::Task.new do |config|
+  #     config.app = 'cabbage-democ'
+  #     config.to = 'cabbage-prodc'
+  #
+  #     config.after do
+  #       puts "It's Miller time"
+  #     end
+  #   end
+  #
+  # A slightly more complex example which will create 6 rake tasks: before_stage, stage,
+  # after_stage, before_promote, promote, after_promote
+  #
+  #   KapostDeploy::Task.new(:stage) do |config|
+  #     config.app = 'cabbage-stagingc'
+  #     config.to = %w[cabbage-sandboxc cabbage-democ]
+  #
+  #     config.after do
+  #       sleep 60*2 # wait for dynos to restart
+  #       notifier.ping "The eagle has landed. [Go validate](https://testbed.sandbox.com/dashboard)!"
+  #       Launchy.open("https://testbed.sandbox.com/dashboard")
+  #     end
+  #   end
+  #
+  #   KapostDeploy::Task.new(:promote) do |config|
+  #     config.app = 'cabbage-sandbox1c'
+  #     config.to = 'cabbage-prodc'
+  #
+  #     config.before do
+  #       puts 'Are you sure you did x, y, and z? yes/no: '
+  #       confirm = gets.strip
+  #       exit(1) unless confirm.downcase == 'yes'
+  #     end
+  #   end
+  class Task < Rake::TaskLib
+    attr_accessor :app
+
+    attr_reader :to
+
+    attr_accessor :name
+
+    attr_accessor :slack_config
+
+    def initialize(name = :promote, shell: method(:sh)) # :yield: self
+      defaults
+      @name = name
+      @shell = shell
+
+      yield self if block_given?
+
+      validate
+      define
+    end
+
+    def before(&block)
+      @before = block
+    end
+
+    def after(&block)
+      @after = block
+    end
+
+    def to=(to)
+      @to = Array(to)
+    end
+
+    def defaults
+      @name = :promote
+      @app = nil
+      @slack_config = nil
+      @to = []
+      @before = -> {}
+      @after = -> {}
+    end
+
+    def validate
+      fail "No 'app' configured. Set config.app to the application to be promoted" if app.nil?
+      fail "No 'to' configured. Set config.to to the downstream application(s) to be promoted to" if to.empty?
+    end
+
+    def define
+      define_hooks
+
+      desc "Promote #{app} to #{to.join(",")}"
+      task name.to_s do
+        shell("heroku plugins:install heroku-pipelines") unless pipelines_installed?
+        @before.call
+        promote
+        notify_slack
+        @after.call
+      end
+    end
+
+    private
+
+    def shell(command)
+      @shell.call(command)
+    end
+
+    def pipelines_installed?
+      `heroku plugins` =~ /^heroku-pipelines@/
+    end
+
+    def define_hooks
+      namespace :"#{name}" do
+        desc "Perform after-#{name} tasks"
+        task :"after_#{name}" do
+          @after.call
+        end
+
+        desc "Perform before-#{name} tasks"
+        task :"before_#{name}" do
+          @before.call
+        end
+      end
+    end
+
+    def promote
+      shell("heroku pipelines:promote -a #{app} --to #{to.join(",")}")
+    end
+
+    def notify_slack
+      return unless slack_config
+
+      addl = slack_config.fetch(:additional_message, "")
+      addl = "\n#{addl}" unless addl.empty?
+
+      message = "#{identity} promoted *#{app}* to *#{to.join(",")}*#{addl}"
+      slack.notify(message)
+    end
+
+    def identity
+      @identity ||= `whoami`.chomp
+    end
+
+    def slack
+      @slack ||= SlackNotify::Client.new(slack_config)
+    end
+  end
+end

data/lib/tasks/console.rake

@@ -0,0 +1,7 @@
+desc "Open IRB console for gem development environment"
+task :console do
+  require "irb"
+  require "kapost_deploy"
+  ARGV.clear
+  IRB.start
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: kapost_deploy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Croft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.43'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.43'
+- !ruby/object:Gem::Dependency
+  name: slack-notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: pry-remote
+  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: pry-state
+  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: pry-rescue
+  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: pry-stack_explorer
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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: guard-rspec
+  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: terminal-notifier
+  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: terminal-notifier-guard
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: rubygems-tasks
+  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: Execute deployments swiftly and safely using `rake promote`
+email:
+- brandon.croft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/kapost_deploy.rb
+- lib/kapost_deploy/identity.rb
+- lib/kapost_deploy/task.rb
+- lib/tasks/console.rake
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/kapost/kapost_deploy
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Deployment rake tasks for Kapost applications
+test_files: []