Commit b2ea3121 by Luciano Barletta

Update README.md

1 parent c55501f7
Showing 1 changed file with 33 additions and 0 deletions
......@@ -51,3 +51,36 @@ En caso de que no exista el servicio o este no admita el tipo, se devolverá un
### myserver.com/cons
Por este link se consulta el estado de los mensajes que se quieren enviar, mandando el id bajo 'id' (POST). Se devuelve 'queued' o 'delivered'. Si fue enviado el mensaje se archiva y no puede ser consultado nuevamente.
## Contribuir
Para contribuir con el proyecto se debe popular el archivo `services.py`
La forma de hacer esto consta de lo siguiente:
- Para servicios existentes se pueden agregar tipos de datos, en cuyo caso deberán ser incluidos en la clase `Datatypes` con su respectivo chequeo de validez en `validate`
- Para agregar nuevos servicios se debe hacer una nueva clase que derive de `ServiceBase` e implementar las funciones de dicha clase abstracta. Luego agregar el servicio a `Services` con su validación y expandir `serviceFactory(serv)` para que pueda devolver una instancia de la nueva clase
En el método
python```
@abstractmethod
def send(self,data):
pass
```
data es un dictionario que contiene los datos del pedido guardados en la base de datos
- En 'id' está el id del pedido, que coincide con el nombre del archivo a mandar
- En 'dir' está el nombre del directorio bajo el cual se encuentra el archivo a enviar
- En 'dest' se encuentra el destinatario
- En 'type' se encuentra el formato de lo que queremos mandar
- En 'state' se encuentra el estado del mensaje, que siempre será 'queued' y es completamente irrelevante a la operación
La función retorna un booleano del resultado.
El método
python```
@abstractmethod
def validate(self,datatype):
pass
```
toma un string correspondiente al formato de los datos y retorna un booleano correspondiente a si el servicio soporta o no el tipo de dato. Es una buena práctica usar `Datatypes.validate()` para chequear que el formato existe.
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!