hr_deploy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b28b9132177e558b47d24cb7f9c82fcef1d8e868
+  data.tar.gz: 67d784589f95f0f7aa318be470c41eafee993fe5
+SHA512:
+  metadata.gz: c6d9b7ada7ca554d8599255e6a25f4df5a970ca0eaa3d0559e89de8b3f8388ba641a67de98d72c2070a5d067dd637c31e31234ad95e1f744a24e736eb213cbd8
+  data.tar.gz: 2cab2dbd608ace629c1d29bb7b6d7cd4bac6010025087ff372488a3a5c013874a81842c84afb41a58cfddc7e3d891f94728879c7f7c79f9b3da4dfbc2622fa9e

data/bin/hr_deploy

@@ -0,0 +1,191 @@
+#!/usr/bin/env ruby
+
+require 'hr_deploy/deployer'
+require 'hr_deploy/config_handler'
+require 'hr_deploy/target'
+require 'hr_deploy/version'
+
+private
+
+def main
+  command = parse(ARGV)
+  if command
+    react(command)
+  else
+    puts 'Unknown command'
+    puts
+    help(true)
+    exit 1
+  end
+end
+
+def parse(opts)
+  if opts == [] || opts == ['help']
+    { command: :help }
+
+  elsif opts == ['version']
+    { command: :version }
+
+  elsif opts == ['generate']
+    { command: :generate }
+
+  elsif opts.first == 'deploy' && (opts.length == 1 || opts.length == 2)
+    # This will extract the name of the target to deploy to or nil if no target is specified
+    target = opts[1, opts.length].first
+    { command: :deploy, target: target }
+
+  else
+    nil
+  end
+end
+
+def react(command)
+  if command[:command] == :help
+    help
+
+  elsif command[:command] == :version
+    version
+
+  elsif command[:command] == :generate || command[:command] == :deploy
+    if inside_app?
+      generate if command[:command] == :generate
+      attempt_deploy(command[:target]) if command[:command] == :deploy
+    else
+      puts 'You should be inside a Heroku app to run this command'
+      exit 1
+    end
+
+  else
+    raise "Command was parsed but don't know how to deal with it"
+  end
+end
+
+def generate
+  generate = true
+
+  if HR_Deploy::ConfigHandler.config_exists?
+    print 'Config file already exists. Overwrite? [Y/n] > '
+    generate = ($stdin.gets.chomp == 'Y')
+  end
+
+  if generate
+    HR_Deploy::ConfigHandler.new.generate_config
+    puts "Example config created at #{HR_Deploy::ConfigHandler::CONFIG_FILE_NAME}. Edit it to suit your needs"
+  end
+end
+
+def attempt_deploy(target_name)
+
+  # These tools are needed for all deploys
+  exit 1 unless tools_available?('heroku', 'git')
+
+  if HR_Deploy::ConfigHandler.config_exists?
+    raw_targets = HR_Deploy::ConfigHandler.new.load_targets
+    if raw_targets
+      # Config is correct
+      targets = raw_targets.map { |raw_target| HR_Deploy::Target.new(raw_target) }
+
+      if target_name
+        target = targets.find { |target| target.name == target_name }
+        if target
+          deploy(target)
+        else
+          puts "No such target: #{target_name}"
+          exit 1
+        end
+
+      else
+        # No target is specified, look for the default one
+        default_targets = targets.select { |target| target.default? }
+
+        if default_targets.length == 0
+          puts 'No default target specified. Edit config to specify one'
+          exit 1
+        elsif default_targets.length > 1
+          puts 'Multiple default targets specified. Edit config to specify only one'
+          exit 1
+        else
+          # Deploy default target
+          deploy(default_targets.first)
+        end
+      end
+    else
+      # 'ConfigHandler.new.load_targets' will print out the error here
+      exit 1
+    end
+  else
+    puts "No deployment config is present. Run 'hr_deploy generate' to generate a config example"
+    exit 1
+  end
+end
+
+def deploy(target)
+  # Some targets need 'curl' to disable/enable New Relic pinger
+  exit 1 if target.requires_curl? && !tools_available?('curl')
+
+  # Actual deployment
+  deployer = HR_Deploy::Deployer.new(target)
+  deployer.deploy
+end
+
+def inside_app?
+  File.directory?('.git')
+end
+
+def tools_available?(*tools)
+
+  def command_available?(cmd)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
+        exe = File.join(path, "#{cmd}#{ext}")
+        return true if File.executable? exe
+      end
+    end
+    false
+  end
+
+  all_tools_available = true
+
+  tools.each do |tool|
+    unless command_available?(tool)
+      puts "You don't have access to '#{tool}' command"
+      all_tools_available = false
+    end
+  end
+
+  all_tools_available
+end
+
+def help(after_error = false)
+  help_string = ''
+
+  unless after_error
+    help_string += "hr_deploy - Deploy Rails apps to Heroku\n\n"
+  end
+
+
+  help_string += <<-eos
+Usage:            hr_deploy [command]
+
+The following commands are supported:
+
+generate          Generate a config file which specifies targets to deploy to.
+                  Won't overwrite existing config unless confirmed.
+
+deploy [target]   Deploy to [target]. If no [target] is specified, deploy
+                  to default target specified in config.
+
+version           Show gem version.
+
+help              Show help.
+  eos
+
+  puts help_string
+end
+
+def version
+  puts HR_Deploy::VERSION
+end
+
+main

