heroku-bouncer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6758e63ada289a67c98dfdd75ac078539adf76b1
-  data.tar.gz: 42bd2f4be9cda6bbb7adf8079fe5d256c9be5e7c
+  metadata.gz: 46e27351842e97990f1f62956aeded88e3f0bae4
+  data.tar.gz: 541142e69b9b117107cb279b06a89126912ff139
 SHA512:
-  metadata.gz: eea8f556d0c0b6fa6fe9894a0d7e75ff7a24a2ad468a6612a8b3a704aae32f32f89f23074bbfa2b4fbfdb45e40a80d8f58532d3df0ef18f09c451ec82df859af
-  data.tar.gz: 6c67c0eeac7851fb9702e04f6565c0e08d02341820768470f580392cc811c38329ed33ca64b4776e3b04aa5eaf9e16bb471dd1d80206c1a85ab5bde5482f6e61
+  metadata.gz: c16e1aef5ea19f40c9f74f5d289281b30c6454d982ead1523f942a9c698359e46f091161d1ddeb1638f5057e2902f4cfebfe16a9381212f6c2d9a2aa17aa4751
+  data.tar.gz: d4fff1844530e8e057f885d46616de7d9ad36e401a2718abd5680f34d91b21f9605187eb5c6e3345d0655d2f6120dae2432f4ecbfd3c042e92e3f724b32bc1f5

data/README.md

@@ -3,27 +3,47 @@
 Heroku Bouncer is a Rack middleware (implemented in Sinatra) that
 requires Heroku OAuth on all requests.
 
+## Demo
+
+[heroku-bouncer-demo](https://github.com/schneems/heroku-bouncer-demo) is a
+Sinatra app that uses heroku-bouncer.
+
 ## Use
 
 1. Create your OAuth client using `/auth/heroku/callback` as your
-   callback endpoint:
+   callback endpoint. Use `http://localhost:5000/auth/heroku/callback`
+   for local development with Foreman.
 
     ```sh
-    heroku clients:create likeaboss https://likeaboss.herokuapp.com/auth/heroku/callback
+    heroku clients:register localhost http://localhost:5000/auth/heroku/callback
+    heroku clients:register myapp https://myapp.herokuapp.com/auth/heroku/callback
     ```
 
 2. Set `HEROKU_OAUTH_ID` and `HEROKU_OAUTH_SECRET` in your environment.
-3. Optionally, set the `COOKIE_SECRET` environment variable to a long
-   random string. Otherwise, the OAuth ID and secret are concatenated
-   for use as a secret.
-4. Use the middleware:
+3. Set the `COOKIE_SECRET` environment variable to a long random string.
+   Otherwise, the OAuth ID and secret are concatenated for use as a secret.
+4. Use the middleware.
+
+    **Rack, Sinatra, and Rails 4**
+
+    Add a `use` line to `config.ru`:
 
     ```ruby
-    require 'heroku/bouncer'
-    require 'your_app'
+    require ::File.expand_path('../config/environment', __FILE__)
+
+    use ::Heroku::Bouncer
+    run Rails.application
+    ```
+
+    The middleware does not work properly when configured inside
+    Rails 4.
+
+    **Rails 3**
 
-    use Heroku::Bouncer
-    run YourApp
+    Add a middleware configuration line to `config/application.rb`:
+
+    ```ruby
+    config.middleware.use ::Heroku::Bouncer
     ```
 
 ## Options
@@ -55,7 +75,8 @@ the following keys to your request environment:
 * `bouncer.email`
 * `bouncer.user`
 
-You can access this in your Rack app by reading `request.env[key]`.
+You can access this in Sinatra and Rails by  `request.env[key]`, e.g.
+`request.env['bouncer.token']`.
 
 ## Using the Heroku API
 

data/lib/heroku/bouncer.rb

@@ -76,25 +76,29 @@ class Heroku::Bouncer < Sinatra::Base
 
   # something went wrong
   get '/auth/failure' do
-    session.destroy
+    destroy_session
     redirect to("/")
   end
 
   # logout, single sign-on style
   get '/auth/sso-logout' do
-    session.destroy
+    destroy_session
     auth_url = ENV["HEROKU_AUTH_URL"] || "https://id.heroku.com"
     redirect to("#{auth_url}/logout")
   end
 
   # logout but only locally
   get '/auth/logout' do
-    session.destroy
+    destroy_session
     redirect to("/")
   end
 
 private
 
+  def destroy_session
+    session = nil if session
+  end
+
   def extract_option(options, option, default = nil)
     options.has_key?(option) ? options[option] : default
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-bouncer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jonathan Dance
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-heroku
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Requires Heroku OAuth on all requests.