omniauth-hackid 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.rspec
+/Gemfile.lock
+pkg/*
+.powenv
+tmp
+bin

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'jruby-openssl', :platform => :jruby

data/README.md

@@ -0,0 +1,102 @@
+# OmniAuth HackID
+
+HackID OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side and client-side flows. Read the HackID docs for more details: https://hackid.herokuapp.com/docs
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-hackid'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::HackID` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :facebook, ENV['HACKID_KEY'], ENV['HACKID_SECRET']
+end
+```
+
+[See the example Sinatra app for full examples](https://github.com/mkdynamic/omniauth-facebook/blob/master/example/config.ru)
+
+## Configuring
+
+You can configure several options, which you pass in to the `provider` method via a `Hash`:
+
+* `scope`: A comma-separated list of permissions that has not been implemented yet.
+
+### Custom Callback URL/Path
+
+You can set a custom `callback_url` or `callback_path` option to override the default value. See [OmniAuth::Strategy#callback_url](https://github.com/intridea/omniauth/blob/master/lib/omniauth/strategy.rb#L411) for more details on the default.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'facebook',
+  :uid => '1234567',
+  :info => {
+    :nickname => 'jbloggs',
+    :email => 'joe@bloggs.com',
+    :name => 'Joe Bloggs',
+    :first_name => 'Joe',
+    :last_name => 'Bloggs',
+    :verified => true
+  },
+  :credentials => {
+    :token => 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store
+    :expires_at => 1321747205, # when the access token expires (it always will)
+    :expires => true # this will always be true
+  },
+  :extra => {
+    :raw_info => {
+      :name => 'Joe Bloggs',
+      :email => 'joe@bloggs.com',
+    }
+  }
+}
+```
+
+The precise information available may depend on the permissions which you request.
+
+The expiration time of the access token you obtain will depend on which flow you are using. See below for more details.
+
+### Server-Side Flow
+
+If you use the server-side flow, HackID will give you back a longer loved access token (~ 14 days).
+
+## Supported Rubies
+
+Actively tested with the following Ruby versions:
+
+- MRI 1.9.3
+- MRI 1.9.2
+- MRI 1.8.7
+- JRuby 1.6.5
+
+*NB.* For JRuby, you'll need to install the `jruby-openssl` gem. There's no way to automatically specify this in a Rubygem gemspec, so you need to manually add it your project's own Gemfile:
+
+```ruby
+gem 'jruby-openssl', :platform => :jruby
+```
+
+## License
+
+Copyright (c) 2012 by Mark Dodwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+end
+
+task :default => :test

data/example/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'debugger'
+gem 'omniauth-hackid', :path => '../'

data/example/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-hackid (0.0.1)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.6)
+    debugger (1.2.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    hashie (1.2.0)
+    httpauth (0.1)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    omniauth (1.1.1)
+      hashie (~> 1.2)
+      rack
+    omniauth-oauth2 (1.1.0)
+      oauth2 (~> 0.8.0)
+      omniauth (~> 1.0)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  omniauth-hackid!
+  sinatra

data/example/config.ru

@@ -0,0 +1,36 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-hackid'
+
+SCOPE = 'email,read_stream'
+
+class App < Sinatra::Base
+  # turn off sinatra default X-Frame-Options for FB canvas
+  set :protection, :except => :frame_options
+
+  # server-side flow
+  get '/' do
+    # NOTE: you would just hit this endpoint directly from the browser
+    #       in a real app. the redirect is just here to setup the root
+    #       path in this example sinatra app.
+    redirect '/auth/hackid'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :hackid, ENV['APP_ID'], ENV['APP_SECRET'], :scope => SCOPE
+end
+
+run App.new

data/lib/omniauth-hackid.rb

@@ -0,0 +1 @@
+require 'omniauth/hackid'

data/lib/omniauth/hackid.rb

@@ -0,0 +1,2 @@
+require 'omniauth/hackid/version'
+require 'omniauth/strategies/hackid'

data/lib/omniauth/hackid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module HackID
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/hackid.rb

@@ -0,0 +1,223 @@
+require 'omniauth/strategies/oauth2'
+require 'base64'
+require 'openssl'
+require 'rack/utils'
+
+module OmniAuth
+  module Strategies
+    class HackID < OmniAuth::Strategies::OAuth2
+      class NoAuthorizationCodeError < StandardError; end
+
+      DEFAULT_SCOPE = 'email'
+
+      option :client_options, {
+        :site => 'https://hackid.herokuapp.com',
+        :token_url => '/oauth/access_token'
+      }
+
+      option :token_params, {
+        :parse => :query
+      }
+
+      option :access_token_options, {
+        :mode => :query,
+        :param_name => 'access_token'
+      }
+
+      option :authorize_options, [:scope, :display, :auth_type]
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          'nickname' => raw_info['name'],
+          'email' => raw_info['email'],
+          'name' => raw_info['name'],
+          'first_name' => raw_info['name'].split(" ")[0],
+          'last_name' => raw_info['name'].split(" ")[1],
+          'image' => "",
+          #'description' => raw_info['bio'],
+          'urls' => {
+            #'Facebook' => raw_info['link'],
+            #'Website' => raw_info['website']
+          },
+          #'location' => (raw_info['location'] || {})['name'],
+          'verified' => raw_info['verified']
+        })
+      end
+
+      extra do
+        hash = {}
+        hash['raw_info'] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/me').parsed || {}
+      end
+
+      def build_access_token
+        if access_token = request.params["access_token"]
+          ::OAuth2::AccessToken.from_hash(
+            client, 
+            {"access_token" => access_token}.update(access_token_options)
+          )
+        elsif signed_request_contains_access_token?
+          hash = signed_request.clone
+          ::OAuth2::AccessToken.new(
+            client,
+            hash.delete('oauth_token'),
+            hash.merge!(access_token_options.merge(:expires_at => hash.delete('expires')))
+          )
+        else
+          with_authorization_code! { super }.tap do |token|
+            token.options.merge!(access_token_options)
+          end
+        end
+      end
+
+      def request_phase
+        if signed_request_contains_access_token?
+          # if we already have an access token, we can just hit the
+          # callback URL directly and pass the signed request along
+          params = { :signed_request => raw_signed_request }
+          params[:state] = request.params['state'] if request.params['state']
+          query = Rack::Utils.build_query(params)
+
+          url = callback_url
+          url << "?" unless url.match(/\?/)
+          url << "&" unless url.match(/[\&\?]$/)
+          url << query
+
+          redirect url
+        else
+          super
+        end
+      end
+
+      # NOTE if we're using code from the signed request
+      # then HackID sets the redirect_uri to '' during the authorize
+      # phase + it must match during the access_token phase:
+      # https://github.com/facebook/php-sdk/blob/master/src/base_facebook.php#L348
+      def callback_url
+        if @authorization_code_from_signed_request
+          ''
+        else
+          options[:callback_url] || super
+        end
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+
+      ##
+      # You can pass +display+, +state+ or +scope+ params to the auth request, if
+      # you need to set them dynamically. You can also set these options
+      # in the OmniAuth config :authorize_params option.
+      #
+      # /auth/hackid?display=popup&state=ABC
+      #
+      def authorize_params
+        super.tap do |params|
+          %w[display state scope].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+
+              # to support omniauth-oauth2's auto csrf protection
+              session['omniauth.state'] = params[:state] if v == 'state'
+            end
+          end
+
+          params[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+
+      ##
+      # Parse signed request in order, from:
+      #
+      # 1. the request 'signed_request' param (server-side flow from canvas pages) or
+      # 2. a cookie (client-side flow via JS SDK)
+      #
+      def signed_request
+        @signed_request ||= raw_signed_request &&
+          parse_signed_request(raw_signed_request)
+      end
+
+      private
+
+      def raw_signed_request
+        request.params['signed_request'] ||
+        request.cookies["fbsr_#{client.id}"]
+      end
+
+      ##
+      # If the signed_request comes from a FB canvas page and the user
+      # has already authorized your application, the JSON object will be
+      # contain the access token.
+      #
+      # https://developers.facebook.com/docs/authentication/canvas/
+      #
+      def signed_request_contains_access_token?
+        signed_request &&
+        signed_request['oauth_token']
+      end
+
+      ##
+      # Picks the authorization code in order, from:
+      #
+      # 1. the request 'code' param (manual callback from standard server-side flow)
+      # 2. a signed request (see #signed_request for more)
+      #
+      def with_authorization_code!
+        if request.params.key?('code')
+          yield
+        elsif code_from_signed_request = signed_request && signed_request['code']
+          request.params['code'] = code_from_signed_request
+          @authorization_code_from_signed_request = true
+          begin
+            yield
+          ensure
+            request.params.delete('code')
+            @authorization_code_from_signed_request = false
+          end
+        else
+          raise NoAuthorizationCodeError, 'must pass either a `code` parameter or a signed request (via `signed_request` parameter or a `fbsr_XXX` cookie)'
+        end
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+      def parse_signed_request(value)
+        signature, encoded_payload = value.split('.')
+
+        decoded_hex_signature = base64_decode_url(signature)
+        decoded_payload = MultiJson.decode(base64_decode_url(encoded_payload))
+
+        unless decoded_payload['algorithm'] == 'HMAC-SHA256'
+          raise NotImplementedError, "unkown algorithm: #{decoded_payload['algorithm']}"
+        end
+
+        if valid_signature?(client.secret, decoded_hex_signature, encoded_payload)
+          decoded_payload
+        end
+      end
+
+      def valid_signature?(secret, signature, payload, algorithm = OpenSSL::Digest::SHA256.new)
+        OpenSSL::HMAC.digest(algorithm, secret, payload) == signature
+      end
+
+      def base64_decode_url(value)
+        value += '=' * (4 - value.size.modulo(4))
+        Base64.decode64(value.tr('-_', '+/'))
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization('hackid', 'HackID')