Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 14 KB

README.md

File metadata and controls

256 lines (160 loc) · 14 KB

Participa

El objetivo de esta aplicación es ofrecer una interfaz única a los usuarios interesados donde inscribirse a una organización.

Entre las funcionalidades en las que consiste ahora mismo es con elecciones (integración con Agora Voting), Colaboraciones económicas (donaciones periódicas), Microcréditos (sistema de prestamos distribuidos), Notificaciones móviles (para dispositivos Android),

Pantallazo de Participa

Pantallazo de Participa

Pantallazo de Participa

Pantallazo de Participa

Funcionalidades

Elecciones

Permite servir de censo integrado con Agora Voting: Agora Voting es un software libre de votaciones que permite a cualquier organización realizar procesos electorales de forma segura, flexible, transparente y a un precio competitivo. Permite que las elecciones se realicen en función a la localización del inscrito. En el caso de Podemos, se hace para diferenciar las elecciones de los ámbitos Municipales, Provinciales, Autonómicas y Estatales. A través de esta herramienta se han realizado todas las votaciones vinculantes de Podemos desde hace más de medio año, más de 30 votaciones: documentos organizativos, eticos y políticos, elecciones de cargos internos (secretario general, consejos ciudadanos estatales, autonómicos y minicipales), las distintas fases e iniciativas del proyecto Impulsa, etc. También lo ha utilizado Barcelona En Comú para sus Primarias (candidatos para las elecciones municipales, consejeros y consejeras de distrito y priorización de las 40 medidas iniciales del gobierno).

Colaboraciones económicas

Permite que los usuarios inscritos puedan configurar donaciones de forma periódica (mensual, trimestral o anual) por el importe que quieran (desde 5 a 50 €). Permite que esta colaboración se produzca a través de transferencia bancaria o con tarjeta de crédito (conexión con Redsys). Es uno de las principales formas de ingresos de Podemos (más de € 300.000).

Microcréditos

Permite que usuarios (inscritos o no) den de alta préstamos a la organización de forma puntual. Ha servido para financiar la campaña electoral del año 2015 de Podemos en todas las Comunidades Autonómicas (más de € 1.500.000).

Iniciativas Ciudadanas

Sistema de llegada de propuestas filtradas por votaciones con +1 bottom-up tomando como modelo el sistema planteado en el documento Organizativo de Podemos. Sobre esto mismo se realizará el sistema de Recovatorios de Cargos. Toma iniciativas de una categoría ("Propuestas") en la Plaza Podemos (subreddit de Podemos). Todavía ninguna iniciativa a cumplido los requisitos mínimos de participación impuestos por Podemos.

Equipos de Participación

Permite a los inscritos darse de alta como interesado en formar parte de equipos localizados geográficamente para fomentar la participación presencial y la formación sobre la participación digital.

Verificación por SMS

Método de verificación utilizado por Podemos. Cuando un usuario se inscribe debe confirmar su correo electrónico y su teléfono móvil con un código que se le envía. Con esto se permite que haya mayor cantidad de Participación en pérdida de una mayor seguridad. Estos problemas se suplen con herramientas de Reportes de grupos de usuarios y de Anti Spam con blacklists.

Verificación presencial

Método de verificación utilizado por Barcelona En Comú. Una vez el usuario se inscribe digitalmente debe ir a verificarse presencialmente. Por otro lado un grupo de usuarios de confianza para la organización se encarga de verificar presencialmente los documentos con los requisitos mínimos que debe cumplir (ser mayor de 16 años y con domicilio en Barcelona).

Blog (Brújula)

Sistema de publicación de noticias que sirve de forma de argumentario y comunicación interna con sus inscritos.

Newsletter

Sincronización de usuarios entre sistemas (Participa y Sendy) para los distintos casos que puede haber de falta de sincronía entre las bases de datos, es decir, si un usuario se quiere dar de baja sólo de la newsletter o si quiere darse de baja completamente como usuario.

Formularios y páginas estáticas

Sistema de integración con formularios basados en Wordpress (con el plugin privativo Gravity Forms).

Notificaciones móviles

Se ha hecho una aplicación en Android que sirve para que se pueda enviar notificaciones a los dispositivos móviles. Se utiliza para avisar cuando hay una nueva votación en curso (módulo de Eleciones) así como para hacer avisos durante la campaña electoral. Se trata de una aplicación realizada con Phonegap, por lo que está planificado su desarrollo para IOS (iPhone e iPad).

OpenID

Se ha configurado para que la aplicación sea un proveedor de OpenID, por lo que permite que otras aplicaciones autentifiquen contra los usuarios del censo. Se ha utilizado para la aplicación de "La Expresión del Cambio" (concurso de carteles y canciones).

Instalación

Es una aplicación Ruby On Rails hecha con Rails 4.1 / Ruby 2.0. Se recomienda hacerla en sistemas operativos GNU/Linux (nosotros usamos Ubuntu). Para manejar las gemas recomendamos rvm o rbenv. Para la BBDD recomendamos postgres, pero se puede usar también mysql/sqlite3.

Una vez se tenga configurado el rvm o rbenv los pasos a seguir serían los siguientes:

bundle install
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
rake db:migrate
rails server

Aparte de esto para algunas acciones utilizamos resque, una cola para trabajos asincronos.

Tests

Se pueden comprobar los tests con

rake test

Todos deberían dar OK o SKIP (significa que se ipasa de alto, y que hay que programarlo). Una vez se libere el código se integrará con travis-sci.

APIs externas

  • Para las votaciones de los usuarios usamos Agora Voting, que han realizado una integración con la plataforma de Podemos. La configuración del secreto compartido se encuentra en una clave de secrets.yml. Documentación: Sobre la integración, al momento de escribir esto, Sobre la integración, versión más actualizada, Sobre la API REST general de AgoraVoting.

  • Para el envío de SMS usamos esendex. Puede comprobarse con el comando rake esendex:validate[username,password,account_reference]. La configuración de la autenticación se encuentra en unas claves de secrets.yml.

  • Para el control de excepciones en staging y production usamos una instancia privada de la Asociación aLabs de errbit, una aplicación libre basada en la API de airbrake. Puede comprobarse la conexión con el servidor con el comando rake airbrake:test. La configuración de la autenticación se encuentra en unas claves de secrets.yml.

  • Para la gestión de las colas de trabajo utilizamos resque, que usa como DDBB redis. Un comando útil para desarrollo es el de iniciar un worker: rake resque:work

  • En desarrollo, para comprobar el envio de correos, utilizamos mailcatcher, una gema que levanta un servidor SMTP en el puerto 1025 y una interfaz web para ver los correo s que se envían en en el puerto 1080. Para levantarlo ejecutar el comando mailcatcher

  • Para el envío de correo en producción usamos un SMTP. La configuración va en config/mailserver.yml.

  • Para descargar las últimas iniciativas ciudadanas en Plaza Podemos ejecutamos el comando: rake podemos:reddit

Dependencias

Para ejecutar la aplicación en su totalidad hay que tener los siguientes servicios en funcionamiento:

sudo apt-get install libicu52                       # para manejar cadenas Unicode correctamente
sudo apt-get install postgres                       # para la base de datos, o mysql-server si lo prefieres
sudo apt-get install imagemagick                    # para la generación del captcha
sudo apt-get install redis-server                   # para la gestión de las colas de trabajo (resque)
sudo apt-get install libpq-dev                      # para la gema pg
sudo apt-get install qt5-default libqt5webkit5-dev  # para capybara (tests)
sudo apt-get install wkhtmltopdf                    # para generación de PDFs (microcreditos)

Configuraciones

Se ha intentado que todas las configuraciones esten accessibles con los ficheros de configuración

config/databases.yml
config/secrets.yml

Ver ejemplos en config/databases.yml.example y config/secrets.yml.example.

i18n

