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
|
# frozen_string_literal: true
require 'spec_helper'
require 'grape_entity'
describe Grape::Entity do
subject { Class.new(Grape::API) }
def app
subject
end
describe '#present' do
it 'sets the object as the body if no options are provided' do
inner_body = nil
subject.get '/example' do
present(abc: 'def')
inner_body = body
end
get '/example'
expect(inner_body).to eql(abc: 'def')
end
it 'calls through to the provided entity class if one is given' do
entity_mock = Object.new
allow(entity_mock).to receive(:represent)
subject.get '/example' do
present Object.new, with: entity_mock
end
get '/example'
end
it 'pulls a representation from the class options if it exists' do
entity = Class.new(described_class)
allow(entity).to receive(:represent).and_return('Hiya')
subject.represent Object, with: entity
subject.get '/example' do
present Object.new
end
get '/example'
expect(last_response.body).to eq('Hiya')
end
it 'pulls a representation from the class options if the presented object is a collection of objects' do
entity = Class.new(described_class)
allow(entity).to receive(:represent).and_return('Hiya')
module EntitySpec
class TestObject
end
class FakeCollection
def first
TestObject.new
end
end
end
subject.represent EntitySpec::TestObject, with: entity
subject.get '/example' do
present [EntitySpec::TestObject.new]
end
subject.get '/example2' do
present EntitySpec::FakeCollection.new
end
get '/example'
expect(last_response.body).to eq('Hiya')
get '/example2'
expect(last_response.body).to eq('Hiya')
end
it 'pulls a representation from the class ancestor if it exists' do
entity = Class.new(described_class)
allow(entity).to receive(:represent).and_return('Hiya')
subclass = Class.new(Object)
subject.represent Object, with: entity
subject.get '/example' do
present subclass.new
end
get '/example'
expect(last_response.body).to eq('Hiya')
end
it 'automatically uses Klass::Entity if that exists' do
some_model = Class.new
entity = Class.new(described_class)
allow(entity).to receive(:represent).and_return('Auto-detect!')
some_model.const_set :Entity, entity
subject.get '/example' do
present some_model.new
end
get '/example'
expect(last_response.body).to eq('Auto-detect!')
end
it 'automatically uses Klass::Entity based on the first object in the collection being presented' do
some_model = Class.new
entity = Class.new(described_class)
allow(entity).to receive(:represent).and_return('Auto-detect!')
some_model.const_set :Entity, entity
subject.get '/example' do
present [some_model.new]
end
get '/example'
expect(last_response.body).to eq('Auto-detect!')
end
it 'does not run autodetection for Entity when explicitly provided' do
entity = Class.new(described_class)
some_array = []
subject.get '/example' do
present some_array, with: entity
end
expect(some_array).not_to receive(:first)
get '/example'
end
it 'does not use #first method on ActiveRecord::Relation to prevent needless sql query' do
entity = Class.new(described_class)
some_relation = Class.new
some_model = Class.new
allow(entity).to receive(:represent).and_return('Auto-detect!')
allow(some_relation).to receive(:first)
allow(some_relation).to receive(:klass).and_return(some_model)
some_model.const_set :Entity, entity
subject.get '/example' do
present some_relation
end
expect(some_relation).not_to receive(:first)
get '/example'
expect(last_response.body).to eq('Auto-detect!')
end
it 'autodetection does not use Entity if it is not a presenter' do
some_model = Class.new
entity = Class.new
some_model.class.const_set :Entity, entity
subject.get '/example' do
present some_model
end
get '/example'
expect(entity).not_to receive(:represent)
end
it 'adds a root key to the output if one is given' do
inner_body = nil
subject.get '/example' do
present({ abc: 'def' }, root: :root)
inner_body = body
end
get '/example'
expect(inner_body).to eql(root: { abc: 'def' })
end
%i[json serializable_hash].each do |format|
it "presents with #{format}" do
entity = Class.new(described_class)
entity.root 'examples', 'example'
entity.expose :id
subject.format format
subject.get '/example' do
c = Class.new do
attr_reader :id
def initialize(id)
@id = id
end
end
present c.new(1), with: entity
end
get '/example'
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('{"example":{"id":1}}')
end
it "presents with #{format} collection" do
entity = Class.new(described_class)
entity.root 'examples', 'example'
entity.expose :id
subject.format format
subject.get '/examples' do
c = Class.new do
attr_reader :id
def initialize(id)
@id = id
end
end
examples = [c.new(1), c.new(2)]
present examples, with: entity
end
get '/examples'
expect(last_response.status).to eq(200)
expect(last_response.body).to eq('{"examples":[{"id":1},{"id":2}]}')
end
end
it 'presents with xml' do
entity = Class.new(described_class)
entity.root 'examples', 'example'
entity.expose :name
subject.format :xml
subject.get '/example' do
c = Class.new do
attr_reader :name
def initialize(args)
@name = args[:name] || 'no name set'
end
end
present c.new(name: 'johnnyiller'), with: entity
end
get '/example'
expect(last_response.status).to eq(200)
expect(last_response.headers['Content-type']).to eq('application/xml')
expect(last_response.body).to eq <<~XML
<?xml version="1.0" encoding="UTF-8"?>
<hash>
<example>
<name>johnnyiller</name>
</example>
</hash>
XML
end
it 'presents with json' do
entity = Class.new(described_class)
entity.root 'examples', 'example'
entity.expose :name
subject.format :json
subject.get '/example' do
c = Class.new do
attr_reader :name
def initialize(args)
@name = args[:name] || 'no name set'
end
end
present c.new(name: 'johnnyiller'), with: entity
end
get '/example'
expect(last_response.status).to eq(200)
expect(last_response.headers['Content-type']).to eq('application/json')
expect(last_response.body).to eq('{"example":{"name":"johnnyiller"}}')
end
it 'presents with jsonp utilising Rack::JSONP' do
# Include JSONP middleware
subject.use Rack::JSONP
entity = Class.new(described_class)
entity.root 'examples', 'example'
entity.expose :name
# Rack::JSONP expects a standard JSON response in UTF-8 format
subject.format :json
subject.formatter :json, lambda { |object, _|
object.to_json.encode('utf-8')
}
subject.get '/example' do
c = Class.new do
attr_reader :name
def initialize(args)
@name = args[:name] || 'no name set'
end
end
present c.new(name: 'johnnyiller'), with: entity
end
get '/example?callback=abcDef'
expect(last_response.status).to eq(200)
expect(last_response.headers['Content-type']).to eq('application/javascript')
expect(last_response.body).to include 'abcDef({"example":{"name":"johnnyiller"}})'
end
context 'present with multiple entities' do
it 'present with multiple entities using optional symbol' do
user = Class.new do
attr_reader :name
def initialize(args)
@name = args[:name] || 'no name set'
end
end
user1 = user.new(name: 'user1')
user2 = user.new(name: 'user2')
entity = Class.new(described_class)
entity.expose :name
subject.format :json
subject.get '/example' do
present :page, 1
present :user1, user1, with: entity
present :user2, user2, with: entity
end
get '/example'
expect_response_json = {
'page' => 1,
'user1' => { 'name' => 'user1' },
'user2' => { 'name' => 'user2' }
}
expect(JSON(last_response.body)).to eq(expect_response_json)
end
end
end
end
|