data/lib/hr_deploy/config_handler.rb

@@ -0,0 +1,190 @@
+require 'yaml'
+
+module HR_Deploy
+
+  class ConfigHandler
+
+    CONFIG_FILE_NAME = '.heroku_deploy_config.yaml'
+
+    EXAMPLE_CONFIG =
+        <<-eos
+---
+# Target name, required.
+# This is the target that hr_deploy will deploy to when you execute
+# 'hr_deploy deploy (target)'.
+# This is also what is searched for when you want to deploy to a
+# particular target.
+- :staging:
+
+    # Human readable name of the target, optional, defaults to target name.
+    :description: Staging
+
+    # URL to temporarily disable New Relic availability monitoring, optional.
+    # Should be wrapped in single quotes.
+    # If you use New Relic to monitor availability, replace this with the url
+    # that you use to temporarily disable monitoring. You can find it New Relic
+    # availability settings. Delete this and the following line if you
+    # don't use that.
+    :new_relic_disable_pinger_url: 'http://disable'
+
+    # URL to enable New Relic availability monitoring, optional.
+    # Should be wrapped in single quotes.
+    # If you use New Relic to monitor availability, replace this with the url
+    # that you use to enable monitoring. You can find it New Relic
+    # availability settings. Delete this and the previous line if you
+    # don't use that.
+    :new_relic_enable_pinger_url: 'http://enable'
+
+    # Whether to use Heroku PG Backups add-on, optional, defaults to false.
+    # If you use Heroku PG Backups add-on and want to take database backups
+    # automatically, set this to true. Delete this line if you don't use that.
+    :backup_db: true
+
+    # Whether this target is default, optional, defaults to false.
+    # If default is set to true, this target will be picked automatically
+    # when you execute 'hr_deploy deploy' without arguments.
+    :default: true
+
+# Example of another target, feel free to delete or modify.
+- :production:
+    :description: Production
+    :new_relic_disable_pinger_url: 'http://disable'
+    :new_relic_enable_pinger_url: 'http://enable'
+    :backup_db: true
+    :default: false
+    eos
+
+    def self.config_exists?
+      File.exists?(CONFIG_FILE_NAME)
+    end
+
+    # Check if the YAML file is in the right format
+    def load_targets
+      begin
+        targets = YAML.load_file(CONFIG_FILE_NAME)
+
+      rescue
+        puts 'Could not parse config'
+        puts "Fix it or generate a new one with 'hr_deploy generate'"
+        return nil
+
+      else
+
+        correct_format = true
+
+        if targets.instance_of?(Array)
+          targets.each do |target|
+            if target.instance_of?(Hash) && target.length == 1
+              options = target.values.first
+              unless options.instance_of?(Hash) || options == nil
+                correct_format = false
+                break
+              end
+            else
+              correct_format = false
+              break
+            end
+          end
+        else
+          correct_format = false
+        end
+
+        if correct_format
+          correct_config?(targets) ? targets : nil
+        else
+          puts 'Incorrect config format'
+          puts "Fix it or generate a new one with 'hr_deploy generate'"
+          nil
+        end
+      end
+    end
+
+    def correct_config?(targets)
+      # At this point we know we've got an array of hashes
+      # Each hash has one key, and another hash as the value of that key
+
+      targets.each do |target|
+
+        enable_pinger_url_given = false
+        disable_pinger_url_given = false
+
+        target_name = target.keys.first
+        # Each target name is a symbol
+        unless target_name.instance_of?(Symbol)
+          puts "Target name is specified incorrectly: #{target_name}"
+          return false
+        end
+
+        # Hash of options
+        options = target[target_name]
+
+        # Target might have no options
+        if options
+          options.each do |option, value|
+
+            # Each option name is a symbol
+            unless option.instance_of?(Symbol)
+              puts "Option is specified incorrectly: #{option}"
+              return false
+            end
+
+            case option
+            when :description
+              unless value.instance_of?(String)
+                puts 'Target description should be a string'
+                return false
+              end
+
+            when :new_relic_disable_pinger_url
+              disable_pinger_url_given = true
+              unless value.instance_of?(String)
+                puts 'New Relic disable pinger URL should be a string'
+                return false
+              end
+
+            when :new_relic_enable_pinger_url
+              enable_pinger_url_given = true
+              unless value.instance_of?(String)
+                puts 'New Relic enable pinger URL should be a string'
+                return false
+              end
+
+            when :backup_db
+              unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                puts 'Backup database option should be a boolean'
+                return false
+              end
+
+            when :default
+              unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                puts 'Whether this target is the default one option should be a boolean'
+                return false
+              end
+
+            else
+              puts "Option unknown: #{option}"
+              return false
+            end
+          end
+
+          if enable_pinger_url_given && (!disable_pinger_url_given)
+            puts 'URL to enable New Relic pinger is given, but URL to disable it is not'
+            return false
+          end
+
+          if disable_pinger_url_given && (!enable_pinger_url_given)
+            puts 'URL to disable New Relic pinger is given, but URL to enable it is not'
+            return false
+          end
+        end
+      end
+
+      # Config is correct
+      true
+    end
+
+    def generate_config
+      File.open(CONFIG_FILE_NAME, 'w') { |file| file.write(EXAMPLE_CONFIG) }
+    end
+  end
+end

data/lib/hr_deploy/deployer.rb

@@ -0,0 +1,368 @@
+module HR_Deploy
+
+  class Deployer
+
+    attr_reader :target
+    attr_reader :pinging_interaction
+    attr_reader :perform_db_backup
+
+    def initialize(target)
+      @target = target
+      @pinging_interaction = target.requires_pinging_interaction?
+      @perform_db_backup = target.backup_db?
+    end
+
+    def deploy
+      confirm_deploy
+
+      start_time = Time.now
+      puts "#{target.description} deploy started at #{Time.now.strftime('%H:%M:%S')}"
+      puts
+
+      check_connectivity
+      check_heroku_status
+
+      if pinging_interaction
+        disable_pinging
+        continue?(:disabling_pinger) { enable_maintenance }
+      else
+        enable_maintenance
+      end
+
+      if perform_db_backup
+        continue?(:enabling_maintenance) { backup_db }
+        continue?(:backing_up_db) { push_code }
+      else
+        continue?(:enabling_maintenance) { push_code }
+      end
+
+      continue?(:pushing_code) { migrate_db }
+      continue?(:migrating_db) { restart }
+
+      if pinging_interaction
+        continue?(:restarting) { enable_pinging }
+        continue?(:enabling_pinger) { disable_maintenance }
+      else
+        continue?(:restarting) { disable_maintenance }
+      end
+
+      continue?(:disabling_maintenance) do
+        puts 'Waiting 10 seconds for application to go live...'
+        sleep 10
+        puts 'Opening application...'
+        system("heroku open --remote #{target.name}")
+        puts
+
+        puts "Deploy completed in #{(Time.now - start_time).round} seconds"
+      end
+    end
+
+    private
+
+    def confirm_deploy
+      answered = false
+
+      until answered
+        print "Deploy to #{target.description}? (Yes / No) > "
+        answer = $stdin.gets.chomp
+
+        if answer == 'Yes' || answer == 'yes'
+          answered = true
+          puts
+        elsif answer == 'No' || answer == 'no'
+          abort_deploy(nil)
+        else
+          puts 'Unknown answer'
+          puts
+        end
+      end
+    end
+
+    def abort_deploy(message, stage = nil)
+
+      if stage
+        puts 'Notes:'
+        puts
+
+        case stage
+        when :disabling_pinger
+          puts '1) Application state did not change'
+          puts '2) Availability pinging could not be disabled'
+
+        when :enabling_maintenance
+          puts '1) Application state did not change'
+          puts
+          puts '2) Maintenance mode could not be enabled'
+          if pinging_interaction
+            puts
+            puts '3) Availability pinging is disabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :backing_up_db
+          puts '1) Application state did not change'
+          puts
+          puts '2) Maintenance mode is enabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+          puts
+          puts '3) Database backup could not be created'
+          puts
+          if pinging_interaction
+            puts '4) Availability pinging is disabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :pushing_code
+          puts '1) Application state is unknown'
+          puts
+          puts '2) Maintenance mode is enabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+          puts
+          puts '3) Application code was not pushed properly'
+          puts "* Check releases with 'heroku releases --remote #{target.name}' and rollback with " +
+                   "'heroku rollback (version) --remote #{target.name}' if needed"
+          if pinging_interaction
+            puts
+            puts '4) Availability pinging is disabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :migrating_db
+          puts '1) Application state is unknown'
+          puts
+          puts '2) Maintenance mode is enabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+          puts
+          puts '3) Code was pushed but database was not migrated properly'
+          puts "* Check releases with 'heroku releases --remote #{target.name}' and rollback " +
+                   "with 'heroku rollback (version) --remote #{target.name}' if needed"
+          if perform_db_backup
+            puts "* List database backups with 'heroku pgbackups --remote #{target.name}' and restore " +
+                     "with 'heroku pgbackups:restore (database name) (version) --remote #{target.name}' if needed"
+          end
+          if pinging_interaction
+            puts
+            puts '4) Availability pinging is disabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :restarting
+          puts '1) Application state is unknown'
+          puts
+          puts '2) Maintenance mode is enabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+          puts
+          puts '3) Database was migrated but could not restart'
+          puts "* Try to restart manually with 'heroku restart --remote #{target.name}'"
+          puts "* Check releases with 'heroku releases --remote #{target.name}' and rollback " +
+                   "with 'heroku rollback (version) --remote #{target.name}' if needed"
+          if perform_db_backup
+            puts "* List database backups with 'heroku pgbackups --remote #{target.name}' and restore " +
+                     "with 'heroku pgbackups:restore (database name) (version) --remote #{target.name}' if needed"
+          end
+          if pinging_interaction
+            puts
+            puts '4) Availability pinging is disabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :enabling_pinger
+          puts '1) Application has been deployed'
+          puts
+          puts '2) Maintenance mode is enabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+          if pinging_interaction
+            puts
+            puts '3) Availability pinging could not be enabled'
+            puts "* To enable: curl #{target.enable_pinger_url}"
+          end
+
+        when :disabling_maintenance
+          puts '1) Application has been deployed'
+          puts
+          puts '2) Maintenance mode could not be disabled'
+          puts "* To disable: heroku maintenance:off --remote #{target.name}"
+
+        else
+          raise 'Unknown stage'
+        end
+
+        puts
+      end
+
+      if message
+        puts "Deploy aborted with message: #{message}"
+      else
+        puts 'Deploy aborted'
+      end
+
+      exit
+    end
+
+    def continue?(stage)
+      answered = false
+
+      until answered
+
+        case stage
+        when :disabling_pinger
+          print 'Pinger disabled? (Yes / No) > '
+        when :enabling_maintenance
+          print 'Maintenance mode enabled? (Yes / No) > '
+        when :backing_up_db
+          print 'Database backed up? (Yes / No) > '
+        when :pushing_code
+          print 'Code pushed successfully? (Yes / No) > '
+        when :migrating_db
+          print 'Database migrated? (Yes / No) > '
+        when :restarting
+          print 'Restarted? (Yes / No) > '
+        when :enabling_pinger
+          print 'Pinger enabled? (Yes / No) > '
+        when :disabling_maintenance
+          print 'Maintenance mode disabled? (Yes / No) > '
+        else
+          raise 'Unknown stage'
+        end
+
+        answer = $stdin.gets.chomp
+
+        if answer == 'Yes' || answer == 'yes'
+          answered = true
+          puts
+          yield
+        elsif answer == 'No' || answer == 'no'
+          puts
+          abort_deploy(nil, stage)
+        else
+          puts 'Unknown answer'
+          puts
+        end
+      end
+
+    end
+
+    def check_connectivity
+      require 'open-uri'
+
+      puts 'Checking Internet connection...'
+
+      begin
+        open('http://www.google.com')
+      rescue
+        puts 'Not connected to the Internet'
+        puts
+        abort_deploy('Not connected to the Internet')
+      else
+        puts 'Internet connection is fine'
+        puts
+      end
+    end
+
+    def check_heroku_status
+
+      require 'uri'
+      require 'net/http'
+      require 'net/https'
+      require 'json'
+
+      puts 'Checking Heroku status...'
+
+      uri = URI.parse('https://status.heroku.com/api/v3/current-status')
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      begin
+        response = http.request(request)
+
+      rescue
+        puts 'Could not fetch Heroku status'
+        puts
+        abort_deploy('Could not fetch Heroku status')
+
+      else
+        if response.code == '200'
+
+          status = JSON.parse(response.body)
+          status = status['status'] if status
+
+          if status && status['Production'] && status['Development']
+
+            production_ok = status['Production'] == 'green'
+            development_ok = status['Development'] == 'green'
+
+            if production_ok && development_ok
+              puts 'Heroku is operating correctly'
+              puts
+            else
+              puts 'Heroku is having problems'
+              puts
+              abort_deploy('Heroku is having problems')
+            end
+          else
+
+            puts 'Could not parse Heroku status'
+            puts
+            abort_deploy('Could not parse Heroku status')
+          end
+
+        else
+          puts 'Could not fetch Heroku status'
+          puts
+          abort_deploy('Could not fetch Heroku status')
+        end
+      end
+    end
+
+    def disable_pinging
+      puts 'Disabling availability pinger...'
+      system("curl #{target.disable_pinger_url}")
+      puts
+    end
+
+    def enable_maintenance
+      puts 'Enabling maintenance mode...'
+      system("heroku maintenance:on --remote #{target.name}")
+      puts
+    end
+
+    def backup_db
+      puts 'Backing up database...'
+      system("heroku pgbackups:capture --expire --remote #{target.name}")
+      puts
+    end
+
+    def push_code
+      puts 'Pushing code...'
+      system("git push #{target.name} master")
+      puts
+    end
+
+    def migrate_db
+      puts 'Migrating database...'
+      system("heroku run rake db:migrate --remote #{target.name}")
+      puts
+    end
+
+    def restart
+      puts 'Restarting...'
+      system("heroku restart --remote #{target.name}")
+      puts
+    end
+
+    def enable_pinging
+      puts 'Enabling availability pinger...'
+      system("curl #{target.enable_pinger_url}")
+      puts
+    end
+
+    def disable_maintenance
+      puts 'Disabling maintenance mode...'
+      system("heroku maintenance:off --remote #{target.name}")
+      puts
+    end
+  end
+end

data/lib/hr_deploy/target.rb

@@ -0,0 +1,55 @@
+module HR_Deploy
+
+  class Target
+
+    attr_reader :name
+    attr_reader :description
+    attr_reader :disable_pinger_url
+    attr_reader :enable_pinger_url
+
+    def backup_db?
+      !!@backup_db
+    end
+
+    def default?
+      !!@default
+    end
+
+    def requires_curl?
+      !!disable_pinger_url
+    end
+
+    def requires_pinging_interaction?
+      # If URL to disable pinging is set, we want to disable and enable pinging when deploying
+      disable_pinger_url
+    end
+
+    def initialize(raw_target)
+      target_name = raw_target.keys.first
+      @name = target_name.to_s
+
+      options = raw_target[target_name]
+      # Target might have no options
+      if options
+        options.each do |option, value|
+          case option
+          when :description
+            @description = value
+          when :new_relic_disable_pinger_url
+            @disable_pinger_url = value
+          when :new_relic_enable_pinger_url
+            @enable_pinger_url = value
+          when :backup_db
+            @backup_db = value
+          when :default
+            @default = value
+          else
+            raise "Unknown option: #{option}"
+          end
+        end
+      end
+
+      @description = name unless description
+    end
+  end
+end

data/lib/hr_deploy/version.rb

@@ -0,0 +1,3 @@
+module HR_Deploy
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: hr_deploy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Gubitskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies: []
+description: Easily deploy your Rails apps to Heroku with one command, automatically
+  taking care of things such as checking current Heroku status, enabling maintenance
+  mode, creating database backups, etc. Multiple deployment targets are supported
+email: d.gubitskiy@gmail.com
+executables:
+- hr_deploy
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hr_deploy/deployer.rb
+- lib/hr_deploy/config_handler.rb
+- lib/hr_deploy/target.rb
+- lib/hr_deploy/version.rb
+- bin/hr_deploy
+homepage: https://github.com/enthrops/hr_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: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Deploy your Rails apps to Heroku
+test_files: []
+has_rdoc: