-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into feature/add-template-to-voucher-set
- Loading branch information
Showing
116 changed files
with
2,560 additions
and
1,047 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
app/Events/VoucherBeneficiaryDistributions/VoucherBeneficiaryDistributionCreated.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?php | ||
|
|
||
| namespace App\Events\VoucherBeneficiaryDistributions; | ||
|
|
||
| use App\Models\VoucherBeneficiaryDistribution; | ||
| use Illuminate\Broadcasting\InteractsWithSockets; | ||
| use Illuminate\Broadcasting\PrivateChannel; | ||
| use Illuminate\Foundation\Events\Dispatchable; | ||
| use Illuminate\Queue\SerializesModels; | ||
|
|
||
| class VoucherBeneficiaryDistributionCreated | ||
| { | ||
| use Dispatchable, InteractsWithSockets, SerializesModels; | ||
|
|
||
| /** | ||
| * Create a new event instance. | ||
| * | ||
| * @param VoucherBeneficiaryDistribution $voucherBeneficiaryDistribution | ||
| */ | ||
| public function __construct(public VoucherBeneficiaryDistribution $voucherBeneficiaryDistribution) {} | ||
|
|
||
| /** | ||
| * Get the channels the event should broadcast on. | ||
| * | ||
| * @return array<int, \Illuminate\Broadcasting\Channel> | ||
| */ | ||
| public function broadcastOn(): array | ||
| { | ||
| return [ | ||
| new PrivateChannel('channel-name'), | ||
| ]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
248 changes: 248 additions & 0 deletions
248
app/Http/Controllers/Api/V1/ApiVoucherBeneficiaryDistributionController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,248 @@ | ||
| <?php | ||
|
|
||
| /** @noinspection PhpUnusedParameterInspection */ | ||
|
|
||
| namespace App\Http\Controllers\Api\V1; | ||
|
|
||
| use App\Enums\ApiResponse; | ||
| use App\Http\Controllers\Api\HandlesAPIRequests; | ||
| use App\Http\Controllers\Controller; | ||
| use App\Models\Voucher; | ||
| use App\Models\VoucherBeneficiaryDistribution; | ||
| use App\Models\VoucherSet; | ||
| use Crypt; | ||
| use Exception; | ||
| use Illuminate\Http\JsonResponse; | ||
| use Illuminate\Support\Facades\Auth; | ||
| use Illuminate\Support\Facades\Validator; | ||
| use Illuminate\Validation\Rule; | ||
| use Knuckles\Scribe\Attributes\Authenticated; | ||
| use Knuckles\Scribe\Attributes\BodyParam; | ||
| use Knuckles\Scribe\Attributes\Endpoint; | ||
| use Knuckles\Scribe\Attributes\Group; | ||
| use Knuckles\Scribe\Attributes\Response; | ||
| use Knuckles\Scribe\Attributes\Subgroup; | ||
|
|
||
| #[Group('App Endpoints')] | ||
| #[Subgroup('/voucher-beneficiary-distribution', 'API for create voucher beneficiary distributions')] | ||
| class ApiVoucherBeneficiaryDistributionController extends Controller | ||
| { | ||
| use HandlesAPIRequests; | ||
|
|
||
| /** | ||
| * Set the related data the GET request is allowed to ask for | ||
| */ | ||
| public array $availableRelations = []; | ||
|
|
||
| public static array $searchableFields = [ | ||
| ]; | ||
|
|
||
| /** | ||
| * @hideFromAPIDocumentation | ||
| */ | ||
| public function index(): JsonResponse | ||
| { | ||
| $this->responseCode = 403; | ||
| $this->message = ApiResponse::RESPONSE_METHOD_NOT_ALLOWED->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| #[Endpoint( | ||
| title : 'POST /', | ||
| description : 'Create a new beneficiary distribution.', | ||
| authenticated: true | ||
| )] | ||
| #[Authenticated] | ||
| #[BodyParam( | ||
| name : 'voucher_id', | ||
| type : 'uuid', | ||
| description: 'The UUID of the voucher to be distributed. required_without:resend_beneficiary_distribution_id', | ||
| required : false | ||
| )] | ||
| #[BodyParam( | ||
| name : 'beneficiary_email', | ||
| type : 'email', | ||
| description: 'The email for the voucher beneficiary. required_without:resend_beneficiary_distribution_id', | ||
| required : false | ||
| )] | ||
| #[BodyParam( | ||
| name : 'resend_beneficiary_distribution_id', | ||
| type : 'integer', | ||
| description: 'The database ID for a beneficiary distribution that you would like to resend. Must belong to your team. required_without:beneficiary_email,voucher_id', | ||
| required : false | ||
| )] | ||
| #[Response( | ||
| content : '{"meta":{"responseCode":200,"limit":50,"offset":0,"message":"Saved.","cached":false,"availableRelations":[]},"data":{"id": "1234"}}', | ||
| status : 200, | ||
| description: '', | ||
| )] | ||
| public function store(): JsonResponse | ||
| { | ||
| /** | ||
| * The validation array. | ||
| */ | ||
| $validationArray = [ | ||
| 'voucher_id' => [ | ||
| 'required_without:resend_beneficiary_distribution_id', | ||
| 'string', | ||
| Rule::exists('vouchers', 'id'), | ||
| ], | ||
| 'beneficiary_email' => [ | ||
| 'required_without:resend_beneficiary_distribution_id', | ||
| 'email', | ||
| ], | ||
| 'resend_beneficiary_distribution_id' => [ | ||
| 'sometimes', | ||
| Rule::exists('voucher_beneficiary_distributions', 'id'), | ||
| ], | ||
| ]; | ||
|
|
||
| $validator = Validator::make($this->request->all(), $validationArray); | ||
|
|
||
| if ($validator->fails()) { | ||
|
|
||
| $this->responseCode = 400; | ||
| $this->message = $validator->errors()->first(); | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| try { | ||
|
|
||
| $voucherId = $this->request->get('voucher_id'); | ||
| $beneficiaryEmail = $this->request->get('beneficiary_email'); | ||
|
|
||
| /** | ||
| * Ensure the authenticated user team owns the voucher | ||
| */ | ||
| $voucher = Voucher::where('created_by_team_id', Auth::user()->current_team_id) | ||
| ->orWhere('allocated_to_service_team_id', Auth::user()->current_team_id) | ||
| ->find($voucherId); | ||
|
|
||
| if (!$voucher) { | ||
| $this->responseCode = 404; | ||
| $this->message = ApiResponse::RESPONSE_NOT_FOUND->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * The client is re-sending an existing distribution. | ||
| */ | ||
| if ($this->request->has('resend_beneficiary_distribution_id')) { | ||
|
|
||
| $id = $this->request->get('resend_beneficiary_distribution_id'); | ||
|
|
||
| $voucherBeneficiaryDistribution = VoucherBeneficiaryDistribution::find($id); | ||
|
|
||
| if (!$voucherBeneficiaryDistribution) { | ||
| $this->responseCode = 404; | ||
| $this->message = ApiResponse::RESPONSE_NOT_FOUND->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * Ensure the voucher set belongs to the user's current team | ||
| */ | ||
| $voucherSet = VoucherSet::where('created_by_team_id', Auth::user()->current_team_id) | ||
| ->orWhere('allocated_to_service_team_id', Auth::user()->current_team_id) | ||
| ->find($voucherBeneficiaryDistribution->voucher_set_id); | ||
| if (!$voucherSet) { | ||
| $this->responseCode = 404; | ||
| $this->message = ApiResponse::RESPONSE_NOT_FOUND->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| $decryptedEmail = Crypt::decrypt($voucherBeneficiaryDistribution->beneficiary_email_encrypted); | ||
|
|
||
| $model = new VoucherBeneficiaryDistribution(); | ||
| $model->voucher_id = $voucherBeneficiaryDistribution->voucher_id; | ||
| $model->voucher_set_id = $voucherBeneficiaryDistribution->voucher_set_id; | ||
| $model->beneficiary_email_encrypted = Crypt::encrypt($decryptedEmail); | ||
| $model->created_by_user_id = Auth::id(); | ||
| $model->save(); | ||
|
|
||
| $this->data = $model; | ||
|
|
||
| return $this->respond(); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Ensure this voucher has not been sent to someone else. | ||
| */ | ||
| $numExistingDistributionsForThisVoucher = VoucherBeneficiaryDistribution::where('voucher_id', $voucherId) | ||
| ->count(); | ||
|
|
||
| if ($numExistingDistributionsForThisVoucher > 0) { | ||
| $this->responseCode = 400; | ||
| $this->message = ApiResponse::RESPONSE_ALREADY_EXISTS->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * This voucher has not been sent to anybody else. | ||
| */ | ||
| $model = new VoucherBeneficiaryDistribution(); | ||
| $model->voucher_id = $voucher->id; | ||
| $model->voucher_set_id = $voucher->voucher_set_id; | ||
| $model->beneficiary_email_encrypted = Crypt::encrypt($beneficiaryEmail); | ||
| $model->created_by_user_id = Auth::id(); | ||
| $model->save(); | ||
|
|
||
| $this->data = $model; | ||
|
|
||
| } | ||
| catch (Exception $e) { | ||
|
|
||
| $this->responseCode = 500; | ||
| $this->message = ApiResponse::RESPONSE_ERROR->value . ': "' . $e->getMessage() . '".'; | ||
|
|
||
| } | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * @hideFromAPIDocumentation | ||
| * | ||
| * @param int $id | ||
| */ | ||
| public function show(int $id) | ||
| { | ||
| $this->responseCode = 403; | ||
| $this->message = ApiResponse::RESPONSE_METHOD_NOT_ALLOWED->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * @hideFromAPIDocumentation | ||
| * | ||
| * @param string $id | ||
| */ | ||
| public function update(string $id) | ||
| { | ||
| $this->responseCode = 403; | ||
| $this->message = ApiResponse::RESPONSE_METHOD_NOT_ALLOWED->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
|
|
||
| /** | ||
| * @hideFromAPIDocumentation | ||
| * | ||
| * @param string $id | ||
| */ | ||
| public function destroy(string $id) | ||
| { | ||
| $this->responseCode = 403; | ||
| $this->message = ApiResponse::RESPONSE_METHOD_NOT_ALLOWED->value; | ||
|
|
||
| return $this->respond(); | ||
| } | ||
| } |
36 changes: 36 additions & 0 deletions
36
app/Jobs/VoucherBeneficiaryDistributions/SendVoucherToBeneficiary.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?php | ||
|
|
||
| namespace App\Jobs\VoucherBeneficiaryDistributions; | ||
|
|
||
| use App\Models\VoucherBeneficiaryDistribution; | ||
| use App\Notifications\VoucherBeneficiaryDistributions\BeneficiaryVoucherDistributionEmail; | ||
| use Crypt; | ||
| use Illuminate\Contracts\Queue\ShouldQueue; | ||
| use Illuminate\Foundation\Queue\Queueable; | ||
| use Illuminate\Support\Facades\Notification; | ||
|
|
||
| class SendVoucherToBeneficiary implements ShouldQueue | ||
| { | ||
| use Queueable; | ||
|
|
||
| /** | ||
| * Create a new job instance. | ||
| * | ||
| * @param VoucherBeneficiaryDistribution $voucherBeneficiaryDistribution | ||
| */ | ||
| public function __construct(public VoucherBeneficiaryDistribution $voucherBeneficiaryDistribution) {} | ||
|
|
||
| /** | ||
| * Execute the job. | ||
| */ | ||
| public function handle(): void | ||
| { | ||
| if (env('APP_ENV') != 'testing') { | ||
|
|
||
| $address = Crypt::decrypt($this->voucherBeneficiaryDistribution->beneficiary_email_encrypted); | ||
|
|
||
| Notification::route('mail', $address) | ||
| ->notify(new BeneficiaryVoucherDistributionEmail($this->voucherBeneficiaryDistribution)); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.