heroku_ops 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 387d93e0a3e2f8801af4cd0a0ff792fbe50ea3fb
+  data.tar.gz: 6d00fdc0ce03b61fcc07e15580b6f9f39e645c91
+SHA512:
+  metadata.gz: 8ebbb62e94d49842902a5d88b41c92e9d511b89d44771f3e5d7c5a66b515e9dc555b8efdc9a7a6abfc2ee7131b941d224b9cb87ae66555aa5c7def17c3a0e6f2
+  data.tar.gz: 91042e589e978cd8a3564e909256d3288215dc7bbfd68e41681258dad9af45fd4bbfb9e2eb3eaf6cf927aa8ca4f7aaa81ba2c6c085f38f971921aa47ea0c613f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 nrowegt
+
+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,68 @@
+# HerokuOps
+
+A (for now) very opinionated gem which has 3 sections:
+
+* pipeline/app setup
+* db restore (pull down your heroku database and `psql < tmp/latest.db`)
+* deploys (push to heroku remotes)
+
+These tasks all assume your heroku application names are of the format `"#{Rails.application.class.parent_name.underscore.gsub('_','-')}-#{environment}"`, where environment is one of staging, production. Setting up an app includes the following free Heroku addons:
+
+*heroku-postgresql:hobby-dev
+*newrelic:wayne
+*papertrail:choklad
+*rediscloud:30 
+*scheduler:standard
+*sendgrid:starter
+
+App name configuration flags and more detailed documentation will come in a later version.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heroku_ops', group: :development # No need to include this on production or staging
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku_ops
+
+## Usage
+To see an updated list of tasks and descriptions:
+`bundle exec rake heroku_ops -T heroku_ops`
+
+~~~bash
+rake heroku_ops:db:restore                  # Pull Down a copy of the database from the specified heroku environment
+rake heroku_ops:db:restore:from_local_dump  # Restore from local dump file (defaults to '/tmp/latest.dump' - specify with DUMP_FILE Environmental Variable)
+rake heroku_ops:db:restore:local            # Erase local development and test database and restore from the local dump file
+rake heroku_ops:db:restore:production       # Restore a local copy of Heroku's Production Environment database
+rake heroku_ops:db:restore:staging          # Restore a local copy of Heroku's Staging Environment database
+rake heroku_ops:deploy                      # Deploy Safely to Heroku
+rake heroku_ops:deploy:production           # Deploy to Heroku's Production Environment
+rake heroku_ops:deploy:production:quick     # Quick Deploy to Production, without running migrations
+rake heroku_ops:deploy:staging:quick        # Quick Deploy to Staging, without running migrations
+rake heroku_ops:pipeline:setup              # Create a pipeline, staging and production applications
+rake heroku_ops:pipeline:setup:pipeline     # Setup a pipeline with your applications in the appropriate stages
+rake heroku_ops:pipeline:setup:production   # Setup a production app (with addons) and git remote for heroku
+rake heroku_ops:pipeline:setup:staging      # Setup a staging app (with addons) and remote for heroku
+~~~
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nrowegt/heroku_ops.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Thanks to [@danielricecodes](http://www.ldstudios.co/) for the inspiration and the initial base implementations of the restore and deploy tasks.
+

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heroku_ops"
+
+# 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/heroku_ops.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku_ops/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku_ops"
+  spec.version       = HerokuOps::VERSION
+  spec.authors       = ["nrowegt"]
+  spec.email         = ["rowe.nathaniel@gmail.com"]
+
+  spec.summary       = "Helpful Heroku Ops Rake Tasks"
+  spec.description   = "Tasks to setup pipelines for your app with the typical free tier addons and run deploys and db restores"
+  spec.homepage      = "https://github.com/nrowegt/heroku_ops"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/heroku_ops/railtie.rb

@@ -0,0 +1,7 @@
+class HerokuOps::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/pipeline_setup.rake'
+    load 'tasks/deploy.rake'
+    load 'tasks/db_restore.rake'
+  end
+end

data/lib/heroku_ops/version.rb

@@ -0,0 +1,3 @@
+module HerokuOps
+  VERSION = "0.0.2"
+end

data/lib/heroku_ops.rb

@@ -0,0 +1,6 @@
+require "heroku_ops/version"
+require "heroku_ops/railtie" if defined?(Rails)
+
+module HerokuOps
+  # TODO DRY rake tasks by moving repeated code here
+end

data/lib/tasks/db_restore.rake

@@ -0,0 +1,55 @@
+DataBaseReference = ""
+
+namespace :heroku_ops do
+  namespace :db do
+    desc 'Pull Down a copy of the database from the specified heroku environment'
+    task :restore do
+      env = ENV['ENV']
+
+      abort "Please specify ENV=production or ENV=staging" unless env
+      app = app_name_from_environment(env)
+
+      if ENV['LATEST'] #if this is here, then create a fresh backup, if not grab whichever is the latest
+        sh "heroku pg:backups capture --app #{app}"
+      end
+
+      sh "curl -o tmp/latest.dump `heroku pg:backups public-url --app #{app} | head -n 1`"
+
+      #ensures there are no extra tables or views
+      Rake::Task["heroku_ops:db:restore:local"].invoke
+    end
+
+    namespace :restore do
+      desc "Restore a local copy of Heroku's Staging Environment database"
+      task :staging do
+        ENV['ENV'] = "staging"
+        Rake::Task["heroku_ops:db:restore"].invoke
+      end
+
+      desc "Restore a local copy of Heroku's Production Environment database"
+      task :production do
+        ENV['ENV'] = "production"
+        Rake::Task["heroku_ops:db:restore"].invoke
+      end
+
+      desc "Erase local development and test database and restore from the local dump file."
+      task :local do
+        #ensures there are no extra tables or views
+        Rake::Task["db:drop"].invoke
+        Rake::Task["db:create"].invoke
+
+        Rake::Task["heroku_ops:db:restore:from_local_dump"].invoke
+        #migrate the database, remove sensitive information, and setup tests
+        Rake::Task["db:migrate"].invoke
+        Rake::Task["db:test:prepare"].invoke
+      end
+
+      desc "Restore from local dump file (defaults to '/tmp/latest.dump' - specify with DUMP_FILE Environmental Variable)"
+      task :from_local_dump do
+        dump_file_location = (ENV['DUMP_FILE'] || "tmp/latest.dump")
+        #in backticks so that pg_restore warnings dont exit this routine
+        `pg_restore --verbose --clean --no-acl --no-owner -h localhost -d #{Rails.application.class.parent_name.underscore}_development #{dump_file_location}`
+      end
+    end
+  end
+end

data/lib/tasks/deploy.rake

@@ -0,0 +1,85 @@
+def app_name_from_environment(env)
+  case env.downcase
+  when "production"
+    "#{Rails.application.class.parent_name.underscore.gsub('_','-')}-production"
+  when "staging"
+    "#{Rails.application.class.parent_name.underscore.gsub('_','-')}-staging"
+  end
+end
+
+def push_command_from_env(env)
+  case env
+  when "production"
+    "git push #{env} master"
+  when "staging"
+    # heroku requires that deployes be pushed to the master branch on heroku git repo
+    "git push #{env} staging:master"
+  end
+end
+
+namespace :heroku_ops do
+  desc 'Deploy Safely to Heroku'
+  task :deploy do
+    env = ENV['ENV']
+
+    abort "Please specify ENV={production|staging}" unless env
+
+    app_name = app_name_from_environment(env)
+
+    #take db backup first
+    sh "heroku pg:backups capture --app #{app_name}"
+
+    #push up new code release
+    sh push_command_from_env(env)
+
+    #migrate database and ensure seed values are present always (Settings, ContentMgmts)
+    sh "heroku run rake db:migrate db:seed --app #{app_name}"
+
+    #restart dynos to ensure all users get the new released version immediately
+    sh "heroku restart --app #{app_name}"
+
+    #warm up the Heroku dynos
+    sh "curl -o /dev/null http://#{app_name}.herokuapp.com"
+  end
+
+  namespace :deploy do
+    desc "Deploy to Heroku's Staging Environment"
+
+    desc "Deploy to Heroku's Production Environment"
+    task :production do
+      ENV['ENV'] = "production"
+      sh "git push origin master"
+      Rake::Task["heroku_ops:deploy"].invoke
+    end
+
+    task :staging do
+      ENV['ENV'] = "staging"
+      sh "git push origin staging"
+      Rake::Task["heroku_ops:deploy"].invoke
+    end
+
+    namespace :production do
+      desc 'Quick Deploy to Production, without running migrations.'
+      task :quick do
+        app_name = app_name_from_environment(env)
+        Bundler.with_clean_env do
+          puts `git push origin master`
+          puts `git push production master`
+          puts `heroku restart --app app_name`
+        end
+      end
+    end
+
+    namespace :staging do
+      desc 'Quick Deploy to Staging, without running migrations.'
+      task :quick do
+        app_name = app_name_from_environment(env)
+        Bundler.with_clean_env do
+          puts `git push origin staging`
+          puts `git push staging staging:master`
+          puts `heroku restart --app app_name`
+        end
+      end
+    end
+  end
+end

data/lib/tasks/pipeline_setup.rake

@@ -0,0 +1,60 @@
+def base_app_name
+  "#{Rails.application.class.parent_name.underscore.gsub('_','-')}"
+end
+
+def app_name_for_env(env)
+  case env.downcase
+  when "production"
+    "#{base_app_name}-production"
+  when "staging"
+    "#{base_app_name}-staging"
+  end
+end
+
+def create_addons_for_appname(appname)
+  sh "heroku addons:create heroku-postgresql:hobby-dev -a #{appname}"
+  sh "heroku addons:create newrelic:wayne -a #{appname}"
+  sh "heroku addons:create papertrail:choklad -a #{appname}"
+  sh "heroku addons:create rediscloud:30  -a #{appname}"
+  sh "heroku addons:create scheduler:standard -a #{appname}"
+  sh "heroku addons:create sendgrid:starter -a #{appname}"
+end
+
+def create_remote_for_appname(env, appname)
+  sh "git remote add #{env} git@heroku.com:#{appname}.git"
+end
+
+namespace :heroku_ops do
+  namespace :pipeline do
+    desc 'Create a pipeline, staging and production applications.'
+    task :setup do
+      Rake::Task['heroku_ops:pipeline:setup:staging'].invoke
+      Rake::Task['heroku_ops:pipeline:setup:production'].invoke
+      Rake::Task['heroku_ops:pipeline:setup:pipeline'].invoke
+    end
+
+    namespace :setup do
+      desc "Setup a staging app (with addons) and remote for heroku"
+      task :staging do
+        app_name = app_name_for_env("staging")
+        sh "heroku create #{app_name}"
+        sh "git remote remove heroku"        
+        create_addons_for_appname(app_name)
+        create_remote_for_appname("staging", app_name)
+      end
+      desc "Setup a production app (with addons) and git remote for heroku"      
+      task :production do
+        app_name = app_name_for_env("production")
+        sh "heroku create #{app_name}"
+        sh "git remote remove heroku"        
+        create_addons_for_appname(app_name)
+        create_remote_for_appname("production", app_name)
+      end
+      desc "Setup a pipeline with your applications in the appropriate stages."
+      task :pipeline do
+        sh "heroku pipelines:create -a#{app_name_for_env("staging")} --stage staging"
+        sh "heroku pipelines:add -a#{app_name_for_env("production")} #{base_app_name} --stage production"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: heroku_ops
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- nrowegt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: Tasks to setup pipelines for your app with the typical free tier addons
+  and run deploys and db restores
+email:
+- rowe.nathaniel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heroku_ops.gemspec
+- lib/heroku_ops.rb
+- lib/heroku_ops/railtie.rb
+- lib/heroku_ops/version.rb
+- lib/tasks/db_restore.rake
+- lib/tasks/deploy.rake
+- lib/tasks/pipeline_setup.rake
+homepage: https://github.com/nrowegt/heroku_ops
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Helpful Heroku Ops Rake Tasks
+test_files: []