omniauth-foursquare 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - ree

data/README.md

@@ -0,0 +1,42 @@
+# OmniAuth Foursquare
+
+This gem contains the Foursquare strategy for OmniAuth.
+
+Foursquare uses the OAuth2 flow, you can read about it here: https://developer.foursquare.com/docs/oauth.html
+
+## How To Use It
+
+So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
+
+    gem 'omniauth-foursquare'
+
+You can pull them in directly from github e.g.:
+
+    gem 'omniauth-foursquare', :git => 'https://github.com/arunagw/omniauth-foursquare.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :foursquare, "consumer_key", "consumer_secret" 
+    end
+
+You will obviously have to put in your key and secret, which you get when you register your app with Foursquare (they call them API Key and Secret Key). 
+
+Now just follow the README at: https://github.com/intridea/omniauth
+
+## Supported Rubies
+
+OmniAuth Foursquare is tested under 1.8.7, 1.9.2, 1.9.3 and Ruby Enterprise Edition.
+
+[![CI Build
+Status](https://secure.travis-ci.org/arunagw/omniauth-foursquare.png)](http://travis-ci.org/arunagw/omniauth-foursquare)
+
+## License
+
+Copyright (c) 2011 by Arun Agrawal
+
+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

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/omniauth-foursquare/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Foursquare
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/omniauth/strategies/foursquare_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'omniauth-foursquare'
+
+describe OmniAuth::Strategies::Foursquare do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+  end
+  
+  subject do
+    OmniAuth::Strategies::Foursquare.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct Foursquare site' do
+      subject.client.site.should eq('https://foursquare.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/access_token')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'firstName' => 'Fred', 'lastName' => 'Smith' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+    
+    context 'when data is present in raw info' do
+      it 'returns the first name' do
+        subject.info[:first_name].should eq('Fred')
+      end
+    
+      it 'returns the last name' do
+        subject.info[:last_name].should eq('Smith')
+      end
+    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
+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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-foursquare
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-06 00:00:00.000000000Z
+date: 2011-11-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
-  requirement: &70357413319660 !ruby/object:Gem::Requirement
+  requirement: &70335668645640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70357413319660
+  version_requirements: *70335668645640
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
-  requirement: &70357413318920 !ruby/object:Gem::Requirement
+  requirement: &70335668644900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70357413318920
+  version_requirements: *70335668644900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70357413318400 !ruby/object:Gem::Requirement
+  requirement: &70335668644340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70357413318400
+  version_requirements: *70335668644340
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70357413317980 !ruby/object:Gem::Requirement
+  requirement: &70335668642680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357413317980
+  version_requirements: *70335668642680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70357413316920 !ruby/object:Gem::Requirement
+  requirement: &70335668642040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357413316920
+  version_requirements: *70335668642040
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70357413306680 !ruby/object:Gem::Requirement
+  requirement: &70335668641500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70357413306680
+  version_requirements: *70335668641500
 description: Foursquare OAuth strategy for OmniAuth
 email:
 - arunagw@gmail.com
@@ -85,12 +85,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- README.md
 - Rakefile
 - lib/omniauth-foursquare.rb
 - lib/omniauth-foursquare/version.rb
 - lib/omniauth/strategies/foursquare.rb
 - omniauth-foursquare.gemspec
+- spec/omniauth/strategies/foursquare_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
 homepage: https://github.com/arunagw/omniauth-foursquare
 licenses: []
 post_install_message: 
@@ -105,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2644114744049422317
+      hash: 1474676171529160353
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,11 +120,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2644114744049422317
+      hash: 1474676171529160353
 requirements: []
 rubyforge_project: omniauth-foursquare
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Foursquare OAuth strategy for OmniAuth
-test_files: []
+test_files:
+- spec/omniauth/strategies/foursquare_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb