paratrooper 1.4.2 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f62f87661b86c70e2e8734ddd93a7e98d1b9efc7
-  data.tar.gz: b1b2d6d30d6b62b686ff039f1a91835191c7334d
+  metadata.gz: 7cdee8a2553bcc4297a5201449429d4be4c9075e
+  data.tar.gz: 95a19b97249116f577655ab60298af1d396c3a92
 SHA512:
-  metadata.gz: 0aac9f0ed9d23d09603e1851b8fc7da35d463793db9652725cad40e0ad4b043a8f4caea7ac3fa07bbe31a282d1719f62bfe2644f49a21e6c5d2f70f47d2635d2
-  data.tar.gz: 31c6fb7829cd85e0051c6fe982f17129c83ca47081a099f731a382e430e76ced578067d3b905d0f7bb3da5bfa4c08538bf4f2a084baa1639fe4d326074265397
+  metadata.gz: c617517de7e35016f00629f22e5567ac6d57129bcdecb07ce1c6545e32f25d06245d207c53143c8f1df3c0dade39dbfa69b006248b8f001b207ca8a7b16e12e2
+  data.tar.gz: 939942fc3004f1deb0134ded9e71b515ce11bd324fc347b2a8df9d52ef380212ec1aabad287eddea0cb852139ae0ab4963d832d2c91fa43ce92bafd09cdabc11

data/.gitignore

@@ -1 +1,3 @@
 *.gem
