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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
|
# frozen_string_literal: true
require 'spec_helper'
require 'shared/versioning_examples'
describe Grape::API do
subject(:a_remounted_api) { Class.new(described_class) }
let(:root_api) { Class.new(described_class) }
def app
root_api
end
describe 'remounting an API' do
context 'with a defined route' do
before do
a_remounted_api.get '/votes' do
'10 votes'
end
end
context 'when mounting one instance' do
before do
root_api.mount a_remounted_api
end
it 'can access the endpoint' do
get '/votes'
expect(last_response.body).to eql '10 votes'
end
end
context 'when mounting twice' do
before do
root_api.mount a_remounted_api => '/posts'
root_api.mount a_remounted_api => '/comments'
end
it 'can access the votes in both places' do
get '/posts/votes'
expect(last_response.body).to eql '10 votes'
get '/comments/votes'
expect(last_response.body).to eql '10 votes'
end
end
context 'when mounting on namespace' do
before do
stub_const('StaticRefToAPI', a_remounted_api)
root_api.namespace 'posts' do
mount StaticRefToAPI
end
root_api.namespace 'comments' do
mount StaticRefToAPI
end
end
it 'can access the votes in both places' do
get '/posts/votes'
expect(last_response.body).to eql '10 votes'
get '/comments/votes'
expect(last_response.body).to eql '10 votes'
end
end
end
describe 'with dynamic configuration' do
context 'when mounting an endpoint conditional on a configuration' do
subject(:a_remounted_api) do
Class.new(described_class) do
get 'always' do
'success'
end
given configuration[:mount_sometimes] do
get 'sometimes' do
'sometimes'
end
end
end
end
it 'mounts the endpoints only when configured to do so' do
root_api.mount({ a_remounted_api => 'with_conditional' }, with: { mount_sometimes: true })
root_api.mount({ a_remounted_api => 'without_conditional' }, with: { mount_sometimes: false })
get '/with_conditional/always'
expect(last_response.body).to eq 'success'
get '/with_conditional/sometimes'
expect(last_response.body).to eq 'sometimes'
get '/without_conditional/always'
expect(last_response.body).to eq 'success'
get '/without_conditional/sometimes'
expect(last_response.status).to eq 404
end
end
context 'when using an expression derived from a configuration' do
subject(:a_remounted_api) do
Class.new(described_class) do
get(mounted { "api_name_#{configuration[:api_name]}" }) do
'success'
end
end
end
before do
root_api.mount a_remounted_api, with: {
api_name: 'a_name'
}
end
it 'mounts the endpoint with the name' do
get 'api_name_a_name'
expect(last_response.body).to eq 'success'
end
it 'does not mount the endpoint with a null name' do
get 'api_name_'
expect(last_response.body).not_to eq 'success'
end
context 'when the expression lives in a namespace' do
subject(:a_remounted_api) do
Class.new(described_class) do
namespace :base do
get(mounted { "api_name_#{configuration[:api_name]}" }) do
'success'
end
end
end
end
it 'mounts the endpoint with the name' do
get 'base/api_name_a_name'
expect(last_response.body).to eq 'success'
end
it 'does not mount the endpoint with a null name' do
get 'base/api_name_'
expect(last_response.body).not_to eq 'success'
end
end
end
context 'when executing a standard block within a `mounted` block with all dynamic params' do
subject(:a_remounted_api) do
Class.new(described_class) do
mounted do
desc configuration[:description] do
headers configuration[:headers]
end
get configuration[:endpoint] do
configuration[:response]
end
end
end
end
let(:api_endpoint) { 'custom_endpoint' }
let(:api_response) { 'custom response' }
let(:endpoint_description) { 'this is a custom API' }
let(:headers) do
{
'XAuthToken' => {
'description' => 'Validates your identity',
'required' => true
}
}
end
it 'mounts the API and obtains the description and headers definition' do
root_api.mount a_remounted_api, with: {
description: endpoint_description,
headers: headers,
endpoint: api_endpoint,
response: api_response
}
get api_endpoint
expect(last_response.body).to eq api_response
expect(a_remounted_api.instances.last.endpoints.first.options[:route_options][:description])
.to eq endpoint_description
expect(a_remounted_api.instances.last.endpoints.first.options[:route_options][:headers])
.to eq headers
end
end
context 'when executing a custom block on mount' do
subject(:a_remounted_api) do
Class.new(described_class) do
get 'always' do
'success'
end
mounted do
configuration[:endpoints].each do |endpoint_name, endpoint_response|
get endpoint_name do
endpoint_response
end
end
end
end
end
it 'mounts the endpoints only when configured to do so' do
root_api.mount a_remounted_api, with: { endpoints: { 'api_name' => 'api_response' } }
get 'api_name'
expect(last_response.body).to eq 'api_response'
end
end
context 'when the configuration is part of the arguments of a method' do
subject(:a_remounted_api) do
Class.new(described_class) do
get configuration[:endpoint_name] do
'success'
end
end
end
it 'mounts the endpoint in the location it is configured' do
root_api.mount a_remounted_api, with: { endpoint_name: 'some_location' }
get '/some_location'
expect(last_response.body).to eq 'success'
get '/different_location'
expect(last_response.status).to eq 404
root_api.mount a_remounted_api, with: { endpoint_name: 'new_location' }
get '/new_location'
expect(last_response.body).to eq 'success'
end
context 'when the configuration is the value in a key-arg pair' do
subject(:a_remounted_api) do
Class.new(described_class) do
version 'v1', using: :param, parameter: configuration[:version_param]
get 'endpoint' do
'version 1'
end
version 'v2', using: :param, parameter: configuration[:version_param]
get 'endpoint' do
'version 2'
end
end
end
it 'takes the param from the configuration' do
root_api.mount a_remounted_api, with: { version_param: 'param_name' }
get '/endpoint?param_name=v1'
expect(last_response.body).to eq 'version 1'
get '/endpoint?param_name=v2'
expect(last_response.body).to eq 'version 2'
get '/endpoint?wrong_param_name=v2'
expect(last_response.body).to eq 'version 1'
end
end
end
context 'on the DescSCope' do
subject(:a_remounted_api) do
Class.new(described_class) do
desc 'The description of this' do
tags ['not_configurable_tag', configuration[:a_configurable_tag]]
end
get 'location' do
'success'
end
end
end
it 'mounts the endpoint with the appropiate tags' do
root_api.mount({ a_remounted_api => 'integer' }, with: { a_configurable_tag: 'a configured tag' })
end
end
context 'on the ParamScope' do
subject(:a_remounted_api) do
Class.new(described_class) do
params do
requires configuration[:required_param], type: configuration[:required_type]
end
get 'location' do
'success'
end
end
end
it 'mounts the endpoint in the location it is configured' do
root_api.mount({ a_remounted_api => 'string' }, with: { required_param: 'param_key', required_type: String })
root_api.mount({ a_remounted_api => 'integer' }, with: { required_param: 'param_integer', required_type: Integer })
get '/string/location', param_key: 'a'
expect(last_response.body).to eq 'success'
get '/string/location', param_integer: 1
expect(last_response.status).to eq 400
get '/integer/location', param_integer: 1
expect(last_response.body).to eq 'success'
get '/integer/location', param_integer: 'a'
expect(last_response.status).to eq 400
end
context 'on dynamic checks' do
subject(:a_remounted_api) do
Class.new(described_class) do
params do
optional :restricted_values, values: -> { [configuration[:allowed_value], 'always'] }
end
get 'location' do
'success'
end
end
end
it 'can read the configuration on lambdas' do
root_api.mount a_remounted_api, with: { allowed_value: 'sometimes' }
get '/location', restricted_values: 'always'
expect(last_response.body).to eq 'success'
get '/location', restricted_values: 'sometimes'
expect(last_response.body).to eq 'success'
get '/location', restricted_values: 'never'
expect(last_response.status).to eq 400
end
end
end
context 'when the configuration is read within a namespace' do
before do
a_remounted_api.namespace 'api' do
params do
requires configuration[:required_param]
end
get "/#{configuration[:path]}" do
'10 votes'
end
end
root_api.mount a_remounted_api, with: { path: 'votes', required_param: 'param_key' }
root_api.mount a_remounted_api, with: { path: 'scores', required_param: 'param_key' }
end
it 'will use the dynamic configuration on all routes' do
get 'api/votes', param_key: 'a'
expect(last_response.body).to eql '10 votes'
get 'api/scores', param_key: 'a'
expect(last_response.body).to eql '10 votes'
get 'api/votes'
expect(last_response.status).to eq 400
end
end
context 'a very complex configuration example' do
before do
top_level_api = Class.new(described_class) do
remounted_api = Class.new(Grape::API) do
get configuration[:endpoint_name] do
configuration[:response]
end
end
expression_namespace = mounted { configuration[:namespace].to_s * 2 }
given(mounted { configuration[:should_mount_expressed] != false }) do
namespace expression_namespace do
mount remounted_api, with: { endpoint_name: configuration[:endpoint_name], response: configuration[:endpoint_response] }
end
end
end
root_api.mount top_level_api, with: configuration_options
end
context 'when the namespace should be mounted' do
let(:configuration_options) do
{
should_mount_expressed: true,
namespace: 'bang',
endpoint_name: 'james',
endpoint_response: 'bond'
}
end
it 'gets a response' do
get 'bangbang/james'
expect(last_response.body).to eq 'bond'
end
end
context 'when should be mounted is nil' do
let(:configuration_options) do
{
should_mount_expressed: nil,
namespace: 'bang',
endpoint_name: 'james',
endpoint_response: 'bond'
}
end
it 'gets a response' do
get 'bangbang/james'
expect(last_response.body).to eq 'bond'
end
end
context 'when it should not be mounted' do
let(:configuration_options) do
{
should_mount_expressed: false,
namespace: 'bang',
endpoint_name: 'james',
endpoint_response: 'bond'
}
end
it 'gets a response' do
get 'bangbang/james'
expect(last_response.body).not_to eq 'bond'
end
end
end
context 'when the configuration is read in a helper' do
subject(:a_remounted_api) do
Class.new(described_class) do
helpers do
def printed_response
configuration[:some_value]
end
end
get 'location' do
printed_response
end
end
end
it 'will use the dynamic configuration on all routes' do
root_api.mount(a_remounted_api, with: { some_value: 'response value' })
get '/location'
expect(last_response.body).to eq 'response value'
end
end
context 'when the configuration is read within the response block' do
subject(:a_remounted_api) do
Class.new(described_class) do
get 'location' do
configuration[:some_value]
end
end
end
it 'will use the dynamic configuration on all routes' do
root_api.mount(a_remounted_api, with: { some_value: 'response value' })
get '/location'
expect(last_response.body).to eq 'response value'
end
end
end
end
end
|