Wiki de EGC - Contribuciones del usuario [es]

Cabina de votaciones - 17 18 - G2

2018-01-14T16:01:22Z

Jualopmun2:

== Objetivo del subsistema ==
Permitir la votación para las distintas votaciones disponibles en el sistema.

== Consideraciones ==
* Debe comprobar que el usuario autenticado tiene permiso para participar en la votación indicada
* Se debe encargar de la encriptación del voto para que se envíe de manera segura
* Repositorio del año pasado: https://github.com/AgoraUS-G1-1617/Cabina-de-votaciones
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Cabina_de_votación_1617_G1

'''
== 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_user: (int) identificador del usuario que ha votado, es única y es posible verificar el voto [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. 

'''Consulta de permisos de voto'''
Tipo: GET 
URL: http://egc-cabina.es/api/check/vote.json?user=x&election=y 
Parámetros:
user: Nombre de usuario al que comprobar si puede votar
election: Identificador de la votación a comprobar
Formato JSON Ejemplo, usuario "user" puede votar en "election":

{
"result": true,
"reason": "can_vote"
}

Otras consideraciones: "reason" determina la razón de por qué no puede votar y pueden ser alguno de los siguientes: 
- "can_vote" El usuario puede votar.
- "already_voted" El usuario ha realizado su voto y la votación es de un sólo voto, por lo tanto no podrá votar.
- "cant_vote" El usuario no pertenece a un grupo de votación.
- "user_not_found" El usuario introducido no existe.
- "election_not_found" La votación introducida no existe.
- "election_not_open" La votación no ha abierto todavía el plazo de votación.

'''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[(int,string)]) Lista que contendrá el par question_id, que es el identificador de la pregunta como int, y answer, que es la respuesta del usuario. La representación de cada par sería la siguiente:
{
"question_id": 0,
"answer": "..."
}

Formato JSON Ejemplo: Creando un voto por el usuario 23, la votación 34, el grupo de usuarios 13. Se debe enviar:

{
"id_user": 23,
"id_election": 34,
"answers": [
{
"question_id": 0,
"answer": "Algo"
},
{
"question_id": 1,
"answer": "Sí"
}
]
}

La respuesta a esta petición será:

{
"result": true,
"reason": "can_vote"
}

== Plantillas HTML ==

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

'''Votación de la pregunta X'''

{% block body %} 
<\h2>{{ election['nombre'] }}<\/h2> 
<\hr/> 
<\p>{{ election['descripcion'] }}<\/p> 
<\hr/> 
{% for question in election['preguntas'] %} 
<\p>Pregunta {{ question['nombre'] }}<\/p> 
<\span>{{ question['descripcion'] }}<\/span> 
{% if question['tipo_pregunta'] == "Cerrada" %} 
<select> 
{% for answer in question['respuestas'] %} 
<option value="{{\answer.seleccionada}}">{{answer['texto_pregunta']}}</option> 
{% endfor %} 
</select> 
{% endif %} 
{% if question['tipo_pregunta'] == "Abierta" %} 
<\p> 
{{ question['texto_pregunta'] }} 
<input id="answer" value="{{ question.respuestas[0].texto_respuesta}}" /> 
<\/p> 
{% endif %} 
{% endfor %} 
<button>Enviar voto</button> 
<\hr/> 
{% endblock %} 

'''Final de la votación de la encuesta'''

{% block body %} 
<\h2>{{ election.nombre }}<\/h2> 
<\hr/> 
<\p>{{ election.descripcion }}<\/p> 
<\hr/> 
<\p>Gracias por responder a {{ election.nombre }}<\/p> 
<button>Finalizar</button>
{% endblock %}

Para que pueda mostrarse, se ha tenido que añadir <\ en la mayoría de las etiquetas HTML, así como añadir \answers en el select dentro de la página de votación.

== Código de respuesta del servidor HTTP ==

Para nuestra API, hemos definido los siguientes códigos de respuestas del servidor HTTP:

{| border="1" style="border-collapse:collapse"
|-
! Código
! Valor result
! Valor msg
! Posible motivo
|-
| 200
| true
| Successfull
|El usuario ha realizado correctamente el voto
|-
| 404
| false
| User not found
| El usuario no ha realizado correctamente el voto
|-
| 403
| false
| Don't have access
| El usuario ha realizado correctamente el voto pero no tiene los permisos necesarios para el procesamiento de su voto
|}

'''
== Decisiones de diseño ==
'''

'''Cifrado de los votos'''
Para el cifrado de los votos, se seguirá el siguiente criptosistema. Primero, se recogerá la representación en JSON del voto, siguiendo el siguiente formato:
{
"question_id": <id_de_la_pregunta>,
"answer": "<respuesta_a_la_pregunta>"
}

