Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added integration with rick-and-morty API #4

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
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
65 changes: 65 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
<maven.checkstyle.plugin.configLocation>
https://raw.githubusercontent.com/mate-academy/style-guides/master/java/checkstyle.xml
</maven.checkstyle.plugin.configLocation>
<lombok.mapstruct.binding.version>0.2.0</lombok.mapstruct.binding.version>
<mapstruct.version>1.5.5.Final</mapstruct.version>
</properties>
<dependencies>
<dependency>
Expand All @@ -37,18 +39,80 @@
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>

<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.2.0</version>
</dependency>

<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct</artifactId>
<version>${mapstruct.version}</version>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>${mapstruct.version}</version>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</path>
<path>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-mapstruct-binding</artifactId>
<version>${lombok.mapstruct.binding.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
Expand All @@ -66,6 +130,7 @@
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
<linkXRef>false</linkXRef>
<sourceDirectories>src</sourceDirectories>
</configuration>
</plugin>
</plugins>
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/mate/academy/rickandmorty/config/WebAppConfig.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package mate.academy.rickandmorty.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class WebAppConfig {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
package mate.academy.rickandmorty.controller;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import java.util.List;
import lombok.RequiredArgsConstructor;
import mate.academy.rickandmorty.dto.internal.CharacterDto;
import mate.academy.rickandmorty.service.CharacterService;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@Tag(name = "Rick and Morty character management",
description = "endpoints for working with third-party Rick and Morty API"
)
@RequiredArgsConstructor
@RestController
@RequestMapping("/api/rick-and-morty/characters")
public class CharacterController {
private final CharacterService characterService;

@Operation(
summary = "Retrieve random character",
description = "Retrieve random character from database."
)
@GetMapping("/random")
public CharacterDto getRandom() {
return characterService.getRandomCharacter();
}

@Operation(
summary = "Search characters by name",
description = "Search all characters whose name contains the search string."
)
@GetMapping("/search")
public List<CharacterDto> searchByName(
@RequestParam String name, @PageableDefault(sort = "id", size = 5) Pageable pageable) {
return characterService.searchCharacters(name, pageable);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package mate.academy.rickandmorty.dto.external;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

@JsonIgnoreProperties(ignoreUnknown = true)
public record CharacterInfoDto(
@JsonProperty("id") Long externalId,
String name,
String status,
String gender) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package mate.academy.rickandmorty.dto.external;

import java.util.List;

public record CharacterResponseDto(

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a general recommendation on record formatting

if your record has 1-2 fields, you can:

public record SomeRecord(String field1, Integer field2) {

if your record has more than 2 fields:

public record SomeRecord(String field1, 
                         int field2,
                         Double field3,
                         boolean field4) {

or alrternative:

public record SomeRecord(
         String field1, 
         int field2,
         Double field3,
         boolean field4) {

MetaInfoDto info, List<CharacterInfoDto> results) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package mate.academy.rickandmorty.dto.external;

public record MetaInfoDto(
Integer count,
Integer pages,
String next,
String prev) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package mate.academy.rickandmorty.dto.internal;

public record CharacterDto(
Long id,
Long externalId,
String name,
String status,
String gender) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package mate.academy.rickandmorty.exception;

public class CharacterNotFoundException extends RuntimeException {
public CharacterNotFoundException(String message) {
super(message);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package mate.academy.rickandmorty.exception;

public class RetrieveDataException extends RuntimeException {
public RetrieveDataException(String message, Throwable cause) {
super(message, cause);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package mate.academy.rickandmorty.mapper;

import mate.academy.rickandmorty.dto.external.CharacterInfoDto;
import mate.academy.rickandmorty.dto.internal.CharacterDto;
import mate.academy.rickandmorty.model.Character;
import org.mapstruct.InjectionStrategy;
import org.mapstruct.Mapper;
import org.mapstruct.NullValueCheckStrategy;

@Mapper(
componentModel = "spring",
injectionStrategy = InjectionStrategy.CONSTRUCTOR,
nullValueCheckStrategy = NullValueCheckStrategy.ALWAYS
)
public interface CharacterMapper {
CharacterDto toDto(Character character);

Character toCharacter(CharacterInfoDto bookRequestDto);
}
30 changes: 30 additions & 0 deletions src/main/java/mate/academy/rickandmorty/model/Character.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package mate.academy.rickandmorty.model;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
import lombok.Data;

@Data
@Entity
@Table(name = "characters")
public class Character {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

@Column(nullable = false, unique = true)
private Long externalId;

@Column(nullable = false)
private String name;

@Column(nullable = false)
private String status;

@Column(nullable = false)
private String gender;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package mate.academy.rickandmorty.repository;

import java.util.List;
import mate.academy.rickandmorty.model.Character;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface CharacterRepository extends JpaRepository<Character, Long> {
List<Character> findAllByNameContainingIgnoreCase(String name, Pageable pageable);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package mate.academy.rickandmorty.service;

import java.util.List;
import mate.academy.rickandmorty.dto.internal.CharacterDto;
import org.springframework.data.domain.Pageable;

public interface CharacterService {
CharacterDto getRandomCharacter();

List<CharacterDto> searchCharacters(String name, Pageable pageable);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package mate.academy.rickandmorty.service;

import java.util.ArrayList;
import java.util.List;
import lombok.RequiredArgsConstructor;
import mate.academy.rickandmorty.dto.external.CharacterInfoDto;
import mate.academy.rickandmorty.dto.external.CharacterResponseDto;
import mate.academy.rickandmorty.exception.RetrieveDataException;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

@Component
@RequiredArgsConstructor
public class CharactersClient {
@Value("${rick-and-morty.api.url}")
private String apiUrl;
private final RestTemplate restTemplate;

public List<CharacterInfoDto> loadCharacters() {
try {
var characterResponseDto = restTemplate
.getForObject(apiUrl, CharacterResponseDto.class);
var characters = new ArrayList<>(characterResponseDto.results());
String nextPageUrl = characterResponseDto.info().next();
while (nextPageUrl != null) {
characterResponseDto = restTemplate
.getForObject(nextPageUrl, CharacterResponseDto.class);
characters.addAll(characterResponseDto.results());
nextPageUrl = characterResponseDto.info().next();
}
return characters;
} catch (Exception e) {
throw new RetrieveDataException("Retrieving characters failed", e);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package mate.academy.rickandmorty.service.impl;

import jakarta.annotation.PostConstruct;
import java.util.List;
import java.util.Optional;
import lombok.RequiredArgsConstructor;
import mate.academy.rickandmorty.dto.internal.CharacterDto;
import mate.academy.rickandmorty.exception.CharacterNotFoundException;
import mate.academy.rickandmorty.mapper.CharacterMapper;
import mate.academy.rickandmorty.model.Character;
import mate.academy.rickandmorty.repository.CharacterRepository;
import mate.academy.rickandmorty.service.CharacterService;
import mate.academy.rickandmorty.service.CharactersClient;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.stereotype.Service;

@RequiredArgsConstructor
@Service
public class CharacterServiceImpl implements CharacterService {
private static final int PAGE_SIZE = 1;
private static final int FIRST_INDEX = 0;
private final CharacterRepository characterRepository;
private final CharactersClient charactersClient;
private final CharacterMapper characterMapper;

@PostConstruct
public void initCharacters() {
List<Character> list = charactersClient.loadCharacters().stream()
.map(characterMapper::toCharacter)
.toList();
characterRepository.saveAll(list);
}

@Override
public CharacterDto getRandomCharacter() {
long numberOfCharacters = characterRepository.count();
int pageNumber = (int)(Math.random() * numberOfCharacters);
Page<Character> page = characterRepository.findAll(PageRequest.of(pageNumber, PAGE_SIZE));
return Optional.ofNullable(page.getContent().get(FIRST_INDEX))
.map(characterMapper::toDto)
.orElseThrow(() -> new CharacterNotFoundException(
"Can't generate random character")
);
}

@Override
public List<CharacterDto> searchCharacters(
String name, @PageableDefault(size = 5, sort = "id") Pageable pageable) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no need to use @PageableDefault here

return characterRepository.findAllByNameContainingIgnoreCase(name, pageable)
.stream()
.map(characterMapper::toDto)
.toList();
}
}
9 changes: 8 additions & 1 deletion src/main/resources/application.properties
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@

server.port=8081
spring.datasource.url=jdbc:mysql://localhost:3306/rick_and_morty?serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=611001
spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.show-sql=true
rick-and-morty.api.url=https://rickandmortyapi.com/api/character
Loading