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
|
# frozen_string_literal: true
shared_examples_for 'versioning' do
it 'sets the API version' do
subject.format :txt
subject.version 'v1', macro_options
subject.get :hello do
"Version: #{request.env['api.version']}"
end
versioned_get '/hello', 'v1', **macro_options
expect(last_response.body).to eql 'Version: v1'
end
it 'adds the prefix before the API version' do
subject.format :txt
subject.prefix 'api'
subject.version 'v1', macro_options
subject.get :hello do
"Version: #{request.env['api.version']}"
end
versioned_get '/hello', 'v1', **macro_options.merge(prefix: 'api')
expect(last_response.body).to eql 'Version: v1'
end
it 'is able to specify version as a nesting' do
subject.version 'v2', macro_options
subject.get '/awesome' do
'Radical'
end
subject.version 'v1', macro_options do
get '/legacy' do
'Totally'
end
end
versioned_get '/awesome', 'v1', **macro_options
expect(last_response.status).to be 404
versioned_get '/awesome', 'v2', **macro_options
expect(last_response.status).to be 200
versioned_get '/legacy', 'v1', **macro_options
expect(last_response.status).to be 200
versioned_get '/legacy', 'v2', **macro_options
expect(last_response.status).to be 404
end
it 'is able to specify multiple versions' do
subject.version 'v1', 'v2', macro_options
subject.get 'awesome' do
'I exist'
end
versioned_get '/awesome', 'v1', **macro_options
expect(last_response.status).to be 200
versioned_get '/awesome', 'v2', **macro_options
expect(last_response.status).to be 200
versioned_get '/awesome', 'v3', **macro_options
expect(last_response.status).to be 404
end
context 'with different versions for the same endpoint' do
context 'without a prefix' do
it 'allows the same endpoint to be implemented' do
subject.format :txt
subject.version 'v2', macro_options
subject.get 'version' do
request.env['api.version']
end
subject.version 'v1', macro_options do
get 'version' do
"version #{request.env['api.version']}"
end
end
versioned_get '/version', 'v2', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v2')
versioned_get '/version', 'v1', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('version v1')
end
end
context 'with a prefix' do
it 'allows the same endpoint to be implemented' do
subject.format :txt
subject.prefix 'api'
subject.version 'v2', macro_options
subject.get 'version' do
request.env['api.version']
end
subject.version 'v1', macro_options do
get 'version' do
"version #{request.env['api.version']}"
end
end
versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('version v1')
versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v2')
end
end
end
context 'with before block defined within a version block' do
it 'calls before block that is defined within the version block' do
subject.format :txt
subject.prefix 'api'
subject.version 'v2', macro_options do
before do
@output ||= 'v2-'
end
get 'version' do
@output += 'version'
end
end
subject.version 'v1', macro_options do
before do
@output ||= 'v1-'
end
get 'version' do
@output += 'version'
end
end
versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v1-version')
versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v2-version')
end
end
it 'does not overwrite version parameter with API version' do
subject.format :txt
subject.version 'v1', macro_options
subject.params { requires :version }
subject.get :api_version_with_version_param do
params[:version]
end
versioned_get '/api_version_with_version_param?version=1', 'v1', **macro_options
expect(last_response.body).to eql '1'
end
context 'with catch-all' do
let(:options) { macro_options }
let(:v1) do
klass = Class.new(Grape::API)
klass.version 'v1', options
klass.get 'version' do
'v1'
end
klass
end
let(:v2) do
klass = Class.new(Grape::API)
klass.version 'v2', options
klass.get 'version' do
'v2'
end
klass
end
before do
subject.format :txt
subject.mount v1
subject.mount v2
subject.route :any, '*path' do
params[:path]
end
end
context 'v1' do
it 'finds endpoint' do
versioned_get '/version', 'v1', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v1')
end
it 'finds catch all' do
versioned_get '/whatever', 'v1', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to end_with 'whatever'
end
end
context 'v2' do
it 'finds endpoint' do
versioned_get '/version', 'v2', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('v2')
end
it 'finds catch all' do
versioned_get '/whatever', 'v2', **macro_options
expect(last_response.status).to eq(200)
expect(last_response.body).to end_with 'whatever'
end
end
end
end
|
