omniauth-facebook 1.0.0.rc1

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'omniauth-oauth2', :git => 'git://github.com/intridea/omniauth-oauth2.git'

data/README.md

@@ -0,0 +1,30 @@
+# OmniAuth Facebook  [![Build Status](http://travis-ci.org/mkdynamic/omniauth-facebook.png?branch=master)](http://travis-ci.org/mkdynamic/omniauth-facebook)
+
+**Note:** This gem is designed to work with the unreleased OmniAuth 1.0 library. It will not be officially released on RubyGems.org until OmniAuth 1.0 is released.
+
+This gem contains the Facebook strategy for OmniAuth.
+
+## Supported Flows
+
+Supports the Server-side Flow as described in the the Facebook docs:
+http://developers.facebook.com/docs/authentication
+
+**Pending:** Supports the Client-side Flow via parsing out the verification code from the signed request cookie.
+
+## Ruby
+
+Tested with the following Ruby versions:
+
+- MRI 1.9.2
+- MRI 1.8.7
+- JRuby 1.6.4
+
+## License
+
+Copyright (c) 2011 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'omniauth-facebook', :path => '../'

data/example/config.ru

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-facebook'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/facebook'
+  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 :facebook, ENV['APP_ID'], ENV['APP_SECRET'], :scope => 'email,read_stream'
+end
+
+run App.new

data/lib/omniauth-facebook.rb

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

data/lib/omniauth/facebook.rb

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

data/lib/omniauth/facebook/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Facebook
+    VERSION = "1.0.0.rc1"
+  end
+end

data/lib/omniauth/strategies/facebook.rb

@@ -0,0 +1,76 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Facebook < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://graph.facebook.com',
+        :token_url => '/oauth/access_token'
+      }
+
+      option :token_params, {
+        :parse => :query
+      }
+
+      option :access_token_options, {
+        :header_format => 'OAuth %s',
+        :param_name => 'access_token'
+      }
+      
+      uid { raw_info['id'] }
+      
+      info do
+        prune!({
+          'nickname' => raw_info['username'],
+          'email' => raw_info['email'],
+          'name' => raw_info['name'],
+          'first_name' => raw_info['first_name'],
+          'last_name' => raw_info['last_name'],
+          'image' => "http://graph.facebook.com/#{uid}/picture?type=square",
+          'description' => raw_info['bio'],
+          'urls' => {
+            'Facebook' => raw_info['link'],
+            'Website' => raw_info['website']
+          },
+          'location' => (raw_info['location'] || {})['name']
+        })
+      end
+      
+      credentials do
+        prune!({
+          'expires' => access_token.expires?,
+          'expires_at' => access_token.expires_at
+        })
+      end
+      
+      extra do
+        prune!({
+          'raw_info' => raw_info
+        })
+      end
+      
+      def raw_info
+        @raw_info ||= access_token.get('/me').parsed
+      end
+
+      def build_access_token
+        super.tap do |token|
+          token.options.merge!(access_token_options)
+        end
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+      
+      private
+      
+      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
+    end
+  end
+end

