paratrooper 2.4.1 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56e1f38d2b16ea6a3a7ea3f638ca46299dbb593d
-  data.tar.gz: 52ca5fd168124dffdec952b953e56bbbeac73479
+  metadata.gz: 84bd6c187cb422b1e72b4dc30aa60012f46600b3
+  data.tar.gz: 3d14dd42f2b029cf97418d1508a84b250e6750c4
 SHA512:
-  metadata.gz: 5363c5346e761369f59b7d1dc57568dd0a18f6bc47f9125d7a4b898111e82153fd4aba5fe20005d3f6a1502ce9906d48cd99241a8bb8de51bf490a159e1251c7
-  data.tar.gz: c3ed3e7e73606aca077b6264a2313863f66dacdca8b5428c1d085072f130d25fda734f1323e420cb56f3cd3487b7b4d3124b13f539e2c15942aa394d975508ad
+  metadata.gz: c29d2b06b09efe69089e18e791509d30affa865e0bc9a22dc1a8ed7db3fba3bd30142c54238fa31761f433b8039e793e99d0a1bed8566e65c8ff800e590250d5
+  data.tar.gz: e05a117d41e9811b65621b54ca91501573b7a4503a645ec7fa618bfdeb2c37798c353ca4245b47fab73c1c2737a66bf5d3ada33238c3277d55f760bdc480bcac

data/.gitignore

