-
-
Notifications
You must be signed in to change notification settings - Fork 50
/
Copy pathEndpointBlocksTest.php
353 lines (302 loc) · 16.3 KB
/
EndpointBlocksTest.php
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
<?php
namespace FiveamCode\LaravelNotionApi\Tests;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Block;
use FiveamCode\LaravelNotionApi\Entities\Blocks\BulletedListItem;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Embed;
use FiveamCode\LaravelNotionApi\Entities\Blocks\File;
use FiveamCode\LaravelNotionApi\Entities\Blocks\HeadingOne;
use FiveamCode\LaravelNotionApi\Entities\Blocks\HeadingThree;
use FiveamCode\LaravelNotionApi\Entities\Blocks\HeadingTwo;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Image;
use FiveamCode\LaravelNotionApi\Entities\Blocks\NumberedListItem;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Paragraph;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Pdf;
use FiveamCode\LaravelNotionApi\Entities\Blocks\ToDo;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Toggle;
use FiveamCode\LaravelNotionApi\Entities\Blocks\Video;
use FiveamCode\LaravelNotionApi\Entities\Collections\BlockCollection;
use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
use Illuminate\Support\Facades\Http;
use Notion;
/**
* Class EndpointBlocksTest.
*
* The fake API responses are based on Notions documentation.
*
* @see https://developers.notion.com/reference/get-block-children
*/
class EndpointBlocksTest extends NotionApiTest
{
/** @test */
public function it_throws_a_notion_exception_bad_request()
{
// failing /v1/blocks
Http::fake([
'https://api.notion.com/v1/blocks/b55c9c91-384d-452b-81db-d1ef79372b76/children*' => Http::response(
json_decode('{}', true),
400,
['Headers']
),
]);
$this->expectException(NotionException::class);
$this->expectExceptionMessage('Bad Request');
$this->expectExceptionCode(400);
Notion::block('b55c9c91-384d-452b-81db-d1ef79372b76')->children();
}
/** @test */
public function it_returns_block_collection_with_children()
{
// successful /v1/blocks/BLOCK_DOES_EXIST/children
Http::fake([
'https://api.notion.com/v1/blocks/b55c9c91-384d-452b-81db-d1ef79372b76/children*' => Http::response(
json_decode(file_get_contents('tests/stubs/endpoints/blocks/response_specific_block_children_200.json'), true),
200,
['Headers']
),
]);
$blockChildren = Notion::block('b55c9c91-384d-452b-81db-d1ef79372b76')->children();
$this->assertInstanceOf(BlockCollection::class, $blockChildren);
$blockChildrenCollection = $blockChildren->asCollection();
$this->assertContainsOnly(Block::class, $blockChildrenCollection);
$this->assertIsIterable($blockChildrenCollection);
$this->assertCount(3, $blockChildrenCollection);
// check first child
$blockChild = $blockChildrenCollection->first();
$this->assertInstanceOf(Block::class, $blockChild);
$this->assertEquals('heading_2', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertArrayHasKey('text', $blockChild->getRawContent());
$this->assertArrayHasKey(0, $blockChild->getRawContent()['text']);
$this->assertArrayHasKey('plain_text', $blockChild->getRawContent()['text'][0]);
$this->assertEquals('Lacinato kale', $blockChild->getRawContent()['text'][0]['plain_text']);
}
/** @test */
public function it_returns_block_collection_with_children_as_correct_instances()
{
// successful /v1/blocks/BLOCK_DOES_EXIST/children
Http::fake([
'https://api.notion.com/v1/blocks/1d719dd1-563b-4387-b74f-20da92b827fb/children*' => Http::response(
json_decode(file_get_contents('tests/stubs/endpoints/blocks/response_specific_supported_blocks_200.json'), true),
200,
['Headers']
),
]);
$blockChildren = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->children();
$this->assertInstanceOf(BlockCollection::class, $blockChildren);
// check collection
$blockChildrenCollection = $blockChildren->asCollection();
$this->assertContainsOnly(Block::class, $blockChildrenCollection);
$this->assertIsIterable($blockChildrenCollection);
$this->assertCount(13, $blockChildrenCollection);
// check paragraph
$blockChild = $blockChildrenCollection[0];
$this->assertInstanceOf(Paragraph::class, $blockChild);
$this->assertEquals('paragraph', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('paragraph_block', $blockChild->getContent()->getPlainText());
// check heading_1
$blockChild = $blockChildrenCollection[1];
$this->assertInstanceOf(HeadingOne::class, $blockChild);
$this->assertEquals('heading_1', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('heading_one_block', $blockChild->getContent()->getPlainText());
// check heading_2
$blockChild = $blockChildrenCollection[2];
$this->assertInstanceOf(HeadingTwo::class, $blockChild);
$this->assertEquals('heading_2', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('heading_two_block', $blockChild->getContent()->getPlainText());
// check heading_3
$blockChild = $blockChildrenCollection[3];
$this->assertInstanceOf(HeadingThree::class, $blockChild);
$this->assertEquals('heading_3', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('heading_three_block', $blockChild->getContent()->getPlainText());
// check bulleted_list_item
$blockChild = $blockChildrenCollection[4];
$this->assertInstanceOf(BulletedListItem::class, $blockChild);
$this->assertEquals('bulleted_list_item', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('bulleted_list_item_block', $blockChild->getContent()->getPlainText());
// check numbered_list_item
$blockChild = $blockChildrenCollection[5];
$this->assertInstanceOf(NumberedListItem::class, $blockChild);
$this->assertEquals('numbered_list_item', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('numbered_list_item_block', $blockChild->getContent()->getPlainText());
// check to_do
$blockChild = $blockChildrenCollection[6];
$this->assertInstanceOf(ToDo::class, $blockChild);
$this->assertEquals('to_do', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('to_do_block', $blockChild->getContent()->getPlainText());
// check toggle
$blockChild = $blockChildrenCollection[7];
$this->assertInstanceOf(Toggle::class, $blockChild);
$this->assertEquals('toggle', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('toggle_block', $blockChild->getContent()->getPlainText());
// check embed
$blockChild = $blockChildrenCollection[8];
$this->assertInstanceOf(Embed::class, $blockChild);
$this->assertEquals('embed', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('Testcaption', $blockChild->getCaption()->getPlainText());
$this->assertEquals('https://notion.so', $blockChild->getUrl());
// check image
$blockChild = $blockChildrenCollection[9];
$this->assertInstanceOf(Image::class, $blockChild);
$this->assertEquals('image', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('test', $blockChild->getCaption()->getPlainText());
$this->assertEquals('external', $blockChild->getHostingType());
$this->assertEquals('https://images.unsplash.com/photo-1593642533144-3d62aa4783ec?ixlib=rb-1.2.1&q=85&fm=jpg&crop=entropy&cs=srgb', $blockChild->getUrl());
// check file
$blockChild = $blockChildrenCollection[10];
$this->assertInstanceOf(File::class, $blockChild);
$this->assertEquals('file', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('TestCaption', $blockChild->getCaption()->getPlainText());
$this->assertEquals('external', $blockChild->getHostingType());
$this->assertEquals('https://images.unsplash.com/photo-1593642533144-3d62aa4783ec?ixlib=rb-1.2.1&q=85&fm=jpg&crop=entropy&cs=srgb', $blockChild->getUrl());
// check video
$blockChild = $blockChildrenCollection[11];
$this->assertInstanceOf(Video::class, $blockChild);
$this->assertEquals('video', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('TestCaption', $blockChild->getCaption()->getPlainText());
$this->assertEquals('external', $blockChild->getHostingType());
$this->assertEquals('https://www.w3schools.com/html/mov_bbb.mp4', $blockChild->getUrl());
// check pdf
$blockChild = $blockChildrenCollection[12];
$this->assertInstanceOf(Pdf::class, $blockChild);
$this->assertEquals('pdf', $blockChild->getType());
$this->assertFalse($blockChild->hasChildren());
$this->assertEquals('TestCaption', $blockChild->getCaption()->getPlainText());
$this->assertEquals('external', $blockChild->getHostingType());
$this->assertEquals('https://notion.so/testpdf.pdf', $blockChild->getUrl());
}
/** @test */
public function it_throws_a_notion_exception_not_found()
{
// failing /v1/blocks/BLOCK_DOES_NOT_EXIST/children
Http::fake([
'https://api.notion.com/v1/blocks/b55c9c91-384d-452b-81db-d1ef79372b11*' => Http::response(
json_decode(file_get_contents('tests/stubs/endpoints/blocks/response_specific_404.json'), true),
200,
['Headers']
),
]);
$this->expectException(NotionException::class);
$this->expectExceptionMessage('Not found');
$this->expectExceptionCode(404);
Notion::block('b55c9c91-384d-452b-81db-d1ef79372b11')->children();
}
/** @test */
public function it_returns_parent_block_in_which_new_blocks_have_been_successfully_appended()
{
//TODO: Change in release 0.7.0 or 0.8.0
//!IMPORTANT: This will be changed in Notion version 2021-08-16, because a list of the newly created block children will be returned
//!https://developers.notion.com/changelog/notion-version-2021-08-16#append-block-children-returns-a-list-of-blocks
// successful /v1/blocks/BLOCK_DOES_EXIST/children [patch]
Http::fake([
'https://api.notion.com/v1/blocks/1d719dd1-563b-4387-b74f-20da92b827fb/children*' => Http::response(
json_decode(file_get_contents('tests/stubs/endpoints/blocks/response_specific_block_200.json'), true),
200,
['Headers']
),
]);
$paragraph = Paragraph::create('New TextBlock');
$bulletedListItem = BulletedListItem::create('New TextBlock');
$headingOne = HeadingOne::create('New TextBlock');
$headingTwo = HeadingTwo::create('New TextBlock');
$headingThree = HeadingThree::create('New TextBlock');
$numberedListItem = NumberedListItem::create('New TextBlock');
$toDo = ToDo::create('New TextBlock');
$toggle = Toggle::create(['New TextBlock']);
$embed = Embed::create('https://5amco.de', 'Testcaption');
$image = Image::create('https://images.unsplash.com/photo-1593642533144-3d62aa4783ec?ixlib=rb-1.2.1&q=85&fm=jpg&crop=entropy&cs=srgb', 'Testcaption');
$file = File::create('https://images.unsplash.com/photo-1593642533144-3d62aa4783ec?ixlib=rb-1.2.1&q=85&fm=jpg&crop=entropy&cs=srgb', 'Testcaption');
$video = Video::create('https://www.w3schools.com/html/mov_bbb.mp4', 'TestCaption');
$pdf = Pdf::create('https://notion.so/testpdf.pdf', 'TestCaption');
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($paragraph);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($bulletedListItem);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($headingOne);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($headingTwo);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($headingThree);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($numberedListItem);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($toDo);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($toggle);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($embed);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($image);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($file);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($video);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append($pdf);
$this->assertInstanceOf(Block::class, $parentBlock);
$parentBlock = Notion::block('1d719dd1-563b-4387-b74f-20da92b827fb')->append([$paragraph, $bulletedListItem, $headingOne, $headingTwo, $headingThree, $numberedListItem, $toDo, $toggle, $embed, $image, $video, $pdf]);
$this->assertInstanceOf(Block::class, $parentBlock);
}
/**
* @dataProvider classProvider
*/
public function classProvider(): array
{
return [
[BulletedListItem::class],
[HeadingOne::class],
[HeadingTwo::class],
[HeadingThree::class],
[NumberedListItem::class],
[Paragraph::class],
[ToDo::class],
[Toggle::class],
];
}
/**
* @test
*
* @dataProvider classProvider
*
* @param $entityClass
*/
public function it_throws_an_handling_exception_for_wrong_type($entityClass)
{
$this->expectException(HandlingException::class);
$paragraph = $entityClass::create(new \stdClass());
}
/** @test */
public function it_retrieves_a_single_block()
{
// successful /v1/blocks/BLOCK_DOES_EXIST
Http::fake([
'https://api.notion.com/v1/blocks/a6f8ebe8d5df4ffab543bcd54d1c3bad' => Http::response(
json_decode(file_get_contents('tests/stubs/endpoints/blocks/response_specific_block_200.json'), true),
200,
['Headers']
),
]);
$block = \Notion::block('a6f8ebe8d5df4ffab543bcd54d1c3bad')->retrieve();
$this->assertInstanceOf(Block::class, $block);
$this->assertInstanceOf(Paragraph::class, $block);
$this->assertEquals('a6f8ebe8-d5df-4ffa-b543-bcd54d1c3bad', $block->getId());
$this->assertEquals('paragraph', $block->getType());
$this->assertEquals('This is a paragraph test', $block->getContent()->getPlainText());
$this->assertEquals('block', $block->getObjectType());
$this->assertEquals('page_id', $block->getParentType());
$this->assertEquals('f2939732-f694-4ce2-b613-f28db6ded673', $block->getParentId());
$this->assertTrue($block->isArchived());
}
}