data/omniauth-facebook.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/facebook/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-facebook'
+  s.version  = OmniAuth::Facebook::VERSION
+  s.authors  = ['Mark Dodwell']
+  s.email    = ['mark@mkdynamic.co.uk']
+  s.summary  = 'Facebook strategy for OmniAuth'
+  s.homepage = 'https://github.com/mkdynamic/omniauth-facebook'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.0.0.rc2'
+
+  s.add_development_dependency 'rspec', '~> 2.7.0'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/facebook_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+require 'omniauth-facebook'
+
+describe OmniAuth::Strategies::Facebook do
+  subject do
+    OmniAuth::Strategies::Facebook.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct Facebook site' do
+      subject.client.site.should eq('https://graph.facebook.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth/access_token')
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'is empty by default' do
+      subject.authorize_params.should be_empty
+    end
+  end
+
+  describe '#token_params' do
+    it 'has correct parse strategy' do
+      subject.token_params[:parse].should eq(:query)
+    end
+  end
+
+  describe '#access_token_options' do
+    it 'has correct param name by default' do
+      subject.access_token_options[:param_name].should eq('access_token')
+    end
+
+    it 'has correct header format by default' do
+      subject.access_token_options[:header_format].should eq('OAuth %s')
+    end
+  end
+  
+  describe '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { 'id' => '123' } }
+    end
+    
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+  
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'name' => 'Fred Smith' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    context 'when optional data is not present in raw info' do
+      it 'has no email key' do
+        subject.info.should_not have_key('email')
+      end
+
+      it 'has no nickname key' do
+        subject.info.should_not have_key('nickname')
+      end
+    
+      it 'has no first name key' do
+        subject.info.should_not have_key('first_name')
+      end
+    
+      it 'has no last name key' do
+        subject.info.should_not have_key('last_name')
+      end
+    
+      it 'has no location key' do
+        subject.info.should_not have_key('location')
+      end
+    
+      it 'has no description key' do
+        subject.info.should_not have_key('description')
+      end
+    
+      it 'has no urls' do
+        subject.info.should_not have_key('urls')
+      end
+    end
+    
+    context 'when data is present in raw info' do
+      it 'returns the name' do
+        subject.info['name'].should eq('Fred Smith')
+      end
+    
+      it 'returns the email' do
+        @raw_info['email'] = 'fred@smith.com'
+        subject.info['email'].should eq('fred@smith.com')
+      end
+
+      it 'returns the username as nickname' do
+        @raw_info['username'] = 'fredsmith'
+        subject.info['nickname'].should eq('fredsmith')
+      end
+    
+      it 'returns the first name' do
+        @raw_info['first_name'] = 'Fred'
+        subject.info['first_name'].should eq('Fred')
+      end
+    
+      it 'returns the last name' do
+        @raw_info['last_name'] = 'Smith'
+        subject.info['last_name'].should eq('Smith')
+      end
+    
+      it 'returns the location name as location' do
+        @raw_info['location'] = { 'id' => '104022926303756', 'name' => 'Palo Alto, California' }
+        subject.info['location'].should eq('Palo Alto, California')
+      end
+    
+      it 'returns bio as description' do
+        @raw_info['bio'] = 'I am great'
+        subject.info['description'].should eq('I am great')
+      end
+    
+      it 'returns the square format facebook avatar url' do
+        @raw_info['id'] = '321'
+        subject.info['image'].should eq('http://graph.facebook.com/321/picture?type=square')
+      end
+    
+      it 'returns the Facebook link as the Facebook url' do
+        @raw_info['link'] = 'http://www.facebook.com/fredsmith'
+        subject.info['urls'].should be_a(Hash)
+        subject.info['urls']['Facebook'].should eq('http://www.facebook.com/fredsmith')
+      end
+    
+      it 'returns website url' do
+        @raw_info['website'] = 'https://my-wonderful-site.com'
+        subject.info['urls'].should be_a(Hash)
+        subject.info['urls']['Website'].should eq('https://my-wonderful-site.com')
+      end
+    
+      it 'return both Facebook link and website urls' do
+        @raw_info['link'] = 'http://www.facebook.com/fredsmith'
+        @raw_info['website'] = 'https://my-wonderful-site.com'
+        subject.info['urls'].should be_a(Hash)
+        subject.info['urls']['Facebook'].should eq('http://www.facebook.com/fredsmith')
+        subject.info['urls']['Website'].should eq('https://my-wonderful-site.com')
+      end
+    end
+  end
+  
+  describe '#raw_info' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'performs a GET to https://graph.facebook.com/me' do
+      @access_token.stub(:get) { double('OAuth2::Response').as_null_object }
+      @access_token.should_receive(:get).with('/me')
+      subject.raw_info
+    end
+    
+    it 'returns a Hash' do
+      @access_token.stub(:get).with('/me') do
+        raw_response = double('Faraday::Response')
+        raw_response.stub(:body) { '{ "ohai": "thar" }' }
+        raw_response.stub(:status) { 200 }
+        raw_response.stub(:headers) { { 'Content-Type' => 'application/json' } }
+        OAuth2::Response.new(raw_response)
+      end
+      subject.raw_info.should be_a(Hash)
+      subject.raw_info['ohai'].should eq('thar')
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+    
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+    
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+    
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+      
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    end
+    
+    it 'returns the refresh token and expiry time when expiring' do
+      ten_mins_from_now = (Time.now + 360).to_i
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { '321' }
+      @access_token.stub(:expires_at) { ten_mins_from_now }
+      subject.credentials['refresh_token'].should eq('321')
+      subject.credentials['expires_at'].should eq(ten_mins_from_now)
+    end
+    
+    it 'does not return the refresh token when it is nil and expiring' do
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { nil }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+    
+    it 'does not return the refresh token when not expiring' do
+      @access_token.stub(:expires?) { false }
+      @access_token.stub(:refresh_token) { 'XXX' }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+  end
+  
+  describe '#extra' do
+    before :each do
+      @raw_info = { 'name' => 'Fred Smith' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    it 'returns a Hash' do
+      subject.extra.should be_a(Hash)
+    end
+    
+    it 'contains raw info' do
+      subject.extra.should eq({ 'raw_info' => @raw_info })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-facebook
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+  prerelease: 6
+platform: ruby
+authors:
+- Mark Dodwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: &2153016200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153016200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153015460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153015460
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153014400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153014400
+description: 
+email:
+- mark@mkdynamic.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-facebook.rb
+- lib/omniauth/facebook.rb
+- lib/omniauth/facebook/version.rb
+- lib/omniauth/strategies/facebook.rb
+- omniauth-facebook.gemspec
+- spec/omniauth/strategies/facebook_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/mkdynamic/omniauth-facebook
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Facebook strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/facebook_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: