Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions app/Http/Controllers/PoliciesController.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

use App\Http\Resources\PoliciesCollection;
use App\Policy;
use App\PolicyAcceptance;
use Carbon\CarbonImmutable;
use Illuminate\Http\Request;

class PoliciesController extends Controller {
public function getCurrentPolicies(): PoliciesCollection {
Expand All @@ -20,4 +22,23 @@ public function getCurrentPolicies(): PoliciesCollection {

return new PoliciesCollection($currentPolicies);
}

public function getMissingPolicies(Request $request): PoliciesCollection {
$now = CarbonImmutable::now();

$activePolicyIds = Policy::where('active_from', '<=', $now)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we have this block of code twice here, I think it could be nice to have a private function for this query and call the it both in getCurrentPolicies and getMissingPolicies.

->selectRaw('MAX(id) as id')
->groupBy('policy_type')
->pluck('id');

$acceptedPolicyIds = PolicyAcceptance::where('user_id', $request->user()->id)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think of renaming this to $userAcceptedPolicyIds just for clarity.

->whereIn('policy_id', $activePolicyIds)
->pluck('policy_id');

$missingPolicies = Policy::whereIn('id', $activePolicyIds)
->whereNotIn('id', $acceptedPolicyIds)
->get();

return new PoliciesCollection($missingPolicies);
}
}
1 change: 1 addition & 0 deletions routes/api.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
$router->group(['middleware' => ['auth:api']], function () use ($router): void {
$router->get('auth/login', ['uses' => 'Auth\LoginController@getLogin']);
$router->delete('auth/login', ['uses' => 'Auth\LoginController@deleteLogin']);
$router->get('v1/policies/missing', ['uses' => 'PoliciesController@getMissingPolicies']);

// policy acceptances
$router->put('v1/policy_acceptances', ['uses' => 'PolicyAcceptanceController@store']);
Expand Down
139 changes: 139 additions & 0 deletions tests/Routes/PoliciesControllerTest.php

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there are now two polliciesControllerTest.php. one in the controller tests dir and this one. Will be good to merge this two test files because they contain tests from the same class.

Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<?php

namespace Tests\Routes;

use App\Policy;
use App\PolicyAcceptance;
use App\User;
use Carbon\CarbonImmutable;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Tests\TestCase;

class PoliciesControllerTest extends TestCase {
use DatabaseTransactions;

private string $missingPoliciesRoute = 'v1/policies/missing';

private function createPolicy(string $type, CarbonImmutable $activeFrom, string $content): Policy {
return Policy::create([
'policy_type' => $type,
'active_from' => $activeFrom,
'content_vue_file' => $content,
]);
}

public function testMissingPoliciesRequiresAuthentication(): void {
$this->json('GET', $this->missingPoliciesRoute)
->assertStatus(401);
}

public function testMissingPoliciesReturnsOnlyLatestCurrentPolicyPerType(): void {
$user = User::factory()->create();
$now = CarbonImmutable::now();

// Future policy (should be ignored because it is not active yet)
$this->createPolicy('terms-of-use', $now->addDays(10), 'terms-of-use/version-future.vue');

$olderTerms = $this->createPolicy('terms-of-use', $now->subDays(10), 'terms-of-use/version-1.vue');
$latestTerms = $this->createPolicy('terms-of-use', $now->subDays(1), 'terms-of-use/version-2.vue');
$this->createPolicy('terms-of-use', $now->addDays(1), 'terms-of-use/version-3.vue');

$olderHosting = $this->createPolicy('hosting-policy', $now->subDays(20), 'hosting-policy/version-1.vue');
$latestHosting = $this->createPolicy('hosting-policy', $now->subDays(2), 'hosting-policy/version-2.vue');

$response = $this->actingAs($user, 'api')
->json('GET', $this->missingPoliciesRoute)
->assertStatus(200)
->assertJsonStructure([
'items' => [
['metadata' => ['policy_id', 'type', 'active_from', 'content_vue_file']],
],
]);

$items = collect($response->json('items'));

$this->assertCount(2, $items);

$this->assertTrue($items->contains(function (array $item) use ($latestTerms): bool {
return $item['metadata']['policy_id'] === $latestTerms->id
&& $item['metadata']['type'] === 'terms-of-use'
&& $item['metadata']['active_from'] === $latestTerms->active_from->format('Y-m-d')
&& $item['metadata']['content_vue_file'] === 'terms-of-use/version-2.vue';
}));

$this->assertTrue($items->contains(function (array $item) use ($latestHosting): bool {
return $item['metadata']['policy_id'] === $latestHosting->id
&& $item['metadata']['type'] === 'hosting-policy'
&& $item['metadata']['active_from'] === $latestHosting->active_from->format('Y-m-d')
&& $item['metadata']['content_vue_file'] === 'hosting-policy/version-2.vue';
}));

$this->assertFalse($items->contains(function (array $item) use ($olderTerms): bool {
return $item['metadata']['policy_id'] === $olderTerms->id;
}));

$this->assertFalse($items->contains(function (array $item) use ($olderHosting): bool {
return $item['metadata']['policy_id'] === $olderHosting->id;
}));

$this->assertCount(1, $items->where('metadata.type', 'terms-of-use'));
$this->assertCount(1, $items->where('metadata.type', 'hosting-policy'));
}

public function testMissingPoliciesExcludesAlreadyAcceptedPoliciesForCurrentUser(): void {
$user = User::factory()->create();
$anotherUser = User::factory()->create();
$now = CarbonImmutable::now();

$terms = $this->createPolicy('terms-of-use', $now->subDays(1), 'terms-of-use/version-2.vue');
$hosting = $this->createPolicy('hosting-policy', $now->subDays(1), 'hosting-policy/version-1.vue');

PolicyAcceptance::create([
'user_id' => $user->id,
'policy_id' => $terms->id,
'accepted_at' => $now,
]);

// Acceptance by another user must not affect current user response
PolicyAcceptance::create([
'user_id' => $anotherUser->id,
'policy_id' => $hosting->id,
'accepted_at' => $now,
]);

$response = $this->actingAs($user, 'api')
->json('GET', $this->missingPoliciesRoute)
->assertStatus(200);

$items = collect($response->json('items'));

$this->assertCount(1, $items);
$this->assertSame($hosting->id, $items->first()['metadata']['policy_id']);
$this->assertSame('hosting-policy', $items->first()['metadata']['type']);
}

public function testMissingPoliciesReturnsEmptyListWhenAllCurrentPoliciesAccepted(): void {
$user = User::factory()->create();
$now = CarbonImmutable::now();

$terms = $this->createPolicy('terms-of-use', $now->subDays(1), 'terms-of-use/version-2.vue');
$hosting = $this->createPolicy('hosting-policy', $now->subDays(1), 'hosting-policy/version-1.vue');

PolicyAcceptance::create([
'user_id' => $user->id,
'policy_id' => $terms->id,
'accepted_at' => $now,
]);

PolicyAcceptance::create([
'user_id' => $user->id,
'policy_id' => $hosting->id,
'accepted_at' => $now,
]);

$this->actingAs($user, 'api')
->json('GET', $this->missingPoliciesRoute)
->assertStatus(200)
->assertJson(['items' => []]);
}
}
Loading