paratrooper 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,18 +1,36 @@
 PATH
   remote: .
   specs:
-    paratrooper (0.0.1)
+    paratrooper (0.0.2)
       heroku-api
 
 GEM
   remote: http://rubygems.org/
   specs:
-    excon (0.16.10)
-    heroku-api (0.3.7)
-      excon (~> 0.16.10)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    excon (0.16.7)
+    heroku-api (0.3.6)
+      excon (~> 0.16.7)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    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
+  rspec (~> 2.12)

data/README.md

@@ -18,16 +18,18 @@ 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
-Paratrooper.new('amazing-app')
+Paratrooper::Deploy.new('amazing-app')
 ```
 
 also you can provide a tag name for repository use
 
 ```ruby
-Paratrooper.new('amazing-app', tag: 'staging')
+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.
@@ -54,14 +56,14 @@ require 'paratrooper'
 namespace :deploy do
   desc 'Deploy app in staging environment'
   task :staging do
-    deployment = Paratrooper.new("amazing-staging-app", tag: 'staging')
+    deployment = Paratrooper::Deploy.new("amazing-staging-app", tag: 'staging')
 
     deployment.deploy
   end
 
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper.new("amazing-production-app", tag: 'production')
+    deployment = Paratrooper::Deploy.new("amazing-production-app", tag: 'production')
 
     deployment.deploy
   end

data/lib/paratrooper.rb

@@ -1,6 +1,5 @@
-require "paratrooper/version"
+require 'paratrooper/version'
 require 'paratrooper/deploy'
 
 module Paratrooper
-
 end

data/lib/paratrooper/default_formatter.rb

@@ -0,0 +1,11 @@
+module Paratrooper
+  class DefaultFormatter
+    def puts(message)
+      puts
+      puts "=" * 80
+      puts ">> #{message}"
+      puts "=" * 80
+      puts
+    end
+  end
+end

data/lib/paratrooper/deploy.rb

@@ -1,51 +1,55 @@
 require 'heroku-api'
+require 'paratrooper/default_formatter'
 
 module Paratrooper
   class Deploy
-    attr_reader :app_name, :heroku, :tag_name
+    attr_reader :app_name, :formatter, :system_caller, :heroku, :tag_name
 
     def initialize(app_name, options = {})
-      @app_name = app_name
-      @heroku   = options[:heroku_auth] || Heroku::API.new(api_key: ENV['HEROKU_API_KEY'])
-      @tag_name = options[:tag]
+      @app_name      = app_name
+      @formatter     = options[:formatter] || DefaultFormatter.new
+      @heroku        = options[:heroku_auth] || Heroku::API.new(api_key: ENV['HEROKU_API_KEY'])
+      @tag_name      = options[:tag]
+      @system_caller = options[:system_caller] || SystemCaller.new
     end
 
     def activate_maintenance_mode
       notify_screen("Activating Maintenance Mode")
-      heroku.post_app_maintenance(app_name, '1')
+      app_maintenance_on
     end
 
     def deactivate_maintenance_mode
       notify_screen("Deactivating Maintenance Mode")
-      heroku.post_app_maintenance(app_name, '0')
+      app_maintenance_off
     end
 
     def update_repo_tag
-      unless tag_name.empty?
+      unless tag_name.nil? || tag_name.empty?
         notify_screen("Updating Repo Tag: #{tag_name}")
-        system "git tag #{tag_name} -f"
-        system "git push origin #{tag_name}"
+        system_call "git tag #{tag_name} -f"
+        system_call "git push origin #{tag_name}"
       end
     end
 
     def push_repo(branch = 'master')
       notify_screen("Pushing #{branch} to Heroku")
-      system "git push -f #{git_remote} #{branch}"
+      system_call "git push -f #{git_remote} #{branch}"
     end
 
     def run_migrations
       notify_screen("Running database migrations")
-      system "heroku run rake db:migrate --app #{app_name}"
+      system_call "heroku run rake db:migrate --app #{app_name}"
     end
 
     def app_restart
-      heroku.post_ps_restart(app_name)
+      notify_screen("Restarting application")
+      _app_restart
     end
 
-    def warm_instance(wait_time = 5)
+    def warm_instance(wait_time = 3)
       sleep wait_time
       notify_screen("Accessing #{app_url} to warm up your application")
-      system "curl -Il http://#{app_url}"
+      system_call "curl -Il http://#{app_url}"
     end
 
     def default_deploy
@@ -60,20 +64,46 @@ module Paratrooper
     alias_method :deploy, :default_deploy
 
     private
-    def git_remote
-      "git@heroku.com:#{app_name}.git"
+    def _app_maintenance(flag)
+      heroku.post_app_maintenance(app_name, flag)
     end
 
-    def app_url
+    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
+    end
+
+    def git_remote
+      "git@heroku.com:#{app_name}.git"
+    end
+
     def notify_screen(message)
-      puts
-      puts "=" * 80
-      puts ">> #{message}"
-      puts "=" * 80
-      puts
+      formatter.puts(message)
+    end
+
+    def system_call(call)
+      system_caller.execute(call)
+    end
+  end
+
+  SystemCaller = Struct.new(:call) do
+    def execute
+      system(call)
     end
   end
 end

data/lib/paratrooper/system_caller.rb

@@ -0,0 +1,5 @@
+SystemCaller = Struct.new(:call) do
+  def execute
+    system(call)
+  end
+end

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/paratrooper.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'pry'
   gem.add_dependency 'heroku-api'
 end

