-
Notifications
You must be signed in to change notification settings - Fork 470
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removed obsolet double bang !! and .nil? check in the Endpoint's hidden? method.
- Loading branch information
Showing
2 changed files
with
119 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'spec_helper' | ||
|
||
class SampleAuth < Grape::Middleware::Base | ||
module AuthMethods | ||
attr_accessor :access_token | ||
|
||
def protected_endpoint=(protected) | ||
@protected_endpoint = protected | ||
end | ||
|
||
def protected_endpoint? | ||
@protected_endpoint || false | ||
end | ||
|
||
def access_token | ||
@_access_token | ||
end | ||
|
||
def access_token=(token) | ||
@_access_token = token | ||
end | ||
end | ||
|
||
def context | ||
env['api.endpoint'] | ||
end | ||
|
||
def before | ||
context.extend(SampleAuth::AuthMethods) | ||
context.protected_endpoint = !!context.options[:route_options][:auth] | ||
|
||
return unless context.protected_endpoint? | ||
scopes = context.options[:route_options][:auth][:scopes].map(&:to_sym) | ||
authorize!(*scopes) unless scopes.include? :false | ||
context.access_token = env['HTTP_AUTHORIZATION'] | ||
end | ||
end | ||
|
||
module Extension | ||
def sample_auth(*scopes) | ||
description = route_setting(:description) || route_setting(:description, {}) | ||
description[:auth] = { scopes: scopes } | ||
end | ||
|
||
Grape::API.extend self | ||
end | ||
|
||
describe 'a guarded api endpoint' do | ||
before :all do | ||
class GuardedMountedApi < Grape::API | ||
access_token_valid = proc { |token = nil| token.nil? || token != '12345' } | ||
|
||
desc 'Show endpoint if authenticated', hidden: access_token_valid | ||
get '/auth' do | ||
{ foo: 'bar' } | ||
end | ||
end | ||
|
||
class GuardedApi < Grape::API | ||
mount GuardedMountedApi | ||
add_swagger_documentation endpoint_auth_wrapper: SampleAuth, | ||
swagger_endpoint_guard: 'sample_auth false', | ||
oauth_token: 'access_token' | ||
end | ||
end | ||
|
||
def app | ||
GuardedApi | ||
end | ||
|
||
context 'when a correct token is passed with the request' do | ||
subject do | ||
get '/swagger_doc.json', {}, 'HTTP_AUTHORIZATION' => '12345' | ||
JSON.parse(last_response.body) | ||
end | ||
|
||
it 'retrieves swagger-documentation for the endpoint' do | ||
expect(subject).to eq( | ||
'info' => { 'title' => 'API title', 'version' => '0.0.1' }, | ||
'swagger' => '2.0', | ||
'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'], | ||
'host' => 'example.org', | ||
'paths' => { | ||
'/auth' => { | ||
'get' => { | ||
'summary' => 'Show endpoint if authenticated', | ||
'description' => 'Show endpoint if authenticated', | ||
'produces' => ['application/json'], | ||
'tags' => ['auth'], | ||
'operationId' => 'getAuth', | ||
'responses' => { '200' => { 'description' => 'Show endpoint if authenticated' } } | ||
} | ||
} | ||
} | ||
) | ||
end | ||
end | ||
|
||
context 'when a bad token is passed with the request' do | ||
subject do | ||
get '/swagger_doc.json', {}, 'HTTP_AUTHORIZATION' => '123456' | ||
JSON.parse(last_response.body) | ||
end | ||
|
||
it 'does not retrieve swagger-documentation for the endpoint - only the info_object' do | ||
expect(subject).to eq( | ||
'info' => { 'title' => 'API title', 'version' => '0.0.1' }, | ||
'swagger' => '2.0', | ||
'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'], | ||
'host' => 'example.org' | ||
) | ||
end | ||
end | ||
end |