Deprecate the CompanyBan model (#46)

* Deprecate the CompanyBan model

* Replace the usage of CompanyBan with CompanyMember

Author: ShawnCZek

src/Models/CompanyBan.php

@@ -2,143 +2,13 @@
 
 namespace TruckersMP\APIClient\Models;
 
-use Carbon\Carbon;
-
-class CompanyBan
+/**
+ * This represents a banned company member.
+ *
+ * @deprecated This model is identical to CompanyMember and will be removed in
+ * the next major version. Please, avoid using it in your project.
+ * @see CompanyMember
+ */
+class CompanyBan extends CompanyMember
 {
-    /**
-     * The player's member ID within the company.
-     *
-     * @var int
-     */
-    protected $id;
-
-    /**
-     * The ID of the user.
-     *
-     * @var int
-     */
-    protected $userId;
-
-    /**
-     * The username of the user.
-     *
-     * @var string
-     */
-    protected $username;
-
-    /**
-     * The Steam ID of the user.
-     *
-     * @var int
-     */
-    protected $steamId;
-
-    /**
-     * The player's role ID within the company.
-     *
-     * @var int
-     */
-    protected $roleId;
-
-    /**
-     * The player's role name within the company.
-     *
-     * @var string
-     */
-    protected $roleName;
-
-    /**
-     * The date at which the user joined the company.
-     *
-     * @var Carbon
-     */
-    protected $joinDate;
-
-    /**
-     * Create a new CompanyBan instance.
-     *
-     * @param  array  $ban
-     * @return void
-     */
-    public function __construct(array $ban)
-    {
-        $this->id = $ban['id'];
-        $this->userId = $ban['user_id'];
-        $this->username = $ban['username'];
-        $this->steamId = $ban['steam_id'];
-        $this->roleId = $ban['role_id'];
-        $this->roleName = $ban['role'];
-        $this->joinDate = new Carbon($ban['joinDate'], 'UTC');
-    }
-
-    /**
-     * Get the player's member ID within the company.
-     *
-     * @return int
-     */
-    public function getId(): int
-    {
-        return $this->id;
-    }
-
-    /**
-     * Get the ID of the user.
-     *
-     * @return int
-     */
-    public function getUserId(): int
-    {
-        return $this->userId;
-    }
-
-    /**
-     * Get the username of the user.
-     *
-     * @return string
-     */
-    public function getUsername(): string
-    {
-        return $this->username;
-    }
-
-    /**
-     * Get the Steam ID of the user.
-     *
-     * @return int
-     */
-    public function getSteamId(): int
-    {
-        return $this->steamId;
-    }
-
-    /**
-     * Get the ID of the member's role within the company.
-     *
-     * @return int
-     */
-    public function getRoleId(): int
-    {
-        return $this->roleId;
-    }
-
-    /**
-     * Get the name of the member's role within the company.
-     *
-     * @return string
-     */
-    public function getRoleName(): string
-    {
-        return $this->roleName;
-    }
-
-    /**
-     * Get the date the member joined the company.
-     *
-     * @return Carbon
-     */
-    public function getJoinDate(): Carbon
-    {
-        return $this->joinDate;
-    }
 }

src/Requests/Company/BanIndexRequest.php

@@ -5,7 +5,7 @@
 use Illuminate\Support\Collection;
 use Psr\Http\Client\ClientExceptionInterface;
 use TruckersMP\APIClient\Exceptions\ApiErrorException;
-use TruckersMP\APIClient\Models\CompanyBan;
+use TruckersMP\APIClient\Models\CompanyMember;
 use TruckersMP\APIClient\Requests\Request;
 
 class BanIndexRequest extends Request
@@ -43,14 +43,14 @@ public function getEndpoint(): string
     /**
      * Get the data for the request.
      *
-     * @return Collection|CompanyBan[]
+     * @return Collection|CompanyMember[]
      *
      * @throws ApiErrorException
      * @throws ClientExceptionInterface
      */
     public function get(): Collection
     {
         return (new Collection($this->send()['response']['members']))
-            ->mapInto(CompanyBan::class);
+            ->mapInto(CompanyMember::class);
     }
 }

tests/TestCase.php

@@ -20,7 +20,6 @@
 use TruckersMP\APIClient\Exceptions\ApiErrorException;
 use TruckersMP\APIClient\Models\Ban;
 use TruckersMP\APIClient\Models\Company;
-use TruckersMP\APIClient\Models\CompanyBan;
 use TruckersMP\APIClient\Models\CompanyEventIndex;
 use TruckersMP\APIClient\Models\CompanyIndex;
 use TruckersMP\APIClient\Models\CompanyMember;
@@ -399,7 +398,7 @@ public function companyMember(int $companyId, int $memberId): CompanyMember
      * Get the members within the specified company that are currently banned.
      *
      * @param  int  $id
-     * @return Collection|CompanyBan[]
+     * @return Collection|CompanyMember[]
      *
      * @throws PhpfastcacheInvalidArgumentException
      * @throws ApiErrorException

tests/Unit/CompanyBanTest.php

@@ -4,7 +4,7 @@
 
 use Illuminate\Support\Collection;
 use Tests\TestCase;
-use TruckersMP\APIClient\Models\CompanyBan;
+use TruckersMP\APIClient\Models\CompanyMember;
 
 class CompanyBanTest extends TestCase
 {
@@ -23,7 +23,7 @@ public function it_can_get_all_the_bans()
         if ($bans->count() > 0) {
             $ban = $bans[0];
 
-            $this->assertInstanceOf(CompanyBan::class, $ban);
+            $this->assertInstanceOf(CompanyMember::class, $ban);
         }
     }
 }