DC/dc-project
1
1
Fork 0
Code Issues 25 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

create SQL function for get citizen votes with multiple target ids

Browse Source 
add updated_at field on vote table
This commit is contained in:
Fabrice Lecomte
2019-10-03 15:43:39 +02:00
parent 51cc5b640d
commit c5a2f92b19
8 changed files with 134 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/main/kotlin/fr/dcproject/repository/Vote.kt
View File

@@ -31,21 +31,6 @@ open class Vote <T: UuidEntity>(override var requester: Requester): RepositoryI<
)!!
}
fun findByCitizen(
citizen: CitizenEntity,
target: String,
typeReference: TypeReference<List<VoteEntity<T>>>,
page: Int = 1,
limit: Int = 50
): Paginated<VoteEntity<T>> =
findByCitizen(
citizen.id ?: error("The citizen must have an id"),
target,
typeReference,
page,
limit
)
fun findByCitizen(
citizenId: UUID,
target: String,
@@ -61,6 +46,21 @@ open class Vote <T: UuidEntity>(override var requester: Requester): RepositoryI<
))
}
}
fun findCitizenVotesByTargets(
citizen: CitizenEntity,
targets: List<UUID>
): List<VoteEntity<*>> {
val typeReference = object: TypeReference<List<VoteEntity<UuidEntity>>>() {}
return requester.run {
val citizenId = citizen.id ?: error("The citizen must have an id")
getFunction("find_citizen_votes_by_target_ids")
.select(typeReference, mapOf(
"citizen_id" to citizenId,
"ids" to targets
))
}
}
}
class VoteArticle (requester: Requester): Vote<Article>(requester) {
@@ -70,7 +70,7 @@ class VoteArticle (requester: Requester): Vote<Article>(requester) {
limit: Int = 50
): Paginated<VoteEntity<Article>> =
findByCitizen(
citizen,
citizen.id ?: error("The citizen must have an id"),
"article",
object: TypeReference<List<VoteEntity<Article>>>() {},
page,
@@ -85,7 +85,7 @@ class VoteConstitution (requester: Requester): Vote<Constitution>(requester) {
limit: Int = 50
): Paginated<VoteEntity<Constitution>> =
findByCitizen(
citizen,
citizen.id ?: error("The citizen must have an id"),
"constitution",
object: TypeReference<List<VoteEntity<Constitution>>>() {},
page,

16
src/main/kotlin/fr/dcproject/routes/VoteArticle.kt
View File

@@ -15,6 +15,7 @@ import io.ktor.locations.put
import io.ktor.request.receive
import io.ktor.response.respond
import io.ktor.routing.Route
import java.util.*
import fr.dcproject.entity.Article as ArticleEntity
import fr.dcproject.entity.Vote as VoteEntity
import fr.dcproject.repository.VoteArticle as VoteArticleRepository
@@ -33,6 +34,14 @@ object VoteArticlePaths {
limit: Int = 50,
val search: String? = null
): PaginatedRequestI by PaginatedRequest(page, limit)
@Location("/citizens/{citizen}/votes")
class CitizenVotesByIdsRequest(val citizen: Citizen, id: List<String>) {
val id: List<UUID> = id
.map { it.trim() }
.filter { it.isNotBlank() }
.map { UUID.fromString(it) }
}
}
@KtorExperimentalLocationsAPI
@@ -55,4 +64,11 @@ fun Route.voteArticle(repo: VoteArticleRepository) {
call.respond(votes)
}
get<VoteArticlePaths.CitizenVotesByIdsRequest> {
val votes = repo.findCitizenVotesByTargets(it.citizen, it.id)
assertCan(VIEW, votes)
call.respond(votes)
}
}

53
src/main/resources/openApi.yaml
View File

@@ -62,14 +62,7 @@ paths:
- citizen
operationId: getCitizen
parameters:
- name: citizen
in: path
description: ID of citizen
example: e74be8e4-6823-47c4-bd1b-789725b2fa8e
required: true
schema:
type: string
format: uuid
- $ref: '#/components/parameters/citizen'
responses:
200:
description: The Citizen object
@@ -79,6 +72,40 @@ paths:
$ref: '#/components/schemas/CitizenResponse'
404:
description: Citizen not found
/citizens/{citizen}/votes:
get:
security:
- JWTAuth: []
summary: Get Citizen
tags:
- citizen
operationId: getCitizenVotes
parameters:
- $ref: '#/components/parameters/citizen'
- name: id
in: query
required: true
example:
- 1329ab90-edae-cfed-f863-c8cb069fa327
- cab54e50-ce85-bba0-da23-fc9f75feeaf5
schema:
type: array
items:
type: string
format: uuid
responses:
200:
description: The Votes objects
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VoteResponse'
404:
description: Citizen not found
/citizens:
get:
security:
@@ -609,6 +636,16 @@ components:
schema:
type: string
citizen:
name: citizen
in: path
description: ID of citizen
example: 770d46e8-c458-417d-beaf-0f2faa109b26
required: true
schema:
type: string
format: uuid
securitySchemes:
JWTAuth:
type: http

32
src/main/resources/sql/functions/vote/find_citizen_votes_by_target_ids.sql Normal file
View File

@@ -0,0 +1,32 @@
create or replace function find_citizen_votes_by_target_ids(
_citizen_id uuid,
_ids uuid[],
_reference regclass default null,
out resource json
) language plpgsql as
$$
begin
select
json_agg(t)
into resource
from (
select
v.*,
find_reference_by_id(v.target_id, _reference) as target,
find_citizen_by_id(v.created_by_id) as created_by
from vote as v
where
(_reference is null or _reference = target_reference)
and target_id = any(_ids)
and created_by_id = _citizen_id
order by
_ids
limit 100
) as t;
end;
$$;
-- drop function if exists find_citizen_votes_by_target_ids(uuid, uuid[], regclass);

12
src/main/resources/sql/functions/vote/vote.sql
View File

@@ -7,25 +7,29 @@ begin
values (_created_by_id, _target_id, _note, _anonymous)
on conflict (created_by_id, target_id) do update set
note = excluded.note,
anonymous = excluded.anonymous;
anonymous = excluded.anonymous,
updated_at = now();
elseif reference = 'constitution'::regclass then
insert into vote_for_constitution (created_by_id, target_id, note, anonymous)
values (_created_by_id, _target_id, _note, _anonymous)
on conflict (created_by_id, target_id) do update set
note = excluded.note,
anonymous = excluded.anonymous;
anonymous = excluded.anonymous,
updated_at = now();
elseif reference = 'comment_on_article'::regclass then
insert into vote_for_comment_on_article (created_by_id, target_id, note, anonymous)
values (_created_by_id, _target_id, _note, _anonymous)
on conflict (created_by_id, target_id) do update set
note = excluded.note,
anonymous = excluded.anonymous;
anonymous = excluded.anonymous,
updated_at = now();
elseif reference = 'comment_on_constitution'::regclass then
insert into vote_for_comment_on_constitution (created_by_id, target_id, note, anonymous)
values (_created_by_id, _target_id, _note, _anonymous)
on conflict (created_by_id, target_id) do update set
note = excluded.note,
anonymous = excluded.anonymous;
anonymous = excluded.anonymous,
updated_at = now();
else
raise exception '% no implemented', reference::text;
end if;

1
src/main/resources/sql/migrations/0000-init_schema.up.sql
View File

@@ -450,6 +450,7 @@ execute procedure set_comment_parents_ids();
create table vote
(
updated_at timestamptz default now() not null check ( updated_at >= created_at ),
anonymous boolean default true not null,
note int not null check ( note >= -1 and note <= 1 ),
foreign key (created_by_id) references citizen (id),

7
src/test/resources/feature/vote.feature
View File

@@ -29,3 +29,10 @@ Feature: vote Article
| limit | 50 |
| total | 1 |
| result[0].note | 1 |
Scenario: Can get votes of current citizen by target ids
Given I am authenticated as John Doe with id "64b7b379-2298-43ec-b428-ba134930cabd"
When I send a GET request to "/citizens/64b7b379-2298-43ec-b428-ba134930cabd/votes?id=9226c1a3-8091-c3fa-7d0d-c2e98c9bee7b&id=64b1f265-bfb3-332b-eef9-d00f63a3beaa"
Then the response status code should be 200
And the response should contain object:
| [0].note | 1 |

6
src/test/sql/vote.sql
View File

@@ -38,6 +38,7 @@ declare
$json$;
votes jsonb;
votes_of_citizen json;
votes_of_citizen_for_targets json;
votes_total int;
begin
-- insert user for context
@@ -97,6 +98,11 @@ begin
assert (votes_total = 1), format('votes count for user %s must be 1, instead of %s', _citizen_id, votes_total);
assert ((votes_of_citizen#>>'{0,note}')::int = -1), format('the note must be -1, instead of %s', (votes_of_citizen#>>'{0,note}'));
-- test "find_citizen_votes_by_target_ids"
select find_citizen_votes_by_target_ids(_citizen_id, array[(created_article->>'id')]::uuid[]) into votes_of_citizen_for_targets;
assert (json_array_length(votes_of_citizen_for_targets) = 1), format('the function must be return 1 vote, instead of %s', json_array_length(votes_of_citizen_for_targets));
assert (votes_of_citizen_for_targets#>>'{0,target_id}' = created_article->>'id'), format('target_id of vote must be %s, instead of %s', created_article->>'id', votes_of_citizen_for_targets#>>'{0,target_id}');
-- delete vote and context
delete from vote;
delete from article;