paratrooper 1.1.3 → 1.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paratrooper (0.3.0)
+    paratrooper (1.1.3)
       heroku-api (~> 0.3)
       netrc (~> 0.7)
 
@@ -11,7 +11,7 @@ GEM
     coderay (1.0.8)
     diff-lcs (1.1.3)
     excon (0.16.10)
-    heroku-api (0.3.7)
+    heroku-api (0.3.8)
       excon (~> 0.16.10)
     method_source (0.8.1)
     netrc (0.7.7)

data/README.md

@@ -1,4 +1,4 @@
-## Paratrooper
+![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)
@@ -175,6 +175,11 @@ end
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Thanks
+
+* [Rye Mason][] for the fantastic heading image
+
 [Heroku]: http://heroku.com
 [Heroku Toolbelt]: http://toolbelt.heroku.com
 [New Relic]: http://newrelic.com
+[Rye Mason]: https://github.com/ryenotbread

data/lib/paratrooper/deploy.rb

@@ -1,62 +1,119 @@
 require 'paratrooper/heroku_wrapper'
-require 'paratrooper/default_formatter'
 require 'paratrooper/system_caller'
+require 'paratrooper/notifiers/screen_notifier'
 
 module Paratrooper
+
+  # Public: Entry point into the library.
+  #
   class Deploy
-    attr_reader :app_name, :formatter, :system_caller, :heroku, :tag_name,
+    attr_reader :app_name, :notifiers, :system_caller, :heroku, :tag_name,
       :match_tag
 
+    # 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 responsible for handling
+    #                             notifications (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).
     def initialize(app_name, options = {})
       @app_name      = app_name
-      @formatter     = options[:formatter] || DefaultFormatter.new
+      @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
     end
 
+    def setup
+      notify(:setup)
+    end
+
+    def teardown
+      notify(:teardown)
+    end
+
+    def notify(step, options={})
+      notifiers.each do |notifier|
+        notifier.notify(step, default_payload.merge(options))
+      end
+    end
+
+    # Public: Activates Heroku maintenance mode.
+    #
     def activate_maintenance_mode
-      notify_screen("Activating Maintenance Mode")
+      notify(:activate_maintenance_mode)
       heroku.app_maintenance_on
     end
 
+    # Public: Deactivates Heroku maintenance mode.
+    #
     def deactivate_maintenance_mode
-      notify_screen("Deactivating Maintenance Mode")
+      notify(:deactivate_maintenance_mode)
       heroku.app_maintenance_off
     end
 
+    # Public: Creates a git tag and pushes it to repository.
+    #
     def update_repo_tag
       unless tag_name.nil? || tag_name.empty?
-        notify_screen("Updating Repo Tag: #{tag_name}")
+        notify(:update_repo_tag)
         system_call "git tag #{tag_name} #{match_tag} -f"
         system_call "git push -f origin #{tag_name}"
       end
     end
 
+    # Public: Pushes repository to Heroku.
+    #
     def push_repo
       reference_point = tag_name || 'master'
-      notify_screen("Pushing #{reference_point} to Heroku")
+      notify(:push_repo, reference_point: reference_point)
       system_call "git push -f #{git_remote} #{reference_point}:master"
     end
 
+    # Public: Runs rails database migrations on your application.
+    #
     def run_migrations
-      notify_screen("Running database migrations")
+      notify(:run_migrations)
       system_call "heroku run rake db:migrate --app #{app_name}"
     end
 
+    # Public: Restarts application on Heroku.
+    #
     def app_restart
-      notify_screen("Restarting application")
+      notify(:app_restart)
       heroku.app_restart
     end
 
+    # Public: cURL for application URL to start your Heroku dyno.
+    #
     def warm_instance(wait_time = 3)
       sleep wait_time
-      notify_screen("Accessing #{app_url} to warm up your application")
+      notify(:warm_instance)
       system_call "curl -Il http://#{app_url}"
     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
+    # * cURL'ing application URL to warm Heroku dyno
+    #
+    # Alias: #deploy
     def default_deploy