Para modificar los distintos idiomas, revisar los ficheros de config/locales/ Para agregar uno nuevo se deben seguir los siguientes pasos:

  • Agregarlo en la línea de 'scope locale' en config/routes
  • Agregarlo en la UI de cambio de idiomas del footer en app/views/layouts/application.html.erb
  • Agregarlo en la configuración para idiomas válidos en config/application.rb

Newsletter

TODO: documentar integración con Sendy

Colaboraciones

Para la forma de pago "Suscripción con Tarjeta de Crédito/Débito" hemos hecho una integración con Redsys.

Para esto hace falta tener una cuenta bancaria dada de alta en Redsys, tener acceso a su (entorno de pruebas)[https://sis-t.redsys.es:25443/canales/] y configurar los parámetros necesarios en config/secrets.yml

Para realizar las pruebas en su entorno y que finalice correctamente es necesario poner la siguiente información de tarjeta:

  Tarjeta: 4548812049400004
  Fecha de caducidad: 12/20
  Código de Seguridad: 123
  CIP: 123456

Se pueden ver los documentos desde los que se han partido para su implementación en doc/redsys.

Configuración inicial

Aparte de instalar y configurar la aplicación, inicialmente hay que configurarla siguiendo los siguientes pasos:

  1. Comprobar que se hayan instalado todas las gemas y librerias del sistema, que se haya realizado la creación y migración de la base de datos, configuración de servicios externos y claves privadas en secrets.yml, etc. Todo lo que pone en README.md y en bin/bootstrap.sh

  2. La aplicación base consta de un censo de usuarios cuyo registro debe hacerse confirmando con envíos de correo y SMS. Si se quieren utilizar los otros módulos hay que poner habilitarlo en la sección de secrets.yml:

  features:
    collaborations: true
    microcredits: true
    elections: true
    proposals: true
    notifications: true
    participation_teams: true
  1. Para personalizara nivel de imagen para cada organización hace falta realizar lo siguiente:
  • Copiar vendor/overrides/skeleton a vendor/overrides/nombre_organizacion

  • Modificar en config/secrets.yml

  organization:
    name: "skeleton"
    folder: "skeleton"

por los de la organización, por ejemplo:

  organization:
    name: "Podemos"
    folder: "podemos"

o

  organization:
    name: "Barcelona en Comú"
    folder: "bec"
  • Dentro de esta estructura se puede personalizar los distintos directorios de Rails. Ver como se hace para otras organizaciones.
    • Cambios en mensajes y traducciones: config/locales
    • Cambios en vistas: si se quiere modificar alguna vista: app/views
    • Cambios en ficheros estáticos (CSS/JS/imagenes): app/assets

En general cualquier tipo de personalización específica para la organización intentará llevarse a vendor/overrides para mantener separado lo que es la parte genérica de la específica.

Esto es un trabajo en curso, por lo que todavía hay ficheros que no están del todo separados en este modelo de overrides, lo ideal es ir pasando todo esto al modelo de Rails.application.secrets.

  • Rails.application.secrets es bastante largo y no funciona con algunas gemas (por ejemplo capistrano). Se puede reemplazar por dotenv/figaro o algo por el estilo que lo haga más corto.
  • En db/schema.rb se comparten los campos en todas las organizaciones. Por ejemplo, Podemos no necesita el campo user.district. Lo mismo se aplica con los ficheros de db/migrations/
  • Hay que poder reemplazar/extender ciertas gemas en Gemfile/Gemfile.lock. Por ejemplo, amazon_ses / mailjet.
  • Hay que poder reemplazar el directorio public/
  • Hay que poder reemplazar las configuraciones especificas de capistrano en config/deploy/*.rb. No se puede hacer usando Rails.application.secrets ya que no levanta Rails, así que es un motivo para pasar a dotenv/figaro.
  • En algunos ficheros generales hay referencias a Podemos: por ejemplo el prefijo "podemos." de i18n en config/locales/app.es.yml, ficheros en lib/, app/workers.