omniauth-github 1.0.3 → 1.1.0

data/README.md

@@ -10,7 +10,18 @@ on the [GitHub Applications Page](https://github.com/settings/applications).
       provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET']
     end
 
-### Scopes
+## Github Enterprise Usage
+
+    provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET'],
+        {
+          :client_options => {
+            :site => 'https://github.YOURDOMAIN.com/api/v3',
+            :authorize_url => 'https://github.YOURDOMAIN.com/login/oauth/authorize',
+            :token_url => 'https://github.YOURDOMAIN.com/login/oauth/access_token',
+          }
+        }
+
+## Scopes
 
 GitHub API v3 lets you set scopes to provide granular access to different types of data: 
 

data/lib/omniauth-github/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GitHub
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

data/lib/omniauth/strategies/github.rb

@@ -12,6 +12,16 @@ module OmniAuth
       def request_phase
         super
       end
+      
+      def authorize_params
+        super.tap do |params|
+          %w[scope client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
 
       uid { raw_info['id'].to_s }
 
@@ -34,20 +44,27 @@ module OmniAuth
 
       def raw_info
         access_token.options[:mode] = :query
-        @raw_info ||= access_token.get('/user').parsed
+        @raw_info ||= access_token.get('user').parsed
       end
 
       def email
-        raw_info['email'] || (email_access_allowed? ? emails.first : nil)
+        raw_info['email'] || primary_email
+      end
+
+      def primary_email
+        primary = emails.find{|i| i['primary'] }
+        primary && primary['email'] || emails.first && emails.first['email']
       end
 
+      # The new /user/emails API - http://developer.github.com/v3/users/emails/#future-response
       def emails
+        return [] unless email_access_allowed?
         access_token.options[:mode] = :query
-        @emails ||= access_token.get('/user/emails').parsed
+        @emails ||= access_token.get('user/emails', :headers => { 'Accept' => 'application/vnd.github.v3' }).parsed
       end
 
       def email_access_allowed?
-        options['scope'] && !(options['scope'] == 'public')
+        options['scope'] =~ /user/
       end
 
     end

data/spec/omniauth/strategies/github_spec.rb

@@ -1,10 +1,33 @@
 require 'spec_helper'
 
 describe OmniAuth::Strategies::GitHub do
+  let(:access_token) { stub('AccessToken', :options => {}) }
+  let(:parsed_response) { stub('ParsedResponse') }
+  let(:response) { stub('Response', :parsed => parsed_response) }
+
+  let(:enterprise_site)          { 'https://some.other.site.com/api/v3' }
+  let(:enterprise_authorize_url) { 'https://some.other.site.com/login/oauth/authorize' }
+  let(:enterprise_token_url)     { 'https://some.other.site.com/login/oauth/access_token' }
+  let(:enterprise) do
+    OmniAuth::Strategies::GitHub.new('GITHUB_KEY', 'GITHUB_SECRET',
+        {
+            :client_options => {
+                :site => enterprise_site,
+                :authorize_url => enterprise_authorize_url,
+                :token_url => enterprise_token_url
+            }
+        }
+    )
+  end
+
   subject do
     OmniAuth::Strategies::GitHub.new({})
   end
 
+  before(:each) do
+    subject.stub!(:access_token).and_return(access_token)
+  end
+
   context "client options" do
     it 'should have correct site' do
       subject.options.client_options.site.should eq("https://api.github.com")
@@ -17,6 +40,20 @@ describe OmniAuth::Strategies::GitHub do
     it 'should have correct token url' do
       subject.options.client_options.token_url.should eq('https://github.com/login/oauth/access_token')
     end
+
+    describe "should be overrideable" do
+      it "for site" do
+        enterprise.options.client_options.site.should eq(enterprise_site)
+      end
+
+      it "for authorize url" do
+        enterprise.options.client_options.authorize_url.should eq(enterprise_authorize_url)
+      end
+
+      it "for token url" do
+        enterprise.options.client_options.token_url.should eq(enterprise_token_url)
+      end
+    end
   end
 
   context "#email_access_allowed?" do
@@ -25,24 +62,24 @@ describe OmniAuth::Strategies::GitHub do
       subject.should_not be_email_access_allowed
     end
 
-    it "should not allow email if scope is 'public'" do
-      subject.options['scope'] = 'public'
-      subject.should_not be_email_access_allowed
-    end
-
     it "should allow email if scope is user" do
       subject.options['scope'] = 'user'
       subject.should be_email_access_allowed
     end
 
-    it "should allow email if scope is scope is a bunch of stuff" do
-      subject.options['scope'] = 'user,public_repo,repo,delete_repo,gist'
+    it "should allow email if scope is a bunch of stuff including user" do
+      subject.options['scope'] = 'public_repo,user,repo,delete_repo,gist'
       subject.should be_email_access_allowed
     end
 
-    it "should assume email access allowed if scope is scope is something currently not documented " do
+    it "should not allow email if scope is other than user" do
+      subject.options['scope'] = 'repo'
+      subject.should_not be_email_access_allowed
+    end
+
+    it "should assume email access not allowed if scope is something currently not documented " do
       subject.options['scope'] = 'currently_not_documented'
-      subject.should be_email_access_allowed
+      subject.should_not be_email_access_allowed
     end
   end
 
@@ -57,11 +94,41 @@ describe OmniAuth::Strategies::GitHub do
       subject.email.should be_nil
     end
 
+    it "should return the primary email if there is no raw_info and email access is allowed" do
+      emails = [
+        { 'email' => 'secondary@example.com', 'primary' => false },
+        { 'email' => 'primary@example.com',   'primary' => true }
+      ]
+      subject.stub!(:raw_info).and_return({})
+      subject.options['scope'] = 'user'
+      subject.stub!(:emails).and_return(emails)
+      subject.email.should eq('primary@example.com')
+    end
+
     it "should return the first email if there is no raw_info and email access is allowed" do
+      emails = [
+        { 'email' => 'first@example.com',   'primary' => false },
+        { 'email' => 'second@example.com',  'primary' => false }
+      ]
       subject.stub!(:raw_info).and_return({})
       subject.options['scope'] = 'user'
-      subject.stub!(:emails).and_return([ 'you@example.com' ])
-      subject.email.should eq('you@example.com')
+      subject.stub!(:emails).and_return(emails)
+      subject.email.should eq('first@example.com')
+    end
+  end
+
+  context "#raw_info" do
+    it "should use relative paths" do
+      access_token.should_receive(:get).with('user').and_return(response)
+      subject.raw_info.should eq(parsed_response)
+    end
+  end
+
+  context "#emails" do
+    it "should use relative paths" do
+      access_token.should_receive(:get).with('user/emails', :headers=>{"Accept"=>"application/vnd.github.v3"}).and_return(response)
+      subject.options['scope'] = 'user'
+      subject.emails.should eq(parsed_response)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-github
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Official OmniAuth strategy for GitHub.