Aluraflix

Aluraflix é uma implementação de uma API REST desenvolvida durante o Alura Challenge Back-End da Alura.

Sobre

É uma API para uma Plataforma de compatilhamento de vídeos. A plataforma deve permitir ao usuário montar playlists com links para seus vídeos preferidos, separados por categorias.

Tecnologias

• Java
• Spring Boot
• Spring Data
• Spring Boot Developer Tools
• Spring Docs
• H2 Database
• PostgreSQL
• Docker e Docker Compose
• Junit Jupiter
• Hibernate
• Jakarta Validator

Começando

# clone o projeto
git clone https://github.com/adrianoavelino/aluraflix.git

# entre no diretório
cd aluraflix

Para inicializar a aplicação utilizando docker-compose:

# inicie a aplicação
docker-compose up -d

Para inicialalizar a aplicação no container, no ambiente de produção, utilizando docker, execute os seguintes passos, após clonar e entrar no diretório da aplicação:

# gera o jar da aplicação
./mvnw clean package -DskipTests

# gera a imagem docker da aplicação
docker build -t adrianoavelino/aluraflix:1 .

# inicia o container do banco de dados
docker-compose up -d db

# inicia a aplicação no docker
docker run -it -p 8080:8080 \
-e SPRING_PROFILES_ACTIVE='prod' \
-e DATASOURCE_URL='jdbc:postgresql://db:5432/aluraflix' \
-e DATASOURCE_USERNAME='adriano' \
-e DATASOURCE_PASSWORD='adriano' \
-e JWT_SECRET='123456' \
-e JWT_EXPIRATION='8640000' \
-e SERVER_PORT='8080' \
--network=aluraflix_default adrianoavelino/aluraflix:1

Para inicializar a aplicação, utilizando live reload, em sua IDE:

• configure as variáveis de ambiente:

Nome	Valor
SPRING_PROFILES_ACTIVE	prod
DATASOURCE_URL	jdbc:postgresql://localhost:5432/aluraflix
DATASOURCE_USERNAME	adriano
DATASOURCE_PASSWORD	adriano
DATASOURCE_DATABASE	aluraflix
JWT_SECRET	123456
JWT_EXPIRATION	8640000
SERVER_PORT	8080

• inicie o banco de dados:

# inicia o container do banco de dados
docker-compose up -d db

Agora bastar iniciar a aplicação utilizando a classe src/main/java/br/com/alura/aluraflix/AluraflixApplication.java.

Outras informações

Para acessar o banco de dados via linha de comando no docker execute:

# acessa o banco de dados na linha de comando
docker-compose exec db mysql -u adriano -p

Usuário e senha do banco de dados:

Usuário	Senha
adriano	adriano

Documentação

A documentação da API está disponível localmente ou na aplicação online no Heroku.

Testes

Testes automatizados

O testes autopmatizados podem ser executados em três ambientes: localmente, via docker ou docker-compose:

Testes no ambiente local

antes de executar os teste inicie o container do banco de dados com o comando docker-compose up -d db

Comando para executar os testes no terminal:

• Testes de Repository:

# VideoRepositoryTest
./mvnw test -Dspring.datasource.url=jdbc:h2:mem:testaluraflix \
-Dspring.datasource.username=sa \
-Dspring.datasource.password= \
-Djwt.secret=123456 \
-Djwt.expiration=8640000 \
-Dtest=br.com.alura.aluraflix.repository.VideoRepositoryTest -e

# CategoriaRepositoryTest
./mvnw test -Dspring.datasource.url=jdbc:h2:mem:testaluraflix \
-Dspring.datasource.username=sa \
-Dspring.datasource.password= \
-Djwt.secret=123456 \
-Djwt.expiration=8640000 \
-Dtest=br.com.alura.aluraflix.repository.CategoriaRepositoryTest -e

• VideoController:

# VideoControllerTest
./mvnw test -Dspring.datasource.url=jdbc:h2:mem:testaluraflix \
-Dspring.datasource.username=sa \
-Dspring.datasource.password= \
-Djwt.secret=123456 \
-Djwt.expiration=8640000 \
-Dtest=br.com.alura.aluraflix.controller.VideoControllerTest -e

# CategoriaControllerTest
./mvnw test -Dspring.datasource.url=jdbc:h2:mem:testaluraflix \
-Dspring.datasource.username=sa \
-Dspring.datasource.password= \
-Djwt.secret=123456 \
-Djwt.expiration=8640000 \
-Dtest=br.com.alura.aluraflix.controller.CategoriaControllerTest -e

Testes via docker

antes de executar os teste inicie o container do banco de dados com o comando docker-compose up -d db

# gera a imagem docker da aplicação
docker build -t adrianoavelino/aluraflix_test:latest . -f Dockerfile-test

# executa os testes
docker run -it -v /tmp/m2docker:/root/.m2 \
-v /tmp/m2docker:/root/.m2 \
-e SPRING_DATASOURCE_URL='jdbc:h2:mem:testaluraflix' \
-e SPRING_DATASOURCE_USERNAME='sa' \
-e SPRING_DATASOURCE_PASSWORD='' \
-e JWT_SECRET='123456' \
-e JWT_EXPIRATION='8640000' \
--network=aluraflix_default adrianoavelino/aluraflix_test:latest

Testes via docker-compose

docker-compose -f docker-compose-test.yml up --build

Testes manuais

Primeiramente vamos realizar a única requisição que não necessita de token, a requisição para os vídeos free:

• GET /v1/videos/free

curl --location --request GET 'http://localhost:8080/v1/videos/free'

Para as próximas requisições iremos precisar de um token válido que conseguimos através da seguinte requisição:

• POST /v1/auth:

curl --location --request POST 'http://localhost:8080/v1/auth' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "admin@email.com",
    "senha": "123456"
}'

Exemplo de resposta:

{
    "token": "<SEU_TOKEN>",
    "bearer": "Bearer"
}

<SEU_TOKEN> será um valor semelhante à eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJBUEkgQWx1cmFmbGl4Iiwic3ViIjoiMSIsImlhdCI6MTYzMDAyMTU4NiwiZXhwIjoxNjMwMDMwMjI2fQ.pE1i-QSn3YCrCw48hp6KJe_bBTWTSpqZ-wnRUHhn1J0

Com o token em mãos é possível realizar as seguintes requisições:

• GET /v1/videos:

curl --location --request GET 'http://localhost:8080/v1/videos/' \
--header 'Authorization: Bearer <SEU_TOKEN>'

• GET /v1/videos/{id}:

curl --location --request GET 'http://localhost:8080/v1/videos/1' \
--header 'Authorization: Bearer <SEU_TOKEN>'

• POST /v1/videos:

curl --location --request POST 'http://localhost:8080/v1/videos' \
--header 'Authorization: Bearer <SEU_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "titulo": "Algumas Dicas de CSS",
    "descricao": "Dicas de uso de SASS e especificadade CSS",
    "url": "https://youtu.be/bOdrGg5oc3E",
    "categoriaId": 1
}'

• PUT /v1/videos/{id}:

curl --location --request PUT 'http://localhost:8080/v1/videos/' \
--header 'Authorization: Bearer <SEU_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "titulo": "Algumas Dicas de CSS atualizado",
    "descricao": "Dicas de uso de SASS e especificadade CSS Atualizado",
    "url": "https://www.youtube.com/watch?v=atualizado",
    "categoriaId": 2

• DELETE /v1/videos/{id}:

curl --location --request DELETE 'http://localhost:8080/v1/videos/2' \
--header 'Authorization: Bearer <SEU_TOKEN>'

• GET /v1/categorias

curl --location --request GET 'http://localhost:8080/v1/categorias' \
--header 'Authorization: Bearer <SEU_TOKEN>'

• GET /v1/categorias/{id}

curl --location --request GET 'http://localhost:8080/v1/categorias/1' \
--header 'Authorization: Bearer <SEU_TOKEN>'

• POST /v1/categorias

curl --location --request POST 'http://localhost:8080/v1/categorias' \
--header 'Authorization: Bearer <SEU_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "titulo": "categoria 2",
    "cor": "#ffccff"
}'

• PUT /v1/categorias

curl --location --request PUT 'http://localhost:8080/v1/categorias' \
--header 'Authorization: Bearer <SEU_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1,
    "titulo": "LIVRE Atualizado",
    "cor": "#FFFFFFF atualizado"
}'

• DELETE /v1/categorias/{id}

curl --location --request DELETE 'http://localhost:8080/v1/categorias/2' \
--header 'Authorization: Bearer <SEU_TOKEN>'