data/spec/paratrooper/deploy_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'paratrooper/deploy'
+
+describe Paratrooper::Deploy do
+  let(:deployer) do
+    described_class.new(app_name, default_options.merge(options))
+  end
+  let(:app_name) { 'app' }
+  let(:default_options) do
+    {
+      heroku_auth: heroku,
+      formatter: formatter,
+      system_caller: system_caller
+    }
+  end
+  let(:options) { Hash.new }
+  let(:heroku) do
+    double(:heroku,
+      post_app_maintenance: true,
+      post_ps_restart: true,
+      get_domains: domain_response
+    )
+  end
+  let(:formatter) { double(:formatter, puts: '') }
+  let(:system_caller) { double(:system_caller) }
+  let(:domain_response) do
+    double(:domain_response, body: [{'domain' => 'application_url'}])
+  end
+
+  describe "options" do
+    context "accepts :tag" do
+      let(:options) { { tag: 'tag_name' } }
+
+      it "and responds to #tag_name" do
+        expect(deployer.tag_name).to eq('tag_name')
+      end
+    end
+
+    context "accepts :heroku_auth" do
+      let(:options) { { heroku_auth: heroku } }
+      let(:heroku) { double(:heroku) }
+
+      it "and responds to #heroku" do
+        expect(deployer.heroku).to eq(heroku)
+      end
+    end
+
+    context "accepts :formatter" do
+      let(:options) { { formatter: formatter } }
+      let(:formatter) { double(:formatter) }
+
+      it "and responds to #formatter" do
+        expect(deployer.formatter).to eq(formatter)
+      end
+    end
+  end
+
+  describe "#activate_maintenance_mode" do
+    let(:options) { { formatter: formatter } }
+    let(:formatter) { double(:formatter, puts: true) }
+
+    it "displays message" do
+      formatter.should_receive(:puts).with('Activating Maintenance Mode')
+      deployer.activate_maintenance_mode
+    end
+
+    it "makes call to heroku to turn on maintenance mode" do
+      heroku.should_receive(:post_app_maintenance).with(app_name, '1')
+      deployer.activate_maintenance_mode
+    end
+  end
+
+  describe "#deactivate_maintenance_mode" do
+    it "displays message" do
+      formatter.should_receive(:puts).with('Deactivating Maintenance Mode')
+      deployer.deactivate_maintenance_mode
+    end
+
+    it "makes call to heroku to turn on maintenance mode" do
+      heroku.should_receive(:post_app_maintenance).with(app_name, '0')
+      deployer.deactivate_maintenance_mode
+    end
+  end
+
+  describe "#update_repo_tag" do
+    context "when a tag_name is available" do
+      let(:options) { { tag: 'awesome' } }
+
+      before do
+        system_caller.stub(:execute)
+      end
+
+      it 'displays message' do
+        formatter.should_receive(:puts).with('Updating Repo Tag: awesome')
+        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
+      end
+
+      it 'pushes git tag' do
+        system_caller.should_receive(:execute).with('git push origin awesome')
+        deployer.update_repo_tag
+      end
+    end
+
+    context "when a tag_name is unavailable" do
+      let(:options) { Hash.new }
+
+      it 'no repo tags are created' do
+        system_caller.should_not_receive(:execute)
+        deployer.update_repo_tag
+      end
+    end
+  end
+
+  describe "#push_repo" do
+    before do
+      system_caller.stub(:execute)
+    end
+
+    it 'displays message' do
+      formatter.should_receive(:puts).with('Pushing master to Heroku')
+      deployer.push_repo
+    end
+
+    it 'pushes repo to heroku' do
+      expected_call = 'git push -f git@heroku.com:app.git master'
+      system_caller.should_receive(:execute).with(expected_call)
+      deployer.push_repo
+    end
+  end
+
+  describe "#run_migrations" do
+    before do
+      system_caller.stub(:execute)
+    end
+
+    it 'displays message' do
+      formatter.should_receive(:puts).with('Running database migrations')
+      deployer.run_migrations
+    end
+
+    it 'pushes repo to heroku' do
+      expected_call = 'heroku run rake db:migrate --app app'
+      system_caller.should_receive(:execute).with(expected_call)
+      deployer.run_migrations
+    end
+  end
+
+  describe "#app_restart" do
+    it 'displays message' do
+      formatter.should_receive(:puts).with('Restarting application')
+      deployer.app_restart
+    end
+
+    it 'restarts your heroku instance' do
+      heroku.should_receive(:post_ps_restart).with(app_name)
+      deployer.app_restart
+    end
+  end
+
+  describe "#warm_instance" do
+    before do
+      system_caller.stub(:execute)
+    end
+
+    it 'displays message' do
+      expected_notice = 'Accessing application_url to warm up your application'
+      formatter.should_receive(:puts).with(expected_notice)
+      deployer.warm_instance(0)
+    end
+
+    it 'pings application url' do
+      expected_call = 'curl -Il http://application_url'
+      system_caller.should_receive(:execute).with(expected_call)
+      deployer.warm_instance(0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: heroku-api
   requirement: !ruby/object:Gem::Requirement
@@ -43,9 +75,13 @@ files:
 - README.md
 - Rakefile
 - lib/paratrooper.rb
+- lib/paratrooper/default_formatter.rb
 - lib/paratrooper/deploy.rb
+- lib/paratrooper/system_caller.rb
 - lib/paratrooper/version.rb
 - paratrooper.gemspec
+- spec/paratrooper/deploy_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/hashrocket/paratrooper
 licenses: []
 post_install_message: 
@@ -70,4 +106,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Library to create task for deployment to Heroku
-test_files: []
+test_files:
+- spec/paratrooper/deploy_spec.rb
+- spec/spec_helper.rb