ldc-crm/tests/Client/CrmClientV2CustomerTest.php
Jérémy Munsch 81aabdab72
Version 3.0.0
This removes api authentification with token in favor of signature method.
Refactorize code and clean up. It add more unit test plus code coverage
in test/converage.

- Added config.api.timestampTimeout
- Added Helper::signRequest This calculates the request signature
- Added more unit tests and extend code coverage.
- Added rate limiter for web routes
- Added RemoveSpaces Sanitizer on api requests
- Added stress test suite
- Changed AuthServiceProvider api-token to api-hmac
- Changed CustomerSeeder to have at least of customer activated (for unit tests)
- Changed used transation for saveing multiple models
- Changed, in ServiceController generateApiToken to generateServicePassword
- Changed, timestamp has to be send in request with a DateTime format, it also has to a UTC  value
- Composer added brianium/paratest
- Composer update
- Fixed case where removing single optin could be the wrong one (not for the good service)
- Fixed customer delete
- Fixed customer would not be resolved by brand.
- Fixed Really check that request is json checking body content, preventing sending malformed requests
- Remove ApiError::needAuth
- Removed api_token
- Removed ApiController::authenticate
- Removed config.api.tokenTimeout
- Removed Header check or usage because of HAProxy doing weird stuff
- Removed lock files from gitignore
- Removed memcached dependency
- Removed unused questions resources api routes
- Removed workspace file

Migrations
- Added unique index on services.bearer_token
- Changed customer_id on customer_answer is nullable
- Changed services.bearer_pwd length to 312 (the size of the token)
- Dropped services.api_token and service.api_token_date
2022-01-06 12:11:05 +01:00

534 lines
16 KiB
PHP

