Diferencia entre revisiones de «Cabina de votaciones - 17 18»

De Wiki de EGC
Saltar a: navegación, buscar
(Página creada con «''' == Resumen del trabajo == ''' Nuestro trabajo consistirá en realizar el apartado de cabina de votación que consiste en permitir mediante el uso de un conjunto de mét...»)
 
(Mejorada (por parte de Javier) la descripción de la API y añadidas las plantillas HTML.)
Línea 5: Línea 5:
  
 
'''
 
'''
−
== Tecnologías que se usarán ==
+
== Objetivo del subsistema ==
 
'''
 
'''
−
Se usará node.js (Javascript) junto con npm para poder importar librerías con mayor facilidad.
+
Nuestro trabajo consistirá en realizar el apartado de cabina de votación que consiste en permitir mediante el uso de un conjunto de métodos la posibilidad de que los usuarios puedan votar anónimamente teniendo en cuenta las restricciones posibles que puedan existir.
 +
 
 +
'''Tecnologías que se usarán''':
 +
Subsistema: Cabina de votación
 +
Lenguaje/Herramienta: Node.js 9.2 (Javascript v8)
 +
Bibliotecas:
 +
- restify: 6.3.4
 +
- rest: 2.0.0
 +
- lodash: 4.17.4
 +
- async: 2.6.0
 +
Sistema de gestión de bibliotecas: npm
 +
Base de datos: No (Aunque es necesaria alguna forma de verificar los votos a partir del usuario encriptado).
  
 
'''
 
'''
 
== APIs y datos que se usarán y devolverán ==
 
== APIs y datos que se usarán y devolverán ==
 
'''
 
'''
−
Necesitaremos obtener los datos básicos de la encuesta (nombre de la encuesta, autor de la misma, descripción si hubiera...), el conjunto de preguntas con sus respectivas respuestas de dicha encuesta, y los datos del usuario que está votando (o en caso de ser anónimo, poder verificar las reglas de negocio relacionadas con dicho usuario si pudiera o no votar).
+
 
−
Devolveremos por cada usuario (de manera encriptada y anónima) las respuestas elegidas por el usuario para cada pregunta de la encuesta.
+
'''Estructura de un voto''':
 +
 
 +
id: (int) identificador del voto [pk, autoincrementable]
 +
encrypted_user: (string) identificador del usuario que ha votado de forma encriptada, es única y es posible verificar el voto (voto anónimo) [unique, not null]
 +
id_election: (int) identificador de la votación [fk, not null]
 +
encrypted_answers: (string) es un string con el contenido de la votación cifrado.
 +
 
 +
'''Obtención de un voto''':
 +
Tipo: GET
 +
URL: http://egc-cabina.es/api/get/vote.json?id=x&id_election=y
 +
Parámetros: id_vote: Identificador del voto (x)
 +
            id_election: Identificador de la elección del voto (y)
 +
Formato JSON Ejemplo: Obtención del voto 1
 +
<nowiki>
 +
{
 +
    "vote": {
 +
        "id": "1",
 +
        "encrypted_user": "xgs5fdy2",
 +
        "id_election": "165",
 +
        "encrypted_answers": "..."
 +
    }
 +
}</nowiki>
 +
 
 +
'''Consulta de votos''':
 +
Tipo: GET
 +
URL: http://egc-cabina.es/api/get/votes.json?encrypted_user=x&id_election=y
 +
Parámetros: encrypted_user: (opcional) Identificador del usuario encriptado. (x)
 +
            id_election (opcional) Identificador de la votación (y)
 +
Formato JSON Ejemplo: Buscando la votación 165
 +
 
 +
<nowiki>
 +
{
 +
    "votos": {
 +
        "vote1": {
 +
            "id": "1",
 +
            "encrypted_user": "xgs5fdy2",
 +
            "id_election": "165",
 +
            "encrypted_anwers": "..."
 +
        },
 +
 
 +
        "voto2": {
 +
            "id": "2",
 +
            "encrypted_user": "whedvsg3",
 +
            "id_election": "165",
 +
            "encrypted_anwers": "..."
 +
        }
 +
    }
 +
}</nowiki>
 +
 
 +
'''Creación de voto''':
 +
Tipo: POST
 +
URL: http://egc-cabina.es/api/create/vote.json
 +
Parámetros: id_user: (int) Identificador del usuario (sin encriptar)
 +
            id_election: (int) Identificador de la votación
 +
            answers: (list[string]) Lista con las respuestas de la votación de forma ordenada (en la posición 1 estará la respuesta a la pregunta 1 de la votación)
 +
Formato JSON Ejemplo: Creando un voto por el usuario 23, la votación 34, el grupo de usuarios 13.
 +
<nowiki>
 +
{
 +
    "result": true,
 +
    "vote": {
 +
        "id": "1",
 +
        "encrypted_user": "as5d8gr4",
 +
        "id_election": "34",
 +
        "id_group": "13",
 +
        "encrypted_answers": "..."
 +
    }
 +
}</nowiki>
 +
 
 +
 
 +
== Plantillas HTML ==
 +
 
 +
Se tiene pensado que el formato de la cabina de votación sea el siguiente:
 +
 
 +
'''Votación de la pregunta X'''
 +
 
 +
<nowiki>
 +
<hX><!-- Nombre de la encuesta --></hX>
 +
<hr/>
 +
<p><!-- Descripción de la encuesta --></p>
 +
<hr/>
 +
<p>Pregunta <!-- X --></p>
 +
<span><!-- Texto de la preguna X --></span>
 +
