https://github.com/sabrina-poderis/reddit-api-app
O desafio consiste em criar um programa que consulte a api do reddit uma vez por dia, salve as postagens hot do subredit artificial e criar dois endpoints para consulta desses dados
https://github.com/sabrina-poderis/reddit-api-app
laravel8x php73
Last synced: 5 months ago
JSON representation
O desafio consiste em criar um programa que consulte a api do reddit uma vez por dia, salve as postagens hot do subredit artificial e criar dois endpoints para consulta desses dados
- Host: GitHub
- URL: https://github.com/sabrina-poderis/reddit-api-app
- Owner: Sabrina-Poderis
- Created: 2022-03-27T16:06:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-27T22:43:31.000Z (over 4 years ago)
- Last Synced: 2025-03-13T02:34:02.230Z (over 1 year ago)
- Topics: laravel8x, php73
- Language: PHP
- Homepage:
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Desafio Backend
O desafio consiste em criar um programa que consulte a api do [reddit](https://www.reddit.com/dev/api/) uma vez por dia (deve ser uma tarefa agendada para rodar em um horário específico que você definir).
A sua tarefa diária deve salvar num banco de dados SQL as postagens que estejam HOT do subredit [artificial](https://api.reddit.com/r/artificial/hot). Você deve salvar título da postagem, nome do autor, timestamp da criação, número de "ups" e número de comentários, e criar dois endpoints para consulta desses dados (endpoints REST ou usando graphql).
O primeiro endpoint deve receber como parâmetro uma data inicial, uma data final e uma ordem (as ordens possíveis são número de "ups" e número de comentários) e deve retornar as postagens criadas dentro desse range seguindo a ordem estipulada (em ordem decrescente).
O segundo endpoint deve receber como parâmetro uma ordem (as ordens possíveis são número de "ups" e número de comentários) e deve retornar uma lista de autores
seguindo a ordem estipulada (em ordem decrescente)
Você pode utilizar qualquer linguagem para resolver o desafio, mas preferimos que seja em PHP (é a linguagem que mais utilizamos aqui). Além disso, não esqueça de incluir instruções sobre como executar o seu projeto.
O que vamos avaliar:
- Se atende ao que foi pedido;
- Arquitetura bem definida;
- Legibilidade e organização;
- Falhas de segurança;
- Tratamento de erros;
- Quantidade de bugs.
Pontos extras:
- Testes unitários;
- Uso de container;
- Documentação;
- Utilizar framework CakePHP
-----------------------------------
## Instruções para desenvolvimento
- Instalação do [Xampp/PHP](https://sourceforge.net/projects/xampp/files/XAMPP%20Windows/7.3.33/)
- Instalação do [Composer](https://getcomposer.org/download/) para utilização do laravel
### Banco de dados
- Inicializar o MySQL via xampp
- Criar um novo banco de dados chamado `reddit-api-app`
- Iniciar o terminal
- Entrar na pasta do projeto `cd reddit-api-app`
- Criar as tabelas necessárias `php artisan migrate`
### Inicilização do servidor via terminal (Windows)
- Iniciar o terminal
- Entrar na pasta do htdocs `cd C:\xampp\htdocs`
- Clonar o projeto `git clone https://github.com/Sabrina-Poderis/Reddit-API-App.git`
- Entrar na pasta do projeto `cd reddit-api-app`
- Instalar o composer `composer install`
- Criar o .env `cp .env.example .env`
- Gerar a chave do servidor artisan `php artisan key:generate`
- Inicializar o servidor `php artisan serve`
- Inicializar a fila que executará a consulta da API `php artisan schedule:work`
## Principais arquivos do projeto
- [Rotas e validação de parâmetros GET](routes/web.php)
- [Model das postagens que estejam HOT do subredit](app/Models/HotPost.php)
- [Repositório das postagens](app/Repositories/HotPostRepository.php)
- [Controller dos endpoins](app/Http/Controllers/HotPostController.php)
- [Definição do agendamento da tarefa de consulta a API](app/Console/Kernel.php)
- [Seeder que consulta a API e alimenta o banco](database/seeders/HotPostsTableSeeder.php)
## Endpoints
### Created posts
`http://127.0.0.1:8000/created-posts/{initial_date}/{final_date}/{order}`
> Retorna as postagens criadas dentro desse range seguindo a ordem estipulada (em ordem decrescente)
Parâmetros de entrada:
- initial_date: datetime string `yyyy-mm-dd`
- final_date: datetime string `yyyy-mm-dd`
- order: `num_comments` ou `ups`
Exemplo de saída:
```
[
{"id" :16,
"title" : "my meme generating AI just came up with this (not technically AI)",
"author" : "snoggel",
"ups" : 173,
"num_comments" : 8,
"post_created_at": "2022-03-25 06:53:29",
"created_at" : "2022-03-27T19:16:02.000000Z",
"updated_at" : "2022-03-27T19:16:02.000000Z"
},
{"id" :3,
"title" : "\ud83d\udc49 Impressed With AlphaFold? Checkout This Protein Structure Prediction Model (FastFold) That Reduces AlphaFold\u2019s Training Time From 11 Days To 67 Hours",
"author" : "No_Coffee_4638",
"ups" : 38,
"num_comments" : 2,
"post_created_at": "2022-03-27 04:29:04",
"created_at" : "2022-03-27T19:16:02.000000Z",
"updated_at" : "2022-03-27T19:16:02.000000Z"
},
]
```
cURL:
```
curl http://127.0.0.1:8000/created-posts/2022-03-01/2022-03-28/ups
curl http://127.0.0.1:8000/created-posts/2022-03-23/2022-03-25/num_comments
curl http://127.0.0.1:8000/created-posts/2022-03-23/2022-03-24/num_comments
curl http://127.0.0.1:8000/created-posts/2022-03-28/2022-03-28/ups
```
### Authors
`http://127.0.0.1:8000/authors/{order}`
> Retorna uma lista de autores seguindo a ordem estipulada (em ordem decrescente)
Parâmetros de entrada:
- order: `num_comments` ou `ups`
Exemplo de saída:
```
[
{"author":"snoggel"},
{"author":"CyberByte"},
{"author":"bigshinna"},
{"author":"No_Coffee_4638"}
]
```
cURL:
```
curl http://127.0.0.1:8000/authors/ups
curl http://127.0.0.1:8000/authors/num_comments
```