forge-joniko/ldc-crm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Api Remove single optin using hashcode

Browse source
This commit is contained in:
Jérémy Munsch 2023-06-28 15:16:37 +02:00
parent 020fd8b092
commit 78a166af00
No known key found for this signature in database
GPG key ID: 18361AF3BFEC0FEC
8 changed files with 159 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
app/Http/Controllers/Api/V2/OptinController.php
View file

@ -6,7 +6,9 @@ use App\Enums\ApiError;
use App\Exceptions\Api\V2\ApiErrorException;
use App\Exceptions\Api\V2\CrmException;
use App\Http\Controllers\Controller;
use App\Http\Requests\Api\V2\BaseApiRequest;
use App\Http\Requests\Api\V2\SingleOptinRequest;
use App\Http\Requests\Api\V2\SingleOptinRemoveWithHashcodeRequest;
use App\Models\CustomerInfo;
use App\Models\Service;
use Illuminate\Http\JsonResponse;
@ -36,15 +38,7 @@ class OptinController extends Controller
$q->where('id', $service->brand->id);
})->firstOrNew();
if ($request->opt_in) {
$singleOptin->fill($request->validated());
$singleOptin->brand()->associate($service->brand);
$success = $singleOptin->save();
} else {
$success = $singleOptin->delete() !== false;
}
if (!$success) {
if (!$this->changeOptin($service, $request, \boolval($request->opt_in), $singleOptin)) {
// @codeCoverageIgnoreStart
throw new CrmException('Api failed to update single optin.');
// @codeCoverageIgnoreEnd
@ -52,4 +46,48 @@ class OptinController extends Controller
return response()->json();
}
/**
* Creates a new Single optin or destroys it if exists using hashcode
*
* @param \App\Http\Requests\Api\V2\SingleOptinRemoveWithHashcodeRequest $request
* @param \App\Models\Service $service
* @return \Illuminate\Http\JsonResponse
* @throws \App\Exceptions\Api\V2\CrmException If the single optin could not be removed.
*/
public function optoutWithHashcode(SingleOptinRemoveWithHashcodeRequest $request, Service $service)
{
/** @var \App\Models\SingleOptin */
$singleOptin = SingleOptin::query()->where('hashcode', $request->hashcode)
->whereHas('brand', function ($q) use ($service) {
$q->whereId($service->brand->id);
})->firstOrFail();
if ($singleOptin and !$this->changeOptin($service, $request, \boolval($request->opt_in), $singleOptin)) {
// @codeCoverageIgnoreStart
throw new CrmException('Api failed to update single optin.');
// @codeCoverageIgnoreEnd
}
return response()->json();
}
/**
* Changes the optin state
*
* @param \App\Models\Service $service
* @param \App\Http\Requests\Api\V2\BaseApiRequest $request
* @param boolean $optin
* @param \App\Models\SingleOptin $singleOptin
* @return boolean Returns false in case of failure.
*/
private function changeOptin(Service $service, BaseApiRequest $request, bool $optin, SingleOptin $singleOptin): bool
{
if ($optin) {
$singleOptin->fill($request->validated());
$singleOptin->brand()->associate($service->brand);
return $singleOptin->save();
}
return $singleOptin->delete() !== false;
}
}

18
app/Http/Requests/Api/V2/SingleOptinRemoveWithHashcodeRequest.php Normal file
View file

@ -0,0 +1,18 @@
<?php
namespace App\Http\Requests\Api\V2;
class SingleOptinRemoveWithHashcodeRequest extends BaseApiRequest
{
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules(): array
{
return [
'hashcode' => 'required|string|size:36'
];
}
}

14
app/Models/CustomerInfo.php
View file

@ -118,4 +118,18 @@ class CustomerInfo extends Model
$q->where('email', $email);
});
}
/**
* Get customer info from hashcode
*
* @param \App\Models\Brand $brand
* @param string $hashcode
* @return \Illuminate\Database\Eloquent\Builder
*/
public static function getFromHashcode(Brand $brand, string $hashcode)
{
return CustomerInfo::query()->whereHas('brand', function (Builder $q) use ($brand) {
$q->where('id', $brand->id);
})->where('hashcode', $hashcode);
}
}

2
composer.json
View file

@ -1,7 +1,7 @@
{
"name": "ldc/ldccrmv2",
"type": "project",
"version": "3.1.0",
"version": "3.0.6",
"description": "LDC CRM V2 - revamped",
"license": "MIT",
"require": {

1
routes/api.php
View file

@ -51,6 +51,7 @@ Route::prefix('v2')->name('apiV2.')->group(function () {
// * OPTINS
Route::post('/optin', [V2OptinController::class, 'optin'])->name('optin');
Route::post('/optout', [V2OptinController::class, 'optoutWithHashcode'])->name('optout-hashcode');
// * CUSTOMERS
Route::apiResource('customers', V2CustomerController::class, [

2
tests/CRM/ApiV2/ApiBase.php
View file

@ -86,7 +86,7 @@ class ApiBase extends BaseTestCase
*/
protected function getCustomer(bool $status = true, bool $random = true): array
{
$login = CustomerLogin::whereStatus($status);
$login = CustomerLogin::query()->where('status', $status);
if ($random) {
$login = $login->inRandomOrder();
}

56
tests/CRM/ApiV2/SingleOptinTest.php
View file

@ -87,6 +87,62 @@ class SingleOptinTest extends ApiBase
$this->assertEquals(ApiError::singleOptinCustomerExists()->label, $json->json('data.message'));
}
/**
* Test set single optin off using hashcode
* route: apiV2.optout-hashcode
*
* @return void
*/
public function testSetSingleOptoutWithHashcode()
{
$service = Service::firstOrFail();
// * Make sure a single optin exists.
$singleOptin = SingleOptin::query()->where('email', 'singleoptout@hotmail.fr')->firstOrNew();
$singleOptin->brand()->associate($service->brand);
$singleOptin->email = 'singleoptout@hotmail.fr';
$singleOptin->saveOrFail();
$singleOptin->refresh();
$response = $this->callApiWithToken($service, 'post', route('apiV2.optout-hashcode'), [
'hashcode' => $singleOptin->hashcode
]);
$json = $response->decodeResponseJson();
$this->assertApiResponseStatusIs($json, ApiStatus::OK());
$this->assertFalse(
SingleOptin::query()->where('email', 'singleoptout@hotmail.fr')->exists(),
'Single optin should have been removed for email "singleoptout@hotmail.fr"'
);
}
/**
* Test set single optin off using hashcode fails if does not exists
* route: apiV2.optout-hashcode
*
* @return void
*/
public function testSetSingleOptoutWithHashcodeFailsIfDoesNotExists()
{
$service = Service::firstOrFail();
// * Make sure a single optin exists.
$singleOptin = SingleOptin::query()->where('email', 'singleoptout@hotmail.fr')->firstOrNew();
$singleOptin->brand()->associate($service->brand);
$singleOptin->email = 'singleoptout@hotmail.fr';
$singleOptin->saveOrFail();
$singleOptin->refresh();
// * Make sure a single optin does exists.
$singleOptin->delete();
$response = $this->callApiWithToken($service, 'post', route('apiV2.optout-hashcode'), [
'hashcode' => $singleOptin->hashcode
]);
$json = $response->decodeResponseJson();
$this->assertApiResponseStatusIs($json, ApiStatus::KO());
$this->assertEquals(ApiError::modelNotFound()->value, $json->json('data.code'));
}
/**
* Store a customer in DB
*

21
tests/Client/CrmClientV2SingleOptinTest.php
View file

@ -61,4 +61,25 @@ class CrmClientV2SingleOptinTest extends CrmClientTester
$this->assertTrue($customer->save());
$this->assertFalse(SingleOptin::setStatus($randomMail, true));
}
/**
* Remove single optin with hashcode test
*
* Calling multiple times single optin true should not fail.
*
* @return void
*/
public function testRemoveSingleOptinWithHashcode()
{
// Set single optin and check.
$this->assertTrue(SingleOptin::setStatus('singleoptinrandom@gmail.com', true));
$this->assertTrue(ModelsSingleOptin::query()->where('email', 'singleoptinrandom@gmail.com')->exists());
$hashcode = ModelsSingleOptin::query()
->where('email', 'singleoptinrandom@gmail.com')->sole('hashcode')->hashcode;
// Remove single optin test and check.
$this->assertTrue(SingleOptin::unsetStatusWithHashcode($hashcode));
$this->assertTrue(!ModelsSingleOptin::query()->where('email', 'singleoptinrandom@gmail.com')->exists());
}
}