te-emprego/api

API Oficial do Te Emprego

O Te Emprego é um projeto criado por @danielbonifacio que consiste em uma plataforma 100% gratuita e funcional para a procura e divulgação de qualquer tipo de emprego/serviço.

Knowledge necessário para contribuir

• ES6
• React
• Styled Components

Não pretende dar suporte a Internet Explorer, independente da versão.

Design

Abaixo algumas especificações de design.

Download do pacote de identidade visual em pdf ou ai

Cores

• Primaria: #673AB7 (available at: config.colors.primary)
• Texto escuro: #646464 (available at: config.colors.darkText)
• Texto claro: #707070 (available at: config.colors.lightText)
• Branco: #707070 (available at: config.colors.white)

Espaçamentos

Espaçamentos por escala:

1. 20px (default)
2. 40px
3. 60px

Raio de borda

1. 10px (default)
2. 5px

---

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

api's Issues

CORS

Habilitar Cross Domain Requests

Swagger será implementado?

Tenho dúvidas de alguns endpoints necessários caso eu fosse contribuir.

Confirmação de Email

Atualmente qualquer email é considerado válido e não existe uma forma de validar se aquele usuário realmente é dono do email providenciado.

Sugestão:
Adicionar um campo email_confirmed: Boolean no usuário.

Já existe um template de email de boas vindas. Aproveitável para o caso.

Talvez seguir alguns padrões aplicáveis pensando neste link: How to make email confirmation a little easier for your users.

Limitar requisições abusivas

Atualmente é possível sobrecarregar a API com muitas requisições.

É preciso limitar as requisições para previnir abusos e possíveis ataque de força bruta provenientes de API.

Alguns pacotes que podem ajudar:

• express-slow-down
• express-rate-limit

Lembrando que haverá uma ponte do Cloudflare com a API, então soluções da Cloudflare podem ser aplicadas, também.

Renovação de token

O token é a garantia de autenticidade, e precisa ter o máximo de segurança possível.

Mudanças necessárias:

• Tempo de validade: 20 minutos
• Conteudo: { user: { permissions }, expiration }

Sugestão:
O usuário não precisa saber que seu Token vence e precisa ser renovado de 20 em 20 minutos. Isso vai ser feito automaticamente pelo cliente através de uma rota de renovação.

A rota de renovação deve garantir que o token a ser renovado é apto à renovação.

Características de um token apto à renovação:

• Ainda não expirou; ou
• Expirou há menos de 24 horas.

Durante a renovação será necessário buscar as (possíveis) novas permissões daquele usuário no banco de dados.

Regras de contribuição e código de conduta

• Adicionar um link público para o código de conduta;
• Adicionar regras de contribuição para o projeto.

Possibilitar redes sociais e site no perfil do usuário

Habilitar a possibilidade de usuários colocarem as redes sociais mais comuns no perfil.

Serve para qualquer tipo de perfil.

contact: {
  website: String,
  socials: {
    facebook: String,
    twitter: String,
    linkedin: String,
    github: String,
    youtube: String,
  }
}

Users module

Finalizar o módulo de usuário.

• Atualizar dados do usuário
• Listagem de usuários
• Criar usuário
• Atualizar dados do usuário
• Desativar o usuário
• Listagem de um usuário especifico

Listagem de usuários

• rota: {module}/
• método: get
• retorno: User[]

Listagem de um usuário especifico

• rota: {module}/:userId
• método: get
• retorno: User

Criar usuário

• rota: {module}/
• método: post
• retorno: User

Atualizar dados do usuário

Deve aceitar props parciais. Ou seja: apenas atualizar props enviadas.

• rota: {module}/:userId
• método: put
• retorno: User

Desativar o usuário

Não vamos permitir que usuários sejam deletados. Apenas uma chave vai dizer se ele está ativo ou não.

• rota: {module}/:userId
• método: put
• retorno: User

DeprecationWarning: Mongoose

Quando utilizo os métodos findOneAndUpdate ou findOneAndDelete o mongoose dispara esse aviso de deprecation:

DeprecationWarning: Mongoose: `findOneAndUpdate()` and `findOneAndDelete()` without the `useFindAndModify` option set to false are deprecated.

Padronizar métodos dos módulos

Atualizar informações do usuário

Atualmente o método @controller/user.updateProps atualiza informações aninhadas, mas não mantém os filhos que não foram atualizados.

Sugestão:
Arrumar uma forma de mesclar o objeto atual com o novo, e salvar este resultado.

Talvez utilizando o lodash _.merge() consiga resolver isso.

Lembrando que o request.me não é confiável para atualizar propriedades, pois o token pode estar desatualizado. Será necessário fazer uma nova consulta pelo me._id.

Source atual citado

Build script

Atualmente a API só possui um ambiente de desenvolvimento.
Precisamos de um script para empacotar o typescript e gerar o bundle.

Atualmente, o que transpila o typescript é o sucrase.
Mas não é a melhor opção para o build.

Reestruturar imports e exports de interfaces

As interfaces estão avulsas, bagunçadas no projeto.

Refatorar as exportações e importações, por meio do alias @interfaces

Data validation

Implementar validação de dados por meio de um DTO básico.

Sugestão: usar o pacote class-validator, que da suporte para decorators.

Limitador especial para login

A rota de login precisa receber um middleware de rate limit especial, com valores menores, para minimizar ataques de forca bruta.

As configuracoes podem ser setadas diretamente na exportacao do middleware, visto que o valor eh constante.

A cada 2 minutos, apenas 10 requisicoes na rota deverao ser permitidas.

Remover sucrase

O Sucrase é muito rápido, mas seu build é bem fraco e, por não dar suporte aos decorators do typescript, não podemos mais usar no projeto, visto que um dos pacotes class-validator utiliza decorators.