heroku-bouncer 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5cf7d5667b8fe25211a018e2b73c8f625f71c55
-  data.tar.gz: 6f20284b00d3080f0f8ad6417853394eeb7d9791
+  metadata.gz: 665c9d7aafb5ad2f6d67e2b2c6534afe7114a310
+  data.tar.gz: 740248c7d7ff94e833d11c3072b4d605e545d540
 SHA512:
-  metadata.gz: 7bd2301810bba207ec13b0da82e2a64fd4b331c37b1f30abf13ae0aedc5ca756f600752d1db3302c8d89495f2017da161303d55dfce89a4ff7cb21a1efb3fc82
-  data.tar.gz: bb4a81dba1617a144bd0614ac080009afb97974f4baf0b63f0f60f1a06f7d2d7f9335950cb9e0b28f52e9921efc1baf7a4bea25bf01a7c8b261494347fff4b48
+  metadata.gz: 98037d0ba899477a43af554df33b0edeaad5b4381e761a8b44d4f91025bd036d92b5cb5c82b83edca30f3edb52a0caf3772b0d7ad327d02834cf8d180299bdde
+  data.tar.gz: 229ef416b7d70912a4d38cbb8b76feed9013b6d4a8b5a350b07590a26bc78735116dbd46f34eff5ec38a547c8aa39a0ae2cb155b7710e3a941a628289a22733e

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.6.0
+
+* #42: add `allow_if_user` which takes the user object, instead of just
+  an email. Thanks @jacobian!
+* #43: allow bouncer to be installed at sub-paths of the app by using
+  `request.path_info`. Thanks @dpiddy!
+
 # 0.5.2
 
 * #40: fixes redirects to non-standard ports (other than 80/443). Thanks

data/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# tl;dr
+
+PRs welcome. Please write tests, add an entry to CHANGELOG.md for your
+change, and if the change is user-facing, update README.md.
+
+# Contributing
+
+Contributions welcome! Here are some ways you can help:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing tests or specifications
+* by writing code (**no patch is too small!** Fix typos, add comments, etc)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/heroku/heroku-bouncer/issues
+
+## Submitting an Issue
+
+We use the [GitHub issue tracker][issues] to track bugs and features.
+Before submitting a bug report or feature request, check to make sure it
+hasn't already been submitted. When submitting a bug report, please
+include a [Gist][] that includes a stack trace and any details that may
+be necessary to reproduce the bug, including your gem version, Ruby
+version, and operating system.  Ideally, a bug report should include a
+pull request with failing specs.
+
+[Gist]: https://gist.github.com/
+
+## Getting Started Locally
+
+Fork, then clone the repo:
+
+    git clone git@github.com:your-username/heroku-bouncer.git
+
+Bundle install using your preferred arguments:
+
+    bundle install -j8 --path .bundle
+
+Make sure the tests pass:
+
+    bundle exec rake
+
+## Submitting a Pull Request
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix. Please include tests and a
+   proposed change to the `CHANGELOG.md` file.
+4. Make sure the tests pass using `bundle exec rake`.
+5. Please try to remove any trailing whitespace and make sure all files
+   end in a newline. `git diff --check` before committing can help.
+6. Add, commit, and push your changes.
+7. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/README.md

@@ -42,7 +42,7 @@ Sinatra app that uses heroku-bouncer.
     require 'my_app'
 
     # use `openssl rand -base64 32` to generate a secret
-    use Rack::Session::Cookie, secret: "..."
+    use Rack::Session::Cookie, secret: "...", key: "my_app_session"
     use Heroku::Bouncer,
       oauth: { id: "...", secret: "..." }, secret: "..."
     run MyApp
@@ -57,7 +57,7 @@ Sinatra app that uses heroku-bouncer.
     ```ruby
     class MyApp < Sinatra::Base
       ...
-      enable :sessions, secret: "..."
+      enable :sessions, secret: "...", key: "my_app_session"
       use ::Heroku::Bouncer,
         oauth: { id: "...", secret: "..." }, secret: "..."
       ...
@@ -98,6 +98,11 @@ Here are the supported options you can pass to the middleware:
 * `allow_if`: A lambda that takes an email address. If the lambda evaluates to
   true, allow the user through. If false, redirects to `redirect_url`.
   By default, all users are allowed through after authenticating.
+* `allow_if_user`: A lambda that takes the 
+  [account resource](https://devcenter.heroku.com/articles/platform-api-reference#account) 
+  representing the user. If the lambda evaluates to true, allow the user
+  through. If false, redirects to `redirect_url`. By default, all users are
+  allowed through after authenticating.
 * `redirect_url`: Where unauthorized users are redirected to. Defaults to
   `www.heroku.com`.
 * `expose_token`: Expose the OAuth token in the session, allowing you to

data/lib/heroku/bouncer/middleware.rb

@@ -20,18 +20,24 @@ class Heroku::Bouncer::Middleware < Sinatra::Base
     else
       super(app)
       @cookie_secret = extract_option(options, :secret, SecureRandom.base64(32))
-      @allow_if = extract_option(options, :allow_if, nil)
+      @allow_if_user = extract_option(options, :allow_if_user, nil)
       @redirect_url = extract_option(options, :redirect_url, 'https://www.heroku.com')
 
       # backwards-compatibilty for `herokai_only`:
       #  * check email for ending with `@heroku.com`
       #  * The redirect URL can be passed as a string value to `herokai_only`
-      herokai_only = extract_deprecated_option("please use `allow_if` instead", options, :herokai_only, false)
+      herokai_only = extract_deprecated_option("please use `allow_if_user` instead", options, :herokai_only, false)
       if herokai_only
         if herokai_only.is_a?(String) && !options[:redirect_url]
           @redirect_url = herokai_only
         end
-        @allow_if ||= lambda { |email| email.end_with?("@heroku.com") }
+        @allow_if_user ||= lambda { |user| user['email'].end_with?("@heroku.com") }
+      end
+
+      # backwards-compatibility for allow_if
+      allow_if = extract_option(options, :allow_if, false)
+      if allow_if
+        @allow_if_user ||= lambda { |user| allow_if.call(user['email']) }  
       end
 
       @expose_token = extract_option(options, :expose_token, false)
@@ -77,11 +83,13 @@ class Heroku::Bouncer::Middleware < Sinatra::Base
   # callback when successful, time to save data
   get '/auth/heroku/callback' do
     token = request.env['omniauth.auth']['credentials']['token']
-    if @expose_email || @expose_user || !@allow_if.nil?
+    if @expose_email || @expose_user || !@allow_if_user.nil?
       user = fetch_user(token)
       # Wrapping lambda to prevent short-circut proc return
-      if @allow_if.respond_to?(:call) && !lambda{ @allow_if.call(user['email'])}.call
-        redirect to(@redirect_url) and return
+      if @allow_if_user.respond_to?(:call)
+        if !lambda{ @allow_if_user.call(user)}.call
+          redirect to(@redirect_url) and return
+        end
       end
       @expose_user ? store_write(:user, user) : store_write(:user, true)
       store_write(:email, user['email']) if @expose_email
@@ -138,7 +146,7 @@ private
   end
 
   def auth_request?
-    %w[/auth/heroku/callback /auth/heroku /auth/failure /auth/sso-logout /auth/logout /auth/login].include?(request.path)
+    %w[/auth/heroku/callback /auth/heroku /auth/failure /auth/sso-logout /auth/logout /auth/login].include?(request.path_info)
   end
 
   def session_nonce_mismatch?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-bouncer
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Jonathan Dance
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-heroku
@@ -158,8 +158,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - CHANGELOG.md
+- CONTRIBUTING.md
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - README.md
 - Rakefile
@@ -189,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rapidly add Heroku OAuth to your Ruby app.