Continue to implement opinion

improve target reference
Improve Tests for Opinion
fix SQL:upsert_opinion

src/main/resources/openapi.yaml

@@ -650,6 +650,123 @@ paths:
         401:
           $ref: '#/components/responses/401'
 
+  /articles/{article}/opinions:
+    parameters:
+      - $ref: '#/components/parameters/article'
+    put:
+      security:
+        - JWTAuth: []
+      summary: Add Opinion on one article
+      tags:
+        - opinion
+        - article
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ArticleOpinionRequest'
+      responses:
+        201:
+          description: Return the opinion
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Opinion'
+        401:
+          $ref: '#/components/responses/401'
+  /opinions:
+    get:
+      summary: Get all opinions choices
+      tags:
+        - opinion
+      parameters:
+        - in: query
+          required: false
+          name: targets
+          description: opinion available for defined target
+          example:
+            - article
+          schema:
+            type: array
+            items:
+              type: string
+      responses:
+        200:
+          description: return
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OpinionChoices'
+  /opinions/{opinion}:
+    parameters:
+      - $ref: '#/components/parameters/opinion'
+    get:
+      summary: Get one opinion Choices
+      tags:
+        - opinion
+      responses:
+        200:
+          description: return
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OpinionChoice'
+  /citizens/{citizen}/opinions:
+    parameters:
+      - $ref: '#/components/parameters/citizen'
+    get:
+      security:
+        - JWTAuth: []
+      summary: Get all opinions of citizen filtered by target ids
+      tags:
+        - opinion
+        - citizen
+      parameters:
+        - in: query
+          required: true
+          name: id
+          description: target ids
+          example:
+            - 9226c1a3-8091-c3fa-7d0d-c2e98c9bee7b
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
+      responses:
+        200:
+          description: Opinions
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Opinion'
+  /citizens/{citizen}/opinions/articles:
+    parameters:
+      - $ref: '#/components/parameters/citizen'
+    get:
+      security:
+        - JWTAuth: []
+      summary: Get all opinions of one citizen
+      tags:
+        - opinion
+        - citizen
+      responses:
+        200:
+          description: Opinions
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - $ref: '#/components/schemas/Paginated'
+                  - type: object
+                    properties:
+                      result:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/Opinion'
+
 
   /citizens/{citizen}/votes/articles:
     parameters:
@@ -789,7 +906,7 @@ components:
       name: citizen
       in: path
       description: ID of citizen
-      example: 4d673bfa-eaef-4290-b52f-85a9c8a7eba5
+      example: 6434f4f9-f570-f22a-c134-8668350651ff
       required: true
       schema:
         type: string
@@ -804,6 +921,15 @@ components:
       schema:
         type: string
         format: uuid
+    opinion:
+      in: path
+      required: true
+      name: opinion
+      description: Opinion ID
+      example: 6e978eb5-3c48-0def-b093-e01f43983adb
+      schema:
+        type: string
+        format: uuid
 
     constitution:
       name: constitution
@@ -861,6 +987,13 @@ components:
         updated_at:
           type: string
           format: 'date-time'
+    DeletedAt:
+      properties:
+        deleted_at:
+          type: string
+          format: 'date-time'
+        deleted:
+          type: boolean
 
     versionId:
       properties:
@@ -1221,7 +1354,70 @@ components:
             Opinion1: 1
             Opinion2: 55
 
+    ArticleOpinionRequest:
+      type: object
+      properties:
+        opinion_choice:
+          type: string
+          format: uuid
+          example: 6e978eb5-3c48-0def-b093-e01f43983adb
 
