1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
require 'spec_helper'
describe OmniAuth::Strategies::GitHub do
let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
let(:parsed_response) { instance_double('ParsedResponse') }
let(:response) { instance_double('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
allow(subject).to receive(:access_token).and_return(access_token)
end
context 'client options' do
it 'should have correct site' do
expect(subject.options.client_options.site).to eq('https://api.github.com')
end
it 'should have correct authorize url' do
expect(subject.options.client_options.authorize_url).to eq('https://github.com/login/oauth/authorize')
end
it 'should have correct token url' do
expect(subject.options.client_options.token_url).to eq('https://github.com/login/oauth/access_token')
end
describe 'should be overrideable' do
it 'for site' do
expect(enterprise.options.client_options.site).to eq(enterprise_site)
end
it 'for authorize url' do
expect(enterprise.options.client_options.authorize_url).to eq(enterprise_authorize_url)
end
it 'for token url' do
expect(enterprise.options.client_options.token_url).to eq(enterprise_token_url)
end
end
end
context '#email_access_allowed?' do
it 'should not allow email if scope is nil' do
expect(subject.options['scope']).to be_nil
expect(subject).to_not be_email_access_allowed
end
it 'should allow email if scope is user' do
subject.options['scope'] = 'user'
expect(subject).to be_email_access_allowed
end
it 'should allow email if scope is a bunch of stuff including user' do
subject.options['scope'] = 'public_repo,user,repo,delete_repo,gist'
expect(subject).to be_email_access_allowed
end
it 'should not allow email if scope does not grant email access' do
subject.options['scope'] = 'repo,user:follow'
expect(subject).to_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'
expect(subject).to_not be_email_access_allowed
end
end
context '#email' do
it 'should return email from raw_info if available' do
allow(subject).to receive(:raw_info).and_return({ 'email' => 'you@example.com' })
expect(subject.email).to eq('you@example.com')
end
it 'should return nil if there is no raw_info and email access is not allowed' do
allow(subject).to receive(:raw_info).and_return({})
expect(subject.email).to be_nil
end
it 'should not 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 }
]
allow(subject).to receive(:raw_info).and_return({})
subject.options['scope'] = 'user'
allow(subject).to receive(:emails).and_return(emails)
expect(subject.email).to be_nil
end
it 'should not 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 }
]
allow(subject).to receive(:raw_info).and_return({})
subject.options['scope'] = 'user'
allow(subject).to receive(:emails).and_return(emails)
expect(subject.email).to be_nil
end
end
context '#raw_info' do
it 'should use relative paths' do
expect(access_token).to receive(:get).with('user').and_return(response)
expect(subject.raw_info).to eq(parsed_response)
end
it 'should use the header auth mode' do
expect(access_token).to receive(:get).with('user').and_return(response)
subject.raw_info
expect(access_token.options[:mode]).to eq(:header)
end
end
context '#emails' do
it 'should use relative paths' do
expect(access_token).to receive(:get).with('user/emails', :headers => {
'Accept' => 'application/vnd.github.v3'
}).and_return(response)
subject.options['scope'] = 'user'
expect(subject.emails).to eq(parsed_response)
end
it 'should use the header auth mode' do
expect(access_token).to receive(:get).with('user/emails', :headers => {
'Accept' => 'application/vnd.github.v3'
}).and_return(response)
subject.options['scope'] = 'user'
subject.emails
expect(access_token.options[:mode]).to eq(:header)
end
end
context '#info.email' do
it 'should use any available email' do
allow(subject).to receive(:raw_info).and_return({})
allow(subject).to receive(:email).and_return('you@example.com')
expect(subject.info['email']).to eq('you@example.com')
end
end
context '#info.urls' do
it 'should use html_url from raw_info' do
allow(subject).to receive(:raw_info).and_return({ 'login' => 'me', 'html_url' => 'http://enterprise/me' })
expect(subject.info['urls']['GitHub']).to eq('http://enterprise/me')
end
end
context '#extra.scope' do
it 'returns the scope on the returned access_token' do
expect(subject.scope).to eq('user')
end
end
describe '#callback_url' do
it 'is a combination of host, script name, and callback path' do
allow(subject).to receive(:full_host).and_return('https://example.com')
allow(subject).to receive(:script_name).and_return('/sub_uri')
expect(subject.callback_url).to eq('https://example.com/sub_uri/auth/github/callback')
end
end
end
|
