Snapshot and Fake Tests Later

.gitignore

@@ -2,4 +2,5 @@
 vendor
 .phpunit.result.cache
 coverage/
-.phpunit.cache/
+.phpunit.cache/
+.env*

src/LaravelNotionApiServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace FiveamCode\LaravelNotionApi;
 
+use FiveamCode\LaravelNotionApi\Macros\PestHttpRecorder;
 use Illuminate\Support\ServiceProvider;
 
 /**
@@ -32,5 +33,9 @@ public function register()
         $this->app->singleton(Notion::class, function () {
             return new Notion(config('laravel-notion-api.notion-api-token'), config('laravel-notion-api.version'));
         });
+
+        if ($this->app->runningInConsole()) {
+            PestHttpRecorder::register();
+        }
     }
 }

src/Macros/PestHttpRecorder.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Macros;
+
+use GuzzleHttp\Client;
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Str;
+
+class PestHttpRecorder
+{
+    public static function register()
+    {
+        Http::macro('recordAndFakeLater', function (array|string $urls = ['*']) {
+            if (! is_array($urls)) {
+                $urls = [$urls];
+            }
+
+            $recorder = new HttpRecorder();
+            $httpFakeCallbacks = [];
+
+            foreach ($urls as $url) {
+                $httpFakeCallbacks[$url] = fn (Request $request) => $recorder->handle($request);
+            }
+
+            Http::fake($httpFakeCallbacks);
+
+            return $recorder;
+        });
+    }
+}
+
+class HttpRecorder
+{
+    private $snapshotDirectory = 'snapshots';
+
+    private $usePrettyJson = true;
+
+    public function storeIn($directory)
+    {
+        $this->snapshotDirectory = $directory;
+
+        return $this;
+    }
+
+    public function minifyJson()
+    {
+        $this->usePrettyJson = false;
+
+        return $this;
+    }
+
+    public function handle(Request $request)
+    {
+        $forceRecording = in_array('--force-recording', $_SERVER['argv']);
+
+        $urlInfo = parse_url($request->url());
+
+        // create specific filename for storing snapshots
+        $method = Str::lower($request->method());
+        $name = Str::slug(Str::replace('/', '-', $urlInfo['path']));
+        $query = Str::slug(Str::replace('&', '_', Str::replace('=', '-', $urlInfo['query'])));
+
+        $fileName = "{$method}_{$name}_{$query}.json";
+        $directoryPath = "tests/{$this->snapshotDirectory}";
+        $filePath = "{$directoryPath}/{$fileName}";
+
+        if ($forceRecording || ! File::exists($filePath)) {
+            File::makeDirectory($directoryPath, 0744, true, true);
+
+            $client = new Client();
+            $response = $client->request($request->method(), $request->url(), [
+                'headers' => $request->headers(),
+                'body' => $request->body(),
+                'http_errors' => false,
+            ]);
+
+            $recordedResponse = [
+                'status' => $response->getStatusCode(),
+                'data' => json_decode($response->getBody()->getContents(), true),
+            ];
+
+            file_put_contents(
+                $filePath,
+                json_encode($recordedResponse, $this->usePrettyJson ? JSON_PRETTY_PRINT : 0)
+            );
+
+            return Http::response($recordedResponse['data'], $response->getStatusCode());
+        }
+
+        $preRecordedData = json_decode(file_get_contents($filePath), true);
+
+        return Http::response($preRecordedData['data'], $preRecordedData['status']);
+    }
+}

tests/EndpointBlocksTest.php

@@ -314,6 +314,7 @@ public function classProvider(): array
 
     /**
      * @test
+     *
      * @dataProvider classProvider
      *
      * @param $entityClass

tests/EndpointCommentsTest.php

@@ -42,7 +42,6 @@
 });
 
 it('should fetch list of comments with an accurate representation of attributes', function () {
-
     // successfull /v1/comments
     Http::fake([
         'https://api.notion.com/v1/comments?block_id=abf6b0af-6eaa-45ca-9715-9fa147ef6b17*' => Http::response(
@@ -114,7 +113,6 @@
 });
 
 it('successfully creates a comment within a page', function () {
-
     // successfull (post) /v1/comments
     Http::fake([
         'https://api.notion.com/v1/comments*' => Http::response(

tests/EndpointDatabaseTest.php

@@ -29,8 +29,7 @@
  * @see https://developers.notion.com/reference/post-database-query
  */
 it('returns a database endpoint instance', function () {
-
-// TODO update for new Filter behaviour
+    // TODO update for new Filter behaviour
     $endpoint = Notion::database('897e5a76ae524b489fdfe71f5945d1af');
 
     $this->assertInstanceOf(Database::class, $endpoint);
@@ -136,7 +135,6 @@
 });
 
 it('throws a notion exception for a bad request', function () {
-
     // failing /v1/databases
     Http::fake([
         'https://api.notion.com/v1/databases/8284f3ff77e24d4a939d19459e4d6bdc/query*' => Http::response(

tests/EndpointPagesTest.php

@@ -107,7 +107,6 @@ public function it_throws_a_notion_exception_not_found()
     /** @test */
     public function it_assembles_properties_for_a_new_page()
     {
-
         // test values
         $pageId = '0349b883a1c64539b435289ea62b6eab';
         $pageTitle = 'I was updated from Tinkerwell';

tests/FilterBagTest.php

@@ -128,7 +128,6 @@
 });
 
 it('creates a filter bag with with the AND operator and a nested OR condition', function () {
-
     // Filter for all entries that are
     // (KnownFor == Univac && (Name == Grace || Name == Jean))
 

tests/Pest.php

@@ -1,5 +1,13 @@
 <?php
 
+use Dotenv\Dotenv;
 use FiveamCode\LaravelNotionApi\Tests\NotionApiTest;
+use Illuminate\Support\Facades\Config;
 
-uses(NotionApiTest::class)->in(__DIR__);
+uses(NotionApiTest::class)->beforeEach(function () {
+    if (file_exists(__DIR__.'/../.env.testing')) {
+        $dotenv = Dotenv::createImmutable(__DIR__.'/..', '.env.testing');
+        $dotenv->load();
+    }
+    Config::set('laravel-notion-api.notion-api-token', env('NOTION_API_TOKEN', ''));
+})->in(__DIR__);

tests/RecordedEndpointCommentsTest.php

@@ -0,0 +1,49 @@
+<?php
+
+use Carbon\Carbon;
+use FiveamCode\LaravelNotionApi\Entities\Collections\CommentCollection;
+use FiveamCode\LaravelNotionApi\Entities\Comment;
+use FiveamCode\LaravelNotionApi\Entities\PropertyItems\RichText;
+use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
+use Illuminate\Support\Facades\Http;
+
+beforeEach(function () {
+    Http::recordAndFakeLater('https://api.notion.com/v1/comments*')
+        ->storeIn('snapshots/comments');
+});
+
+it('should fetch list of comments with an accurate representation of attributes', function () {
+    $commentCollection = \Notion::comments()->ofBlock('cb588bcbcbdb4f2eac3db05446b8f5d9');
+
+    $collection = $commentCollection->asCollection();
+    $json = $commentCollection->asJson();
+
+    expect($commentCollection)->toBeInstanceOf(CommentCollection::class);
+    expect($collection)->toBeInstanceOf(\Illuminate\Support\Collection::class);
+    expect($json)->toBeString();
+
+    expect($collection->count())->toBe(1);
+    expect($collection->first())->toBeInstanceOf(Comment::class);
+    expect($collection->first()->getObjectType())->toBe('comment');
+    expect($collection->first()->getId())->toBe('99457ae4-8262-413a-b224-0bd82346d885');
+    expect($collection->first()->getCreatedTime())->toEqual(Carbon::parse('2023-02-18T10:53:00.000000+0000')->toDateTime());
+    expect($collection->first()->getLastEditedTime())->toEqual(Carbon::parse('2023-02-18T10:53:00.000000+0000')->toDateTime());
+    expect($collection->first()->getCreatedBy()->getId())->toBe('04536682-603a-4531-a18f-4fa89fdfb4a8');
+    expect($collection->first()->getLastEditedBy())->toBe(null);
+    expect($collection->first()->getText())->toBe('This is a Test Comment for Laravel');
+    expect($collection->first()->getRichText()->getPlainText())->toBe('This is a Test Comment for Laravel');
+    expect($collection->first()->getRichText())->toBeInstanceOf(RichText::class);
+    expect($collection->first()->getParentId())->toBe('cb588bcb-cbdb-4f2e-ac3d-b05446b8f5d9');
+    expect($collection->first()->getParentType())->toBe('page_id');
+    expect($collection->first()->getDiscussionId())->toBe('f203fa27-fe02-40c9-be9f-fb35e2e956ba');
+
+    expect($json)->toBeJson();
+});
+
+it('should throw correct exception if block_id has not been found when listing comments', function () {
+    $this->expectException(NotionException::class);
+    $this->expectExceptionMessage('Not Found');
+    $this->expectExceptionCode(404);
+
+    \Notion::comments()->ofBlock('cbf6b0af-6eaa-45ca-9715-9fa147ef6b17')->list();
+});

tests/snapshots/comments/get_v1-comments_block-id-cb588bcbcbdb4f2eac3db05446b8f5d9-page-size-100.json

@@ -0,0 +1,46 @@
+{
+    "status": 200,
+    "data": {
+        "object": "list",
+        "results": [
+            {
+                "object": "comment",
+                "id": "99457ae4-8262-413a-b224-0bd82346d885",
+                "parent": {
+                    "type": "page_id",
+                    "page_id": "cb588bcb-cbdb-4f2e-ac3d-b05446b8f5d9"
+                },
+                "discussion_id": "f203fa27-fe02-40c9-be9f-fb35e2e956ba",
+                "created_time": "2023-02-18T10:53:00.000Z",
+                "last_edited_time": "2023-02-18T10:53:00.000Z",
+                "created_by": {
+                    "object": "user",
+                    "id": "04536682-603a-4531-a18f-4fa89fdfb4a8"
+                },
+                "rich_text": [
+                    {
+                        "type": "text",
+                        "text": {
+                            "content": "This is a Test Comment for Laravel",
+                            "link": null
+                        },
+                        "annotations": {
+                            "bold": false,
+                            "italic": false,
+                            "strikethrough": false,
+                            "underline": false,
+                            "code": false,
+                            "color": "default"
+                        },
+                        "plain_text": "This is a Test Comment for Laravel",
+                        "href": null
+                    }
+                ]
+            }
+        ],
+        "next_cursor": null,
+        "has_more": false,
+        "type": "comment",
+        "comment": []
+    }
+}

tests/snapshots/comments/get_v1-comments_block-id-cbf6b0af-6eaa-45ca-9715-9fa147ef6b17-page-size-100.json

@@ -0,0 +1,9 @@
+{
+    "status": 404,
+    "data": {
+        "object": "error",
+        "status": 404,
+        "code": "object_not_found",
+        "message": "Could not find block with ID: cbf6b0af-6eaa-45ca-9715-9fa147ef6b17. Make sure the relevant pages and databases are shared with your integration."
+    }
+}