jw-heroku-rails 0.4.6

data/lib/heroku/rails/tasks.rb

@@ -0,0 +1,232 @@
+require 'heroku-rails'
+
+HEROKU_CONFIG_FILE = File.join(HerokuRails::Config.root, 'config', 'heroku.yml')
+HEROKU_CONFIG = HerokuRails::Config.new(HEROKU_CONFIG_FILE)
+HEROKU_RUNNER = HerokuRails::Runner.new(HEROKU_CONFIG)
+
+# create all the the environment specific tasks
+(HEROKU_CONFIG.apps).each do |heroku_env, app_name|
+  desc "Select #{heroku_env} Heroku app for later commands"
+  task heroku_env do
+
+    # callback switch_environment
+    @heroku_app = {:env => heroku_env, :app_name => app_name}
+    Rake::Task["heroku:switch_environment"].reenable
+    Rake::Task["heroku:switch_environment"].invoke
+
+    HEROKU_RUNNER.add_environment(heroku_env)
+  end
+end
+
+desc 'Select all Heroku apps for later command'
+task :all do
+  HEROKU_RUNNER.all_environments
+end
+
+namespace :heroku do
+  def system_with_echo(*args)
+    HEROKU_RUNNER.system_with_echo(*args)
+  end
+
+  desc 'Add git remotes for all apps in this project'
+  task :remotes => :all do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo("git remote add #{heroku_env} #{repo}")
+    end
+  end
+
+  desc 'Lists configured apps'
+  task :apps => :all do
+    puts "\n"
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      puts "#{heroku_env} maps to the Heroku app #{app_name} located at:"
+      puts "  #{repo}"
+      puts
+    end
+  end
+
+  desc "Get remote server information on the heroku app"
+  task :info do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku info --app #{app_name}"
+      puts "\n"
+    end
+  end
+
+  desc "Get config settings on the heroku app"
+  task :config do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku config --app #{app_name}"
+      puts "\n"
+    end
+  end
+
+  namespace :maintenance do
+    desc "turn on maintenance page for the heroku app"
+    task :on do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        system_with_echo "heroku maintenance:on --app #{app_name}"
+        puts "\n"
+      end
+    end
+
+    desc "turn off maintenance page for the heroku app"
+    task :off do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        system_with_echo "heroku maintenance:off --app #{app_name}"
+        puts "\n"
+      end
+    end
+  end
+
+  desc "Deploys, migrates and restarts latest code"
+  task :deploy => "heroku:before_deploy" do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      puts "\n\nDeploying to #{app_name}..."
+      # set the current heroku_app so that callbacks can read the data
+      @heroku_app = {:env => heroku_env, :app_name => app_name, :repo => repo}
+      Rake::Task["heroku:before_each_deploy"].reenable
+      Rake::Task["heroku:before_each_deploy"].invoke(app_name)
+
+      rake_cmd = HEROKU_CONFIG.rake_cmd(heroku_env)
+
+      branch = `git branch`.scan(/^\* (.*)\n/).flatten.first.to_s
+      if branch.present?
+        @git_push_arguments ||= []
+        system_with_echo "git push #{repo} #{@git_push_arguments.join(' ')} #{branch}:master && #{rake_cmd} --app #{app_name} db:migrate && heroku restart --app #{app_name}"
+      else
+        puts "Unable to determine the current git branch, please checkout the branch you'd like to deploy"
+        exit(1)
+      end
+      Rake::Task["heroku:after_each_deploy"].reenable
+      Rake::Task["heroku:after_each_deploy"].invoke(app_name)
+      puts "\n"
+    end
+    Rake::Task["heroku:after_deploy"].invoke
+  end
+
+  # Callback before all deploys
+  task :before_deploy do
+  end
+
+  # Callback after all deploys
+  task :after_deploy do
+  end
+
+  # Callback before each deploy
+  task :before_each_deploy, [:app_name] do |t,args|
+  end
+
+  # Callback after each deploy
+  task :after_each_deploy, [:app_name] do |t,args|
+  end
+
+  # Callback for when we switch environment
+  task :switch_environment do
+  end
+
+  desc "Force deploys, migrates and restarts latest code"
+  task :force_deploy do
+    @git_push_arguments ||= []
+    @git_push_arguments << '--force'
+    Rake::Task["heroku:deploy"].execute
+  end
+
+  desc "Captures a bundle on Heroku"
+  task :capture do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku bundles:capture --app #{app_name}"
+    end
+  end
+
+  desc "Opens a remote console"
+  task :console do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku console --app #{app_name}"
+    end
+  end
+
+  desc "Shows the Heroku logs"
+  task :logs do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku logs --app #{app_name}"
+    end
+  end
+
+  desc "Restarts remote servers"
+  task :restart do
+    HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+      system_with_echo "heroku restart --app #{app_name}"
+    end
+  end
+
+  namespace :setup do
+
+    desc "Creates the apps on Heroku"
+    task :apps do
+      HEROKU_RUNNER.setup_apps
+    end
+
+    desc "Setup the Heroku stacks from heroku.yml config"
+    task :stacks do
+      HEROKU_RUNNER.setup_stacks
+    end
+
+    desc "Setup the Heroku collaborators from heroku.yml config"
+    task :collaborators do
+      HEROKU_RUNNER.setup_collaborators
+    end
+
+    desc "Setup the Heroku environment config variables from heroku.yml config"
+    task :config do
+      HEROKU_RUNNER.setup_config
+    end
+
+    desc "Setup the Heroku addons from heroku.yml config"
+    task :addons do
+      HEROKU_RUNNER.setup_addons
+    end
+
+    desc "Setup the Heroku domains from heroku.yml config"
+    task :domains do
+      HEROKU_RUNNER.setup_domains
+    end
+  end
+
+  desc "Setup Heroku deploy environment from heroku.yml config"
+  task :setup => [
+    "heroku:setup:apps",
+    "heroku:setup:stacks",
+    "heroku:setup:collaborators",
+    "heroku:setup:config",
+    "heroku:setup:addons",
+    "heroku:setup:domains",
+  ]
+
+  namespace :db do
+    desc "Migrates and restarts remote servers"
+    task :migrate do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        rake_cmd = HEROKU_CONFIG.rake_cmd(heroku_env)
+        system_with_echo "#{rake_cmd} --app #{app_name} db:migrate && heroku restart --app #{app_name}"
+      end
+    end
+
+    desc "Pulls the database from heroku and stores it into db/dumps/"
+    task :pull do
+      HEROKU_RUNNER.each_heroku_app do |heroku_env, app_name, repo|
+        system_with_echo "heroku pgdumps:capture --app #{app_name}"
+        dump = `heroku pgdumps --app #{app_name}`.split("\n").last.split(" ").first
+        system_with_echo "mkdir -p #{HerokuRails::Config.root}/db/dumps"
+        file = "#{HerokuRails::Config.root}/db/dumps/#{dump}.sql.gz"
+        url = `heroku pgdumps:url --app #{app_name} #{dump}`.chomp
+        system_with_echo "wget", url, "-O", file
+
+        # TODO: these are a bit distructive...
+        # system_with_echo "rake db:drop db:create"
+        # system_with_echo "gunzip -c #{file} | #{HerokuRails::Config.root}/script/dbconsole"
+        # system_with_echo "rake jobs:clear"
+      end
+    end
+  end
+end

data/spec/fixtures/heroku-config.yml

@@ -0,0 +1,48 @@
+apps:
+  production: awesomeapp
+  staging: awesomeapp-staging
+
+stacks:
+  all: bamboo-mri-1.9.2
+  staging: bamboo-ree-1.8.7
+
+config:
+  all:
+    BUNDLE_WITHOUT: "test:development"
+    CONFIG_VAR1: "config1"
+    CONFIG_VAR2: "config2"
+
+  production:
+    CONFIG_VAR1: "config1-production"
+
+  staging:
+    CONFIG_VAR1: "config1-staging"
+    STAGING_CONFIG: "special-staging"
+
+collaborators:
+  all:
+    - "all-user1@somedomain.com"
+    - "all-user2@somedomain.com"
+    - "all-user2@somedomain.com"
+  staging:
+    - "staging-user@somedomain.com"
+  production:
+    - "production-user@somedomain.com"
+
+domains:
+  staging:
+    - "staging.awesomeapp.com"
+  production:
+    - "awesomeapp.com"
+    - "www.awesomeapp.com"
+
+addons:
+  all:
+    # add any other addons here
+    - custom_domains:basic
+    - newrelic:bronze
+
+  production:
+    # list production env specific addons here
+    - ssl:piggyback
+    - cron:daily

data/spec/heroku/rails/heroku_config_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+module HerokuRails
+  describe Config do
+    before(:each) do
+      @config = Config.new(config_path("heroku-config.yml"))
+    end
+
+    it "should read the configuration file" do
+      @config.settings.should_not be_empty
+    end
+
+    describe "#apps" do
+      it "should return the list of apps defined" do
+        @config.apps.should have(2).apps
+        @config.apps.should include("production" => "awesomeapp")
+        @config.apps.should include("staging" => "awesomeapp-staging")
+      end
+    end
+
+    describe "#app_names" do
+      it "should return the list of apps defined" do
+        @config.app_names.should have(2).names
+        @config.app_names.should include("awesomeapp")
+        @config.app_names.should include("awesomeapp-staging")
+      end
+    end
+
+    describe "#app_environments" do
+      it "should return a list of the environments defined" do
+        @config.app_environments.should have(2).environments
+        @config.app_environments.should include("production")
+        @config.app_environments.should include("staging")
+      end
+    end
+
+    describe "#stack" do
+      it "should return the associated stack for an environment" do
+        @config.stack("staging").should == "bamboo-ree-1.8.7"
+      end
+
+      it "should default to the all setting if not explicitly defined" do
+        @config.stack("production").should == "bamboo-mri-1.9.2"
+      end
+    end
+
+    describe "#config" do
+      context "staging environment" do
+        before(:each) do
+          @config = @config.config("staging")
+        end
+        it "should include configs defined in 'staging'" do
+          @config["STAGING_CONFIG"].should == "special-staging"
+        end
+
+        it "should include configs defined in 'all'" do
+          @config["BUNDLE_WITHOUT"].should == "test:development"
+        end
+
+        it "should use configs defined in 'staging' ahead of configs defined in 'all'" do
+          @config["CONFIG_VAR1"].should == "config1-staging"
+        end
+      end
+    end
+
+    describe "#collaborators" do
+      context "staging environment" do
+        before(:each) do
+          @collaborators = @config.collaborators('staging')
+        end
+
+        it "should include the collaborators defined in 'all'" do
+          @collaborators.should include('all-user1@somedomain.com')
+          @collaborators.should include('all-user2@somedomain.com')
+          @collaborators.should have(3).collaborators
+        end
+
+        it "should include collaborators defined in 'staging'" do
+          @collaborators.should include('staging-user@somedomain.com')
+        end
+
+        it "should not include collaborators defined in 'production'" do
+          @collaborators.should_not include('production-user@somedomain.com')
+        end
+      end
+    end
+
+    describe "#domains" do
+      context "staging environment" do
+        before(:each) do
+          @domains = @config.domains('staging')
+        end
+
+        it "should include the domains defined in 'staging'" do
+          @domains.should include('staging.awesomeapp.com')
+        end
+
+        it "should not include the domains defined in 'production'" do
+          @domains.should_not include('awesomeapp.com')
+          @domains.should_not include('www.awesomeapp.com')
+        end
+      end
+
+      context "production environment" do
+        it "should include the domains defined in 'production'" do
+          @domains = @config.domains('production')
+          @domains.should include('awesomeapp.com')
+          @domains.should include('www.awesomeapp.com')
+        end
+      end
+    end
+
+    describe "#addons" do
+      context "staging environment" do
+        before(:each) do
+          @addons = @config.addons('staging')
+        end
+
+        it "should include addons defined in 'all'" do
+          @addons.should include('custom_domains:basic')
+          @addons.should include('newrelic:bronze')
+        end
+
+        it "should not include addons defined in 'production'" do
+          @addons.should_not include('ssl:piggyback')
+        end
+      end
+    end
+
+  end
+end

data/spec/heroku/rails/heroku_runner_spec.rb

@@ -0,0 +1 @@
+# needz moar test!

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'heroku-rails'
+require 'bundler/setup'
+
+
+RSpec.configure do |c|
+  # setup fixtures path
+  c.before(:all) do
+    @fixture_path = Pathname.new(File.join(File.dirname(__FILE__), "/fixtures"))
+    raise "Fixture folder not found: #{@fixture_path}" unless @fixture_path.directory?
+  end
+
+  # returns the file path of a fixture setting file
+  def config_path(filename)
+    @fixture_path.join(filename)
+  end
+
+end
+

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jw-heroku-rails
+version: !ruby/object:Gem::Version
+  version: 0.4.6
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Whitmire
+- Elijah Miller
+- Glenn Roberts
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Manage multiple Heroku instances/apps for a single Rails app using Rake.
+  It's the Capistrano for Heroku, without the suck.
+email: jeff@jwhitmire.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- TODO
+- CHANGELOG
+files:
+- lib/generators/heroku/config_generator.rb
+- lib/generators/templates/heroku.rake
+- lib/generators/templates/heroku.yml
+- lib/heroku/rails/tasks.rb
+- lib/heroku-rails/config.rb
+- lib/heroku-rails/railtie.rb
+- lib/heroku-rails/runner.rb
+- lib/heroku-rails.rb
+- spec/fixtures/heroku-config.yml
+- spec/heroku/rails/heroku_config_spec.rb
+- spec/heroku/rails/heroku_runner_spec.rb
+- spec/spec_helper.rb
+- heroku-rails.gemspec
+- Gemfile
+- Gemfile.lock
+- CHANGELOG
+- LICENSE
+- Rakefile
+- README.md
+- TODO
+homepage: http://github.com/jwhitmire/heroku-rails
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2821336418249926558
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2821336418249926558
+requirements: []
+rubyforge_project: none
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Deployment and configuration tools for Heroku/Rails
+test_files:
+- spec/fixtures/heroku-config.yml
+- spec/heroku/rails/heroku_config_spec.rb
+- spec/heroku/rails/heroku_runner_spec.rb
+- spec/spec_helper.rb