@@ -1,3 +1,8 @@
 *.gem
 bin/*
 Gemfile.lock
+
+.bundle
+.rspec
+.ruby-version
+.ruby-gemset

data/CHANGELOG.md

@@ -1,13 +1,20 @@
 # Changelog
 
+## 3.0.0.beta1
+
+- Moved all state into configuration object
+- Updated interface to start a deploy Ex: `Paratrooper.deploy('appname')`
+- If any exception is thrown, the deploy process is aborted
+- Stop deploy process if there is no access to Heroku
+
 ## 2.4.1
 
-- Fix Deploy#app_url for wildcard domains
+- Fix `Deploy#app_url` for wildcard domains
 
 ## 2.4.0
 
 - Maintenance mode only runs around migrations now
-- README updates around maintenance_mode=
+- README updates around `maintenance_mode=`
 
 ## 2.3.0
 

data/README.md

@@ -1,9 +1,8 @@
 ![Paratrooper](http://f.cl.ly/items/0Z1v1P1l1B1h1k1l2q0E/paratrooper_header.png)
 
-[![Gem Version](https://badge.fury.io/rb/paratrooper.png)](http://badge.fury.io/rb/paratrooper)
-[![Build Status](https://travis-ci.org/mattpolito/paratrooper.png?branch=master)](https://travis-ci.org/mattpolito/paratrooper)
-[![Code Climate](https://codeclimate.com/github/mattpolito/paratrooper.png)](https://codeclimate.com/github/mattpolito/paratrooper)
-[![Gitter chat](https://badges.gitter.im/mattpolito/paratrooper.png)](https://gitter.im/mattpolito/paratrooper)
+[![Gem Version](http://img.shields.io/gem/v/paratrooper.svg?style=flat)](http://badge.fury.io/rb/paratrooper)
+[![Build Status](http://img.shields.io/travis/mattpolito/paratrooper/master.svg?style=flat)](https://travis-ci.org/mattpolito/paratrooper)
+[![Code Climate](http://img.shields.io/codeclimate/github/mattpolito/paratrooper.svg?style=flat)](https://codeclimate.com/github/mattpolito/paratrooper)
 
 Simplify your [Heroku][] deploy with quick and concise deployment rake tasks.
 

data/lib/paratrooper.rb

@@ -2,4 +2,7 @@ require 'paratrooper/version'
 require 'paratrooper/deploy'
 
 module Paratrooper
+  def self.deploy(app_name, options = {}, &block)
+    Deploy.call(app_name, options, &block)
+  end
 end

data/lib/paratrooper/callbacks.rb

@@ -14,14 +14,14 @@ module Paratrooper
       @callbacks ||= Hash.new { |hash, key| hash[key] = [] }
     end
 
-    private
-
     def build_callback(name, context = nil, &block)
       execute_callback("before_#{name}".to_sym, context)
       block.call if block_given?
       execute_callback("after_#{name}".to_sym, context)
     end
 
+    private
+
     def execute_callback(name, context)
       callbacks[name].each { |c| c.call(context) }
     end

data/lib/paratrooper/configuration.rb

@@ -0,0 +1,94 @@
+require 'paratrooper/heroku_wrapper'
+require 'paratrooper/http_client_wrapper'
+require 'paratrooper/system_caller'
+require 'paratrooper/callbacks'
+require 'paratrooper/pending_migration_check'
+require 'paratrooper/source_control'
+require 'paratrooper/notifiers/screen_notifier'
+
+module Paratrooper
+  class Configuration
+    include Callbacks
+
+    attr_accessor :branch_name, :app_name, :api_key
+    attr_writer :protocol, :heroku, :migration_check,
+      :system_caller, :deployment_host, :http_client, :screen_notifier,
+      :source_control
+
+    alias :branch= :branch_name=
+
+    def attributes=(attrs)
+      attrs.each do |method, value|
+        public_send("#{method}=", value)
+      end
+    end
+
+    def branch_name?
+      !branch_name.to_s.strip.empty?
+    end
+
+    def migration_check
+      @migration_check ||= PendingMigrationCheck.new(source_control.deployment_sha, heroku, system_caller)
+    end
+
+    def heroku
+      @heroku ||= HerokuWrapper.new(app_name)
+    end
+
+    def screen_notifier
+      @screen_notifier ||= Notifiers::ScreenNotifier.new
+    end
+
+    def notifiers=(notifers)
+      @notifiers = Array(notifers)
+    end
+
+    def notifiers
+      @notifiers ||= [@screen_notifier]
+    end
+
+    def protocol
+      @protocol ||= 'http'
+    end
+
+    def deployment_host
+      @deployment_host ||= 'heroku.com'
+    end
+
+    def http_client
+      @http_client ||= HttpClientWrapper.new
+    end
+
+    def maintenance
+      @maintenance ||= false
+    end
+
+    def maintenance=(val)
+      @maintenance = !!val
+    end
+
+    def maintenance?
+      @maintenance
+    end
+
+    def force_push=(val)
+      @force_push= !!val
+    end
+
+    def force_push
+      @force_push ||= false
+    end
+
+    def force_push?
+      @force_push
+    end
+
+    def system_caller
+      @system_caller ||= SystemCaller.new
+    end
+
+    def source_control
+      @source_control ||= SourceControl.new(self)
+    end
+  end
+end

data/lib/paratrooper/deploy.rb

@@ -1,24 +1,22 @@
-require 'paratrooper/heroku_wrapper'
-require 'paratrooper/system_caller'
-require 'paratrooper/notifiers/screen_notifier'
-require 'paratrooper/pending_migration_check'
-require 'paratrooper/callbacks'
-require 'paratrooper/http_client_wrapper'
+require 'forwardable'
+require 'paratrooper/configuration'
+require 'paratrooper/error'
 
 module Paratrooper
 
   # Public: Entry point into the library.
   #
   class Deploy
-    include Callbacks
+    extend Forwardable
+    delegate [:system_caller, :migration_check, :notifiers,
+      :deloyment_host, :heroku, :source_control, :screen_notifier
+    ] => :config
 
-    attr_accessor :app_name, :notifiers, :system_caller, :heroku, :tag_name,
-      :match_tag_name, :protocol, :deployment_host, :migration_check, :debug,
-      :screen_notifier, :branch_name, :http_client, :maintenance
+    attr_writer :config
 
-    alias_method :tag=, :tag_name=
-    alias_method :match_tag=, :match_tag_name=
-    alias_method :branch=, :branch_name=
+    def self.call(app_name, options = {}, &block)
+      new(app_name, options, &block).deploy
+    end
 
     # Public: Initializes a Deploy
     #
@@ -30,14 +28,12 @@ module Paratrooper
     #                               notified of steps in deployment process
     #                               (optional).
     #            :heroku          - Object wrapper around heroku-api (optional).
-    #            :tag             - String name to be used as a git reference
-    #                               point for deploying from specific tag
-    #                               (optional).
-    #            :match_tag       - String name of git reference point to match
-    #                               :tag to (optional).
     #            :branch          - String name to be used as a git reference
-    #                               point for deploying from specific branch
+    #                               point for deploying from specific branch.
+    #                               Use :head to deploy from current branch
     #                               (optional).
+    #            :force           - Force deploy using (-f flag) on deploy
+    #                               (optional, default: false)
     #            :system_caller   - Object responsible for calling system
     #                               commands (optional).
     #            :protocol        - String web protocol to be used when pinging
@@ -55,22 +51,12 @@ module Paratrooper
     #                               (optional).
     #
     def initialize(app_name, options = {}, &block)
-      @app_name        = app_name
-      @screen_notifier = options[:screen_notifier] || Notifiers::ScreenNotifier.new
-      @notifiers       = options[:notifiers] || [@screen_notifier]
-      @heroku          = options[:heroku] || HerokuWrapper.new(app_name, options)
-      @tag_name        = options[:tag]
-      @branch_name     = options[:branch]
-      @match_tag_name  = options[:match_tag] || 'master'
-      @system_caller   = options[:system_caller] || SystemCaller.new(debug)
-      @protocol        = options[:protocol] || 'http'
-      @deployment_host = options[:deployment_host] || 'heroku.com'
-      @debug           = options[:debug] || false
-      @migration_check = options[:migration_check] || PendingMigrationCheck.new(match_tag_name, heroku, system_caller)
-      @http_client     = options[:http_client] || HttpClientWrapper.new
-      @maintenance     = options[:maintenance] || false
+      config.attributes = options.merge(app_name: app_name)
+      block.call(config) if block_given?
+    end
 
-      block.call(self) if block_given?
+    def config
+      @config ||= Configuration.new
     end
 
     # Public: Hook method called first in the deploy process.
@@ -93,7 +79,7 @@ module Paratrooper
     # Public: Activates Heroku maintenance mode.
     #
     def activate_maintenance_mode
-      return unless maintenance && pending_migrations?
+      return unless maintenance_necessary?
       callback(:activate_maintenance_mode) do
         notify(:activate_maintenance_mode)
         heroku.app_maintenance_on
@@ -103,41 +89,22 @@ module Paratrooper
     # Public: Deactivates Heroku maintenance mode.
     #
     def deactivate_maintenance_mode
-      return unless pending_migrations?
+      return unless maintenance_necessary?
       callback(:deactivate_maintenance_mode) do
         notify(:deactivate_maintenance_mode)
         heroku.app_maintenance_off
       end
     end
 
-    def maintenance_mode(&block)
-      activate_maintenance_mode
-      block.call if block_given?
-      deactivate_maintenance_mode
-    end
-
-    # Public: Creates a git tag and pushes it to repository.
-    #
-    def update_repo_tag
-      unless tag_name.nil? || tag_name.empty?
-        callback(:update_repo_tag) do
-          notify(:update_repo_tag)
-          system_call "git tag #{tag_name} #{match_tag_name} -f"
-          system_call "git push -f origin #{tag_name}"
-        end
-      end
-    end
-
     # Public: Pushes repository to Heroku.
     #
     # Based on the following precedence:
-    # branch_name / tag_name / 'master'
+    # branch_name / 'master'
     #
     def push_repo
-      reference_point = git_branch_name || git_tag_name || 'master'
       callback(:push_repo) do
-        notify(:push_repo, reference_point: reference_point)
-        system_call "git push -f #{deployment_remote} #{reference_point}:refs/heads/master"
+        notify(:push_repo)
+        source_control.push_to_deploy
       end
     end
 
@@ -161,41 +128,26 @@ module Paratrooper
       end
     end
 
-    # Public: cURL for application URL to start your Heroku dyno.
-    #
-    # wait_time - Integer length of time (seconds) to wait before making call
-    #             to app
-    #
-    def warm_instance(wait_time = 3)
-      callback(:warm_instance) do
-        notify(:warm_instance)
-        sleep wait_time
-        http_client.get("#{protocol}://#{app_url}")
-      end
-    end
-
     # Public: Execute common deploy steps.
     #
     # Default deploy consists of:
     # * Activating maintenance page
-    # * Updating repository tag
     # * Pushing repository to Heroku
     # * Running database migrations
     # * Restarting application on Heroku
     # * Deactivating maintenance page
-    # * Accessing application URL to warm Heroku dyno
     #
     # Alias: #deploy
     def default_deploy
       setup
-      update_repo_tag
       push_repo
       maintenance_mode do
         run_migrations
         app_restart
       end
-      warm_instance
       teardown
+    rescue Paratrooper::Error => e
+      abort(e.message)
     end
     alias_method :deploy, :default_deploy
 
@@ -208,40 +160,33 @@ module Paratrooper
     end
 
     private
-    def app_url
-      heroku.app_url.sub(/\A\*\./, 'www.')
+    def maintenance_mode(&block)
+      activate_maintenance_mode
+      block.call if block_given?
+      deactivate_maintenance_mode
+    end
+
+    def maintenance_necessary?
+      config.maintenance? && pending_migrations?
     end
 
     def callback(name, &block)
-      build_callback(name, screen_notifier, &block)
+      config.build_callback(name, screen_notifier, &block)
     end
 
     # Internal: Payload data to be sent with notifications
     #
     def default_payload
       {
-        app_name: app_name,
-        app_url: app_url,
-        deployment_remote: deployment_remote,
-        tag_name: tag_name,
-        match_tag: match_tag_name
+        app_name: config.app_name,
+        deployment_remote: source_control.remote,
+        force_push: config.force_push,
+        reference_point: source_control.reference_point,
       }
     end
 
-    def git_remote(host, name)
-      "git@#{host}:#{name}.git"
-    end
-
-    def git_branch_name
-      "refs/heads/#{branch_name}" if branch_name
-    end
-
-    def git_tag_name
-      "refs/tags/#{tag_name}" if tag_name
-    end
-
     def deployment_remote
-      git_remote(deployment_host, app_name)
+      source_control.remote
     end
 
     # Internal: Notifies other objects that an event has occurred
@@ -256,19 +201,11 @@ module Paratrooper
     end
 
     def pending_migrations?
-      migration_check.migrations_waiting?
+      @pending_migrations ||= migration_check.migrations_waiting?
     end
 
     def restart_required?
       pending_migrations?
     end
-
-    # Internal: Calls commands meant to go to system
-    #
-    # call - String version of system command
-    #
-    def system_call(call)
-      system_caller.execute(call)
-    end
   end
 end

data/lib/paratrooper/error.rb

@@ -0,0 +1,3 @@
+module Paratrooper
+  class Error < StandardError; end
+end

data/lib/paratrooper/heroku_wrapper.rb

@@ -1,9 +1,17 @@
 require 'heroku-api'
 require 'rendezvous'
 require 'paratrooper/local_api_key_extractor'
+require 'paratrooper/error'
 
 module Paratrooper
   class HerokuWrapper
+    class ErrorNoAccess < Paratrooper::Error
+      def initialize(name)
+        msg = "It appears that you may not have access to #{name}"
+        super(msg)
+      end
+    end
+
     attr_reader :api_key, :app_name, :heroku_api, :key_extractor, :rendezvous
 
     def initialize(app_name, options = {})
@@ -15,7 +23,7 @@ module Paratrooper
     end
 
     def app_restart
-      heroku_api.post_ps_restart(app_name)
+      client(:post_ps_restart, app_name)
     end
 
     def app_maintenance_off
@@ -26,44 +34,30 @@ module Paratrooper
       app_maintenance('1')
     end
 
-    def app_url
-      app_domain_name
-    end
-
     def run_migrations
       run_task('rake db:migrate')
     end
 
     def run_task(task_name)
-      data = heroku_api.post_ps(app_name, task_name, attach: 'true').body
+      data = client(:post_ps, app_name, task_name, attach: 'true').body
       rendezvous.start(url: data['rendezvous_url'])
     end
 
     def last_deploy_commit
-      data = heroku_api.get_releases(app_name).body
+      data = client(:get_releases, app_name).body
       return nil if data.empty?
       data.last['commit']
     end
 
     private
-    def app_domain_name
-      if custom_domain_response
-        custom_domain_response['domain']
-      else
-        default_domain_name
-      end
-    end
-
     def app_maintenance(flag)
-      heroku_api.post_app_maintenance(app_name, flag)
-    end
-
-    def default_domain_name
-      heroku_api.get_app(app_name).body['domain_name']['domain']
+      client(:post_app_maintenance, app_name, flag)
     end
 
-    def custom_domain_response
-      @custom_domain_response ||= heroku_api.get_domains(app_name).body.last
+    def client(method, *args)
+      heroku_api.public_send(method, *args)
+    rescue Heroku::API::Errors::Forbidden => e
+      raise ErrorNoAccess.new(app_name)
     end
   end
 end