added date version to header of all requests; changed connect call order; added deprecated for public use to setToken method; expanded exception message by endpoint

mechelon · mechelon · commit 7bdfce61639e · 2021-05-30T16:32:39.000+02:00
diff --git a/src/Endpoints/Pages.php b/src/Endpoints/Pages.php
@@ -39,7 +39,7 @@ public function find(string $pageId): Page
     public function create(): array
     {
         //toDo
-        throw new HandlingException('Not implemented');
+        throw new HandlingException( 'Not implemented');
     }
 
 
diff --git a/src/Notion.php b/src/Notion.php
@@ -50,6 +50,7 @@ class Notion
      * Notion constructor.
      * @param string|null $version
      * @param string|null $token
+     * @throws HandlingException
      */
     public function __construct(string $token, string $version = 'v1')
     {
@@ -58,16 +59,20 @@ public function __construct(string $token, string $version = 'v1')
         $this->validVersions = collect(['v1']);
 
         $this->setVersion($version);
+        $this->connect();
 
     }
 
     /**
      *
      * @return Notion
+     * @throws HandlingException
      */
     private function connect(): Notion
     {
-        $this->connection = Http::withToken($this->token);
+        $this->connection = Http
+            ::withHeaders($this->buildRequestHeader())
+            ->withToken($this->token);
         return $this;
     }
 
@@ -89,6 +94,7 @@ public function setVersion(string $version): Notion
      * Wrapper function to set version to v1.
      *
      * @return $this
+     * @throws HandlingException
      */
     public function v1(): Notion
     {
@@ -101,11 +107,11 @@ public function v1(): Notion
      *
      * @param string $token
      * @return Notion
+     * @deprecated for public usage; will be set to private in 0.4.0!
      */
     public function setToken(string $token): Notion
     {
         $this->token = $token;
-        $this->connect();
         return $this;
     }
 
@@ -195,7 +201,37 @@ public function getConnection(): ?PendingRequest
     public function checkValidVersion(string $version): void
     {
         if (!$this->validVersions->contains($version)) {
-            throw HandlingException::instance('invalid version for notion-api', ['invalidVersion' => $version]);
+            throw HandlingException::instance('Invalid version for Notion-API endpoint', ['invalidVersion' => $version]);
+        }
+    }
+
+    /**
+     * @return string[]
+     *
+     * @throws HandlingException
+     */
+    private function buildRequestHeader(): array
+    {
+        return [
+            'Notion-Version' => $this->mapVersionToHeaderVersion()
+        ];
+    }
+
+    /**
+     * Due to the inconsistency of the Notion API requiring a endpoint url
+     * with v* as well as a dated version in the request header, this method
+     * maps the given version (e.g. v1) to the version date Notion requires
+     * in the header (e.g. "2021-05-13").
+     * @return string
+     * @throws HandlingException
+     */
+    private function mapVersionToHeaderVersion(): string
+    {
+        switch ($this->version) {
+            case 'v1':
+                return '2021-05-13';
+            default:
+                throw new HandlingException('Invalid version.');
         }
     }
 }
diff --git a/tests/NotionApiTest.php b/tests/NotionApiTest.php
@@ -53,7 +53,7 @@ public function it_returns_notion_instance_with_set_token_and_connection()
     public function it_throws_a_handling_exception_invalid_version()
     {
         $this->expectException(HandlingException::class);
-        $this->expectExceptionMessage('invalid version for notion-api');
+        $this->expectExceptionMessage('Invalid version for Notion-API endpoint');
 
         new Notion('secret_*', 'v-does-not-exist');
     }

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function find(string $pageId): Page`
`39`	`39`	`public function create(): array`
`40`	`40`	`{`
`41`	`41`	`//toDo`
`42`		`- throw new HandlingException('Not implemented');`
	`42`	`+ throw new HandlingException( 'Not implemented');`
`43`	`43`	`}`
`44`	`44`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function it_returns_notion_instance_with_set_token_and_connection()`
`53`	`53`	`public function it_throws_a_handling_exception_invalid_version()`
`54`	`54`	`{`
`55`	`55`	`$this->expectException(HandlingException::class);`
`56`		`- $this->expectExceptionMessage('invalid version for notion-api');`
	`56`	`+ $this->expectExceptionMessage('Invalid version for Notion-API endpoint');`
`57`	`57`
`58`	`58`	`new Notion('secret_*', 'v-does-not-exist');`
`59`	`59`	`}`