Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add refresh token method and unit tests #150

Merged
merged 2 commits into from
Dec 6, 2018
Merged

Add refresh token method and unit tests #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a383344
Add refresh token method and unit tests
joshcanhelp Dec 5, 2018
99e726d
PR feedback
joshcanhelp Dec 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions lib/auth0/api/authentication_endpoints.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,18 @@ def api_token(
# Get access and ID tokens using an Authorization Code.
# @see https://auth0.com/docs/api/authentication#authorization-code
# @param code [string] The authentication code obtained from /authorize
# @param redirect_uri [string] Url to redirect after authorization
# @return [json] Returns the access_token and id_token
# @param redirect_uri [string] URL to redirect to after authorization.
# Required only if it was set at the GET /authorize endpoint
# @param client_id [string] Client ID for the Application
# @param client_secret [string] Client Secret for the Application.
# @return [AccessToken] Returns the access_token and id_token
def exchange_auth_code_for_tokens(
code,
redirect_uri,
redirect_uri: nil,
client_id: @client_id,
client_secret: @client_secret
)
raise Auth0::InvalidParameter, 'Must provide an authorization code' if code.to_s.empty?
raise Auth0::InvalidParameter, 'Must provide a redirect URI' if redirect_uri.to_s.empty?
request_params = {
grant_type: 'authorization_code',
client_id: client_id,
Expand All @@ -49,6 +51,30 @@ def exchange_auth_code_for_tokens(
AccessToken.from_response post('/oauth/token', request_params)
end

# Get access and ID tokens using a refresh token.
# @see https://auth0.com/docs/api/authentication#refresh-token
# @param refresh_token [string] Refresh token to use. Request this with
# the offline_access scope when logging in.
# @param client_id [string] Client ID for the Application
# @param client_secret [string] Client Secret for the Application.
# Required when the Application's Token Endpoint Authentication Method
# is Post or Basic.
# @return [AccessToken] Returns tokens allowed in the refresh_token
def exchange_refresh_token(
refresh_token,
client_id: @client_id,
client_secret: @client_secret
)
raise Auth0::InvalidParameter, 'Must provide a refresh token' if refresh_token.to_s.empty?
request_params = {
grant_type: 'refresh_token',
client_id: client_id,
client_secret: client_secret,
refresh_token: refresh_token
}
AccessToken.from_response post('/oauth/token', request_params)
end

# Retrieve an access token.
# TODO: Deprecate, use the api_token method in this module instead.
# @see https://auth0.com/docs/api/authentication#client-credentials
Expand All @@ -66,7 +92,7 @@ def obtain_access_token(access_token = nil, connection = 'facebook', scope = 'op
end

# Get access and ID tokens using an Authorization Code.
# TODO: Deprecate, use the auth_code_exchange method in this module instead.
# TODO: Deprecate, use the exchange_auth_code_for_tokens method in this module instead.
# @see https://auth0.com/docs/api/authentication#authorization-code
# @param code [string] The access code obtained through passive authentication
# @param redirect_uri [string] Url to redirect after authorization
Expand Down
99 changes: 91 additions & 8 deletions spec/lib/auth0/api/authentication_endpoints_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,17 @@
end


context '.auth_code_exchange' do
context '.exchange_auth_code_for_tokens' do
it { is_expected.to respond_to(:exchange_auth_code_for_tokens) }

it 'is expected to make post request to /oauth/token' do
it 'is expected to make post request to /oauth/token with default params' do
allow(@instance).to receive(:post).with(
'/oauth/token',
client_id: @instance.client_id,
client_secret: @instance.client_secret,
grant_type: 'authorization_code',
code: '__test_auth_code__',
redirect_uri: '__test_redirect_uri__'
redirect_uri: nil
).and_return('access_token' => 'AccessToken')

is_expected.to receive(:post).with(
Expand All @@ -110,27 +110,110 @@
client_secret: @instance.client_secret,
grant_type: 'authorization_code',
code: '__test_auth_code__',
redirect_uri: nil
)

expect(
@instance.exchange_auth_code_for_tokens(
'__test_auth_code__'
)['access_token']
).to eq 'AccessToken'
end

it 'is expected to make post request to /oauth/token with custom params' do
allow(@instance).to receive(:post).with(
'/oauth/token',
grant_type: 'authorization_code',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__',
code: '__test_auth_code__',
redirect_uri: '__test_redirect_uri__'
).and_return('access_token' => 'AccessToken')

is_expected.to receive(:post).with(
'/oauth/token',
grant_type: 'authorization_code',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__',
code: '__test_auth_code__',
redirect_uri: '__test_redirect_uri__'
)

expect(
@instance.exchange_auth_code_for_tokens(
'__test_auth_code__',
'__test_redirect_uri__'
redirect_uri: '__test_redirect_uri__',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__'
)['access_token']
).to eq 'AccessToken'
end

it 'is expected to raise an error when the code is empty' do
expect do
@instance.exchange_auth_code_for_tokens('', '')
@instance.exchange_auth_code_for_tokens(nil)
end.to raise_error 'Must provide an authorization code'
end
end

context '.exchange_refresh_token' do
it { is_expected.to respond_to(:exchange_refresh_token) }

it 'is expected to make post request to /oauth/token with default params' do
allow(@instance).to receive(:post).with(
'/oauth/token',
grant_type: 'refresh_token',
client_id: @instance.client_id,
client_secret: @instance.client_secret,
refresh_token: '__test_refresh_token__'
).and_return('access_token' => 'AccessToken')

is_expected.to receive(:post).with(
'/oauth/token',
grant_type: 'refresh_token',
client_id: @instance.client_id,
client_secret: @instance.client_secret,
refresh_token: '__test_refresh_token__'
)

expect(
@instance.exchange_refresh_token(
'__test_refresh_token__'
)['access_token']
).to eq 'AccessToken'
end


it 'is expected to make post request to /oauth/token with custom params' do
allow(@instance).to receive(:post).with(
'/oauth/token',
grant_type: 'refresh_token',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__',
refresh_token: '__test_refresh_token__'
).and_return('access_token' => 'AccessToken')

is_expected.to receive(:post).with(
'/oauth/token',
grant_type: 'refresh_token',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__',
refresh_token: '__test_refresh_token__'
)

expect(
@instance.exchange_refresh_token(
'__test_refresh_token__',
client_id: '_test_custom_client_id__',
client_secret: '_test_custom_client_secret__'
)['access_token']
).to eq 'AccessToken'
end

it 'is expected to raise an error when the URI is empty' do
it 'is expected to raise an error when the refresh_token is empty' do
expect do
@instance.exchange_auth_code_for_tokens('code', '')
end.to raise_error 'Must provide a redirect URI'
@instance.exchange_refresh_token(nil)
end.to raise_error 'Must provide a refresh token'
end
end

Expand Down