fourchette 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c9f8cf3c1ab81a0d6e9dccfe8bcdc3c514e63cb
-  data.tar.gz: e45ab1fae384d7d27177547d22f5bcaf45a4df79
+  metadata.gz: 87df619b48e95219f34009934e3a32ef4433d059
+  data.tar.gz: a6885be58afb51d2c87d7131df0b6b77c330c49a
 SHA512:
-  metadata.gz: 72e449f543a1a0236c55b3032ce8369ebfcc085c5b19bcaa3f29e1edf2963ac2c811c8afb567825a2d4f4052f9bc38a230f127e9ffe599b31bb514b6366b1930
-  data.tar.gz: a0408665d2915e8f03dd0db64b8abf4913086c522f0fd33f2499a9723ac562e8e45e8a55371527f682566ddf55c7dfc48d9a9e9916f777e2c9d339da34a743e5
+  metadata.gz: 6d3aa7737f01674126abf2bb3d7ebe7df059ad2bb82272e43ff74cad82503bef15b64c57148d55cee990e72de37a6f55694c1f9f9cacd4d9b510aeb2c2dca154
+  data.tar.gz: 7324d4a14c3a4b7c252646e26fe56db2e6087d8fba84447ad015406be800d86d18b5f2c6c0247e25bafe7480690e2e1490bb85b4cd17e32b122905d709d014f4

data/README.md

@@ -11,13 +11,25 @@
   <a href="http://badge.fury.io/rb/fourchette"><img src="https://badge.fury.io/rb/fourchette.svg" alt="Gem Version" height="18"></a>
 </p>
 
-**IMPORTANT: this is a work in progress, use at your own risk.**
-
 Fourchette is your new best friend for having isolated testing environements. 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.
 
 **IMPORTANT: Please note that forking your Heroku app means it will copy the same addon plans and that you will pay for multiple apps and their addons. Watch out!**
 
-## Flow
+## Table of content
+1. How does that work exactly?
+- Features
+- Installation
+  * Configuration
+  * Enable your Fourchette instance
+  * Enable, disable, update or delete the hook
+  * Before & after steps, aka, callbacks
+- Rake tasks
+- Async processing note
+- Contribute
+  - Logging
+- Contributors
+
+## How does that work exactly?
 
 - a PR is created against your GitHub project
 - Fourchette receives an event via GitHub Hooks
@@ -26,24 +38,12 @@ Fourchette is your new best friend for having isolated testing environements. It
 - closing the PR will delete the forked app
 - re-opening the PR will re-create a fork
 
-## Diagram
-
-Seriously? You need a diagram for that? Nope. Not going to do this. PRs accepted...I guess.
-
-## Features
-- single project
-- configuration is made via environement variables
-- async processing
-- it works, but that's about it for now
-
 ## Installation
 
-Those steps could be made way easier, but this is a really minimal implementation.
-
-1. Add `gem 'fourchette'` to your `Gemfile`
-2. Run `bundle install`
-3. Add `require 'fourchette/rake_tasks'` to your `Rakefile`
-4. Create a `Procfile` and a `config.ru` (using the ones from this repo as example)
+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)
+4. run `git init && git add . && git commit -m "Initial commit :tada:"`
 5. push to Heroku
 6. configure the right environement variables (see [#configuration](#configuration))
 7. Enable your Fourchette instance
@@ -53,7 +53,6 @@ Those steps could be made way easier, but this is a really minimal implementatio
 - `export FOURCHETTE_GITHUB_PROJECT="jipiboily/fourchette"`
 - `export FOURCHETTE_GITHUB_USERNAME="jipiboily"`
 - `export FOURCHETTE_GITHUB_PERSONAL_TOKEN='a token here...'` # You can create one here: https://github.com/settings/applications
-- `export FOURCHETTE_HEROKU_USERNAME='me@domain'`
 - `export FOURCHETTE_HEROKU_API_KEY='API key here'`
 - `export FOURCHETTE_HEROKU_APP_TO_FORK='the name of the app to fork from'`
 - `export FOURCHETTE_APP_URL="http://fourchette-app.herokuapp.com"`
@@ -108,17 +107,6 @@ If you want the maximum output in your GitHub comments, set this environment var
 export DEBUG='true'
 ```
 
-## It needs some love...
-
-What needs to be improved?
-
-- currently, it is assuming everything goes well, very little to no error management. This needs to improved.
-- make it simpler to bootstrap a Fourchette app (possibily a rake task to generate the required files and callback overrides)
-- it is not serious until there are specs for it, so add specs for that once we have a solid direction
-- security improvements (we should not accept hooks from anyone else than GitHub)
-- oAuth instead of GitHub token?
-- multi project would be great
-
 # Contributors
 
 Thanks to [@jpsirois](https://github.com/jpsirois/) for the logo!

data/bin/fourchette

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+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."
+    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|
+        copy_file(file_name, "#{name}/#{file_name}")
+      end
+
+      # Run bundle install
+      run("bundle install --gemfile #{name}/Gemfile")
+    end
+  end 
+end
+
+Fourchette::CLI.source_root(File.expand_path("../../templates", __FILE__))
+Fourchette::CLI.start(ARGV)

data/fourchette.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sinatra-contrib"
   spec.add_dependency "octokit"
   spec.add_dependency "git"
-  spec.add_dependency "heroics", "0.0.2"
   spec.add_dependency "heroku" # Deprecated, but best/easiest solution for the pgbackups...
+  spec.add_dependency 'platform-api', '~> 0.2.0'
   spec.add_dependency "sucker_punch"
 
   spec.add_development_dependency 'foreman'

data/lib/fourchette.rb

@@ -1,8 +1,7 @@
 require "fourchette/version"
 require 'sinatra'
 require 'json'
-require 'cgi' # Required for Heroics
-require 'heroics'
+require 'platform-api'
 require 'octokit'
 require 'git'
 require 'sucker_punch'
@@ -30,6 +29,8 @@ end
 
 module Fourchette
   DEBUG = ENV['DEBUG'] ? true : false
+
+  class DeployException < StandardError; end
 end
 
 require_relative 'fourchette/logger'

data/lib/fourchette/callbacks.rb

@@ -6,10 +6,10 @@ class Fourchette::Callbacks
   end
 
   def before
-    logger.info 'Running before steps...'
+    logger.info 'Placeholder for before steps...'
   end
 
   def after
-    logger.info 'Running after steps...'
+    logger.info 'Placeholder for after steps...'
   end
 end

data/lib/fourchette/fork.rb

@@ -10,59 +10,23 @@ class Fourchette::Fork
   def update
     create_unless_exists
 
-    heroku_git_url = @heroku.git_url(fork_name)
-
-    FileUtils.rm_rf('tmp/')
-
-    # Add key to current
-    logger.info "Creating an SSH key"
-    key_path = "~/.ssh/id_rsa-fourchette"
-    public_key_path = "#{key_path}.pub"
-    `ssh-keygen -t rsa -C "temporary@fourchetteapp" -N "" -f #{key_path} -q`
-    public_key_content = `cat #{public_key_path}`
-
-    # Create SSH config file, so that it uses the right SSH key
-    ssh_config_path = "~/.ssh/config"
-    if `cat #{ssh_config_path}`.length == 0
-      # Set the SSH key used, and disable strict host key checking
-      `echo "Host heroku.com\n IdentityFile #{key_path}\n StrictHostKeyChecking no" >> ~/.ssh/config`
-    end
-
-    # Add SSH key to the Heroku account
-    logger.info "Adding the SSH key to your Heroku account"
-    heroku_public_key = @heroku.client.key.create(public_key: public_key_content)
-
-    # Clone & push
-    logger.info "Cloning repository..."
-    repo = Git.clone(github_git_url, 'tmp')
-    repo.checkout(branch_name)
+    options = {
+      source_blob: {
+          url: "https://github.com/#{ENV['FOURCHETTE_GITHUB_PROJECT']}/archive/#{branch_name}.tar.gz?token=#{ENV['FOURCHETTE_GITHUB_PERSONAL_TOKEN']}"
+        }
+    }
+
+    build = @heroku.client.build.create(fork_name, options)
+    monitor_build(build)
+  end
 
-    # TODO - HACK ALERT - Next couple lines are really hacky, and used
-    # instead of calling `git push heroku my_branch_name:master`
-    begin
-      repo.branch('master').delete
-    rescue Git::GitExecuteError
-      # There is no master branch? Hmmm
+  def monitor_build build
+    build_info = @heroku.client.build.info(fork_name, build['id'])
+    while build_info['status'] == 'pending'
+      build_info = @heroku.client.build.info(fork_name, build['id'])
+      sleep 5
     end
-    
-    begin
-      repo.branch('master').merge(branch_name)
-    rescue Git::GitExecuteError
-      # TODO - HACK ALERT! There is certainly a cleaner way to do this...
-    end
-    repo.add_remote('heroku', heroku_git_url)
-
-    logger.info "Pushing to Heroku..."
-    repo.push(repo.remote('heroku'))
-    logger.info "Done pushing to Heroku, apparently!"
-
-    # REMOVE key to the Heroku account
-    logger.info "Removing SSH key from your Heroku account"
-    @heroku.client.key.delete(heroku_public_key['id'])
-
-    # Remove ssh key
-    logger.info "Removing SSH key for file system"
-    FileUtils.rm_rf("~./ssh/id_rsa-fourchette*")
+    fail Fourchette::DeployException if build_info['status'] == 'failed'
   end
 
   def create
@@ -82,12 +46,8 @@ class Fourchette::Fork
     "#{ENV['FOURCHETTE_HEROKU_APP_PREFIX']}-PR-#{pr_number}".downcase # It needs to be lowercase only.
   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")
-  end
-
   def branch_name
-    "remotes/origin/#{@params['pull_request']['head']['ref']}"
+    @params['pull_request']['head']['ref']
   end
 
   def pr_number

data/lib/fourchette/github.rb

@@ -72,7 +72,7 @@ class Fourchette::GitHub
 
   def enable(hook)
     if hook.active
-      logger.error 'The hook is already active, dude!'
+      logger.error 'The hook is already active!'
     else
       toggle_active_state_to hook, true
     end

data/lib/fourchette/heroku.rb

@@ -18,13 +18,9 @@ class Fourchette::Heroku
   end
 
   def client
-    # TODO: add caching... https://github.com/heroku/heroics/#client-side-caching
     unless @heroku_client
-      username = CGI.escape(ENV['FOURCHETTE_HEROKU_USERNAME'])
-      token = ENV['FOURCHETTE_HEROKU_API_KEY']
-      url = "https://#{username}:#{token}@api.heroku.com/schema"
-      options = {default_headers: {'Accept' => 'application/vnd.heroku+json; version=3'}}
-      @heroku_client = Heroics.client_from_schema_url(url, options)
+      api_key = ENV['FOURCHETTE_HEROKU_API_KEY']
+      @heroku_client = PlatformAPI.connect(api_key)
     end
     @heroku_client
   end

data/lib/fourchette/version.rb

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

data/templates/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'puma'
+gem 'fourchette'

data/templates/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -C config/puma.rb

data/templates/Rakefile

@@ -0,0 +1 @@
+require 'fourchette/rake_tasks'

data/templates/callbacks.rb

@@ -0,0 +1,16 @@
+# This is a sample
+class Fourchette::Callbacks
+  include Fourchette::Logger
+
+  def initialize params
+    @params = params
+  end
+
+  def before
+    logger.info 'Placeholder for before steps... (see callbacks.rb to override)'
+  end
+
+  def after
+    logger.info 'Placeholder for after steps... (see callbacks.rb to override)'
+  end
+end

data/templates/config.ru

@@ -0,0 +1,3 @@
+require 'fourchette'
+require 'callbacks'
+run Sinatra::Application

data/templates/config/puma.rb

@@ -0,0 +1,8 @@
+workers Integer(ENV['PUMA_WORKERS'] || 5)
+threads Integer(ENV['PUMA_MIN_THREADS']  || 1), Integer(ENV['PUMA_MAX_THREADS'] || 16)
+
+preload_app!
+
+rackup      DefaultRackup
+port        ENV['PORT']     || 9292
+environment ENV['RACK_ENV'] || 'development'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fourchette
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jean-Philippe Boily
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: heroics
+  name: heroku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: heroku
+  name: platform-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,8 @@ description: Fourchette is your new best friend for having isolated testing envi
   only the code that requires testing.
 email:
 - j@jipi.ca
-executables: []
+executables:
+- fourchette
 extensions: []
 extra_rdoc_files: []
 files:
@@ -196,6 +197,7 @@ files:
 - Procfile
 - README.md
 - Rakefile
+- bin/fourchette
 - config.ru
 - fourchette.gemspec
 - lib/fourchette.rb
@@ -214,6 +216,12 @@ files:
 - spec/lib/fourchette/pull_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/silent-logger.rb
+- templates/Gemfile
+- templates/Procfile
+- templates/Rakefile
+- templates/callbacks.rb
+- templates/config.ru
+- templates/config/puma.rb
 homepage: https://github.com/jipiboily/fourchette
 licenses:
 - MIT