heroku-forward 0.2.0 → 0.3.0

data/README.md

@@ -13,21 +13,20 @@ This gem implements a proxy using [em-proxy](https://github.com/igrigorik/em-pro
 Usage
 -----
 
-Add `heroku-forward` and `em-proxy` to your `Gemfile`. Curently requires HEAD of `em-proxy` because of [this pull request](https://github.com/igrigorik/em-proxy/pull/31).
+Add `heroku-forward` to your `Gemfile`.
 
 ``` ruby
-gem "heroku-forward", "~> 0.1"
-gem "em-proxy", ">= 0.1.8"
+gem "heroku-forward"
 ```
 
-Create an application rackup file, eg. `my_app.ru` that boots your application. Under Rails, this is the file that calls `run`.
+Create a new application rackup file, eg. `my_app.ru` that boots your application. Under Rails, this is the file that calls `run`.
 
 ``` ruby
 require ::File.expand_path('../config/environment',  __FILE__)
 run MyApp::Application
 ```
 
-Modify your rackup file as follows. Under Rails this file is called `config.ru`.
+Modify your default rackup file as follows. Under Rails this file is called `config.ru`.
 
 ``` ruby
 require 'rubygems'
@@ -42,15 +41,16 @@ env = ENV['RACK_ENV'] || 'development'
 require 'em-proxy'
 require 'logger'
 require 'heroku-forward'
+require 'heroku/forward/backends/thin'
 
 application = File.expand_path('../my_app.ru', __FILE__)
 backend = Heroku::Forward::Backends::Thin.new(application: application, env: env)
-proxy = Heroku::Forward::Proxy::Server.new(backend, { host: '0.0.0.0', port: port })
+proxy = Heroku::Forward::Proxy::Server.new(backend, host: '0.0.0.0', port: port)
 proxy.logger = Logger.new(STDOUT)
 proxy.forward!
 ```
 
-This sets up a proxy on the port requested by Heroku and runs your application with Thin.
+This sets up a proxy on the port requested by Heroku and runs your application with [Thin](http://code.macournoyer.com/thin). Other back-ends are also supported, see below.
 
 Foreman
 -------
@@ -88,27 +88,40 @@ Proxy Forwarding Options
 
 `Heroku::Forward::Proxy::Server.forward!` accepts the following options:
 
-* `delay`: number of seconds to sleep before launching the proxy, eg. `proxy.forward!(delay: 15)`. This prevents queuing of requests or reporting invalid `up` status to Heroku. It's recommended to set this value to as close as possible to the boot time of your application and less than the Heroku's 60s boot limit.
+* **delay**: number of seconds to sleep before launching the proxy, eg. `proxy.forward!(delay: 15)`. This prevents queuing of requests or reporting invalid `up` status to Heroku. It's recommended to set this value to as close as possible to the boot time of your application and less than the Heroku's 60s boot limit. Also note that the proxy itself needs time to boot.
 
-SSL
----
-Heroku-forward has SSL support by forwarding SSL arguments to Thin. Know more about Thin & SSL:
+Available Backends
+------------------
 
-```sh
-thin -h
-SSL options:
-        --ssl                        Enables SSL
-        --ssl-key-file PATH          Path to private key
-        --ssl-cert-file PATH         Path to certificate
-        --ssl-verify                 Enables SSL certificate verification
+### Thin
+
+For more information about Thin see [http://code.macournoyer.com/thin](http://code.macournoyer.com/thin).
+
+``` ruby
+require 'heroku/forward/backends/thin'
+
+application = File.expand_path('../my_app.ru', __FILE__)
+backend = Heroku::Forward::Backends::Thin.new(application: application, env: env)
+proxy = Heroku::Forward::Proxy::Server.new(backend, host: '0.0.0.0', port: port)
+proxy.forward!
 ```
 
-In order to forward SSL arguments to thin update your config.ru
+The Thin back-end supports the following options.
+
+* **application**: application to load
+* **env**: environment, eg. `:development`
+
+SSL is also supported.
+
+* **ssl**: enable SSL
+* **ssl-key-file**: path to private key
+* **ssl-cert-file**: path to certificate
+* **ssl-verify**: enable SSL certificate verification
 
 ```ruby
 options = { application: File.expand_path('../my_app.ru', __FILE__) }
 
-# branch to desable SSL depending of your environment
+# branch to disable SSL depending on your environment
 if ENV['THIN_SSL_ENABLED']
   options[:ssl] = true
   options[:ssl_verify] = true
@@ -119,10 +132,31 @@ end
 backend = Heroku::Forward::Backends::Thin.new(options)
 ```
 
+### Unicorn
+
+For more information about Unicorn see [http://unicorn.bogomips.org](http://unicorn.bogomips.org/).
+
+The Unicorn back-end supports the following options.
+
+* **application**: application to load
+* **env**: environment, eg. `:development`
+* **config_file**: Unicorn configuration file
+
+```ruby
+require 'heroku-forward'
+require 'heroku/forward/backends/unicorn'
+
+application = File.expand_path('../my_app.ru', __FILE__)
+config_file = File.expand_path('../config/unicorn.rb', __FILE__)
+backend = Heroku::Forward::Backends::Unicorn.new(application: application, env: env, config_file: config_file)
+proxy = Heroku::Forward::Proxy::Server.new(backend, host: '0.0.0.0', port: port)
+proxy.forward!
+```
+
 Fail-Safe
 ---------
 
-If you're worried about this implementation, consider building a fail-safe. Modify your `config.ru` to run without a proxy if `DISABLE_FORWARD_PROXY` is set as demonstrated in [this gist](https://gist.github.com/4263488). Add `DISABLE_FORWARD_PROXY` via `heroku config:add DISABLE_FORWARD_PROXY=1`.
+If you're worried about always using heroku-forward, consider building a fail-safe. Modify your `config.ru` to run without a proxy if `DISABLE_FORWARD_PROXY` is set as demonstrated in [this gist](https://gist.github.com/4263488). Add `DISABLE_FORWARD_PROXY` via `heroku config:add DISABLE_FORWARD_PROXY=1`.
 
 Reading Materials
 -----------------

data/lib/heroku/forward/backends.rb

@@ -1 +1,6 @@
-require 'heroku/forward/backends/thin'
+module Heroku
+  module Forward
+    module Backends
+    end
+  end
+end

data/lib/heroku/forward/backends/thin.rb

@@ -41,7 +41,7 @@ module Heroku
           spawn_with.push "--socket", @socket
           spawn_with.push "-e", @env.to_s
           spawn_with.push "--ssl" if @ssl
-          spawn_with.push " --ssl-key-file", @ssl_key_file if @ssl_key_file
+          spawn_with.push "--ssl-key-file", @ssl_key_file if @ssl_key_file
           spawn_with.push "--ssl-cert-file", @ssl_cert_file if @ssl_cert_file
           spawn_with.push "--ssl-verify" if @ssl_verify
 

data/lib/heroku/forward/backends/unicorn.rb

@@ -0,0 +1,54 @@
+module Heroku
+  module Forward
+    module Backends
+      class Unicorn
+        attr_accessor :application, :socket, :environment, :pid, :config_file
+        
+        def initialize(options = {})
+          @application = options[:application]
+          @socket = options[:socket] || tmp_filename('unicorn', '.sock')
+          @env = options[:env] || 'development'
+          @config_file = options[:config_file]
+        end
+        
+        def spawn!
+          return false if spawned?
+          check!
+          
+          args = ['unicorn']
+          args.push '--env', @env
+          args.push '--config-file', @config_file if @config_file
+          args.push '--listen', @socket
+          args.push @application
+          
+          @pid = Spoon.spawnp(*args)
+          @spawned = true
+        end
+        
+        def terminate!
+          return false unless spawned?
+          Process.kill 'QUIT', @pid
+          @spawned = false
+          true
+        end
+        
+        def spawned?
+          !!@spawned
+        end
+        
+        private
+        
+        # Borrowed from ruby 1.9's Dir::Tmpname.make_tmpname for 1.8.7-compatibility.
+        def tmp_filename(prefix, suffix)
+          File.join Dir.tmpdir, "#{prefix}#{Time.now.strftime("%Y%m%d")}-#{$$}-#{rand(0x100000000).to_s(36)}#{suffix}"
+        end
+        
+        def check!
+          raise Heroku::Forward::Errors::MissingBackendOptionError.new('application') unless @application && @application.length > 0
+          raise Heroku::Forward::Errors::MissingBackendApplicationError.new(@application) unless File.exists?(@application)
+        end
+        
+      end
+    end
+  end
+end

data/lib/heroku/forward/version.rb

@@ -1,5 +1,5 @@
 module Heroku
   module Forward
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-forward
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-proxy
@@ -156,13 +156,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: em-http-request
+  name: unicorn
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,23 +170,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: 
 email: dblock@dblock.org
 executables: []
@@ -199,6 +199,7 @@ files:
 - lib/heroku/forward.rb
 - lib/heroku/forward/backends.rb
 - lib/heroku/forward/backends/thin.rb
+- lib/heroku/forward/backends/unicorn.rb
 - lib/heroku/forward/config/locales/en.yml
 - lib/heroku/forward/errors.rb
 - lib/heroku/forward/errors/backend_failed_to_start_error.rb
@@ -225,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1460208060339317613
+      hash: -4102819039813777077
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: