Wiki de EGC - Contribuciones del usuario [es]

Equipo de integración general - 17 18 - G2

2017-11-29T15:22:47Z

Jesrivjim: /* Formatos y procedimientos */

== Miembros ==

<ul>
<li>Gonzalo Delgado Chaves</li>
<li>Jesús Rivas Jiménez</li>
<li>Javier Sánchez Parra</li>
<li>Mohammed Alaoui Mhammedi</li>
<li>Roberto García Calero</li>
</ul>

== Repositorio GitHub ==

El repositorio de GitHub del equipo será accesible [https://github.com/EGC-G2-Trabajo-1718/integracion aquí]

== Máquina virtual de desarrollo ==
La máquina virtual de desarrollo (descarga [https://drive.google.com/file/d/1QcyMX2CTODWyq4KWQSWc259S-sidhe4f/view?usp=sharing aquí]) permite a cada equipo desarrollar su trabajo en local y comprobar como se integra con el resto de subsistemas. La máquina virtual comparte una serie de puertos con el equipo anfitrión para conseguir la comunicación. Los puertos asignados a cada subsistema se detallan a continuación:

{| class="wikitable"
!Subsistema
!Puerto
|-
|Wordpress (Portal Jornadas)
|50000
|-
|Portal votaciones
|50010
|-
|Autenticación
|50020
|-
|Administración de censos
|50030
|-
|Administración de votaciones
|50040
|-
|Almacenamiento de votos
|50050
|-
|Cabina de votaciones
|50060
|-
|Recuento
|50070
|}

Esta configuración de puertos se mantiene en el entorno de despliegue. Para acceder a algún servicio la URL consiste en <nowiki>http://localhost:<puerto></nowiki>. Ej: <nowiki>http://localhost:50000</nowiki> para acceder al portal wordpress.

=== Subsistemas desplegados ===
*Wordpress (Portal Jornadas)

=== Configuración de la máquina ===
'''Nota''': la máquina ha sido exportada como un servicio virtualizado de VirtualBox.
*'''Número de CPUs''': 2
*'''RAM Reservada''': 1536MB
*'''SO''': Debian 9 (Stretch)
*'''Usuario''': egc
*'''Contraseña''': egc
*'''Tiene Docker y Docker Compose instalados'''

== Opera ==

Puede acceder a nuestro proyecto en Opera [http://opera.eii.us.es/egc/public/trabajo/ver/id/74 aquí]

== Formatos y procedimientos ==

=== Formato para detallar tecnologías elegidas ===
'''Subsistema''': <Nombre del subsistema/equipo>
'''Lenguaje/Herramienta''': <Lenguaje/herramienta escogida y versión>
'''Sistema de gestión de bibliotecas''': <Herramienta que se usa para añadir bibliotecas/dependencias> (Ej: Java->Maven, Python->pip)
'''Bibliotecas''': <Listado de bibliotecas usadas en el desarrollo.>
'''Nombre_Biblioteca1''': <versión>
'''Necesita Base de datos''': <Sí/No> (En caso afirmativo explicar cuál se está empleando y su versión)

=== Formato para detallar API ===

''' URL base '''
Ruta completa incluido el dominio (Ej: https://censo.nvotesus.es/api/v1, https://censo.nvotesus.es/api)

Por cada ruta de la API:

''' URL relativa '''

Ruta relativa en base a la URL anterior (Ej: /getUser, /storeVote)

''' Descripción '''

Descripción de la tarea que realiza la ruta

''' Petición HTTP '''

Indicar el método HTTP usado (Ej: GET, POST, PUT, DELETE)

''' Parámetros de petición '''

Parametros que puede recibir indicando el nombre, tipo, descripción y valor por defecto (Si tiene valor por defecto significara que es opcional).

Por ejemplo:

{| border="1" style="border-collapse:collapse"
|-
! Nombre
! Tipo
! Descripción
! Valor por defecto
|-
| user
| integer
| Nombre del usuario
|
|}

''' Ejemplo de petición '''

Ejemplo de uso de la url (Ej: GET https://auth.nvotesus.es/api/v1/get?user=test)

''' Respuesta '''

Parametros que puede recibir indicando el nombre, tipo, descripción. Será obligatorio incluir los parametros result y msg

Por ejemplo:

{| border="1" style="border-collapse:collapse"
|-
! Nombre
! Tipo
! Descripción
|-
| result
| Boolean
| Resultado de la operación
|-
| msg
| String
| Mensaje de resultado o error
|}

''' Ejemplo de respuesta '''

Ejemplo de la respuesta a recibir.

{
"result" : true,
"msg" : "Successfull"
"username" : "tansalalv",
"name" : "Tania",
"surname" : "Salguero Álvarez",
"email" : "mail@example.com",
"genre" : "Femenino",
"autonomous_community" : "Andalucía",
"age" : "21",
"role" : "USUARIO"
}

''' Códigos de error '''

Códigos de error que puede devolver el método indicando el código HTTP, valor de result, valor del mensaje y una breve explicación de porque ha podido pasar.

Por ejemplo:

{| border="1" style="border-collapse:collapse"
|-
! Código
! Valor result
! Valor msg
! Posible motivo
|-
| 200
| true
| Successfull
|
|-
| 404
| false
| User not found
| El usuario indicado no existe.
|-
| 403
| false
| Don't have access
| No tienes permisos para acceder.
|}

=== Formato general para detallar incidencias ===
Las incidencias pueden emplearse no solo para fallos.
'''Título''': <breve título sobre la incidencia>
'''Prioridad''': a seleccionar entre distintos valores: ''urgente'', ''alto'', ''medio'', ''bajo''.
'''Estado''': ''pendiente'', ''en curso'', ''finalizado''. Los dos primeros estados deberían meterse como etiquetas en GitHub, el último estado se prouduce cuando se cierra la incidencia en GitHub.
'''Descripción''': <descripción detallada del error>
La descripción puede incluir imagenes o la salida emitida por el fallo.
'''Etiquetas''': <etiquetas de GitHub para clasificar las incidencias>
''enhancement'': propuesta de mejora
''bug'': fallos encontrados en el sistema
''help wanted'': incidencia que puede ser resuelta por un miembro del equipo pero que ha sido atendida previamente por otro
''question'': (a usar solo entre miembros del equipo) dudas sobre un commit en concreto, hay que referenciar el commit en cuestión

=== Procedimiento general para la gestión de incidencias ===
# Establecer a un miembro del equipo el rol de gestor de incidencias.
# Cuando se registre una incidencia, el gestor deberá evaluar la prioridad, asignar las etiquetas correspondientes (si faltasen) y un responsable de la incidencia.
# El responsable trabajará en la incidencia. Si un commit cierra una incidencia deberá incluir en el cuerpo del commit "Closes #<id de la incidencia>"

Las incidencias pueden incluirse en ''Proyectos'' de GitHub.

Estas diapositivas incluyen información complementaria:
https://github.com/InnosoftDaysPresidencia/Presidencia/raw/master/GitHub/Gu%C3%ADa%20de%20GitHub%20Classroom.pdf

=== Formato general de commits ===
El formato general de los commits parte de la siguiente [http://karma-runner.github.io/1.0/dev/git-commit-msg.html base].

Es importante diferenciar entre los tipos (types) y usar todos en la medida de lo posible. Los ámbitos o focos (scopes) pueden emplearse para hacer referencia a distintas funcionalidades (features).

A continuación se detalla un ejemplo:

'''Título del commit''': fix: redirección errónea tras emitir voto
'''Cuerpo del commit''': Después de que el usuario emitiese su voto este era redireccionado a una URL no existente. Ahora el usuario es redireccionado al panel principal.
'''Pie del commit''': Closes #<número de la incidencia en GitHub>

Ejemplo en texto:
fix: redirección errónea tras emitir voto

Después de que el usuario emitiese su voto este era redireccionado a una URL no existente. Ahora el usuario es redireccionado al panel principal.

Closes #19

=== Gestión de ramas ===
Cada equipo debe establecer una metodología de gestión de ramas. A continuación ponemos un ejemplo de gestión de ramas:
[[File:branch-flow.png|center|thumb|1000px|link=https://1984.lsi.us.es/wiki-egc/images/egc/d/dc/Branch-flow.png]]

Equipo de integración general - 17 18 - G2

2017-11-29T15:22:04Z

Jesrivjim: /* Formato para detallar API */

Equipo de integración general - 17 18 - G2

2017-11-29T15:21:41Z

Jesrivjim: /* Formatos y procedimientos */

Cabina de votaciones - 17 18 - G2

2017-11-21T12:36:08Z

Jesrivjim: /* Consideraciones */

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

Autenticación - 17 18 - G2

2017-11-21T12:35:58Z

Jesrivjim: /* Consideraciones */

== Objetivo del subsistema ==
Gestionar todos los usuarios registrados y permitir el inicio de sesión para acceder a los distintos subsistemas.

== Consideraciones ==
* Se deben gestionar roles o permisos para permitir el acceso a los distintos subsistemas. Por ejemplo, permisos solo para votar, para organizar votaciones, gestionar censos, ...
* Debe permitir que los otros subsistemas puedan conocer si un usuario está autenticado
* Repositorio del año pasado: https://github.com/AgoraUS-G1-1617/Autentication
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Autenticación_1617

Cabina de telegram - 17 18 - G2

2017-11-21T12:35:36Z

Jesrivjim: /* Consideraciones */

== Objetivo del subsistema ==
Permitir la votación para las distintas votaciones disponibles en el sistema a través de la aplicación de mensajería Telegram.

== Consideraciones ==
* Debe comprobar que el usuario 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/CabinaTelegram
* Wiki de la asignatura referente al submodulo (año pasado): https://1984.lsi.us.es/wiki-egc/index.php/Cabina_de_votación_Telegram

Cabina de telegram - 17 18 - G2

2017-11-21T12:34:39Z

Jesrivjim:

Cabina de votaciones - 17 18 - G2

2017-11-21T12:34:30Z

Jesrivjim:

Autenticación - 17 18 - G2

2017-11-21T12:34:22Z

Jesrivjim:

Cabina de telegram - 17 18 - G2

2017-11-21T12:26:40Z

Jesrivjim: Página creada con «== Objetivo del subsistema == Permitir la votación para las distintas votaciones disponibles en el sistema a través de la aplicación de mensajería Telegram. == Conside...»

Cabina de votaciones - 17 18 - G2

2017-11-21T12:16:58Z

Jesrivjim: Página creada con «== Objetivo del subsistema == Permitir la votación para las distintas votaciones disponibles en el sistema. == Consideraciones == * Debe comprobar que el usuario autentic...»

Autenticación - 17 18 - G2

2017-11-21T12:11:29Z

Jesrivjim: Página creada con «== Objetivo del subsistema == Gestionar todos los usuarios registrados y permitir el inicio de sesión para acceder a los distintos subsistemas. == Consideraciones == * Se...»

Equipo de integración general - 17 18 - G2

2017-11-21T12:09:32Z

Jesrivjim:

Equipo de integración general - 17 18 - G2

2017-11-20T21:25:45Z

Jesrivjim:

Equipo de integración general - 17 18 - G2

2017-11-20T21:22:53Z

Jesrivjim:

Equipo de integración general - 17 18 - G2

2017-11-20T21:19:18Z

Jesrivjim: Página creada con «== Miembros == <ul> <li>Gonzalo Delgado Chaves</li> <li>Jesús Rivas Jiménez</li> <li>Javier Sánchez Parra</li> <li>Mohammed Alaoui Mhammedi</li> <li>Roberto García Cal...»

== Miembros ==

<ul>
<li>Gonzalo Delgado Chaves</li>
<li>Jesús Rivas Jiménez</li>
<li>Javier Sánchez Parra</li>
<li>Mohammed Alaoui Mhammedi</li>
<li>Roberto García Calero</li>
</ul>

Espacios para el grupo 2 1718

2017-11-20T21:12:10Z

Jesrivjim: /* Lista de proyectos */

EN CONSTRUCCIÓN
== Lista de proyectos ==

* [[Equipo de integración general - 17_18 - G2]]
* [[Gestión del programa - 17_18 - G2]]
* [[Gestión del registro - 17_18 - G2]]
* [[Gestión de visualización del programa - 17_18 - G2]]
* [[Gestión de integración con redes sociales - 17_18 - G2]]
* [[Autenticación - 17_18 - G2]]
* [[Administración de votaciones - 17_18 - G2]]
* [[Administración de censos - 17_18 - G2]]
* [[Cabina de votaciones - 17_18 - G2]]
* [[Cabina de telegram - 17_18 - G2]]
* [[Almacenamiento de votos - 17_18 - G2]]
* [[Recuento de votos - 17_18 - G2]]
* [[Visualización de resultados - 17_18 - G2]]

Espacios para el grupo 2 1718

2017-11-20T21:10:14Z

Jesrivjim: /* Lista de proyectos */

EN CONSTRUCCIÓN
== Lista de proyectos ==

* [[Equipo de integración general - 17_18]]
* [[Gestión del programa - 17_18]]
* [[Gestión del registro - 17_18]]
* [[Gestión de visualización del programa - 17_18]]
* [[Gestión de integración con redes sociales - 17_18]]
* [[Autenticación - 17_18]]
* [[Administración de votaciones - 17_18]]
* [[Administración de censos - 17_18]]
* [[Cabina de votaciones - 17_18]]
* [[Cabina de telegram - 17_18]]
* [[Almacenamiento de votos - 17_18]]
* [[Recuento de votos - 17_18]]
* [[Visualización de resultados - 17_18]]