<?php
namespace Tests\Client;
use App\Models\Brand;
use App\Models\Customer as ModelsCustomer;
use App\Models\SingleOptin;
use Illuminate\Support\Str;
use LDC\LDCCRM\CrmApiV2;
use LDC\LDCCRM\Enums\ApiError;
use LDC\LDCCRM\Enums\Country;
use LDC\LDCCRM\Exceptions\AccessError;
use LDC\LDCCRM\Exceptions\ApiErrorException;
use LDC\LDCCRM\Exceptions\ValidationException;
use LDC\LDCCRM\Models\Customer;
class CrmClientV2CustomerTest extends CrmClientTester
{
/**
* Test get customer prop.
*
* @return void
*/
public function testGetter()
{
$this->expectNotToPerformAssertions();
$client = new Customer();
$client->email;
}
/**
* Test set customer prop
*
* @return void
*/
public function testSetter()
{
$this->expectNotToPerformAssertions();
$client = new Customer();
$client->firstname = 'toto';
$client->firstname;
}
/**
* Test client wrong type.
*
* @return void
*/
public function testSetterFailWrongType()
{
$this->expectException(ValidationException::class);
$client = new Customer();
$client->opt_in = 'toto';
}
/**
* Test country validation.
*
* @return void
*/
public function testSetterFailWrongTypeCountry()
{
$this->expectException(ValidationException::class);
$client = new Customer();
$client->country = 'toto';
}
/**
* Test set all props ok.
*
* @return void
*/
public function testPropsAllSetOk()
{
$this->expectNotToPerformAssertions();
$client = new Customer();
$propTypes = [
'hashcode' => (string)Str::uuid(),
'email' => 'toto@gmail.com',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'StrongPassword!7',
'birth_date' => '1992-02-03',
'phone' => '0673891630',
'address' => 'string',
'address2' => 'string',
'city' => 'string',
'postcode' => 'string',
'country' => Country::afghanistan(),
'opt_in' => 1,
'status' => 1,
];
foreach ($propTypes as $prop => $type) {
$client->{$prop} = $type;
}
}
/**
* Test customer is json serializable.
*
* @return void
*/
public function testJsonSerialize()
{
$client = new Customer();
$propTypes = [
'hashcode' => (string)Str::uuid(),
'email' => 'toto@gmail.com',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'StrongPassword!7',
'birth_date' => '1992-02-03',
'phone' => '0673891630',
'address' => 'string',
'address2' => 'string',
'city' => 'string',
'postcode' => 'string',
'country' => Country::afghanistan(),
'opt_in' => true,
'status' => true,
];
foreach ($propTypes as $prop => $type) {
$client->{$prop} = $type;
}
$jsonDecoded = \json_decode(\json_encode($client), true);
$this->assertIsArray($jsonDecoded);
unset($propTypes['password']);
$propTypes['country'] = Country::afghanistan()->value;
foreach ($propTypes as $key => $value) {
$this->assertArrayHasKey($key, $jsonDecoded);
$this->assertEquals($value, $jsonDecoded[$key]);
}
}
/**
* Test set all props fail.
*
* @return void
*/
public function testPropsAllSetNotOk()
{
$this->expectException(ValidationException::class);
$client = new Customer();
$propTypes = [
'hashcode' => (string)Str::uuid(),
'email' => 'toto@gmail.com',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'StrongPassword!7',
'birth_date' => '1992-02-03',
'phone' => '0673891630',
'address' => 'string',
'address2' => 'string',
'city' => 18,
'postcode' => 'string',
'country' => Country::afghanistan(),
'opt_in' => true,
'status' => true,
];
foreach ($propTypes as $prop => $type) {
$client->{$prop} = $type;
}
}
/**
* Test set unkown prop fail
*
* @return void
*/
public function testPropsAssignUnknown()
{
$this->expectException(AccessError::class);
$customer = new Customer([
'hashcode' => (string)Str::uuid(),
'email' => 'toto@gmail.com',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'StrongPassword!7',
'birth_date' => '1992-02-03',
'phone' => '0673891630',
'address' => 'string',
'address2' => 'string',
'city' => 'string',
'postcode' => 'string',
'country' => Country::afghanistan(),
'opt_in' => true,
'status' => true,
]);
$this->assertNull($customer->unknownProp);
$customer->unknownProp = 'value';
}
/**
* Test set prop fail wrong type
*
* @return void
*/
public function testPropsAssignWrongType()
{
$this->expectException(ValidationException::class);
$customer = new Customer([
'hashcode' => (string)Str::uuid(),
'email' => 'toto@gmail.com',
'firstname' => 'string',
'lastname' => 'string',
'password' => 'StrongPassword!7',
'birth_date' => '1992-02-03',
'phone' => '0673891630',
'address' => 'string',
'address2' => 'string',
'city' => 'string',
'postcode' => 'string',
'country' => Country::afghanistan(),
'opt_in' => true,
'status' => true,
]);
$customer->country = 'value';
}
/**
* Test get customer from hashcode.
*
* @return void
*/
public function testCustomerGet()
{
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$this->assertEquals(Customer::class, get_class($customer));
$this->assertEquals($customer->firstname, static::$info->firstname);
$this->assertEquals($customer->lastname, static::$info->lastname);
$this->assertEquals($customer->birth_date, static::$info->birth_date);
$this->assertEquals($customer->address, static::$info->address);
$this->assertEquals($customer->address2, static::$info->address2);
$this->assertEquals($customer->phone, static::$info->phone);
$this->assertEquals($customer->city, static::$info->city);
$this->assertEquals($customer->postcode, static::$info->postcode);
$this->assertEquals($customer->opt_in, static::$info->opt_in);
$this->assertEquals($customer->hashcode, static::$info->hashcode);
$this->assertEquals($customer->country->value, static::$info->country->value);
$this->assertEquals($customer->country->label, static::$info->country->label);
}
/**
* Test customer activate.
*
* @return void
*/
public function testCustomerActivate()
{
// Get non activated customer.
/** @var \App\Models\Customer */
$customer = ModelsCustomer::whereHas('logins', function ($q) {
$q->where('status', 0)->whereHas('brand', function ($q) {
$q->whereId(static::$brand->id);
});
})->firstOrFail();
$info = $customer->info(static::$brand, ModelsCustomer::FIRST_OR_FAIL);
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew($info->hashcode);
$this->assertTrue($customer->activate());
$this->assertTrue($customer->status);
$this->expectException(ApiErrorException::class);
$this->expectExceptionMessage(ApiError::customerAlreadyActive()->label);
$this->assertTrue($customer->activate());
}
/**
* Test customer update
*
* @return void
*/
public function testCustomerUpdateProps()
{
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$customer->firstname = 'toto';
$this->assertTrue($customer->save());
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$this->assertEquals('Toto', $customer->firstname);
$customer->lastname = 'pouet';
$this->assertTrue($customer->save());
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$this->assertEquals('Pouet', $customer->lastname);
$customer->country = Country::belgium();
$customer->save();
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$this->assertEquals(Country::belgium(), $customer->country);
$customer->email = 'pouet@gmail.com';
$customer->birth_date = '1992-03-08';
$customer->phone = '0388977213';
$customer->address = '30 rue des toto';
$customer->address2 = 'batiment c';
$customer->city = 'toto ville';
$customer->postcode = '83160';
$this->assertTrue($customer->save());
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$this->assertEquals('pouet@gmail.com', $customer->email);
$this->assertEquals('1992-03-08', $customer->birth_date);
$this->assertEquals('0388977213', $customer->phone);
$this->assertEquals('30 rue des toto', $customer->address);
$this->assertEquals('batiment c', $customer->address2);
$this->assertEquals('toto ville', $customer->city);
$this->assertEquals('83160', $customer->postcode);
}
/**
* Test customer toggle optin.
*
* @return void
*/
public function testCustomerToggleOptin()
{
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew(static::$info->hashcode);
$customer->opt_in = false;
$this->assertTrue($customer->save());
$this->assertTrue($customer->toggleOptin());
$this->assertTrue($customer->opt_in);
$this->assertTrue($customer->toggleOptin());
$this->assertFalse($customer->opt_in);
$this->assertTrue($customer->toggleOptin());
$this->assertTrue($customer->opt_in);
}
/**
* test customer store
*
* @return void
*/
public function testCustomerStoreProps()
{
$customer = new Customer();
$customer->firstname = 'toto';
$customer->lastname = 'delarogerie';
$customer->email = 'toto.delarogerie@gmail.com';
$customer->password = 'Complic4tEd!P4assW0rd';
$customer->birth_date = '1992-03-08';
$customer->phone = '0673891160';
$customer->address = 'rue des totos';
$customer->city = 'Toto ville';
$customer->postcode = '72160';
$customer->country = Country::france();
$this->assertTrue($customer->save());
$this->assertEquals('Toto', $customer->firstname);
$this->assertEquals(null, $customer->password);
}
/**
* test customer login
*
* @return void
*/
public function testCustomerLogin()
{
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew('toto.delarogerie@gmail.com');
$this->assertTrue($customer->activate());
$this->assertTrue($customer->status);
$this->assertTrue(Customer::login($customer->email, 'Complic4tEd!P4assW0rd'));
}
/**
* test customer login does not belong to brand.
*
* @return void
*/
public function testCustomerLoginUsingCustomerfromAnotherBrand()
{
$this->expectException(ApiErrorException::class);
$this->expectExceptionCode(ApiError::authFailed());
$email = Str::uuid() . 'loginfromantoherbrand@hotmail.fr';
$data = [
'firstname' => 'Jean2',
'lastname' => 'Bond2',
'birth_date' => \date('1992-03-09'),
'address' => '10 rue des toto',
'email' => $email,
'password' => '123.Mot.De.P4sseNew',
'phone' => '+33654821563',
'country' => Country::luxembourg()->value,
'city' => 'Connerré2',
'postcode' => '72161',
'opt_in' => 0
];
$brand = Brand::where('id', '!=', static::$brand->id)->firstOrFail();
$this->createNewCustomer($data, $brand);
$api = new CrmApiV2();
$crmCustomer = $api->getCustomerOrNew($email);
$this->assertNull($crmCustomer->hashcode);
CrmApiV2::login($email, '123.Mot.De.P4sseNew');
}
/**
* Test prop store fail.
*
* @return void
*/
public function testCustomerStorePropsFails()
{
$this->expectException(ValidationException::class);
$customer = new Customer();
$customer->firstname = 'toto';
$customer->lastname = 'delarogerie';
$customer->email = 'toto.delarogerie@gmail.com';
$customer->password = 'simplepassword';
$customer->birth_date = '1992-03-08';
$customer->phone = '0673891160';
$customer->address = 'rue des totos';
$customer->city = 'Toto ville';
$customer->postcode = '72160';
$customer->country = Country::france();
$this->assertTrue($customer->save());
$this->assertEquals('toto', $customer->firstname);
}
/**
* Create a new customer
* then save it into crm
* then deletes it from crm
* then try again to fetch it
* check if it exists.
*
* @return void
*/
public function testCustomerDelete()
{
$customer = new Customer();
$customer->firstname = 'toto';
$customer->lastname = 'delarogerie';
$customer->email = 'delete.delarogerie@gmail.com';
$customer->password = 'Complic4tEd!P4assW0rd';
$customer->birth_date = '1992-03-08';
$customer->phone = '0673891160';
$customer->address = 'rue des totos';
$customer->city = 'Toto ville';
$customer->postcode = '72160';
$customer->country = Country::france();
$this->assertTrue($customer->save());
$this->assertTrue($customer->delete());
$api = new CrmApiV2();
$customer = $api->getCustomerOrNew('delete.delarogerie@gmail.com');
// * If hash code is null then it is a new customer
$this->assertEquals(null, $customer->hashcode);
}
/**
* Make sute a customer exists and contains data
*
* @param array $data
* @param Brand $brand
* @return void
*/
private function createNewCustomer(array $data, Brand $brand)
{
$customer = \App\Models\Customer::whereEmail($data['email'])
->whereHas('brands', function ($q) use ($brand) {
$q->where('brands.id', '=', $brand->id);
})->firstOrNew();
$customer->fill($data);
$saved = $customer->save();
// * Delete Single optin if exists.
/** @var \App\Models\SingleOptin|null $singleOptin */
$singleOptin = SingleOptin::where('email', $data['email'])
->whereHas('brand', function ($q) use ($brand) {
$q->where('brands.id', '=', $brand->id);
})->first();
if ($singleOptin) {
$saved = $singleOptin->delete() && $saved;
}
/** @var \App\Models\CustomerInfo */
$customerInfo = $customer->info($brand, \App\Models\Customer::FIRST_OR_NEW);
$customerInfo->fill($data);
$customerInfo->brand()->associate($brand);
$customerInfo->customer()->associate($customer);
$saved = $customerInfo->save() && $saved;
/** @var \App\Models\CustomerLogin */
$customerLogin = $customer->login($brand, \App\Models\Customer::FIRST_OR_NEW);
$customerLogin->fill($data);
$customerLogin->brand()->associate($brand);
$customerLogin->customer()->associate($customer);
$saved = $customerLogin->save() && $saved;
$this->assertTrue($saved, 'A new customer should have been created.');
}
}