Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port
116 changes: 116 additions & 0 deletions Instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Challenge - Developer Backend - Ivanilson Santos

Aqui contêm as instruções para os acessos aos endponts dessa API.

## Tecnologias Usadas

- Nodejs.
- MongoDB, utilizando o seu serviço na nuvem, o Atlas.
- Framework ExpressJS para o tratamento das rotas.
- Bibliotca Mongoose para a estruturação de objeto do MongoDB.

##

### Rotas

#### Cadastro do Usuário

- POST: /user/register/

_Body_

```javascript
{
"name": "gabriel",
"email": "gabriel@gabriel.com",
"password": "1213141516"
}
```

#### Login do Usuário

- POST: /user/login/

_Body_

```javascript
{
"name": "gabriel",
"email": "gabriel@gabriel.com",
"password": "1213141516"
}
```

#### Cadastro do Summoner

- POST: /summoner/register/

_Body_

```javascript
{
"summonerName":"Old Wolf King"
}
```

#### Buscar todos os Summoners

- GET: /summoner/

#### Buscar todos os Summoners detalhadamente

- GET: /summoner/detailed/:nickname/:summonerLevelMin/:summonerLevelMax/:winsMin/:winsMax/:lossesMin/:lossesMax/

- OBS: É feito um filtro por vez, ou seja, só pode ser filtrado ou por nome ou por level, assim por diante, nunca dois ao mesmo tempo. Para os filtros numéricos, deve ser colocado tanto o mínimo quanto o máximo, e o resto dos campos deve ser colocado um '@'. Se for colocado o '@' em todo os parâmetros, o response será com todos os usuários. O Campo nome pode ser buscado com partes da string. Um exemplo de como deve ficar o endpoit: /summoner/detailed/@/@/@/10/50/@/@/

#### Deletar Summoner

- DELETE: /summoner/

- OBS: Só poderá ser deletado com o token que foi gerado pelo usuário que criou o summoner.

_Body_

```javascript
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
```


#### Atualizar Summoner

- PUT: /summoner/

OBS: Só poderá ser atualizado com o token que foi gerado pelo usuário que criou o summoner.

_Body_

```javascript
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
```

#### Gerar XLSX de todos os Summoners

- POST: /summoner/xlsx/


##### OBS

- Para iniciar o projeto, antes de tudo, deve se executar o comando "npm install" na raiz do projeto para instalar todas as dependências necessárias, após isso, deve ser executado o comando "node server.js". Com o servidor sendo executando, api pode ser acessada com o localhost:3000.
- O bearer token expira depois de 10 horas que o usuário realizou o Login, podendo esse tempo ser alterado no userControler.js.
- O usuário "Praymer" não consta na base de dados do League of Legends.
- É necessário criar um banco de dados no MongoDB Atlas, passando as suas credencias nas váriaveis de ambiente
- As várias de ambiente necessárias para acessar o projeto são:

- LOL_KEY (chave da API do LoL)
- DB_PASSWORD
- DB_USER
- DB_CLUSTER (caso tenham dúvidas, é possível gerar a string de conexão no próprio MongoDB Atlas, assim, dentro da string, o cluster fica entre a senha e o nome o banco de dados)
- JWT_KEY (chave para aumentar a criptografia do Json Web Token)

- É necessário atualizar a chave da API do League of Legends, pois ela expira em 24 horas.


Loading