fourchette 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80792e1bd7068c821be389021a9f5fed508fa191
-  data.tar.gz: 6339113cc97d55bba92d78f8682d1536e6dab04c
+  metadata.gz: 86b3fc5cd9c714d3d471d4c3d652bc7318ddbba3
+  data.tar.gz: 40ced7fbd5ec40fef7af008bc3ec741054f6f817
 SHA512:
-  metadata.gz: 0461c8fd5f5d17525ac2d53517708debf373abd46e316678448fd33e96b994f1bafcdcd3ab4e85052a926698d7b3832e5782c10005782b86073296d25c48a62b
-  data.tar.gz: 63c99b34b08815f143d9a0b034067e5aa2d2652cc759b429435c685e7262c5395d17e665352af0029da04f0c0c31d6e503640ce48d9cf7255b4285867f0aaa6b
+  metadata.gz: 8ccf7053c47fb02a12ea201ad576b23099c3438326239db955521557504a6d412c3abda99d9bd1ec82b72458255f5393705fac5b88dacec7b047b1d05fc14210
+  data.tar.gz: 713b94f1b440f409b3e6a95e203490f27f81187a28d1fd343bea199688ccbf55d19416c1b8d84c0f4491a541383f3a3c301c6e530eebcdbf98cb4a6a88f659bc

data/Gemfile

@@ -2,4 +2,4 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'puma'
+gem 'puma'

data/Guardfile

@@ -1,5 +1,5 @@
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Jean-Philippe Boily
+Copyright (c) 2014-2015 Jean-Philippe Boily
 
 MIT License
 

data/README.md

@@ -44,6 +44,16 @@ We use it a lot at [Rainforest QA](https://www.rainforestqa.com/). If you want t
 
 ## Installation
 
+You have two choices here, the easy path, or the manual path.
+
+**Easy**
+
+[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2Frainforestapp%2Ffourchette-app)
+
+**Manual**
+
+This will give you more flexibility to create before and after actions, though you could also do it with the easy path and cloning your repo, etc.
+
 1. run `gem install fourchette`
 2. run `fourchette new my-app-name`. You can replace "my-app-name" by whatever you want it, this is the name of the directory your Fourchette app will be created in.
 3. run `cd my-app-name` (replace app name, again)

data/Rakefile

@@ -1,10 +1,10 @@
-require "fourchette/rake_tasks"
+require 'fourchette/rake_tasks'
 
 begin
   require 'rspec/core/rake_task'
   # Set default Rake task to spec
   RSpec::Core::RakeTask.new(:spec)
-  task :default => :spec
+  task default: :spec
 rescue LoadError => ex
   # That's ok, it just means we don't have RSpec loaded
 end
@@ -13,4 +13,4 @@ desc 'Brings up a REPL with the code loaded'
 task :console do
   require './lib/fourchette'
   Pry.start
-end
+end

data/bin/fourchette

@@ -1,26 +1,26 @@
 #!/usr/bin/env ruby
 
-require "thor"
+require 'thor'
 
 module Fourchette
   class CLI < Thor
     include Thor::Actions
 
-    desc "new APP_NAME", "This will create a fourchette app for you under APP_NAME directory."
+    desc 'new APP_NAME', 'This will create a fourchette app for you under APP_NAME directory.'
     def new(name)
       # Create directory
       empty_directory(name)
 
       # Copy template files
-      ['Gemfile','config.ru', 'Procfile', 'Rakefile', 'config/puma.rb', 'callbacks.rb'].each do |file_name|
+      ['Gemfile', 'config.ru', 'Procfile', 'Rakefile', 'config/puma.rb', 'callbacks.rb'].each do |file_name|
         copy_file(file_name, "#{name}/#{file_name}")
       end
 
       # Run bundle install
       run("bundle install --gemfile #{name}/Gemfile")
     end
-  end 
+  end
 end
 
-Fourchette::CLI.source_root(File.expand_path("../../templates", __FILE__))
+Fourchette::CLI.source_root(File.expand_path('../../templates', __FILE__))
 Fourchette::CLI.start(ARGV)

data/fourchette.gemspec

@@ -4,34 +4,34 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fourchette/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fourchette"
+  spec.name          = 'fourchette'
   spec.version       = Fourchette::VERSION
-  spec.authors       = ["Jean-Philippe Boily"]
-  spec.email         = ["j@jipi.ca"]
-  spec.summary       = %q{Your new best friend for isolated testing environments on Heroku.}
-  spec.description   = %q{Fourchette is your new best friend for having isolated testing environment. It will help you test your GitHub PRs against a fork of one your Heroku apps. You will have one Heroku app per PR now. Isn't that amazing? It will make testing way easier and you won't have the (maybe) broken code from other PRs on staging but only the code that requires testing.}
-  spec.homepage      = "https://github.com/jipiboily/fourchette"
-  spec.license       = "MIT"
+  spec.authors       = ['Jean-Philippe Boily']
+  spec.email         = ['j@jipi.ca']
+  spec.summary       = 'Your new best friend for isolated testing environments on Heroku.'
+  spec.description   = "Fourchette is your new best friend for having isolated testing environment. It will help you test your GitHub PRs against a fork of one your Heroku apps. You will have one Heroku app per PR now. Isn't that amazing? It will make testing way easier and you won't have the (maybe) broken code from other PRs on staging but only the code that requires testing."
+  spec.homepage      = 'https://github.com/jipiboily/fourchette'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rake"
-  spec.add_dependency "sinatra"
-  spec.add_dependency "sinatra-contrib"
-  spec.add_dependency "octokit"
-  spec.add_dependency "git"
-  spec.add_dependency "heroku", "~> 3.9" # Deprecated, but best/easiest solution for pgbackups...
-  spec.add_dependency "rest-client" # required for phbackups
+  spec.add_dependency 'rake'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'sinatra-contrib'
+  spec.add_dependency 'octokit'
+  spec.add_dependency 'git'
+  spec.add_dependency 'heroku', '~> 3.9' # Deprecated, but best/easiest solution for pgbackups...
+  spec.add_dependency 'rest-client' # required for phbackups
   spec.add_dependency 'platform-api', '~> 0.2.0'
-  spec.add_dependency "sucker_punch"
-  spec.add_dependency "thor"
+  spec.add_dependency 'sucker_punch'
+  spec.add_dependency 'thor'
 
   spec.add_development_dependency 'foreman'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'terminal-notifier-guard'
   spec.add_development_dependency 'coveralls'

data/lib/fourchette.rb

@@ -1,4 +1,4 @@
-require "fourchette/version"
+require 'fourchette/version'
 require 'sinatra'
 require 'json'
 require 'platform-api'
@@ -7,16 +7,16 @@ require 'git'
 require 'sucker_punch'
 require 'rest-client'
 
+def attempt_pry
+  require 'pry'
+rescue LoadError => ex
+  puts "Oops: #{ex}"
+end
+
 # TODO: Extract this to development.rb and production.rb
 if development?
-  require "sinatra/reloader"
-
-  begin
-    require "pry"
-  rescue LoadError => ex
-    # That's ok, we don't care...it was probably loaded from another project
-    # and not to hack on Fourchette anyways!
-  end
+  require 'sinatra/reloader'
+  attempt_pry
 
   FOURCHETTE_CONFIG = {
     env_name: 'fourchette-dev'
@@ -27,7 +27,6 @@ else
   }
 end
 
-
 module Fourchette
   DEBUG = ENV['DEBUG'] ? true : false
 
@@ -42,4 +41,4 @@ require_relative 'fourchette/fork'
 require_relative 'fourchette/heroku'
 require_relative 'fourchette/pgbackups'
 require_relative 'fourchette/callbacks'
-require_relative 'fourchette/tarball'
+require_relative 'fourchette/tarball'

data/lib/fourchette/fork.rb

@@ -1,7 +1,7 @@
 class Fourchette::Fork
   include Fourchette::Logger
 
-  def initialize params
+  def initialize(params)
     @params = params
     @heroku = Fourchette::Heroku.new
     @github = Fourchette::GitHub.new
@@ -9,43 +9,40 @@ class Fourchette::Fork
 
   def update
     create_unless_exists
-    tarball = Fourchette::Tarball.new
-    tarball_url = tarball.url(github_git_url, git_branch_name, ENV['FOURCHETTE_GITHUB_PROJECT'])
-    options = {
-      source_blob: {
-          url: tarball_url
-        }
-    }
 
-    build = @heroku.client.build.create(fork_name, options)
+    build = @heroku.client.build.create(fork_name, tarball_options)
     monitor_build(build)
   end
 
-  def monitor_build build
-    logger.info "Start of the build process on Heroku..."
+  def monitor_build(build)
+    logger.info 'Start of the build process on Heroku...'
     build_info = @heroku.client.build.info(fork_name, build['id'])
     # Let's just leave some time to Heroku to download the tarball and start
     # the process. This is some random timing that seems to make sense at first.
     sleep 30
     if build_info['status'] == 'failed'
-      @github.comment_pr(pr_number, "The build failed on Heroku. See the activity tab on Heroku.")
+      @github.comment_pr(
+        pr_number, 'The build failed on Heroku. See the activity tab on Heroku.'
+      )
       fail Fourchette::DeployException
     end
   end
 
   def create
-    @github.comment_pr(pr_number, "Fourchette is initializing a new fork.") if Fourchette::DEBUG
+    @github.comment_pr(
+      pr_number, 'Fourchette is initializing a new fork.') if Fourchette::DEBUG
     create_unless_exists
     update
   end
 
   def delete
     @heroku.delete(fork_name)
-    @github.comment_pr(pr_number, "Test app deleted!")
+    @github.comment_pr(pr_number, 'Test app deleted!')
   end
 
   def fork_name
-    "#{ENV['FOURCHETTE_HEROKU_APP_PREFIX']}-PR-#{pr_number}".downcase # It needs to be lowercase only.
+    # It needs to be lowercase only.
+    "#{ENV['FOURCHETTE_HEROKU_APP_PREFIX']}-PR-#{pr_number}".downcase
   end
 
   def branch_name
@@ -57,19 +54,42 @@ class Fourchette::Fork
   end
 
   def create_unless_exists
-    unless @heroku.app_exists?(fork_name)
-      @heroku.fork(ENV['FOURCHETTE_HEROKU_APP_TO_FORK'] ,fork_name)
+    unless app_exists?
+      @heroku.fork(ENV['FOURCHETTE_HEROKU_APP_TO_FORK'], fork_name)
       post_fork_url
     end
   end
 
   private
 
+  def app_exists?
+    @heroku.app_exists?(fork_name)
+  end
+
+  def tarball_options
+    {
+      source_blob: {
+        url: tarball_url
+      }
+    }
+  end
+
+  def tarball_url
+    Fourchette::Tarball.new.url(
+      github_git_url,
+      git_branch_name,
+      ENV['FOURCHETTE_GITHUB_PROJECT']
+    )
+  end
+
   # Update PR with URL. This is a method so that we can override it and just not
   # have that, if we don't want. Use case: we have custom domains, so we post
   # the URLs later on.
   def post_fork_url
-    @github.comment_pr(pr_number, "Test URL: #{@heroku.client.app.info(fork_name)['web_url']}")
+    @github.comment_pr(
+      pr_number,
+      "Test URL: #{@heroku.client.app.info(fork_name)['web_url']}"
+    )
   end
 
   def git_branch_name
@@ -77,6 +97,11 @@ class Fourchette::Fork
   end
 
   def github_git_url
-    @params['pull_request']['head']['repo']['clone_url'].gsub("//github.com", "//#{ENV['FOURCHETTE_GITHUB_USERNAME']}:#{ENV['FOURCHETTE_GITHUB_PERSONAL_TOKEN']}@github.com")
+    @params['pull_request']['head']['repo']['clone_url']
+      .gsub(
+        '//github.com',
+        "//#{ENV['FOURCHETTE_GITHUB_USERNAME']}:" \
+        "#{ENV['FOURCHETTE_GITHUB_PERSONAL_TOKEN']}@github.com"
+      )
   end
 end

data/lib/fourchette/github.rb

@@ -29,14 +29,25 @@ class Fourchette::GitHub
     octokit.remove_hook(ENV['FOURCHETTE_GITHUB_PROJECT'], fourchette_hook.id)
   end
 
-  def comment_pr pr_number, comment
-    comment = "****** FOURCHETTE COMMENT ******\n\n#{comment}\n\n****** END OF FOURCHETTE COMMENT ******" if Fourchette::DEBUG
+  def comment_pr(pr_number, comment)
+    if Fourchette::DEBUG
+      comment = <<-TXT
+        ****** FOURCHETTE COMMENT ******\n
+        \n#{comment}\n\n
+        ****** END OF FOURCHETTE COMMENT ******
+      TXT
+    end
+
     octokit.add_comment(ENV['FOURCHETTE_GITHUB_PROJECT'], pr_number, comment)
   end
 
   private
+
   def octokit
-    @octokit_client ||= Octokit::Client.new(login: ENV['FOURCHETTE_GITHUB_USERNAME'], password: ENV['FOURCHETTE_GITHUB_PERSONAL_TOKEN'])
+    @octokit_client ||= Octokit::Client.new(
+      login: ENV['FOURCHETTE_GITHUB_USERNAME'],
+      password: ENV['FOURCHETTE_GITHUB_PERSONAL_TOKEN']
+    )
   end
 
   def create_hook
@@ -44,18 +55,20 @@ class Fourchette::GitHub
     octokit.create_hook(
       ENV['FOURCHETTE_GITHUB_PROJECT'],
       'web',
-      {
-        url: "#{ENV['FOURCHETTE_APP_URL']}/hooks",
-        content_type: 'json',
-        fourchette_env: FOURCHETTE_CONFIG[:env_name]
-      },
-      {
-        :events => ['pull_request'],
-        :active => true
-      }
+      hook_options,
+      events: ['pull_request'],
+      active: true
     )
   end
 
+  def hook_options
+    {
+      url: "#{ENV['FOURCHETTE_APP_URL']}/hooks",
+      content_type: 'json',
+      fourchette_env: FOURCHETTE_CONFIG[:env_name]
+    }
+  end
+
   def hooks
     octokit.hooks(ENV['FOURCHETTE_GITHUB_PROJECT'])
   end
@@ -82,20 +95,14 @@ class Fourchette::GitHub
     toggle_active_state_to hook, false
   end
 
-  def toggle_active_state_to hook, active_value
+  def toggle_active_state_to(hook, active_value)
     octokit.edit_hook(
       ENV['FOURCHETTE_GITHUB_PROJECT'],
       hook.id,
       'web',
-      {
-        url: "#{ENV['FOURCHETTE_APP_URL']}/hooks",
-        content_type: 'json',
-        fourchette_env: FOURCHETTE_CONFIG[:env_name]
-      },
-      {
-        :events => ['pull_request'],
-        :active => active_value
-      }
+      hook_options,
+      events: ['pull_request'],
+      active: active_value
     )
   end
 end

data/lib/fourchette/heroku.rb

@@ -1,88 +1,92 @@
 class Fourchette::Heroku
   include Fourchette::Logger
 
-  def app_exists? name
-    client.app.list.collect { |app| app if app['name'] == name }.reject(&:nil?).any?
+  EXCEPTIONS = [
+    Excon::Errors::UnprocessableEntity,
+    Excon::Errors::ServiceUnavailable
+  ]
+
+  def app_exists?(name)
+    client.app.list.collect do |app|
+      app if app['name'] == name
+    end.reject(&:nil?).any?
   end
 
-  def fork from, to
+  def fork(from, to)
     create_app(to)
     copy_config(from, to)
     copy_add_ons(from, to)
     copy_pg(from, to)
-    copy_RACK_AND_RAILS_ENV_again(from, to)
+    copy_rack_and_rails_env_again(from, to)
   end
 
-  def delete app_name
+  def delete(app_name)
     logger.info "Deleting #{app_name}"
     client.app.delete(app_name)
   end
 
   def client
-    unless @heroku_client
-      api_key = ENV['FOURCHETTE_HEROKU_API_KEY']
-      @heroku_client = PlatformAPI.connect(api_key)
-    end
-    @heroku_client
+    api_key = ENV['FOURCHETTE_HEROKU_API_KEY']
+    @heroku_client ||= PlatformAPI.connect(api_key)
   end
 
-  def config_vars app_name
+  def config_vars(app_name)
     client.config_var.info(app_name)
   end
 
-  def git_url app_name
+  def git_url(app_name)
     client.app.info(app_name)['git_url']
   end
 
-  def create_app name
+  def create_app(name)
     logger.info "Creating #{name}"
-    client.app.create({ name: name })
+    client.app.create(name: name)
   end
 
-  def copy_config from, to
+  def copy_config(from, to)
     logger.info "Copying configs from #{from} to #{to}"
     from_congig_vars = config_vars(from)
     # WE SHOULD NOT MOVE THE HEROKU_POSTGRES_*_URL or DATABASE_URL...
-    from_congig_vars.reject! { |k, v| k.start_with?('HEROKU_POSTGRESQL_') && k.end_with?('_URL') }
-    from_congig_vars.reject! { |k, v| k == ('DATABASE_URL') }
+    from_congig_vars.reject! do |k, _v|
+      k.start_with?('HEROKU_POSTGRESQL_') && k.end_with?('_URL')
+    end
+    from_congig_vars.reject! { |k, _v| k == ('DATABASE_URL') }
     client.config_var.update(to, from_congig_vars)
   end
 
-  def copy_add_ons from, to
+  def copy_add_ons(from, to)
     logger.info "Copying addons from #{from} to #{to}"
     from_addons = client.addon.list(from)
     from_addons.each do |addon|
       name = addon['plan']['name']
       begin
         logger.info "Adding #{name} to #{to}"
-        client.addon.create(to, { plan: name })
-      rescue Excon::Errors::UnprocessableEntity => e
+        client.addon.create(to, plan: name)
+      rescue *EXCEPTIONS => e
         logger.error "Failed to copy addon #{name}"
         logger.error e
       end
     end
   end
 
-  def copy_pg from, to
+  def copy_pg(from, to)
     if pg_enabled?(from)
       logger.info "Copying Postgres's data from #{from} to #{to}"
       backup = Fourchette::Pgbackups.new
-      logger.info backup.copy(from, to)
+      backup.copy(from, to)
     else
       logger.info "Postgres not enabled on #{from}. Skipping data copy."
     end
   end
 
-  def copy_RACK_AND_RAILS_ENV_again(from, to)
+  def copy_rack_and_rails_env_again(from, to)
     env_to_update = get_original_env(from)
-    unless env_to_update.empty?
-      client.config_var.update(to, env_to_update)
-    end
+    client.config_var.update(to, env_to_update) unless env_to_update.empty?
   end
 
   def get_original_env(from)
     environments = {}
-    ['RACK_ENV', 'RAILS_ENV'].each do |var|
+    %w(RACK_ENV RAILS_ENV).each do |var|
       if client.config_var.info(from)[var]
         environments[var] = client.config_var.info(from)[var]
       end
@@ -92,7 +96,7 @@ class Fourchette::Heroku
 
   def pg_enabled?(app)
     client.addon.list(app).any? do |addon|
-      addon['addon_service']['name'] == 'Heroku Postgres'
+      addon['addon_service']['name'] =~ /heroku.postgres/i
     end
   end
 end