[PHP-70] Support for setting the user's address and date of birth (#46)

* [PHP-70] Support for setting the user's address and date of birth

* [PHP-70] Strict types

* [PHP-70] Simplify the address setter

* [PHP-70] PHPStan errors

* [PHP-70] Add PHP 8.2 and 8.3 to the code quality check matrix

* Revert "[PHP-70] Add PHP 8.2 and 8.3 to the code quality check matrix"

This reverts commit 55032c1.

* [PHP-70] Make address fields optional and fix tests method

* [PHP-70] Fix tests

* [PHP-70] User address's State should be optional

* [PHP-70] Update readme for user address and dob support

* [PHP-70] Update changelog with the new version changes

Author: stefandanaita

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2024-02-09
+
+### Added
+
+- Support for setting the user's address using `$client->user()->address()`
+- Support for setting the user's date of birth using `$client->user()->dateOfBirth()`
+
 ## [1.5.0] - 2024-01-12
 
 ### Added

README.md

@@ -207,7 +207,21 @@ $beneficiary = $client->beneficiary()->externalAccount()
 $user = $client->user()
     ->name('Jane Doe')
     ->phone('+44123456789')
-    ->email('[email protected]');
+    ->email('[email protected]')
+    ->dateOfBirth('2024-01-01');
+```
+
+You are also able to set the user's address:
+
+```php
+$address = $client->user()
+    ->address()
+    ->addressLine1('The Gilbert')
+    ->addressLine2('City of')
+    ->city('London')
+    ->state('London')
+    ->zip('EC2A 1PX')
+    ->countryCode('GB');
 ```
 
 <a name="creating-a-payment-method"></a>

config/bindings.php

@@ -3,13 +3,14 @@
 declare(strict_types=1);
 
 use TrueLayer\Entities;
-use TrueLayer\Entities\User;
 use TrueLayer\Interfaces;
 
 return [
-    Interfaces\UserInterface::class => User::class,
     Interfaces\HppInterface::class => 'makeHpp',
 
+    Interfaces\AddressInterface::class => Entities\Address::class,
+    Interfaces\UserInterface::class => Entities\User::class,
+
     Interfaces\Beneficiary\BeneficiaryBuilderInterface::class => Entities\Beneficiary\BeneficiaryBuilder::class,
     Interfaces\Beneficiary\MerchantBeneficiaryInterface::class => Entities\Beneficiary\MerchantBeneficiary::class,
     Interfaces\Beneficiary\ExternalAccountBeneficiaryInterface::class => Entities\Beneficiary\ExternalAccountBeneficiary::class,

src/Entities/Address.php

@@ -0,0 +1,184 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TrueLayer\Entities;
+
+use TrueLayer\Interfaces\AddressInterface;
+
+class Address extends Entity implements AddressInterface
+{
+    /**
+     * @var string
+     */
+    protected string $addressLine1;
+
+    /**
+     * @var string
+     */
+    protected string $addressLine2;
+
+    /**
+     * @var string
+     */
+    protected string $city;
+
+    /**
+     * @var string
+     */
+    protected string $state;
+
+    /**
+     * @var string
+     */
+    protected string $zip;
+
+    /**
+     * @var string
+     */
+    protected string $countryCode;
+
+    /**
+     * @var string[]
+     */
+    protected array $arrayFields = [
+        'address_line1',
+        'address_line2',
+        'city',
+        'state',
+        'zip',
+        'country_code',
+    ];
+
+    /**
+     * @var string[]
+     */
+    protected array $rules = [
+        'address_line1' => 'string|required',
+        'address_line2' => 'string|nullable',
+        'city' => 'string|required',
+        'state' => 'string|nullable',
+        'zip' => 'string|required',
+        'country_code' => 'string|required',
+    ];
+
+    /**
+     * @return string|null
+     */
+    public function getAddressLine1(): ?string
+    {
+        return $this->addressLine1 ?? null;
+    }
+
+    /**
+     * @param string $addressLine1
+     *
+     * @return AddressInterface
+     */
+    public function addressLine1(string $addressLine1): AddressInterface
+    {
+        $this->addressLine1 = $addressLine1;
+
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getAddressLine2(): ?string
+    {
+        return $this->addressLine2 ?? null;
+    }
+
+    /**
+     * @param string $addressLine2
+     *
+     * @return AddressInterface
+     */
+    public function addressLine2(string $addressLine2): AddressInterface
+    {
+        $this->addressLine2 = $addressLine2;
+
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCity(): ?string
+    {
+        return $this->city ?? null;
+    }
+
+    /**
+     * @param string $city
+     *
+     * @return AddressInterface
+     */
+    public function city(string $city): AddressInterface
+    {
+        $this->city = $city;
+
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getState(): ?string
+    {
+        return $this->state ?? null;
+    }
+
+    /**
+     * @param string $state
+     *
+     * @return AddressInterface
+     */
+    public function state(string $state): AddressInterface
+    {
+        $this->state = $state;
+
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getZip(): ?string
+    {
+        return $this->zip ?? null;
+    }
+
+    /**
+     * @param string $zip
+     *
+     * @return AddressInterface
+     */
+    public function zip(string $zip): AddressInterface
+    {
+        $this->zip = $zip;
+
+        return $this;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getCountryCode(): ?string
+    {
+        return $this->countryCode ?? null;
+    }
+
+    /**
+     * @param string $countryCode
+     *
+     * @return AddressInterface
+     */
+    public function countryCode(string $countryCode): AddressInterface
+    {
+        $this->countryCode = $countryCode;
+
+        return $this;
+    }
+}

src/Entities/Entity.php

@@ -23,7 +23,7 @@ abstract class Entity implements ArrayableInterface, HasAttributesInterface
     /**
      * @var EntityFactoryInterface
      */
-    private EntityFactoryInterface $entityFactory;
+    protected EntityFactoryInterface $entityFactory;
 
     /**
      * @param ValidatorFactory       $validatorFactory

src/Entities/User.php

@@ -4,7 +4,11 @@
 
 namespace TrueLayer\Entities;
 
+use TrueLayer\Exceptions\InvalidArgumentException;
+use TrueLayer\Exceptions\ValidationException;
+use TrueLayer\Interfaces\AddressInterface;
 use TrueLayer\Interfaces\UserInterface;
+use TrueLayer\Validation\ValidType;
 
 final class User extends Entity implements UserInterface
 {
@@ -28,6 +32,16 @@ final class User extends Entity implements UserInterface
      */
     protected string $phone;
 
+    /**
+     * @var AddressInterface
+     */
+    protected AddressInterface $address;
+
+    /**
+     * @var string
+     */
+    protected string $dateOfBirth;
+
     /**
      * @var string[]
      */
@@ -36,18 +50,32 @@ final class User extends Entity implements UserInterface
         'name',
         'email',
         'phone',
+        'address',
+        'date_of_birth',
     ];
 
     /**
      * @var string[]
      */
-    protected array $rules = [
-        'id' => 'string|nullable',
-        'name' => 'string|nullable|required_without:id',
-        'email' => 'string|nullable|email|required_without_all:phone,id',
-        'phone' => 'string|nullable|required_without_all:email,id',
+    protected array $casts = [
+        'address' => AddressInterface::class,
     ];
 
+    /**
+     * @return mixed[]
+     */
+    protected function rules(): array
+    {
+        return [
+            'id' => 'string|nullable',
+            'name' => 'string|nullable|required_without:id',
+            'email' => 'string|nullable|email|required_without_all:phone,id',
+            'phone' => 'string|nullable|required_without_all:email,id',
+            'address' => ['nullable', ValidType::of(AddressInterface::class)],
+            'date_of_birth' => 'string|nullable|date',
+        ];
+    }
+
     /**
      * @return string|null
      */
@@ -127,4 +155,47 @@ public function phone(string $phone): UserInterface
 
         return $this;
     }
+
+    /**
+     * @return AddressInterface|null
+     */
+    public function getAddress(): ?AddressInterface
+    {
+        return $this->address ?? null;
+    }
+
+    /**
+     * @param AddressInterface|null $address
+     *
+     * @throws ValidationException
+     * @throws InvalidArgumentException
+     *
+     * @return AddressInterface
+     */
+    public function address(?AddressInterface $address = null): AddressInterface
+    {
+        $this->address = $address ?: $this->entityFactory->make(AddressInterface::class);
+
+        return $this->address;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function getDateOfBirth(): ?string
+    {
+        return $this->dateOfBirth ?? null;
+    }
+
+    /**
+     * @param string $dateOfBirth
+     *
+     * @return UserInterface
+     */
+    public function dateOfBirth(string $dateOfBirth): UserInterface
+    {
+        $this->dateOfBirth = $dateOfBirth;
+
+        return $this;
+    }
 }