+bin/*
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p374
+2.0.0

data/README.md

@@ -42,6 +42,14 @@ You can also provide a tag:
 Paratrooper::Deploy.new('amazing-app', tag: 'staging')
 ```
 
+or alternatively:
+
+```ruby
+Paratrooper::Deploy.new('amazing-app') do |deploy|
+  deploy.tag = 'staging'
+end
+```
+
 ## Authentication
 
 You can authenticate your Heroku account in a few ways:
@@ -75,6 +83,14 @@ If you use multiple SSH keys for managing multiple accounts, for example in your
 Paratrooper::Deploy.new('app', deployment_host: 'HOST')
 ```
 
+or alternatively:
+
+```ruby
+Paratrooper::Deploy.new('amazing-app') do |deploy|
+  deploy.deployment_host = 'HOST'
+end
+```
+
 This also works if you're using the [heroku-accounts](https://github.com/ddollar/heroku-accounts) plugin:
 
 ```ruby
@@ -97,9 +113,18 @@ This will create/update a `staging` git tag at `HEAD`.
 ```ruby
   Paratrooper::Deploy.new("amazing-production-app",
     tag: 'production',
-    match_tag_to: 'staging'
+    match_tag: 'staging'
   )
 ```
+
+or alternatively:
+
+```ruby
+Paratrooper::Deploy.new('amazing-production-app') do |deploy|
+  deploy.tag       = 'production'
+  deploy.match_tag = 'staging'
+end
+```
 This will create/update a `production` git tag at `staging` and deploy the `production` tag.
 
 ## Sensible Default Deployment
@@ -133,9 +158,10 @@ namespace :deploy do
 
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app",
-      tag: 'production',
-      match_tag_to: 'staging'
+    deployment = Paratrooper::Deploy.new("amazing-production-app") do |deploy|
+      deploy.tag              = 'production',
+      deploy.match_tag        = 'staging',
+      deploy.maintenance_mode = !ENV['NO_MAINTENANCE']
     )
 
     deployment.deploy
@@ -146,43 +172,51 @@ end
 ## Bucking the Norm
 
 Our default deploy gets us most of the way, but maybe it's not for you--we've
-got you covered. Every deployment method sends a notification that can be
-captured and used in almost any way you can imagine.
+got you covered. Every deployment method has a set of callback instructions that can be
+utilized in almost any way you can imagine.
 
-For example, say you want to let [New Relic][] know that you are deploying and
-to disable your application monitoring.
+The `add_callback` method allows for the execution of arbitrary code within different steps of the deploy process.
+
+There are 'before' and 'after' hooks for each of the following:
+
+* setup
+* activate_maintenance_mode
+* update_repo_tag
+* push_repo
+* run_migrations
+* app_restart
+* deactivate_maintenance_mode
+* warm_instance
+* teardown
 
 ### Example Usage
 
-```ruby
-# Gemfile
-gem 'paratrooper-newrelic'
+For example, say you want to let [New Relic][] know that you are deploying and
+to disable your application monitoring.
 
+```ruby
 # lib/tasks/deploy.rake
 require 'paratrooper'
 
 namespace :deploy do
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app",
-      tag: 'production',
-      match_tag_to: 'staging',
-      notifiers: [
-        Paratrooper::Notifiers::ScreenNotifier.new,
-        Paratrooper::Newrelic::Notifier.new('api_key', 'account_id', 'application_id')
-      ]
-    )
+    deployment = Paratrooper::Deploy.new("amazing-production-app") do |deploy|
+      deploy.tag = 'production'
+      deploy.match_tag = 'staging'
+      deploy.add_callback(:before_setup) do
+        system %Q[curl https://rpm.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/disable -X POST -H "X-Api-Key: API_KEY"]
+      end
+      deploy.add_callback(:after_teardown) do
+        system %Q[curl https://rpm.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/enable -X POST -H "X-Api-Key: API_KEY"]
+      end
+    end
+
+    deployment.deploy
   end
 end
 ```
 
-* The `ScreenNotifier` is added by default so when you override the `notifiers`
-  option you need to manually add it to continue receiving screen output.
-
-To make your own notifier, take a look at [`Paratrooper::Notifier`][] to see
-what methods are available for override.
-
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts ||= []
+  t.rspec_opts << '--format progress'
+end
 
 task :default => :spec

data/lib/paratrooper/callbacks.rb

@@ -0,0 +1,21 @@
+module Paratrooper
+  module Callbacks
+    def callback(name, &block)
+      execute_callback("before_#{name}".to_sym)
+      block.call if block_given?
+      execute_callback("after_#{name}".to_sym)
+    end
+
+    def execute_callback(name)
+      callbacks[name].each(&:call)
+    end
+
+    def add_callback(name, &block)
+      callbacks[name] << block
+    end
+
+    def callbacks
+      @callbacks ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+  end
+end

data/lib/paratrooper/deploy.rb

@@ -2,83 +2,109 @@ require 'paratrooper/heroku_wrapper'
 require 'paratrooper/system_caller'
 require 'paratrooper/notifiers/screen_notifier'
 require 'paratrooper/pending_migration_check'
+require 'paratrooper/callbacks'
 
 module Paratrooper
 
   # Public: Entry point into the library.
   #
   class Deploy
-    attr_reader :app_name, :notifiers, :system_caller, :heroku, :tag_name,
-      :match_tag, :protocol, :deployment_host, :migration_check, :debug
+    include Callbacks
+
+    attr_accessor :app_name, :notifiers, :system_caller, :heroku, :tag_name,
+      :match_tag_name, :protocol, :deployment_host, :migration_check, :debug,
+      :maintenance_mode
+
+    alias_method :tag=, :tag_name=
+    alias_method :match_tag=, :match_tag_name=
 
     # Public: Initializes a Deploy
     #
     # app_name - A String naming the Heroku application to be interacted with.
     # options  - The Hash options is used to provide additional functionality.
-    #            :notifiers       - Array of objects interested in being
-    #                               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 (optional).
-    #            :match_tag_to    - String name of git reference point to match
-    #                               :tag to (optional).
-    #            :system_caller   - Object responsible for calling system
-    #                               commands (optional).
-    #            :protocol        - String web protocol to be used when pinging
-    #                               application (optional, default: 'http').
-    #            :deployment_host - String host name to be used in git URL
-    #                               (optional, default: 'heroku.com').
-    #            :migration_check - Object responsible for checking pending
-    #                               migrations (optional).
-    def initialize(app_name, options = {})
-      @app_name        = app_name
-      @notifiers       = options[:notifiers] || [Notifiers::ScreenNotifier.new]
-      @heroku          = options[:heroku] || HerokuWrapper.new(app_name, options)
-      @tag_name        = options[:tag]
-      @match_tag       = options[:match_tag_to] || 'master'
-      @system_caller   = options[:system_caller] || SystemCaller.new(debug)
-      @protocol        = options[:protocol] || 'http'
-      @deployment_host = options[:deployment_host] || 'heroku.com'
-      @debug           = options[:debug] || false
+    #            :notifiers        - Array of objects interested in being
+    #                                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 (optional).
+    #            :match_tag_to     - String name of git reference point to match
+    #                                :tag to (optional).
+    #            :system_caller    - Object responsible for calling system
+    #                                commands (optional).
+    #            :protocol         - String web protocol to be used when pinging
+    #                                application (optional, default: 'http').
+    #            :deployment_host  - String host name to be used in git URL
+    #                                (optional, default: 'heroku.com').
+    #            :migration_check  - Object responsible for checking pending
+    #                                migrations (optional).
+    #            :maintenance_mode - Boolean whether to trigger maintenance
+    #                                mode on and off during deployment
+    #                                (default: true)
+    #            :api_key          - String version of heroku api key.
+    #                                (default: looks in local Netrc file)
+    def initialize(app_name, options = {}, &block)
+      @app_name         = app_name
+      @notifiers        = options[:notifiers] || [Notifiers::ScreenNotifier.new]
+      @heroku           = options[:heroku] || HerokuWrapper.new(app_name, options)
+      @tag_name         = options[:tag]
+      @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
+      @maintenance_mode = options.fetch(:maintenance_mode, true)
       self.migration_check = options[:migration_check]
+      block.call(self) if block_given?
     end
 
-    def setup
-      notify(:setup)
+    def notify(step, options = {})
+      notifiers.each do |notifier|
+        notifier.notify(step, default_payload.merge(options))
+      end
     end
 
-    def teardown
-      notify(:teardown)
+    def setup
+      callback(:setup) do
+        notify(:setup)
+      end
     end
 
-    def notify(step, options={})
-      notifiers.each do |notifier|
-        notifier.notify(step, default_payload.merge(options))
+    def teardown
+      callback(:teardown) do
+        notify(:teardown)
       end
     end
 
     # Public: Activates Heroku maintenance mode.
     #
     def activate_maintenance_mode
-      notify(:activate_maintenance_mode)
-      heroku.app_maintenance_on
+      return unless maintenance_mode?
+      callback(:activate_maintenance_mode) do
+        notify(:activate_maintenance_mode)
+        heroku.app_maintenance_on
+      end
     end
 
     # Public: Deactivates Heroku maintenance mode.
     #
     def deactivate_maintenance_mode
-      notify(:deactivate_maintenance_mode)
-      heroku.app_maintenance_off
+      return unless maintenance_mode?
+      callback(:deactivate_maintenance_mode) do
+        notify(:deactivate_maintenance_mode)
+        heroku.app_maintenance_off
+      end
     end
 
     # Public: Creates a git tag and pushes it to repository.
     #
     def update_repo_tag
       unless tag_name.nil? || tag_name.empty?
-        notify(:update_repo_tag)
-        system_call "git tag #{tag_name} #{match_tag} -f"
-        system_call "git push -f origin #{tag_name}"
+        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
 
@@ -86,31 +112,39 @@ module Paratrooper
     #
     def push_repo
       reference_point = tag_name || 'master'
-      notify(:push_repo, reference_point: reference_point)
-      system_call "git push -f #{deployment_remote} #{reference_point}:refs/heads/master"
+      callback(:push_repo) do
+        notify(:push_repo, reference_point: reference_point)
+        system_call "git push -f #{deployment_remote} #{reference_point}:refs/heads/master"
+      end
     end
 
     # Public: Runs rails database migrations on your application.
     #
     def run_migrations
       return unless pending_migrations?
-      notify(:run_migrations)
-      heroku.run_migrations
+      callback(:run_migrations) do
+        notify(:run_migrations)
+        heroku.run_migrations
+      end
     end
 
     # Public: Restarts application on Heroku.
     #
     def app_restart
-      notify(:app_restart)
-      heroku.app_restart
+      callback(:app_restart) do
+        notify(:app_restart)
+        heroku.app_restart
+      end
     end
 
     # Public: cURL for application URL to start your Heroku dyno.
     #
     def warm_instance(wait_time = 3)
-      sleep wait_time
-      notify(:warm_instance)
-      system_call "curl -Il #{protocol}://#{app_url}"
+      callback(:warm_instance) do
+        notify(:warm_instance)
+        sleep wait_time
+        system_call "curl -Il #{protocol}://#{app_url}"
+      end
     end
 
     # Public: Execute common deploy steps.
@@ -138,6 +172,10 @@ module Paratrooper
     end
     alias_method :deploy, :default_deploy
 
+    def maintenance_mode?
+      !!@maintenance_mode
+    end
+
     private
     def app_url
       heroku.app_url
@@ -149,7 +187,7 @@ module Paratrooper
         app_url: app_url,
         deployment_remote: deployment_remote,
         tag_name: tag_name,
-        match_tag: match_tag
+        match_tag: match_tag_name
       }
     end
 
@@ -166,7 +204,7 @@ module Paratrooper
     end
 
     def migration_check=(obj)
-      @migration_check = obj || PendingMigrationCheck.new(match_tag, heroku, system_caller)
+      @migration_check = obj || PendingMigrationCheck.new(match_tag_name, heroku, system_caller)
       @migration_check.last_deployed_commit
       @migration_check
     end

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "1.4.2"
+  VERSION = "2.0.0.beta1"
 end

data/spec/paratrooper/deploy_spec.rb

@@ -11,7 +11,8 @@ describe Paratrooper::Deploy do
       heroku: heroku,
       notifiers: [],
       system_caller: system_caller,
-      migration_check: migration_check
+      migration_check: migration_check,
+      maintenance_mode: true
     }
   end
   let(:options) { Hash.new }
@@ -32,6 +33,39 @@ describe Paratrooper::Deploy do
     double(:domain_response, body: [{'domain' => 'application_url'}])
   end
 
+  describe "tag=" do
+    specify "tag is set and @tag_name holds value" do
+      deployer.tag = "tag_name"
+      expect(deployer.tag_name).to eq("tag_name")
+    end
+  end
+
+  describe "match_tag_to=" do
+    specify "match_tag is set and @match_tag_name holds value" do
+      deployer.match_tag = "staging"
+      expect(deployer.match_tag_name).to eq("staging")
+    end
+  end
+
+  describe "passing a block to initialize" do
+    it "sets attributes on self" do
+      deployer = described_class.new(app_name, default_options) do |p|
+        p.match_tag = "staging"
+        p.tag = "production"
+        p.debug = true
+        p.maintenance_mode = true
+        p.deployment_host = "HOST"
+        p.protocol = "MOM"
+      end
+      expect(deployer.match_tag_name).to eq("staging")
+      expect(deployer.tag_name).to eq("production")
+      expect(deployer.debug).to be_true
+      expect(deployer.maintenance_mode).to be_true
+      expect(deployer.deployment_host).to eq("HOST")
+      expect(deployer.protocol).to eq("MOM")
+    end
+  end
+
   describe "options" do
     context "accepts :tag" do
       let(:options) { { tag: 'tag_name' } }
@@ -59,6 +93,15 @@ describe Paratrooper::Deploy do
       end
     end
 
+    context "accepts :maintenance_mode" do
+      let(:options) { { maintenance_mode: false } }
+      let(:notifiers) { double(:notifier) }
+
+      it "and responds to #notifiers" do
+        expect(deployer.maintenance_mode?).to eq(false)
+      end
+    end
+
     describe "protocol" do
       context "accepts :protocol" do
         let(:options) { { protocol: 'https' } }
@@ -85,26 +128,62 @@ describe Paratrooper::Deploy do
   end
 
   describe "#activate_maintenance_mode" do
-    it 'sends notification' do
-      deployer.should_receive(:notify).with(:activate_maintenance_mode).once
-      deployer.activate_maintenance_mode
+    context "when maintenance_mode option is 'true'" do
+      let(:options) { { maintenance_mode: true } }
+
+      it 'sends notification' do
+        deployer.should_receive(:notify).with(:activate_maintenance_mode).once
+        deployer.activate_maintenance_mode
+      end
+
+      it "makes call to heroku to turn on maintenance mode" do
+        heroku.should_receive(:app_maintenance_on)
+        deployer.activate_maintenance_mode
+      end
     end
 
-    it "makes call to heroku to turn on maintenance mode" do
-      heroku.should_receive(:app_maintenance_on)
-      deployer.activate_maintenance_mode
+    context "when maintenance_mode option is 'false'" do
+      let(:options) { { maintenance_mode: false } }
+
+      it 'does not send notification' do
+        deployer.should_not_receive(:notify).with(:activate_maintenance_mode)
+        deployer.activate_maintenance_mode
+      end
+
+      it "does not make a call to heroku to turn on maintenance mode" do
+        heroku.should_not_receive(:app_maintenance_on)
+        deployer.activate_maintenance_mode
+      end
     end
   end
 
   describe "#deactivate_maintenance_mode" do
-    it 'sends notification' do
-      deployer.should_receive(:notify).with(:deactivate_maintenance_mode).once
-      deployer.deactivate_maintenance_mode
+    context "when maintenance_mode option is 'true'" do
+      let(:options) { { maintenance_mode: true } }
+
+      it 'sends notification' do
+        deployer.should_receive(:notify).with(:deactivate_maintenance_mode).once
+        deployer.deactivate_maintenance_mode
+      end
+
+      it "makes call to heroku to turn on maintenance mode" do
+        heroku.should_receive(:app_maintenance_off)
+        deployer.deactivate_maintenance_mode
+      end
     end
 
-    it "makes call to heroku to turn on maintenance mode" do
-      heroku.should_receive(:app_maintenance_off)
-      deployer.deactivate_maintenance_mode
+    context "when maintenance_mode option is 'false'" do
+      let(:options) { { maintenance_mode: false } }
+
+      it 'does not send notification' do
+        deployer.should_not_receive(:notify).with(:deactivate_maintenance_mode)
+        deployer.deactivate_maintenance_mode
+      end
+
+      it "does not make a call to heroku to turn on maintenance mode" do
+        heroku.should_not_receive(:app_maintenance_off)
+        deployer.deactivate_maintenance_mode
+      end
     end
   end
 
@@ -123,7 +202,7 @@ describe Paratrooper::Deploy do
 
       context "when deploy_tag is available" do
         before do
-          options.merge!(match_tag_to: 'deploy_this')
+          options.merge!(match_tag: 'deploy_this')
         end
 
         it 'creates a git tag at deploy_tag reference point' do
@@ -244,5 +323,24 @@ describe Paratrooper::Deploy do
         deployer.warm_instance(0)
       end
     end
+
+    describe "adding notification" do
+      after do
+        FileUtils.rm("spec/fixtures/test.txt")
+      end
+
+      it "adds notifier to #notifiers collection" do
+        callback = proc do
+          system("touch spec/fixtures/test.txt")
+        end
+
+        deployer = described_class.new(app_name, default_options) do |p|
+          p.add_callback(:before_setup, &callback)
+        end
+        deployer.setup
+
+        expect(deployer.callbacks[:before_setup]).to eq([callback])
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Matt Polito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,14 +105,15 @@ extra_rdoc_files: []
 files:
 - .bundle/config
 - .gitignore
+- .rspec
 - .ruby-version
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/paratrooper.rb
+- lib/paratrooper/callbacks.rb
 - lib/paratrooper/deploy.rb
 - lib/paratrooper/heroku_wrapper.rb
 - lib/paratrooper/local_api_key_extractor.rb
@@ -144,9 +145,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3

data/Gemfile.lock

@@ -1,42 +0,0 @@
-PATH
-  remote: .
-  specs:
-    paratrooper (1.4.2)
-      heroku-api (~> 0.3)
-      netrc (~> 0.7)
-      rendezvous (~> 0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
-    excon (0.22.1)
-    heroku-api (0.3.11)
-      excon (~> 0.22.1)
-    method_source (0.8.1)
-    netrc (0.7.7)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-    rake (10.0.3)
-    rendezvous (0.0.2)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
-    slop (3.3.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  paratrooper!
-  pry
-  rake
-  rspec (~> 2.12)