+      setup
       activate_maintenance_mode
       update_repo_tag
       push_repo
@@ -64,6 +121,7 @@ module Paratrooper
       app_restart
       deactivate_maintenance_mode
       warm_instance
+      teardown
     end
     alias_method :deploy, :default_deploy
 
@@ -72,14 +130,23 @@ module Paratrooper
       heroku.app_url
     end
 
-    def git_remote
-      "git@heroku.com:#{app_name}.git"
+    def default_payload
+      {
+        app_name: app_name,
+        app_url: app_url,
+        git_remote: git_remote,
+        tag_name: tag_name,
+        match_tag: match_tag
+      }
     end
 
-    def notify_screen(message)
-      formatter.display(message)
+    def git_remote
+      "git@heroku.com:#{app_name}.git"
     end
 
+    # Internal: Calls commands meant to go to system
+    #
+    # call - String version of system command
     def system_call(call)
       system_caller.execute(call)
     end

data/lib/paratrooper/notifier.rb

@@ -0,0 +1,17 @@
+module Paratrooper
+  class Notifier
+    def notify(step_name, options = {})
+      self.send(step_name, options)
+    end
+
+    def activate_maintenance_mode(options = {}); end
+    def deactivate_maintenance_mode(options = {}); end
+    def update_repo_tag(options = {}); end
+    def push_repo(options = {}); end
+    def run_migrations(options = {}); end
+    def app_restart(options = {}); end
+    def warm_instance(options = {}); end
+    def setup(options = {}); end
+    def teardown(options = {}); end
+  end
+end

data/lib/paratrooper/notifiers/airbrake_notifier.rb

@@ -0,0 +1,11 @@
+require 'paratrooper/notifier'
+
+module Paratrooper
+  module Notifiers
+    class AirbrakeNotifier
+      def setup
+        `airbrake deploy`
+      end
+    end
+  end
+end

data/lib/paratrooper/notifiers/new_relic_notifier.rb.rb

@@ -0,0 +1,32 @@
+require 'paratrooper/notifier'
+
+module Paratrooper
+  module Notifiers
+
+    # Public: Sends notification to NewRelic to stop monitoring while deploy is
+    #         happening
+    #
+    class NewRelicNotifier < Notifier
+      attr_reader :account_id, :api_key, :application_id
+
+      # Public: Initializes NewRelicNotifier
+      #
+      # api_key        - String api key from NewRelic
+      # account_id     - String NewRelic account id
+      # application_id - String NewRelic id of application
+      def initialize(api_key, account_id, application_id)
+        @api_key        = api_key
+        @account_id     = account_id
+        @application_id = application_id
+      end
+
+      def setup
+        %x[curl https://heroku.newrelic.com/accounts/#{account_id}/applications/#{application_id}/ping_targets/disable -X POST -H "X-Api-Key: #{api_key}"]
+      end
+
+      def teardown
+        %x[curl https://heroku.newrelic.com/accounts/#{account_id}/applications/#{application_id}/ping_targets/enable -X POST -H "X-Api-Key: #{api_key}"]
+      end
+    end
+  end
+end

data/lib/paratrooper/notifiers/screen_notifier.rb

@@ -0,0 +1,67 @@
+require 'paratrooper/notifier'
+
+module Paratrooper
+  module Notifiers
+
+    # Public: Default notifier for outputting messages to screen.
+    #
+    class ScreenNotifier < Notifier
+      attr_reader :output
+
+      # Public: Initializes ScreenNotifier
+      #
+      # output - IO object (default: STDOUT)
+      def initialize(output = STDOUT)
+        @output = output
+      end
+
+      # Public: Displays message with decoration
+      #
+      # message - String message to be displayed
+      #
+      # Examples
+      #
+      #   display("Excellent Message")
+      #   # =>
+      #   # => ==========================================================================
+      #   # => >> Excellent Message
+      #   # => ==========================================================================
+      #   # =>
+      def display(message)
+        output.puts
+        output.puts "=" * 80
+        output.puts ">> #{message}"
+        output.puts "=" * 80
+        output.puts
+      end
+
+      def activate_maintenance_mode(options = {})
+        display("Activating Maintenance Mode")
+      end
+
+      def deactivate_maintenance_mode(options = {})
+        display("Deactivating Maintenance Mode")
+      end
+
+      def update_repo_tag(options = {})
+        display("Updating Repo Tag: #{options[:tag_name]}")
+      end
+
+      def push_repo(options = {})
+        display("Pushing #{options[:reference_point]} to Heroku")
+      end
+
+      def run_migrations(options = {})
+        display("Running database migrations")
+      end
+
+      def app_restart(options = {})
+        display("Restarting application")
+      end
+
+      def warm_instance(options = {})
+        display("Accessing #{options[:app_url]} to warm up your application")
+      end
+    end
+  end
+end

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/spec/paratrooper/deploy_spec.rb

@@ -9,7 +9,7 @@ describe Paratrooper::Deploy do
   let(:default_options) do
     {
       heroku: heroku,
-      formatter: formatter,
+      notifiers: [],
       system_caller: system_caller
     }
   end
@@ -22,7 +22,6 @@ describe Paratrooper::Deploy do
       app_maintenance_off: true,
     )
   end
-  let(:formatter) { double(:formatter, puts: '') }
   let(:system_caller) { double(:system_caller) }
   let(:domain_response) do
     double(:domain_response, body: [{'domain' => 'application_url'}])
@@ -46,26 +45,19 @@ describe Paratrooper::Deploy do
       end
     end
 
-    context "accepts :formatter" do
-      let(:options) { { formatter: formatter } }
-      let(:formatter) { double(:formatter) }
+    context "accepts :notifiers" do
+      let(:options) { { notifiers: [notifiers] } }
+      let(:notifiers) { double(:notifier) }
 
-      it "and responds to #formatter" do
-        expect(deployer.formatter).to eq(formatter)
+      it "and responds to #notifiers" do
+        expect(deployer.notifiers).to eq([notifiers])
       end
     end
   end
 
   describe "#activate_maintenance_mode" do
-    let(:options) { { formatter: formatter } }
-    let(:formatter) { double(:formatter, puts: true) }
-
-    before do
-      formatter.stub(:display)
-    end
-
-    it "displays message" do
-      formatter.should_receive(:display).with('Activating Maintenance Mode')
+    it 'sends notification' do
+      deployer.should_receive(:notify).with(:activate_maintenance_mode).once
       deployer.activate_maintenance_mode
     end
 
@@ -76,12 +68,8 @@ describe Paratrooper::Deploy do
   end
 
   describe "#deactivate_maintenance_mode" do
-    before do
-      formatter.stub(:display)
-    end
-
-    it "displays message" do
-      formatter.should_receive(:display).with('Deactivating Maintenance Mode')
+    it 'sends notification' do
+      deployer.should_receive(:notify).with(:deactivate_maintenance_mode).once
       deployer.deactivate_maintenance_mode
     end
 
@@ -97,11 +85,10 @@ describe Paratrooper::Deploy do
 
       before do
         system_caller.stub(:execute)
-        formatter.stub(:display)
       end
 
-      it 'displays message' do
-        formatter.should_receive(:display).with('Updating Repo Tag: awesome')
+      it 'sends notification' do
+        deployer.should_receive(:notify).with(:update_repo_tag).once
         deployer.update_repo_tag
       end
 
@@ -142,11 +129,11 @@ describe Paratrooper::Deploy do
   describe "#push_repo" do
     before do
       system_caller.stub(:execute)
-      formatter.stub(:display)
     end
 
-    it 'displays message' do
-      formatter.should_receive(:display).with('Pushing master to Heroku')
+    it 'sends notification' do
+      deployer.should_receive(:notify)
+        .with(:push_repo, reference_point: 'master').once
       deployer.push_repo
     end
 
@@ -160,11 +147,10 @@ describe Paratrooper::Deploy do
   describe "#run_migrations" do
     before do
       system_caller.stub(:execute)
-      formatter.stub(:display)
     end
 
-    it 'displays message' do
-      formatter.should_receive(:display).with('Running database migrations')
+    it 'sends notification' do
+      deployer.should_receive(:notify).with(:run_migrations).once
       deployer.run_migrations
     end
 
@@ -176,12 +162,8 @@ describe Paratrooper::Deploy do
   end
 
   describe "#app_restart" do
-    before do
-      formatter.stub(:display)
-    end
-
-    it 'displays message' do
-      formatter.should_receive(:display).with('Restarting application')
+    it 'sends notification' do
+      deployer.should_receive(:notify).with(:app_restart).once
       deployer.app_restart
     end
 
@@ -194,12 +176,10 @@ describe Paratrooper::Deploy do
   describe "#warm_instance" do
     before do
       system_caller.stub(:execute)
-      formatter.stub(:display)
     end
 
-    it 'displays message' do
-      expected_notice = 'Accessing application_url to warm up your application'
-      formatter.should_receive(:display).with(expected_notice)
+    it 'sends notification' do
+      deployer.should_receive(:notify).with(:warm_instance).once
       deployer.warm_instance(0)
     end
 

data/spec/paratrooper/notifier_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'paratrooper/notifier'
+
+describe Paratrooper::Notifier do
+  let(:notifier) { described_class.new }
+  describe '#notify' do
+    it 'sends correct method options' do
+      notifier.should_receive(:update_repo_tag).with(test: 'blah')
+      notifier.notify(:update_repo_tag, test: 'blah')
+    end
+  end
+end

data/spec/paratrooper/{default_formatter_spec.rb → notifiers/screen_notifier_spec.rb}

@@ -1,7 +1,8 @@
 require 'spec_helper'
-require 'paratrooper/default_formatter'
+require 'paratrooper/notifiers/screen_notifier'
+require 'stringio'
 
-describe Paratrooper::DefaultFormatter do
+describe Paratrooper::Notifiers::ScreenNotifier do
   let(:formatter) { described_class.new(output_stub) }
   let(:output_stub) { StringIO.new }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,18 +107,22 @@ files:
 - README.md
 - Rakefile
 - lib/paratrooper.rb
-- lib/paratrooper/default_formatter.rb
 - lib/paratrooper/deploy.rb
 - lib/paratrooper/heroku_wrapper.rb
 - lib/paratrooper/local_api_key_extractor.rb
+- lib/paratrooper/notifier.rb
+- lib/paratrooper/notifiers/airbrake_notifier.rb
+- lib/paratrooper/notifiers/new_relic_notifier.rb.rb
+- lib/paratrooper/notifiers/screen_notifier.rb
 - lib/paratrooper/system_caller.rb
 - lib/paratrooper/version.rb
 - paratrooper.gemspec
 - spec/fixtures/netrc
-- spec/paratrooper/default_formatter_spec.rb
 - spec/paratrooper/deploy_spec.rb
 - spec/paratrooper/heroku_wrapper_spec.rb
 - spec/paratrooper/local_api_key_extractor_spec.rb
+- spec/paratrooper/notifier_spec.rb
+- spec/paratrooper/notifiers/screen_notifier_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/mattpolito/paratrooper
 licenses: []
@@ -146,9 +150,10 @@ specification_version: 3
 summary: Library to create task for deployment to Heroku
 test_files:
 - spec/fixtures/netrc
-- spec/paratrooper/default_formatter_spec.rb
 - spec/paratrooper/deploy_spec.rb
 - spec/paratrooper/heroku_wrapper_spec.rb
 - spec/paratrooper/local_api_key_extractor_spec.rb
+- spec/paratrooper/notifier_spec.rb
+- spec/paratrooper/notifiers/screen_notifier_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/paratrooper/default_formatter.rb

@@ -1,19 +0,0 @@
-require 'stringio'
-
-module Paratrooper
-  class DefaultFormatter
-    attr_reader :output
-
-    def initialize(output = STDOUT)
-      @output = output
-    end
-
-    def display(message)
-      output.puts
-      output.puts "=" * 80
-      output.puts ">> #{message}"
-      output.puts "=" * 80
-      output.puts
-    end
-  end
-end