paratrooper 0.4.0 → 1.0.0

data/README.md

@@ -1,8 +1,10 @@
-# Paratrooper
-
-Library for handling common tasks when deploying to [Heroku](http://heroku.com)
+## Paratrooper
 
+[![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)
+
+Make your complex deploy to [Heroku][] easy.
 
 ## Installation
 
@@ -20,8 +22,6 @@ Or install it yourself as:
 
 ## Usage
 
->> Note: Before getting started, ensure that `ENV['HEROKU_API_KEY']` is set. If you do not know your api key, you can `cat ~/.netrc`. Your api key will be listed as password in that file. This is necessary until reading your crendentials out of the `.netrc` file is implemented.
-
 Instantiate Paratrooper with the name of your heroku application
 
 ```ruby
@@ -36,6 +36,30 @@ Paratrooper::Deploy.new('amazing-app', tag: 'staging')
 
 Then there are methods available to perform common tasks like creating git tags, running migrations, and warming your application instance.
 
+## Authentication
+
+Authentication with your Heroku account can happen in a few different ways
+
+* Providing API Key
+
+```ruby
+Paratrooper::Deploy.new('app', api_key: 'API_KEY')
+```
+
+* Via environment variable
+
+```ruby
+ENV['HEROKU_API_KEY'] = 'API_KEY'
+Paratrooper::Deploy.new('app')
+```
+
+* Local file storage
+  This method works via a local Netrc file. Storage of this key is handled via the [Heroku Toolbelt][]. This is the default and preferred method of providing your authentication key.
+
+```ruby
+Paratrooper::Deploy.new('app')
+```
+
 ## Sensible Default Deployment
 
 You can use the objects methods any way you'd like but we've provided a sensible default at `Paratrooper#deploy`
@@ -72,6 +96,11 @@ namespace :deploy do
 end
 ```
 
+## Nice to haves
+
+* deploy to heroku from tags
+* send [New Relic][] a notification to toggle heartbeat during deploy
+
 ## Contributing
 
 1. Fork it
@@ -79,3 +108,7 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[Heroku]: http://heroku.com
+[Heroku Toolbelt]: http://toolbelt.heroku.com
+[New Relic]: http://newrelic.com

data/lib/paratrooper/deploy.rb

@@ -4,13 +4,15 @@ require 'paratrooper/system_caller'
 
 module Paratrooper
   class Deploy
-    attr_reader :app_name, :formatter, :system_caller, :heroku, :tag_name
+    attr_reader :app_name, :formatter, :system_caller, :heroku, :tag_name,
+      :deploy_tag
 
     def initialize(app_name, options = {})
       @app_name      = app_name
       @formatter     = options[:formatter] || DefaultFormatter.new
       @heroku        = options[:heroku] || HerokuWrapper.new(app_name, options)
       @tag_name      = options[:tag]
+      @deploy_tag    = options[:deploy_tag] || 'master'
       @system_caller = options[:system_caller] || SystemCaller.new
     end
 
@@ -27,14 +29,14 @@ module Paratrooper
     def update_repo_tag
       unless tag_name.nil? || tag_name.empty?
         notify_screen("Updating Repo Tag: #{tag_name}")
-        system_call "git tag #{tag_name} -f"
+        system_call "git tag #{tag_name} #{deploy_tag} -f"
         system_call "git push origin #{tag_name}"
       end
     end
 
-    def push_repo(branch = 'master')
-      notify_screen("Pushing #{branch} to Heroku")
-      system_call "git push -f #{git_remote} #{branch}"
+    def push_repo
+      notify_screen("Pushing #{deploy_tag} to Heroku")
+      system_call "git push -f #{git_remote} #{deploy_tag}:master"
     end
 
     def run_migrations

data/lib/paratrooper/system_caller.rb

@@ -1,5 +1,7 @@
-class SystemCaller
-  def execute(call)
-    system(call)
+module Paratrooper
+  class SystemCaller
+    def execute(call)
+      system(call)
+    end
   end
 end

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

data/spec/paratrooper/deploy_spec.rb

@@ -105,9 +105,22 @@ describe Paratrooper::Deploy do
         deployer.update_repo_tag
       end
 
-      it 'creates a git tag' do
-        system_caller.should_receive(:execute).with('git tag awesome -f')
-        deployer.update_repo_tag
+      context "when deploy_tag is available" do
+        before do
+          options.merge!(deploy_tag: 'deploy_this')
+        end
+
+        it 'creates a git tag at deploy_tag reference point' do
+          system_caller.should_receive(:execute).with('git tag awesome deploy_this -f')
+          deployer.update_repo_tag
+        end
+      end
+
+      context "when no deploy_tag is available" do
+        it 'creates a git tag at HEAD' do
+          system_caller.should_receive(:execute).with('git tag awesome master -f')
+          deployer.update_repo_tag
+        end
       end
 
       it 'pushes git tag' do
@@ -138,7 +151,7 @@ describe Paratrooper::Deploy do
     end
 
     it 'pushes repo to heroku' do
-      expected_call = 'git push -f git@heroku.com:app.git master'
+      expected_call = 'git push -f git@heroku.com:app.git master:master'
       system_caller.should_receive(:execute).with(expected_call)
       deployer.push_repo
     end

data/spec/paratrooper/heroku_wrapper_spec.rb

@@ -9,7 +9,8 @@ describe Paratrooper::HerokuWrapper do
   let(:options) { Hash.new }
   let(:default_options) do
     {
-      heroku_api: heroku_api
+      heroku_api: heroku_api,
+      key_extractor: double(:key_extractor, get_credentials: 'API_KEY')
     }
   end
   let(:heroku_api) { double(:heroku_api) }

data/spec/paratrooper/local_api_key_extractor_spec.rb

@@ -1,10 +1,15 @@
 require 'spec_helper'
+require 'fileutils'
 require 'paratrooper/local_api_key_extractor'
 
 describe Paratrooper::LocalApiKeyExtractor do
   let(:netrc_klass) { double(:netrc_klass, default_path: fixture_file_path) }
   let(:fixture_file_path) { fixture_path('netrc') }
 
+  before do
+    File.chmod(0600, fixture_file_path)
+  end
+
   describe 'file association' do
     context 'when file path is provided' do
       let(:extractor) { described_class.new(file_path: fixture_file_path) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake