morpheus-heroku 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbd167532237ddbed5b8a0c707a49202c858fe3b
+  data.tar.gz: 2a4812332e2b925baad0e2c9dbdd693f63030883
+SHA512:
+  metadata.gz: 7dc1614c01ad020014cb1a3eb819c2ba8389b944aac12154e0776d635182c9668706f2acb05c917e13b52fa264fcbfd7aa650258ebf03010009fe2bf65dfc560
+  data.tar.gz: 00ceab0393dbc2bb10706387ca951dcd1fc6f95d06312cd0384ea7b3504e04eee94808dd2ef98aacee9a9fbd0aca07adffbe0804b7a45124546b7dae07119fbb

data/.gitignore

@@ -0,0 +1,2 @@
+/*.gem
+.DS_Store

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Catalin Ionescu
+
+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,48 @@
+# MorpheusHeroku
+
+A set of rake tasks to automate interacting with Heroku.
+
+## Assumptions
+
+This gem relies heavily on bash for interacting with Heroku. It's assuming you have the `Heroku CLI`
+installed and `curl`. Your session must be authenticated with heroku (i.e. running `heroku logs` works).
+You must have a Heroku remote set up (`heroku git:remote -a my-app-name`).
+*Warning* We use `--force` when deploying to Heroku.
+
+## Install
+
+Add this to your gemfile
+
+`gem 'morpheus-heroku'`
+
+Generate an initializer for `config/morpheus-heroku.rb` with
+
+`bundle exec rails generate morpheus-heroku`
+
+## Automate deploying to Heroku
+
+MorpheusHeroku will infer the current branch from git, deploy it to Heroku master, run the migrations and then tag
+the release in git.
+
+`bundle exec rake deploy:production`
+
+## Fetch a database backup from Heroku
+
+MorpheusHeroku will fetch the latest PG backup. If there is no backup, then it will create one. It is
+strongly recommended to set a recurring Heroku backup to avoid loading stale data.
+https://devcenter.heroku.com/articles/heroku-postgres-backups#scheduling-backups
+
+`bundle exec rake db:fetch`
+
+## Load a database backup
+
+MorpheusHeroku will fetch the latest database backup and then load it using the `pg_restore` command.
+
+`bundle exec rake db:load`
+
+## Rails 5 Tips
+
+If you see `ActiveRecord::ProtectedEnvironmentError: You are attempting to run a destructive action against your 'production' database.`
+even when running in development, then you need to do this:
+
+`bin/rails db:environment:set RAILS_ENV=development`

data/config/morpheus-heroku-initializer.rb

@@ -0,0 +1,11 @@
+MorpheusHeroku.configure do |config|
+  # config.app_name = "app_name"
+
+  # config.backup_location = "tmp/latest.dump"
+
+  # By default, we use ActiveRecord::Base.connection_config[:database]
+  # config.database_name = "database_development"
+
+  # Show debugging events
+  # config.log_events = false
+end

data/lib/generators/morpheus_heroku_generator.rb

@@ -0,0 +1,8 @@
+class MorpheusHerokuGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../", __FILE__)
+
+  desc "Generate an initializer"
+  def create_initializer_file
+    copy_file "config/morpheus-heroku-initializer.rb", "config/initializers/morpheus-heroku.rb"
+  end
+end

data/lib/morpheus-heroku.rb

@@ -0,0 +1,39 @@
+require 'morpheus-heroku/fetch'
+require 'morpheus-heroku/load'
+require 'morpheus-heroku/deploy'
+
+require 'morpheus-heroku/helper'
+require 'morpheus-heroku/config'
+
+require 'morpheus-heroku/railtie'
+
+module MorpheusHeroku
+  class << self
+    attr_accessor :configuration
+  end
+
+  class NotImplemented < StandardError; end
+
+  extend self
+
+  def fetch
+    MorpheusHeroku::Fetch.run
+  end
+
+  def load
+    MorpheusHeroku::Load.run
+  end
+
+  def deploy(environment = :production)
+    if environment == :production
+      MorpheusHeroku::Deploy.production
+    elsif environment == :staging
+      raise NotImplemented, "MorpheusHeroku doesn't support deploying to staging yet!"
+    end
+  end
+
+  def self.configure
+    self.configuration ||= Config.new
+    yield(configuration)
+  end
+end

data/lib/morpheus-heroku/config.rb

@@ -0,0 +1,11 @@
+module MorpheusHeroku
+  class Config
+    attr_accessor :database_name, :backup_location, :app_name, :log_events
+
+    def initialize
+      @database_name = ActiveRecord::Base.connection_config[:database]
+      @backup_location = "tmp/latest.dump"
+      @log_events = false
+    end
+  end
+end

data/lib/morpheus-heroku/deploy.rb

@@ -0,0 +1,48 @@
+module MorpheusHeroku
+  module Deploy
+    extend self
+
+    def production
+      ensure_local_remote_is_up_to_date!
+      deploy_to_heroku!
+      run_database_migrations!
+      restart_server!
+      tag_release!
+      update_git!
+    end
+
+    private
+
+    def git_branch
+      @branch ||= `git branch | grep -e "^*"`.strip.gsub("* ", "")
+    end
+
+    def ensure_local_remote_is_up_to_date!
+      Helper.bash_run(command: "git pull origin #{git_branch}")
+    end
+
+    def deploy_to_heroku!
+      Helper.bash_run(command: "git push heroku #{git_branch}:master --force")
+    end
+
+    def run_database_migrations!
+      Helper.heroku_run(command: "heroku run rake db:migrate")
+    end
+
+    def tag_release!
+      Helper.bash_run(command: "git tag #{tag_name}")
+    end
+
+    def tag_name
+      "heroku_deploy_#{Time.now.to_s(:db).gsub(/[- :]/, "_")}"
+    end
+
+    def update_git!
+      Helper.bash_run(command: "git push origin --tags")
+    end
+
+    def restart_server!
+      Helper.heroku_run(command: "heroku restart")
+    end
+  end
+end

data/lib/morpheus-heroku/fetch.rb

@@ -0,0 +1,31 @@
+module MorpheusHeroku
+  module Fetch
+    extend self
+
+    def run
+      unless backup_available?
+        Rails.logger.info "No backup available. Generating one"
+        generate_backup!
+      end
+      download_backup!
+    end
+
+    private
+
+    def backup_available?
+      Helper.heroku_run(command: "heroku pg:backups public-url")
+    end
+
+    def generate_backup!
+      Helper.heroku_run(command: "heroku pg:backups capture")
+    end
+
+    def backup_url
+      Helper.heroku_run(command: "heroku pg:backups public-url")
+    end
+
+    def download_backup!
+      Helper.bash_run(command: "curl -o #{MorpheusHeroku.configuration.backup_location} `heroku pg:backups public-url`")
+    end
+  end
+end

data/lib/morpheus-heroku/helper.rb

@@ -0,0 +1,40 @@
+module MorpheusHeroku
+  module Helper
+    extend self
+
+    def heroku_run(command: "")
+      if MorpheusHeroku.configuration.app_name.present?
+        command += " --app #{MorpheusHeroku.configuration.app_name}"
+      end
+      generic_run(command)
+    end
+
+    def bash_run(command: "")
+      generic_run(command)
+    end
+
+    def logger(message = "")
+      if MorpheusHeroku.configuration.log_events
+        puts "<MORPHEUS>".text_red
+        puts "Running: #{message}".text_green
+        puts "RAILS_ENV: #{Rails.env}".text_green
+        puts "APP_NAME: #{MorpheusHeroku.configuration.app_name}".text_green
+        puts "</MORPHEUS>".text_red
+      end
+    end
+
+    private
+
+    def generic_run(command)
+      Helper.logger(command)
+      Bundler.with_clean_env do
+        system(command) || abort("\n== Command #{command} failed ==")
+      end
+    end
+  end
+end
+
+class String
+  def text_red;   "\e[31m#{self}\e[0m" end
+  def text_green; "\e[32m#{self}\e[0m" end
+end

data/lib/morpheus-heroku/load.rb

@@ -0,0 +1,32 @@
+module MorpheusHeroku
+  module Load
+    extend self
+
+    def run
+      ensure_db_environment! if Rails.env.development?
+      drop_database!
+      create_database!
+      load_database!
+    end
+
+    private
+
+    def ensure_db_environment!
+      Helper.bash_run(command: "bundle exec rake db:environment:set RAILS_ENV=development")
+    end
+
+    def drop_database!
+      Helper.logger("Rake::Task['db:drop']")
+      Rake::Task["db:drop"].invoke
+    end
+
+    def create_database!
+      Helper.logger("Rake::Task['db:create']")
+      Rake::Task["db:create"].invoke
+    end
+
+    def load_database!
+      Helper.bash_run(command: "pg_restore -O -n public -d #{MorpheusHeroku.configuration.database_name} #{MorpheusHeroku.configuration.backup_location}")
+    end
+  end
+end

data/lib/morpheus-heroku/railtie.rb

@@ -0,0 +1,8 @@
+module MorpheusHeroku
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/db.rake"
+      load "tasks/deploy.rake"
+    end
+  end
+end

data/lib/morpheus-heroku/version.rb

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

data/lib/tasks/db.rake

@@ -0,0 +1,12 @@
+namespace :db do
+  desc 'Load a production db into dev'
+  task load: :environment do
+    MorpheusHeroku.fetch
+    MorpheusHeroku.load
+  end
+
+  desc 'Fetch the latest backup db from Heroku'
+  task fetch: :environment do
+    MorpheusHeroku.fetch
+  end
+end

data/lib/tasks/deploy.rake

@@ -0,0 +1,6 @@
+namespace :deploy do
+  desc 'Deploy current branch onto Heroku Master'
+  task production: :environment do
+    MorpheusHeroku.deploy(:production)
+  end
+end

data/morpheus-heroku.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'morpheus-heroku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "morpheus-heroku"
+  spec.version       = MorpheusHeroku::VERSION
+  spec.authors       = ["Catalin Ionescu"]
+  spec.email         = ["catalin.ionescu282@gmail.com"]
+
+  spec.summary       = "A set of Rake scrips to automate interactions with Heroku"
+  spec.homepage      = "https://github.com/cionescu/morpheus-heroku"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "rake", ">= 10.0"
+
+  spec.add_development_dependency "rails", ">= 4.2"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: morpheus-heroku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Catalin Ionescu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-01 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: 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: 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'
+description: 
+email:
+- catalin.ionescu282@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- config/morpheus-heroku-initializer.rb
+- lib/generators/morpheus_heroku_generator.rb
+- lib/morpheus-heroku.rb
+- lib/morpheus-heroku/config.rb
+- lib/morpheus-heroku/deploy.rb
+- lib/morpheus-heroku/fetch.rb
+- lib/morpheus-heroku/helper.rb
+- lib/morpheus-heroku/load.rb
+- lib/morpheus-heroku/railtie.rb
+- lib/morpheus-heroku/version.rb
+- lib/tasks/db.rake
+- lib/tasks/deploy.rake
+- morpheus-heroku.gemspec
+homepage: https://github.com/cionescu/morpheus-heroku
+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: A set of Rake scrips to automate interactions with Heroku
+test_files: []
+has_rdoc: