paratrooper 0.0.5 → 0.4.0

data/Gemfile.lock

@@ -1,22 +1,25 @@
 PATH
   remote: .
   specs:
-    paratrooper (0.0.2)
-      heroku-api
+    paratrooper (0.3.0)
+      heroku-api (~> 0.3)
+      netrc (~> 0.7)
 
 GEM
   remote: http://rubygems.org/
   specs:
     coderay (1.0.8)
     diff-lcs (1.1.3)
-    excon (0.16.7)
-    heroku-api (0.3.6)
-      excon (~> 0.16.7)
+    excon (0.16.10)
+    heroku-api (0.3.7)
+      excon (~> 0.16.10)
     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)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -33,4 +36,5 @@ PLATFORMS
 DEPENDENCIES
   paratrooper!
   pry
+  rake
   rspec (~> 2.12)

data/README.md

@@ -2,6 +2,8 @@
 
 Library for handling common tasks when deploying to [Heroku](http://heroku.com)
 
+[![Build Status](https://travis-ci.org/mattpolito/paratrooper.png?branch=master)](https://travis-ci.org/mattpolito/paratrooper)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/paratrooper/default_formatter.rb

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

data/lib/paratrooper/deploy.rb

@@ -1,4 +1,4 @@
-require 'heroku-api'
+require 'paratrooper/heroku_wrapper'
 require 'paratrooper/default_formatter'
 require 'paratrooper/system_caller'
 
@@ -9,19 +9,19 @@ module Paratrooper
     def initialize(app_name, options = {})
       @app_name      = app_name
       @formatter     = options[:formatter] || DefaultFormatter.new
-      @heroku        = options[:heroku_auth] || Heroku::API.new(api_key: ENV['HEROKU_API_KEY'])
+      @heroku        = options[:heroku] || HerokuWrapper.new(app_name, options)
       @tag_name      = options[:tag]
       @system_caller = options[:system_caller] || SystemCaller.new
     end
 
     def activate_maintenance_mode
       notify_screen("Activating Maintenance Mode")
-      app_maintenance_on
+      heroku.app_maintenance_on
     end
 
     def deactivate_maintenance_mode
       notify_screen("Deactivating Maintenance Mode")
-      app_maintenance_off
+      heroku.app_maintenance_off
     end
 
     def update_repo_tag
@@ -44,7 +44,7 @@ module Paratrooper
 
     def app_restart
       notify_screen("Restarting application")
-      _app_restart
+      heroku.app_restart
     end
 
     def warm_instance(wait_time = 3)
@@ -65,28 +65,8 @@ module Paratrooper
     alias_method :deploy, :default_deploy
 
     private
-    def _app_maintenance(flag)
-      heroku.post_app_maintenance(app_name, flag)
-    end
-
-    def _app_restart
-      heroku.post_ps_restart(app_name)
-    end
-
-    def _app_domain_name
-      heroku.get_domains(app_name).body.last['domain']
-    end
-
-    def app_maintenance_off
-      _app_maintenance('0')
-    end
-
-    def app_maintenance_on
-      _app_maintenance('1')
-    end
-
     def app_url
-      _app_domain_name
+      heroku.app_url
     end
 
     def git_remote

data/lib/paratrooper/heroku_wrapper.rb

@@ -0,0 +1,40 @@
+require 'heroku-api'
+require 'paratrooper/local_api_key_extractor'
+
+module Paratrooper
+  class HerokuWrapper
+    attr_reader :api_key, :app_name, :heroku_api, :key_extractor
+
+    def initialize(app_name, options = {})
+      @app_name      = app_name
+      @key_extractor = options[:key_extractor] || LocalApiKeyExtractor
+      @api_key       = options[:api_key] || key_extractor.get_credentials
+      @heroku_api    = options[:heroku_api] || Heroku::API.new(api_key: api_key)
+    end
+
+    def app_restart
+      heroku_api.post_ps_restart(app_name)
+    end
+
+    def app_maintenance_off
+      app_maintenance('0')
+    end
+
+    def app_maintenance_on
+      app_maintenance('1')
+    end
+
+    def app_url
+      app_domain_name
+    end
+
+    private
+    def app_domain_name
+      heroku_api.get_domains(app_name).body.last['domain']
+    end
+
+    def app_maintenance(flag)
+      heroku_api.post_app_maintenance(app_name, flag)
+    end
+  end
+end

data/lib/paratrooper/local_api_key_extractor.rb

@@ -0,0 +1,33 @@
+require 'netrc'
+
+module Paratrooper
+  class LocalApiKeyExtractor
+    attr_reader :file_path, :netrc_klass
+
+    def self.get_credentials
+      new.read_credentials
+    end
+
+    def initialize(options = {})
+      @netrc_klass = options[:netrc_klass] || Netrc
+      @file_path   = options[:file_path] || netrc_klass.default_path
+    end
+
+    def read_credentials
+      ENV['HEROKU_API_KEY'] || read_credentials_for('api.heroku.com')
+    end
+
+    private
+    def netrc
+      @netrc ||= begin
+        File.exists?(file_path) && Netrc.read(file_path)
+      rescue => error
+        raise error
+      end
+    end
+
+    def read_credentials_for(domain)
+      netrc[domain][1]
+    end
+  end
+end

data/lib/paratrooper/version.rb

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

data/paratrooper.gemspec

@@ -10,14 +10,16 @@ Gem::Specification.new do |gem|
   gem.email         = ['matt.polito@gmail.com', 'bthesorceror@gmail.com']
   gem.description   = %q{Library to create task for deployment to Heroku}
   gem.summary       = %q{Library to create task for deployment to Heroku}
-  gem.homepage      = "http://github.com/hashrocket/paratrooper"
+  gem.homepage      = "http://github.com/mattpolito/paratrooper"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.12'
   gem.add_development_dependency 'pry'
-  gem.add_dependency 'heroku-api'
+  gem.add_dependency 'heroku-api', '~> 0.3'
+  gem.add_dependency 'netrc', '~> 0.7'
 end

data/spec/fixtures/netrc

@@ -0,0 +1,6 @@
+machine api.heroku.com
+  login mattman@example.com
+  password LOCAL_API_KEY
+machine code.heroku.com
+  login mattman@example.com
+  password LOCAL_API_KEY

data/spec/paratrooper/default_formatter_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'paratrooper/default_formatter'
+
+describe Paratrooper::DefaultFormatter do
+  let(:formatter) { described_class.new(output_stub) }
+  let(:output_stub) { StringIO.new }
+
+  describe "#display(message)" do
+    it "outputs _message_ to screen" do
+      expected_output = <<-EXPECTED_OUTPUT.gsub(/^ {8}/, '')
+
+        #{'=' * 80}
+        >> MESSAGE
+        #{'=' * 80}
+
+      EXPECTED_OUTPUT
+
+      formatter.display('MESSAGE')
+      output_stub.seek(0)
+
+      expect(output_stub.read).to eq(expected_output)
+    end
+  end
+end

data/spec/paratrooper/deploy_spec.rb

@@ -8,7 +8,7 @@ describe Paratrooper::Deploy do
   let(:app_name) { 'app' }
   let(:default_options) do
     {
-      heroku_auth: heroku,
+      heroku: heroku,
       formatter: formatter,
       system_caller: system_caller
     }
@@ -16,9 +16,10 @@ describe Paratrooper::Deploy do
   let(:options) { Hash.new }
   let(:heroku) do
     double(:heroku,
-      post_app_maintenance: true,
-      post_ps_restart: true,
-      get_domains: domain_response
+      app_url: 'application_url',
+      app_restart: true,
+      app_maintenance_on: true,
+      app_maintenance_off: true,
     )
   end
   let(:formatter) { double(:formatter, puts: '') }
@@ -69,7 +70,7 @@ describe Paratrooper::Deploy do
     end
 
     it "makes call to heroku to turn on maintenance mode" do
-      heroku.should_receive(:post_app_maintenance).with(app_name, '1')
+      heroku.should_receive(:app_maintenance_on)
       deployer.activate_maintenance_mode
     end
   end
@@ -85,7 +86,7 @@ describe Paratrooper::Deploy do
     end
 
     it "makes call to heroku to turn on maintenance mode" do
-      heroku.should_receive(:post_app_maintenance).with(app_name, '0')
+      heroku.should_receive(:app_maintenance_off)
       deployer.deactivate_maintenance_mode
     end
   end
@@ -172,7 +173,7 @@ describe Paratrooper::Deploy do
     end
 
     it 'restarts your heroku instance' do
-      heroku.should_receive(:post_ps_restart).with(app_name)
+      heroku.should_receive(:app_restart)
       deployer.app_restart
     end
   end

data/spec/paratrooper/heroku_wrapper_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'paratrooper/heroku_wrapper'
+
+describe Paratrooper::HerokuWrapper do
+  let(:wrapper) do
+    described_class.new(app_name, default_options.merge(options))
+  end
+  let(:app_name) { 'app_name' }
+  let(:options) { Hash.new }
+  let(:default_options) do
+    {
+      heroku_api: heroku_api
+    }
+  end
+  let(:heroku_api) { double(:heroku_api) }
+
+  describe '#api_key' do
+    context 'when api_key is provided as an option' do
+      let(:options) do
+        {
+          api_key: 'PROVIDED_API_KEY'
+        }
+      end
+
+      it 'returns provided api key' do
+        expect(wrapper.api_key).to eq('PROVIDED_API_KEY')
+      end
+    end
+
+    context 'when no key is provided' do
+      let(:options) do
+        {
+          key_extractor: double(:key_extractor, get_credentials: 'NETRC_API_KEY')
+        }
+      end
+
+      it 'returns api key from locally stored file' do
+        expect(wrapper.api_key).to eq('NETRC_API_KEY')
+      end
+    end
+  end
+
+  describe '#app_restart' do
+    it "calls down to heroku api" do
+      heroku_api.should_receive(:post_ps_restart).with(app_name)
+      wrapper.app_restart
+    end
+  end
+
+  describe '#app_maintenance_off' do
+    it "calls down to heroku api" do
+      heroku_api.should_receive(:post_app_maintenance).with(app_name, '0')
+      wrapper.app_maintenance_off
+    end
+  end
+
+  describe '#app_maintenance_on' do
+    it "calls down to heroku api" do
+      heroku_api.should_receive(:post_app_maintenance).with(app_name, '1')
+      wrapper.app_maintenance_on
+    end
+  end
+
+  describe '#app_domain_name' do
+    let(:response) { double(:response, body: [{'domain' => 'APP_URL'}]) }
+    it "calls down to heroku api" do
+      heroku_api.should_receive(:get_domains).with(app_name).and_return(response)
+      wrapper.app_url
+    end
+  end
+end

data/spec/paratrooper/local_api_key_extractor_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+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') }
+
+  describe 'file association' do
+    context 'when file path is provided' do
+      let(:extractor) { described_class.new(file_path: fixture_file_path) }
+
+      it 'uses provided file path' do
+        expect(extractor.file_path).to eq(fixture_file_path)
+      end
+    end
+
+    context 'when file path is not provided' do
+      let(:extractor) { described_class.new(netrc_klass: netrc_klass) }
+
+      it 'uses default path' do
+        expect(extractor.file_path).to eq(netrc_klass.default_path)
+      end
+    end
+  end
+
+  describe '#read_credentials' do
+      let(:extractor) { described_class.new(netrc_klass: netrc_klass) }
+
+    context 'when environment variable is set' do
+      before do
+        ENV.stub(:[]).with('HEROKU_API_KEY').and_return('ENV_API_KEY')
+      end
+
+      it 'returns credentials' do
+        expect(extractor.read_credentials).to eq('ENV_API_KEY')
+      end
+    end
+
+    context 'when environment variable is not set' do
+      before do
+        ENV.stub(:[]).with('HEROKU_API_KEY').and_return(nil)
+      end
+      it 'returns credentials from local file' do
+        expect(extractor.read_credentials).to eq('LOCAL_API_KEY')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
 require 'rspec'
+
+def fixture_path(file)
+  File.expand_path("../fixtures/#{file}", __FILE__)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -49,17 +65,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Library to create task for deployment to Heroku
 email:
 - matt.polito@gmail.com
@@ -77,12 +109,18 @@ files:
 - 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/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/spec_helper.rb
-homepage: http://github.com/hashrocket/paratrooper
+homepage: http://github.com/mattpolito/paratrooper
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -107,5 +145,10 @@ signing_key:
 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/spec_helper.rb
+has_rdoc: