ldc-crm/app/Http/Controllers/Api/V2/OptinController.php

<?php

namespace App\Http\Controllers\Api\V2;

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 App\Models\SingleOptin;

class OptinController extends Controller
{
    /**
     * Creates a new Single optin or destroys it if exists.
     *
     * @param \App\Http\Requests\Api\V2\SingleOptinRequest $request
     * @param \App\Models\Service                          $service
     * @return \Illuminate\Http\JsonResponse
     * @throws \App\Exceptions\Api\V2\ApiErrorException With ApiError::singleOptinCustomerExists
     *                                                  if this email already has a full account.
     * @throws \App\Exceptions\Api\V2\CrmException If the single optin could not be added or removed.
     */
    public function optin(SingleOptinRequest $request, Service $service): \Illuminate\Http\JsonResponse
    {
        $validatedData = $request->validated();
        if (CustomerInfo::getFromEmail($service->brand, $validatedData['email'])->exists()) {
            throw new ApiErrorException(ApiError::singleOptinCustomerExists);
        }

        /** @var \App\Models\SingleOptin */
        $singleOptin = SingleOptin::query()
            ->where('email', $validatedData['email'])
            ->whereHas('brand', function ($q) use ($service) {
                $q->where('id', $service->brand->id);
            })
            ->firstOrNew();

        if (!$this->changeOptin($service, $request, \boolval($validatedData['opt_in']), $singleOptin)) {
            // @codeCoverageIgnoreStart
            throw new CrmException('Api failed to update single optin.');
            // @codeCoverageIgnoreEnd
        }

        if (isset($validatedData['answer_id'])) {
            $singleOptin->answers()->attach($validatedData['answer_id']);
        }

        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
    ): \Illuminate\Http\JsonResponse {
        /** @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;
    }
}