Merge pull request #14190 from marcusmoore/bug/sc-24685

Fixed consumable checkout via API not sending notification

app/Http/Controllers/Api/ConsumablesController.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers\Api;
 
+use App\Events\CheckoutableCheckedOut;
 use App\Helpers\Helper;
 use App\Http\Controllers\Controller;
 use App\Http\Transformers\ConsumablesTransformer;
@@ -11,6 +12,7 @@
 use App\Models\User;
 use Illuminate\Http\Request;
 use App\Http\Requests\ImageUploadRequest;
+use Illuminate\Support\Facades\Auth;
 
 class ConsumablesController extends Controller
 {
@@ -290,17 +292,9 @@ public function checkout(Request $request, $id)
  ]
  );
 
- // Log checkout event
- $logaction = $consumable->logCheckout($request->input('note'), $user);
- $data['log_id'] = $logaction->id;
- $data['eula'] = $consumable->getEula();
- $data['first_name'] = $user->first_name;
- $data['item_name'] = $consumable->name;
- $data['checkout_date'] = $logaction->created_at;
- $data['note'] = $logaction->note;
- $data['require_acceptance'] = $consumable->requireAcceptance();
-
- return response()->json(Helper::formatStandardApiResponse('success', null, trans('admin/consumables/message.checkout.success')));
+ event(new CheckoutableCheckedOut($consumable, $user, Auth::user(), $request->input('note')));
+
+ return response()->json(Helper::formatStandardApiResponse('success', null, trans('admin/consumables/message.checkout.success')));
 
  }
 

app/Http/Controllers/Consumables/ConsumableCheckoutController.php

@@ -76,7 +76,6 @@ public function store(Request $request, $consumableId)
  return redirect()->route('consumables.index')->with('error', trans('admin/consumables/message.checkout.unavailable'));
  }
 
-
  $admin_user = Auth::user();
  $assigned_to = e($request->input('assigned_to'));
 

database/factories/ConsumableFactory.php

@@ -91,4 +91,29 @@ public function ink()
  ];
  });
  }
+
+ public function withoutItemsRemaining()
+ {
+ return $this->state(function () {
+ return [
+ 'qty' => 1,
+ ];
+ })->afterCreating(function (Consumable $consumable) {
+ $user = User::factory()->create();
+
+ $consumable->users()->attach($consumable->id, [
+ 'consumable_id' => $consumable->id,
+ 'user_id' => $user->id,
+ 'assigned_to' => $user->id,
+ 'note' => '',
+ ]);
+ });
+ }
+
+ public function requiringAcceptance()
+ {
+ return $this->afterCreating(function (Consumable $consumable) {
+ $consumable->category->update(['require_acceptance' => 1]);
+ });
+ }
 }

tests/Feature/Api/Accessories/AccessoryCheckoutTest.php

@@ -21,7 +21,7 @@ public function testCheckingOutAccessoryRequiresCorrectPermission()
  ->assertForbidden();
  }
 
- public function testValidation()
+ public function testValidationWhenCheckingOutAccessory()
  {
  $this->actingAsForApi(User::factory()->checkoutAccessories()->create())
  ->postJson(route('api.accessories.checkout', Accessory::factory()->create()), [

tests/Feature/Api/Consumables/ConsumableCheckoutTest.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Tests\Feature\Api\Consumables;
+
+use App\Models\Actionlog;
+use App\Models\Consumable;
+use App\Models\User;
+use App\Notifications\CheckoutConsumableNotification;
+use Illuminate\Support\Facades\Notification;
+use Tests\Support\InteractsWithSettings;
+use Tests\TestCase;
+
+class ConsumableCheckoutTest extends TestCase
+{
+ use InteractsWithSettings;
+
+ public function testCheckingOutConsumableRequiresCorrectPermission()
+ {
+ $this->actingAsForApi(User::factory()->create())
+ ->postJson(route('api.consumables.checkout', Consumable::factory()->create()))
+ ->assertForbidden();
+ }
+
+ public function testValidationWhenCheckingOutConsumable()
+ {
+ $this->actingAsForApi(User::factory()->checkoutConsumables()->create())
+ ->postJson(route('api.consumables.checkout', Consumable::factory()->create()), [
+ // missing assigned_to
+ ])
+ ->assertStatusMessageIs('error');
+ }
+
+ public function testConsumableMustBeAvailableWhenCheckingOut()
+ {
+ $this->actingAsForApi(User::factory()->checkoutConsumables()->create())
+ ->postJson(route('api.consumables.checkout', Consumable::factory()->withoutItemsRemaining()->create()), [
+ 'assigned_to' => User::factory()->create()->id,
+ ])
+ ->assertStatusMessageIs('error');
+ }
+
+ public function testConsumableCanBeCheckedOut()
+ {
+ $consumable = Consumable::factory()->create();
+ $user = User::factory()->create();
+
+ $this->actingAsForApi(User::factory()->checkoutConsumables()->create())
+ ->postJson(route('api.consumables.checkout', $consumable), [
+ 'assigned_to' => $user->id,
+ ]);
+
+ $this->assertTrue($user->consumables->contains($consumable));
+ }
+
+ public function testUserSentNotificationUponCheckout()
+ {
+ Notification::fake();
+
+ $consumable = Consumable::factory()->requiringAcceptance()->create();
+
+ $user = User::factory()->create();
+
+ $this->actingAsForApi(User::factory()->checkoutConsumables()->create())
+ ->postJson(route('api.consumables.checkout', $consumable), [
+ 'assigned_to' => $user->id,
+ ]);
+
+ Notification::assertSentTo($user, CheckoutConsumableNotification::class);
+ }
+
+ public function testActionLogCreatedUponCheckout()
+ {$consumable = Consumable::factory()->create();
+ $actor = User::factory()->checkoutConsumables()->create();
+ $user = User::factory()->create();
+
+ $this->actingAsForApi($actor)
+ ->postJson(route('api.consumables.checkout', $consumable), [
+ 'assigned_to' => $user->id,
+ 'note' => 'oh hi there',
+ ]);
+
+ $this->assertEquals(
+ 1,
+ Actionlog::where([
+ 'action_type' => 'checkout',
+ 'target_id' => $user->id,
+ 'target_type' => User::class,
+ 'item_id' => $consumable->id,
+ 'item_type' => Consumable::class,
+ 'user_id' => $actor->id,
+ 'note' => 'oh hi there',
+ ])->count(),
+ 'Log entry either does not exist or there are more than expected'
+ );
+ }
+}

tests/Feature/Checkouts/AccessoryCheckoutTest.php

@@ -21,7 +21,7 @@ public function testCheckingOutAccessoryRequiresCorrectPermission()
  ->assertForbidden();
  }
 
- public function testValidation()
+ public function testValidationWhenCheckingOutAccessory()
  {
  $this->actingAs(User::factory()->checkoutAccessories()->create())
  ->post(route('accessories.checkout.store', Accessory::factory()->create()), [

tests/Feature/Checkouts/ConsumableCheckoutTest.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Tests\Feature\Checkouts;
+
+use App\Models\Actionlog;
+use App\Models\Consumable;
+use App\Models\User;
+use App\Notifications\CheckoutConsumableNotification;
+use Illuminate\Support\Facades\Notification;
+use Tests\Support\InteractsWithSettings;
+use Tests\TestCase;
+
+class ConsumableCheckoutTest extends TestCase
+{
+ use InteractsWithSettings;
+
+ public function testCheckingOutConsumableRequiresCorrectPermission()
+ {
+ $this->actingAs(User::factory()->create())
+ ->post(route('consumables.checkout.store', Consumable::factory()->create()))
+ ->assertForbidden();
+ }
+
+ public function testValidationWhenCheckingOutConsumable()
+ {
+ $this->actingAs(User::factory()->checkoutConsumables()->create())
+ ->post(route('consumables.checkout.store', Consumable::factory()->create()), [
+ // missing assigned_to
+ ])
+ ->assertSessionHas('error');
+ }
+
+ public function testConsumableMustBeAvailableWhenCheckingOut()
+ {
+ $this->actingAs(User::factory()->checkoutConsumables()->create())
+ ->post(route('consumables.checkout.store', Consumable::factory()->withoutItemsRemaining()->create()), [
+ 'assigned_to' => User::factory()->create()->id,
+ ])
+ ->assertSessionHas('error');
+ }
+
+ public function testConsumableCanBeCheckedOut()
+ {
+ $consumable = Consumable::factory()->create();
+ $user = User::factory()->create();
+
+ $this->actingAs(User::factory()->checkoutConsumables()->create())
+ ->post(route('consumables.checkout.store', $consumable), [
+ 'assigned_to' => $user->id,
+ ]);
+
+ $this->assertTrue($user->consumables->contains($consumable));
+ }
+
+ public function testUserSentNotificationUponCheckout()
+ {
+ Notification::fake();
+
+ $consumable = Consumable::factory()->create();
+ $user = User::factory()->create();
+
+ $this->actingAs(User::factory()->checkoutConsumables()->create())
+ ->post(route('consumables.checkout.store', $consumable), [
+ 'assigned_to' => $user->id,
+ ]);
+
+ Notification::assertSentTo($user, CheckoutConsumableNotification::class);
+ }
+
+ public function testActionLogCreatedUponCheckout()
+ {
+ $consumable = Consumable::factory()->create();
+ $actor = User::factory()->checkoutConsumables()->create();
+ $user = User::factory()->create();
+
+ $this->actingAs($actor)
+ ->post(route('consumables.checkout.store', $consumable), [
+ 'assigned_to' => $user->id,
+ 'note' => 'oh hi there',
+ ]);
+
+ $this->assertEquals(
+ 1,
+ Actionlog::where([
+ 'action_type' => 'checkout',
+ 'target_id' => $user->id,
+ 'target_type' => User::class,
+ 'item_id' => $consumable->id,
+ 'item_type' => Consumable::class,
+ 'user_id' => $actor->id,
+ 'note' => 'oh hi there',
+ ])->count(),
+ 'Log entry either does not exist or there are more than expected'
+ );
+ }
+}