laerciosantana / bustrackerapi

BusTrackerAPI

Por favor:

*Criem um branch para cada novo conjunto de funcionalidades. Ex: "notifications", "routes", "bus" e etc.

*Ao comitar coloque o branch do commit em colchetes na frente do commit. Ex: "[bus] Adds bus class".

*Para configurar o projeto, crie o 'application/config/config.php'. Use o 'application/config/config.example.php' com exemplo.

*Para conectar com o banco de dados, crie o 'application/config/database.php'. Use o 'application/config/database.example.php' com exemplo.

*Para gerar a domumentação use o make_docs.sh. Obs: é necessario ter instalado o apidoc previamente.

Clientes

• Rastreador android

• Android

• Web

bustrackerapi's Issues

[authentication][feature] Implementar "esqueceu a senha?"

Deve ser implementada "esqueceu a senha?" para recuperar acesso a uma conta.
Deve ter o seguinte fluxo:
Usuário esqueceu a senha --> Ele requisita a função "esqueceu a senha?" --> É enviado um token para o email dele com uma validade de tempo t. Este é um token temporário que o usuario pode usar para entrar com uma nova senha.

sugestões:
[get] users/password --> envia email com token
[put] users/password --> atualiza senha

[bus&routes][feature] Disponibilizar opções de ordenação e tamanho

Nas rotas routes/* e routes/*/bus/* que retornam arrays devem ser disponibilizados parâmetros que possibilitam a ordenação e tamanho dos dados requisitados. Deve ser possível escolher o paramento de ordenação, entre ordem crescente ou ascendente, e onde ira começa e o tamanho(idem SQL LIMIT ) dos dados retornados.

Sugestões para o paramentros:
paramOrd=[paramentro] //paramentro a ser usado para ordenação
ord=[asc | cresc ] // ordena os dados em ordem ascendente ou crescente respectivamente
start=[k] // se inicia o retorno dos dados no elemento k, inclusive
length=[n] // retorna n elementos a partir do start

[notification][feature] Implementar sistema de notificações

Sistema de notificações alimentado pelo google firebase

Esse sistema será usado para enviar notificações aos aplicativos clientes.

Funcionamento

Cliente deve ter acesso a um token de autenticação do google firebase. Com esse token ele ira se registrar no firebase, e obter um id de usuário. Uma vez que ele tenta obtido o id e o token, ele necessita se registrar em quais situações ele deseja ser notificado na API.

Tipos de notificações:

• Nova posição: quando um onibus receber uma nova posição.
• Nova mensagem: quando uma rota, onibus ou administrador em enviar uma mensagem.
• Aproximação:
  • quando o onibus chegar a uma distancia x de um ponto definido pelo usuário.
  • quando o onibus chegar a uma distancia x do usuário.
• De tempo:
  • o cliente deve ser notificado quando o onibus estiver tempo t de um ponto definido.
  • o cliente deve ser notificado quando o onibus estiver tempo t do usuário.
• de erro:
  • onibus saiu da rota .
  • o rastreador do onibus foi desligado ou perdeu a conexão.