Después, se cifrará el contenido de éste JSON a base64, usando como encodificado UTF-8. Finalmente, se recogerá la clave de cifrado de la votación y se aplicará el cifrado XOR, aplicando XOR a la clave y el string en base64 antes mencionado.

== Documentación==

Os dejamos la documentación final del proyecto para que os sirva de ayuda para los próximos años en la asignatura.

Enlace de los documentos: https://mega.nz/#F!C5cSQIBT!8mbrI89vF0l96D0Yby1SJA

Cabina de votaciones - 17 18 - G2

2017-12-03T15:37:46Z

Jualopmun2: /* Código de respuesta del servidor HTTP */

== Objetivo del subsistema ==
Permitir la votación para las distintas votaciones disponibles en el sistema.

== Consideraciones ==
* Debe comprobar que el usuario autenticado tiene permiso para participar en la votación indicada
* Se debe encargar de la encriptación del voto para que se envíe de manera segura
* Repositorio del año pasado: https://github.com/AgoraUS-G1-1617/Cabina-de-votaciones
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Cabina_de_votación_1617_G1

'''
== 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. 

'''Consulta de permisos de voto'''
Tipo: GET 
URL: http://egc-cabina.es/api/check/vote.json?user=x&election=y 
Parámetros:
user: Nombre de usuario al que comprobar si puede votar
election: Identificador de la votación a comprobar
Formato JSON Ejemplo, usuario "user" puede votar en "election":

{
"result": true,
"reason": "can_vote"
}

Otras consideraciones: "reason" determina la razón de por qué no puede votar y pueden ser alguno de los siguientes: 
- "can_vote" El usuario puede votar.
- "already_voted" El usuario ha realizado su voto y la votación es de un sólo voto, por lo tanto no podrá votar.
- "cant_vote" El usuario no pertenece a un grupo de votación.
- "user_not_found" El usuario introducido no existe.
- "election_not_found" La votación introducida no existe.
- "election_not_open" La votación no ha abierto todavía el plazo de votación.

'''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'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
{% for question in election.preguntas %}
<\p>Pregunta {% question.nombre %}<\/p> 
<\span>{% question.descripcion %}<\/span> 
{% if question.tipo_pregunta == "Cerrada" 
{% for answer in question.respuestas %} 
<select> 
<option value="{% answer.seleccionada %}">{% answer.texto_pregunta %} 
</select> 
{% endfor %}
{% if question.tipo_pregunta == "Abierta" %} 
<label...>{% question.texto_pregunta %}</label> 
<input value="{% question.answers[0].texto_respuesta" /> 
{% endif %}
{% endif %}
{% endfor %}
<\hr/> 
<button>Siguiente pregunta</button> 

'''Final de la votación de la encuesta'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
<\p>Gracias por responder a {% election.nombre %}<\/p> 
<button>Finalizar</button>

== Código de respuesta del servidor HTTP ==

Para nuestra API, hemos definido los siguientes códigos de respuestas del servidor HTTP:

{| border="1" style="border-collapse:collapse"
|-
! Código
! Valor result
! Valor msg
! Posible motivo
|-
| 200
| true
| Successfull
|El usuario ha realizado correctamente el voto
|-
| 404
| false
| User not found
| El usuario no ha realizado correctamente el voto
|-
| 403
| false
| Don't have access
| El usuario ha realizado correctamente el voto pero no tiene los permisos necesarios para el procesamiento de su voto
|}

Cabina de votaciones - 17 18 - G2

2017-12-03T15:36:49Z

Jualopmun2: /* Código de respuesta del servidor HTTP */

== Objetivo del subsistema ==
Permitir la votación para las distintas votaciones disponibles en el sistema.

== Consideraciones ==
* Debe comprobar que el usuario autenticado tiene permiso para participar en la votación indicada
* Se debe encargar de la encriptación del voto para que se envíe de manera segura
* Repositorio del año pasado: https://github.com/AgoraUS-G1-1617/Cabina-de-votaciones
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Cabina_de_votación_1617_G1

'''
== 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. 

'''Consulta de permisos de voto'''
Tipo: GET 
URL: http://egc-cabina.es/api/check/vote.json?user=x&election=y 
Parámetros:
user: Nombre de usuario al que comprobar si puede votar
election: Identificador de la votación a comprobar
Formato JSON Ejemplo, usuario "user" puede votar en "election":

{
"result": true,
"reason": "can_vote"
}

Otras consideraciones: "reason" determina la razón de por qué no puede votar y pueden ser alguno de los siguientes: 
- "can_vote" El usuario puede votar.
- "already_voted" El usuario ha realizado su voto y la votación es de un sólo voto, por lo tanto no podrá votar.
- "cant_vote" El usuario no pertenece a un grupo de votación.
- "user_not_found" El usuario introducido no existe.
- "election_not_found" La votación introducida no existe.
- "election_not_open" La votación no ha abierto todavía el plazo de votación.

'''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'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
{% for question in election.preguntas %}
<\p>Pregunta {% question.nombre %}<\/p> 
<\span>{% question.descripcion %}<\/span> 
{% if question.tipo_pregunta == "Cerrada" 
{% for answer in question.respuestas %} 
<select> 
<option value="{% answer.seleccionada %}">{% answer.texto_pregunta %} 
</select> 
{% endfor %}
{% if question.tipo_pregunta == "Abierta" %} 
<label...>{% question.texto_pregunta %}</label> 
<input value="{% question.answers[0].texto_respuesta" /> 
{% endif %}
{% endif %}
{% endfor %}
<\hr/> 
<button>Siguiente pregunta</button> 

'''Final de la votación de la encuesta'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
<\p>Gracias por responder a {% election.nombre %}<\/p> 
<button>Finalizar</button>

== Código de respuesta del servidor HTTP ==

Para nuestra API, hemos definido los siguientes códigos de respuestas del servidor HTTP:

{| border="1" style="border-collapse:collapse"
|-
! Código
! Valor result
! Valor msg
! Posible motivo
|-
| 200
| true
| Successfull
|El usuario ha realizado correctamente el voto
|-
| 404
| false
| User not found
| El usuario no ha realizado correctamente el voto.
|-
| 403
| false
| Don't have access
| El usuario ha realizado correctamente el voto pero no tiene los permisos necesarios para el procesamiento de su voto.
|}

Cabina de votaciones - 17 18 - G2

2017-12-03T15:32:48Z

Jualopmun2:

== Objetivo del subsistema ==
Permitir la votación para las distintas votaciones disponibles en el sistema.

== Consideraciones ==
* Debe comprobar que el usuario autenticado tiene permiso para participar en la votación indicada
* Se debe encargar de la encriptación del voto para que se envíe de manera segura
* Repositorio del año pasado: https://github.com/AgoraUS-G1-1617/Cabina-de-votaciones
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Cabina_de_votación_1617_G1

'''
== 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. 

'''Consulta de permisos de voto'''
Tipo: GET 
URL: http://egc-cabina.es/api/check/vote.json?user=x&election=y 
Parámetros:
user: Nombre de usuario al que comprobar si puede votar
election: Identificador de la votación a comprobar
Formato JSON Ejemplo, usuario "user" puede votar en "election":

{
"result": true,
"reason": "can_vote"
}

Otras consideraciones: "reason" determina la razón de por qué no puede votar y pueden ser alguno de los siguientes: 
- "can_vote" El usuario puede votar.
- "already_voted" El usuario ha realizado su voto y la votación es de un sólo voto, por lo tanto no podrá votar.
- "cant_vote" El usuario no pertenece a un grupo de votación.
- "user_not_found" El usuario introducido no existe.
- "election_not_found" La votación introducida no existe.
- "election_not_open" La votación no ha abierto todavía el plazo de votación.

'''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'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
{% for question in election.preguntas %}
<\p>Pregunta {% question.nombre %}<\/p> 
<\span>{% question.descripcion %}<\/span> 
{% if question.tipo_pregunta == "Cerrada" 
{% for answer in question.respuestas %} 
<select> 
<option value="{% answer.seleccionada %}">{% answer.texto_pregunta %} 
</select> 
{% endfor %}
{% if question.tipo_pregunta == "Abierta" %} 
<label...>{% question.texto_pregunta %}</label> 
<input value="{% question.answers[0].texto_respuesta" /> 
{% endif %}
{% endif %}
{% endfor %}
<\hr/> 
<button>Siguiente pregunta</button> 

'''Final de la votación de la encuesta'''

{% block body %}
<hX>{% election.nombre %}</hX> 
<\hr/> 
<\p>{% election.descripcion %}<\/p> 
<\hr/> 
<\p>Gracias por responder a {% election.nombre %}<\/p> 
<button>Finalizar</button>

== Código de respuesta del servidor HTTP ==

Para nuestra API, hemos definido los siguientes códigos de respuestas del servidor HTTP:

-200 OK: El usuario ha realizado correctamente el voto.

-403 FORBIDEN: El usuario ha realizado correctamente el voto pero no tiene los permisos necesarios para el procesamiento de su voto.

-404 NOT FOUND: El usuario no ha realizado correctamente el voto.

Cabina de votaciones - 17 18

2017-11-24T10:18:50Z

Jualopmun2: 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...»

'''
== 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.

'''
== Tecnologías que se usarán ==
'''
Se usará node.js (Javascript) junto con npm para poder importar librerías con mayor facilidad.

'''
== 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.