omniauth-heroku 0.0.4 → 0.1.0

data/README.md

@@ -1,18 +1,78 @@
 # OmniAuth Heroku
 
-OmniAuth strategy for authenticating to Heroku.
+[OmniAuth](https://github.com/intridea/omniauth) strategy for authenticating to Heroku.
 
 Heroku's support for OAuth is still private/experimental.
 
 
-## Basic Usage
+## Configuration
+
+OmniAuth works as a Rack middleware. Mount this Heroku adapter with:
 
 ```ruby
 use OmniAuth::Builder do
-  provider :heroku, ENV['HEROKU_KEY'], ENV['HEROKU_SECRET']
+  provider :heroku, ENV['HEROKU_ID'], ENV['HEROKU_SECRET']
+end
+```
+
+Your Heroku OAuth client should be set to receive callbacks on `/auth/heroku/callback`.
+
+
+## Usage
+
+Initiate the OAuth flow sending users to `/auth/heroku`.
+
+Once the authorization flow is complete and the user is bounced back to your application, check `env["omniauth.auth"]["credentials"]`. It contains both a refresh token and an access token (identified just as `"token"`) to the account.
+
+We recommend using this access token together with [Heroku.rb](https://github.com/heroku/heroku.rb) to make API calls on behalf of the user.
+
+
+## Example - Rails
+
+Under `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :heroku, ENV['HEROKU_ID'], ENV['HEROKU_SECRET']
 end
 ```
 
+Then add to `config/routes.rb`:
+
+```ruby
+Example::Application.routes.draw do
+  get "login" => "sessions#new"
+  get "/auth/:provider/callback" => "sessions#create"
+end
+```
+
+Controller support:
+
+```ruby
+class SessionsController < ApplicationController
+  def new
+    redirect_to "/auth/heroku"
+  end
+
+  def create
+    access_token = request.env['omniauth.auth']['credentials']['token']
+    heroku_api = Heroku::API.new(:api_key => access_token)
+    @apps = api.get_apps.body
+  end
+end
+```
+
+And view:
+
+```erb
+<h1>Your Heroku apps:</h1>
+
+<ul>
+  <% @apps.each do |app| %>
+    <li><%= app["name"] %></li>
+  <% end %>
+</ul>
+```
 
 ## Meta
 

data/lib/omniauth/strategies/heroku.rb

@@ -10,25 +10,6 @@ module OmniAuth
         :authorize_url => "#{BaseAuthUrl}/oauth/authorize",
         :token_url => "#{BaseAuthUrl}/oauth/token"
       }
-
-      def request_phase
-        super
-      end
-
-      uid { raw_info['id'] }
-
-      info do
-        { 'email' => raw_info['email'] }
-      end
-
-      extra do
-        { 'raw_info' => raw_info }
-      end
-
-      def raw_info
-        access_token.options[:mode] = :header
-        @raw_info ||= access_token.get('/account').parsed
-      end
     end
   end
 end

data/omniauth-heroku.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split("\n")
   gem.name          = "omniauth-heroku"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.4"
+  gem.version       = "0.1.0"
 
   gem.add_dependency 'omniauth', '~> 1.0'
   gem.add_dependency 'omniauth-oauth2', '~> 1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-heroku
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: OmniAuth strategy for Heroku.