refactor timestampables of entities into traid

- move properties created_time, last_updated_time, etc. to its own trait
- remove attributes and methods from entity classes (which are applied by traid)
- apply traid to according entity classes (database, page and block)
- add created_by, last_updated_by to this new trait

Author: johguentner

src/Entities/Blocks/Block.php

@@ -5,13 +5,16 @@
 use DateTime;
 use FiveamCode\LaravelNotionApi\Entities\Entity;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Traits\TimestampableEntity;
 use Illuminate\Support\Arr;
 
 /**
  * Class Block.
  */
 class Block extends Entity
 {
+    use TimestampableEntity;
+
     /**
      * @var string
      */
@@ -37,16 +40,6 @@ class Block extends Entity
      */
     protected string $text = '[warning: unsupported in notion api]';
 
-    /**
-     * @var DateTime
-     */
-    protected DateTime $createdTime;
-
-    /**
-     * @var DateTime
-     */
-    protected DateTime $lastEditedTime;
-
     /**
      * @param  array  $responseData
      *
@@ -69,8 +62,7 @@ protected function fillFromRaw(): void
         $this->fillType();
         $this->fillRawContent();
         $this->fillHasChildren();
-        $this->fillCreatedTime();
-        $this->fillLastEditedTime();
+        $this->fillTimestampableProperties();
     }
 
     private function fillType(): void
@@ -126,22 +118,6 @@ public function hasChildren(): bool
         return $this->hasChildren;
     }
 
-    /**
-     * @return DateTime
-     */
-    public function getCreatedTime(): DateTime
-    {
-        return $this->createdTime;
-    }
-
-    /**
-     * @return DateTime
-     */
-    public function getLastEditedTime(): DateTime
-    {
-        return $this->lastEditedTime;
-    }
-
     public function getContent()
     {
         return $this->content;

src/Entities/Database.php

@@ -3,8 +3,10 @@
 namespace FiveamCode\LaravelNotionApi\Entities;
 
 use DateTime;
+use FiveamCode\LaravelNotionApi\Entities\Properties\People;
 use FiveamCode\LaravelNotionApi\Entities\Properties\Property;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Traits\TimestampableEntity;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
@@ -13,6 +15,8 @@
  */
 class Database extends Entity
 {
+    use TimestampableEntity;
+
     /**
      * @var string
      */
@@ -73,15 +77,7 @@ class Database extends Entity
      */
     protected Collection $properties;
 
-    /**
-     * @var DateTime
-     */
-    protected DateTime $createdTime;
 
-    /**
-     * @var DateTime
-     */
-    protected DateTime $lastEditedTime;
 
     protected function setResponseData(array $responseData): void
     {
@@ -101,8 +97,7 @@ private function fillFromRaw()
         $this->fillObjectType();
         $this->fillProperties();
         $this->fillDatabaseUrl();
-        $this->fillCreatedTime();
-        $this->fillLastEditedTime();
+        $this->fillTimestampableProperties();
     }
 
     private function fillTitle(): void
@@ -268,20 +263,4 @@ public function getPropertyKeys(): array
     {
         return $this->propertyKeys;
     }
-
-    /**
-     * @return DateTime
-     */
-    public function getCreatedTime(): DateTime
-    {
-        return $this->createdTime;
-    }
-
-    /**
-     * @return array
-     */
-    public function getLastEditedTime(): DateTime
-    {
-        return $this->lastEditedTime;
-    }
 }

src/Entities/Entity.php

@@ -3,6 +3,7 @@
 namespace FiveamCode\LaravelNotionApi\Entities;
 
 use Carbon\Carbon;
+use DateTime;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
 use FiveamCode\LaravelNotionApi\Exceptions\NotionException;
 use Illuminate\Support\Arr;
@@ -68,19 +69,6 @@ protected function setResponseData(array $responseData): void
         $this->responseData = $responseData;
     }
 
-    protected function fillCreatedTime()
-    {
-        if (Arr::exists($this->responseData, 'created_time')) {
-            $this->createdTime = new Carbon($this->responseData['created_time']);
-        }
-    }
-
-    protected function fillLastEditedTime()
-    {
-        if (Arr::exists($this->responseData, 'last_edited_time')) {
-            $this->lastEditedTime = new Carbon($this->responseData['last_edited_time']);
-        }
-    }
 
     protected function fillId()
     {

src/Entities/Page.php

@@ -17,6 +17,7 @@
 use FiveamCode\LaravelNotionApi\Entities\Properties\Title;
 use FiveamCode\LaravelNotionApi\Entities\Properties\Url;
 use FiveamCode\LaravelNotionApi\Exceptions\HandlingException;
+use FiveamCode\LaravelNotionApi\Traits\TimestampableEntity;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 
@@ -25,6 +26,8 @@
  */
 class Page extends Entity
 {
+    use TimestampableEntity;
+
     /**
      * @var string
      */
@@ -80,16 +83,6 @@ class Page extends Entity
      */
     protected Collection $properties;
 
-    /**
-     * @var DateTime
-     */
-    protected DateTime $createdTime;
-
-    /**
-     * @var DateTime
-     */
-    protected DateTime $lastEditedTime;
-
     /**
      * Page constructor.
      *
@@ -128,8 +121,7 @@ private function fillFromRaw(): void
         $this->fillPageUrl();
         $this->fillIcon();
         $this->fillCover();
-        $this->fillCreatedTime();
-        $this->fillLastEditedTime();
+        $this->fillTimestampableProperties();
     }
 
     private function fillObjectType(): void
@@ -474,19 +466,4 @@ public function getPropertyKeys(): array
         return $this->propertyKeys;
     }
 
-    /**
-     * @return DateTime
-     */
-    public function getCreatedTime(): DateTime
-    {
-        return $this->createdTime;
-    }
-
-    /**
-     * @return DateTime
-     */
-    public function getLastEditedTime(): DateTime
-    {
-        return $this->lastEditedTime;
-    }
 }

src/Traits/TimestampableEntity.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace FiveamCode\LaravelNotionApi\Traits;
+
+use Carbon\Carbon;
+use DateTime;
+use FiveamCode\LaravelNotionApi\Entities\Entity;
+use FiveamCode\LaravelNotionApi\Entities\User;
+use Illuminate\Support\Arr;
+
+/**
+ * Trait UpdatableEntity
+ * @package FiveamCode\LaravelNotionApi\Traits
+ */
+trait TimestampableEntity
+{
+
+    /**
+     * @var array
+     */
+    protected array $responseData = [];
+
+    /**
+     * @var DateTime
+     */
+    protected DateTime $createdTime;
+
+    /**
+     * @var DateTime
+     */
+    protected DateTime $lastEditedTime;
+
+    /**
+     * @var User
+     */
+    protected User $createdBy;
+
+    /**
+     * @var User
+     */
+    protected User $lastEditedBy;
+
+    protected function fillTimestampableProperties(): void
+    {
+        $this->fillCreatedTime();
+        $this->fillLastEditedTime();
+        $this->fillCreatedBy();
+        $this->fillLastEditedBy();
+    }
+
+    protected function fillCreatedTime(): void
+    {
+        if (Arr::exists($this->responseData, 'created_time')) {
+            $this->createdTime = new Carbon($this->responseData['created_time']);
+        }
+    }
+
+    protected function fillLastEditedTime(): void
+    {
+        if (Arr::exists($this->responseData, 'last_edited_time')) {
+            $this->lastEditedTime = new Carbon($this->responseData['last_edited_time']);
+        }
+    }
+
+    protected function fillCreatedBy(): void
+    {
+        if (Arr::exists($this->responseData, 'created_by')) {
+            $this->createdBy = new User($this->responseData['created_by']);
+        }
+    }
+
+    protected function fillLastEditedBy(): void
+    {
+        if (Arr::exists($this->responseData, 'last_edited_by')) {
+            $this->lastEditedBy = new User($this->responseData['last_edited_by']);
+        }
+    }
+
+    /**
+     * @return DateTime
+     */
+    public function getCreatedTime(): DateTime
+    {
+        return $this->createdTime;
+    }
+
+    /**
+     * @return DateTime
+     */
+    public function getLastEditedTime(): DateTime
+    {
+        return $this->lastEditedTime;
+    }
+
+    /**
+     * @return User
+     */
+    public function getCreatedBy(): User
+    {
+        return $this->createdBy;
+    }
+
+    /**
+     * @return User
+     */
+    public function getLastEditedBy(): User
+    {
+        return $this->lastEditedBy;
+    }
+}