+    OpinionChoices:
+      description: Opinion Choice
+      type: array
+      items:
+        $ref: '#/components/schemas/OpinionChoice'
+
+    OpinionChoice:
+      description: Opinion Choice
+      allOf:
+        - type: object
+          properties:
+            id:
+              type: string
+              format: uuid
+            name:
+              type: string
+              example: opinion1
+            target:
+              type: array
+              required: false
+              nullable: true
+              items:
+                type: string
+                description: the name of the target
+        - $ref: '#/components/schemas/CreatedAt'
+        - $ref: '#/components/schemas/DeletedAt'
+
+    Opinion:
+      description: Opinion
+      allOf:
+        - type: object
+          properties:
+            id:
+              type: string
+              format: uuid
+            name:
+              type: string
+              example: opinion1
+            target:
+              type: object
+              properties:
+                  id:
+                    type: string
+                    format: uuid
+                  reference:
+                    type: string
+                    example: article
+            choice:
+              type: object
+              allOf:
+                - $ref: '#/components/schemas/OpinionChoice'
+            reference:
+              type: string
+              example: opinion_on_article
+        - $ref: '#/components/schemas/CreatedBy'
+        - $ref: '#/components/schemas/CreatedAt'
 
 
 
@@ -1243,11 +1439,7 @@ components:
       required: true
 
 servers:
-  - description: localhost 80
-    url: http://localhost
-  - description: localhost 8080
+  - description: localhost
     url: http://localhost:8080
   - description: production
-    url: http://dc-project.fr
-  - description: SwaggerHub API Auto Mocking
-    url: https://virtserver.swaggerhub.com/flecomte/dc-project/0.1
+    url: http://dc-project.fr

src/main/resources/sql/fixtures/09-opinion.sql

@@ -7,7 +7,10 @@ begin
     delete from opinion_choice;
 
     insert into opinion_choice (id, name, target)
-    select uuid_in(md5('opinion_choice'||row_number() over ())::cstring), 'Opinion'||row_number() over (), '{article}'
+    select
+           uuid_in(md5('opinion_choice'||row_number() over ())::cstring),
+           'Opinion'||row_number() over (),
+           case when row_number() over () % 5 = 0 then null else '{article}'::text[] end
         from generate_series(0,20);
 
     for i in 0..9 loop

src/main/resources/sql/functions/helpers/find_reference_by_id.sql

@@ -11,11 +11,17 @@ begin
             find_article_by_id(_id)
         when 'constitution'::regclass then
             find_constitution_by_id(_id)
+        when 'comment'::regclass then
+            find_comment_by_id(_id)
+        when 'opinion'::regclass then
+            find_opinion_by_id(_id)
         else
-            json_build_object('id', _id)
+            json_build_object('id', _id, 'reference', _reference)
     end
     into resource;
-end;
+
+    resource = resource::jsonb || jsonb_build_object('reference', _reference);
+end
 $$;
 
 -- drop function if exists find_reference_by_id(uuid, regclass, out json);

src/main/resources/sql/functions/opinion/find_citizen_opinions.sql

@@ -18,6 +18,8 @@ begin
     from (
         select
             o.*,
+            find_reference_by_id(o.target_id, o.target_reference) as target,
+            find_citizen_by_id(o.created_by_id) as created_by,
             to_json(ol) as choice
         from opinion as o
         join opinion_choice ol on o.choice_id = ol.id

src/main/resources/sql/functions/opinion/find_citizen_opinions_by_target_id.sql

@@ -11,6 +11,8 @@ begin
     from (
         select
             o.*,
+            find_reference_by_id(o.target_id, o.target_reference) as target,
+            find_citizen_by_id(o.created_by_id) as created_by,
             to_json(ol) as choice
         from opinion as o
         join opinion_choice ol on o.choice_id = ol.id

src/main/resources/sql/functions/opinion/find_citizen_opinions_by_target_ids.sql

@@ -9,6 +9,8 @@ begin
     from (
         select
             o.*,
+            find_reference_by_id(o.target_id, o.target_reference) as target,
+            find_citizen_by_id(o.created_by_id) as created_by,
             to_json(ol) as choice
         from opinion as o
         join opinion_choice ol on o.choice_id = ol.id

src/main/resources/sql/functions/opinion/find_opinion_by_id.sql

@@ -0,0 +1,22 @@
+create or replace function find_opinion_by_id(
+    _id uuid,
+    out resource json
+) language plpgsql as
+$$
+begin
+    select to_json(t)
+    into resource
+    from (
+        select
+            o.*,
+            find_reference_by_id(o.target_id, o.target_reference) as target,
+            find_citizen_by_id(o.created_by_id) as created_by,
+            to_json(ol) as choice
+        from "opinion" as o
+        join opinion_choice ol on o.choice_id = ol.id
+        where o.id = _id
+    ) as t;
+end;
+$$;
+
+-- drop function if exists find_opinion_by_id(uuid, out json);

src/main/resources/sql/functions/opinion/find_opinion_by_opinion.sql

@@ -0,0 +1,27 @@
+create or replace function find_opinion_by_opinion(
+    inout resource json
+) language plpgsql as
+$$
+declare
+    _target_id uuid = (resource#>>'{target, id}')::uuid;
+    _created_by_id uuid = (resource#>>'{created_by, id}')::uuid;
+    _choice_id uuid = (resource#>>'{choice, id}')::uuid;
+begin
+    select to_json(t)
+    into resource
+    from (
+        select
+            o.*,
+            find_reference_by_id(o.target_id, o.target_reference) as target,
+            find_citizen_by_id(o.created_by_id) as created_by,
+            to_json(ol) as choice
+        from "opinion" as o
+        join opinion_choice ol on o.choice_id = ol.id
+        where o.target_id = _target_id
+          and o.created_by_id = _created_by_id
+          and o.choice_id = _choice_id
+    ) as t;
+end;
+$$;
+
+-- drop function if exists find_opinion_by_opinion(json);

src/main/resources/sql/functions/opinion/find_opinion_choices.sql

@@ -8,7 +8,11 @@ begin
         select ol.*
         from opinion_choice ol
         where (ol.deleted_at is null or ol.deleted_at > now())
-           and (ol.target is null or targets is null or array_length(targets, 1) = 0 or ol.target && targets)
+           and (
+               ol.target is null or array_length(ol.target, 1) is null  -- if choice is compatible with all target
+            or targets is null or array_length(targets, 1) is null -- if no target defined
+            or (ol.target && targets) -- if target is compatible
+           )
 
         order by ol.name
     ) t;
@@ -17,4 +21,4 @@ $$;
 
 -- drop function if exists find_opinions();
 
--- select find_opinions();
+-- select find_opinion_choices('{}');

src/main/resources/sql/functions/opinion/opinion.sql

@@ -1,17 +0,0 @@
-create or replace function opinion(reference regclass, _target_id uuid, _created_by_id uuid, _opinion uuid, out resource json)
-    language plpgsql as
-$$
-begin
-    if reference = 'article'::regclass then
-        insert into opinion_on_article (created_by_id, target_id, choice_id)
-        values (_created_by_id, _target_id, _opinion)
-        on conflict (created_by_id, target_id, choice_id) do nothing;
-    else
-        raise exception '% no implemented for opinion', reference::text;
-    end if;
-
-    select count_opinion(_target_id) into resource;
-end;
-$$;
-
--- drop function if exists vote(regclass,uuid,uuid,integer,boolean);

src/main/resources/sql/functions/opinion/upsert_opinion.sql

@@ -0,0 +1,23 @@
+create or replace function upsert_opinion(inout resource json)
+    language plpgsql as
+$$
+declare
+    _reference regclass = (resource#>>'{target, reference}')::regclass;
+    _id uuid = coalesce((resource->>'id')::uuid, uuid_generate_v4());
+    _target_id uuid = (resource#>>'{target, id}')::uuid;
+    _created_by_id uuid = (resource#>>'{created_by, id}')::uuid;
+    _choice_id uuid = (resource#>>'{choice, id}')::uuid;
+begin
+    if _reference = 'article'::regclass then
+        insert into opinion_on_article (id, created_by_id, target_id, choice_id)
+        values (_id, _created_by_id, _target_id, _choice_id)
+        on conflict (created_by_id, target_id, choice_id) do nothing;
+    else
+        raise exception '% no implemented for opinion', _reference::text;
+    end if;
+
+    select find_opinion_by_opinion(resource) into resource;
+end;
+$$;
+
+-- drop function if exists upsert_opinion(json);