<% En el caso de que se trate de una lista de posibles opciones donde sólo se selecciona una %>
 +
    <select>
 +
        <option value="<!-- Valor de la respuesta -->"><!-- Texto de la respuesta -->
 +
    </select>
 +
<% En el caso de que se trate de una respuesta donde habrá que poner texto %>
 +
    <label...><!-- Texto de la pregunta --></label>
 +
    <input value="<!-- Valor de la pregunta -->" />
 +
<hr/>
 +
<button <% Botón de siguiente pregunta %>>Siguiente pregunta</button>
 +
</nowiki>
 +
 
 +
'''Final de la votación de la encuesta'''
 +
 
 +
<nowiki><hX><!-- Nombre de la encuesta --></hX>
 +
<hr/>
 +
<p><!-- Descripción de la encuesta --></p>
 +
<hr/>
 +
<p>Gracias por responder a <!-- Nombre de la encuesta --></p>
 +
<button>Finalizar</button> <% Con este botón, se enviaría a la cabina de votación el voto y los credenciales del usuario que lo ha creado %>
 +
</nowiki>

Revisión del 22:02 25 nov 2017

Resumen del trabajo

Nuestro trabajo consistirá en realizar el apartado de cabina de votación que consiste en permitir mediante el uso de un conjunto de métodos la posibilidad de que los usuarios puedan votar anónimamente teniendo en cuenta las restricciones posibles que puedan existir.

Objetivo del subsistema

Nuestro trabajo consistirá en realizar el apartado de cabina de votación que consiste en permitir mediante el uso de un conjunto de métodos la posibilidad de que los usuarios puedan votar anónimamente teniendo en cuenta las restricciones posibles que puedan existir.

Tecnologías que se usarán: Subsistema: Cabina de votación Lenguaje/Herramienta: Node.js 9.2 (Javascript v8) Bibliotecas: - restify: 6.3.4 - rest: 2.0.0 - lodash: 4.17.4 - async: 2.6.0 Sistema de gestión de bibliotecas: npm Base de datos: No (Aunque es necesaria alguna forma de verificar los votos a partir del usuario encriptado).

APIs y datos que se usarán y devolverán

Estructura de un voto:

id: (int) identificador del voto [pk, autoincrementable] encrypted_user: (string) identificador del usuario que ha votado de forma encriptada, es única y es posible verificar el voto (voto anónimo) [unique, not null] id_election: (int) identificador de la votación [fk, not null] encrypted_answers: (string) es un string con el contenido de la votación cifrado.

Obtención de un voto: Tipo: GET URL: http://egc-cabina.es/api/get/vote.json?id=x&id_election=y Parámetros: id_vote: Identificador del voto (x) 

           id_election: Identificador de la elección del voto (y)

Formato JSON Ejemplo: Obtención del voto 1 { "vote": { "id": "1", "encrypted_user": "xgs5fdy2", "id_election": "165", "encrypted_answers": "..." } }

Consulta de votos: Tipo: GET URL: http://egc-cabina.es/api/get/votes.json?encrypted_user=x&id_election=y Parámetros: encrypted_user: (opcional) Identificador del usuario encriptado. (x) 

           id_election (opcional) Identificador de la votación (y)

Formato JSON Ejemplo: Buscando la votación 165

{ "votos": { "vote1": { "id": "1", "encrypted_user": "xgs5fdy2", "id_election": "165", "encrypted_anwers": "..." }, "voto2": { "id": "2", "encrypted_user": "whedvsg3", "id_election": "165", "encrypted_anwers": "..." } } }

Creación de voto: Tipo: POST URL: http://egc-cabina.es/api/create/vote.json Parámetros: id_user: (int) Identificador del usuario (sin encriptar) 

           id_election: (int) Identificador de la votación
           answers: (list[string]) Lista con las respuestas de la votación de forma ordenada (en la posición 1 estará la respuesta a la pregunta 1 de la votación)

Formato JSON Ejemplo: Creando un voto por el usuario 23, la votación 34, el grupo de usuarios 13. { "result": true, "vote": { "id": "1", "encrypted_user": "as5d8gr4", "id_election": "34", "id_group": "13", "encrypted_answers": "..." } }


Plantillas HTML

Se tiene pensado que el formato de la cabina de votación sea el siguiente:

Votación de la pregunta X

<hX><!-- Nombre de la encuesta --></hX> <hr/> <p><!-- Descripción de la encuesta --></p> <hr/> <p>Pregunta <!-- X --></p> <span><!-- Texto de la preguna X --></span> <% En el caso de que se trate de una lista de posibles opciones donde sólo se selecciona una %> <select> <option value="<!-- Valor de la respuesta -->"><!-- Texto de la respuesta --> </select> <% En el caso de que se trate de una respuesta donde habrá que poner texto %> <label...><!-- Texto de la pregunta --></label> <input value="<!-- Valor de la pregunta -->" /> <hr/> <button <% Botón de siguiente pregunta %>>Siguiente pregunta</button>

Final de la votación de la encuesta

<hX><!-- Nombre de la encuesta --></hX> <hr/> <p><!-- Descripción de la encuesta --></p> <hr/> <p>Gracias por responder a <!-- Nombre de la encuesta --></p> <button>Finalizar</button> <% Con este botón, se enviaría a la cabina de votación el voto y los credenciales del usuario que lo ha creado %>

Obtenido de «https://1984.lsi.us.es/wiki-egc/index.php?title=Cabina_de_votaciones_-_17_18&oldid=6514»