refatoracao global, doucmentacao javadoc, e melhoria significativa da exibicao e tratamento de erros http - com mensagens de erro descritivas, com a causa exata do erro- e nao mais generico 400 por ex

Author: Shelson Ferrari

SECURITY.md

@@ -6,8 +6,8 @@ We only support the latest version of the project. Make sure to update to the la
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.5.1   | :white_check_mark: |
-| < 0.5.1 | :x:                |
+| 0.6.2   | :white_check_mark: |
+| < 0.6.2 | :x:                |
 
 ## Reporting a Vulnerability
 

src/main/java/com/shelson/ShelsonApplication.java

@@ -30,6 +30,17 @@
 /**
  * Main class for the application.
  * This class initializes the Spring Boot application.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * 
+ * @author Shelson Ferrari
+ * 
+ * @see org.springframework.boot.SpringApplication
+ * @see org.springframework.boot.autoconfigure.SpringBootApplication
+ * @see org.slf4j.Logger
+ * @see org.slf4j.LoggerFactory
+ * @see jakarta.annotation.PreDestroy
  */
 @SpringBootApplication
 public class ShelsonApplication {

src/main/java/com/shelson/application/controller/CurrencyConversionController.java

@@ -14,6 +14,7 @@
  * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
  * the Licenses for the specific language governing permissions and limitations under the Licenses.
  */
+
 package com.shelson.application.controller;
 
 import java.util.Enumeration;
@@ -51,6 +52,23 @@
  *     <li>Ensures that the amount to be converted is greater than zero.</li>
  *     <li>Checks for any unexpected parameters in the request and throws a BusinessException if found.</li>
  * </ul>
+ * 
+ * Example usage:
+ * <pre>
+ * {@code
+ * // URL: /api/v1/conversions/convert?source=USD&target=EUR&amount=100
+ * CurrencyConversionDTO conversion = currencyConversionController.convertCurrency("USD", "EUR", 100.0);
+ * System.out.println(conversion);
+ * }
+ * </pre>
+ * 
+ * @author Shelson Ferrari
+ * @version 0.6.3
+ * @since 2024-07-24
+ * 
+ * @see com.shelson.application.dto.CurrencyConversionDTO
+ * @see com.shelson.application.service.CurrencyConversionService
+ * @see org.apache.camel.ProducerTemplate
  */
 @RestController
 @RequestMapping("/api/v1/conversions")

src/main/java/com/shelson/application/controller/HomeController.java

@@ -14,6 +14,7 @@
  * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
  * the Licenses for the specific language governing permissions and limitations under the Licenses.
  */
+
 package com.shelson.application.controller;
 
 import org.slf4j.Logger;
@@ -26,6 +27,18 @@
  * Controller responsible for the application's home page.
  * This controller redirects root application requests to the Swagger UI interface,
  * allowing API exploration.
+ * 
+ * Example usage:
+ * <pre>
+ * {@code
+ * // URL: /
+ * // This will redirect to /swagger-ui.html
+ * }
+ * </pre>
+ * 
+ * @author Shelson Ferrari
+ * @version 0.6.3
+ * @since 2024-07-24
  */
 @Controller
 @Hidden // Ignores this controller in Swagger documentation

src/main/java/com/shelson/application/controller/SwaggerRedirectController.java

@@ -27,6 +27,10 @@
  * Controller responsible for redirecting to the Swagger UI interface.
  * This controller handles two different routes to redirect the user
  * to the Swagger UI.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * @author Shelson Ferrari
  */
 @Controller
 @Hidden

src/main/java/com/shelson/application/dto/CurrencyConversionDTO.java

@@ -10,9 +10,9 @@
  * Apache License, Version 2.0:
  * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software distributed under the Licenses é
- * distribuído em uma base "COMO ESTÁ", SEM GARANTIAS OU CONDIÇÕES DE QUALQUER TIPO, expressas ou implícitas. Veja
- * os Licenses para a linguagem específica que rege permissões e limitações sob os Licenses.
+ * Unless required by applicable law or agreed to in writing, software distributed under the Licenses is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
+ * the Licenses for the specific language governing permissions and limitations under the Licenses.
  */
 package com.shelson.application.dto;
 
@@ -32,6 +32,13 @@
 
 /**
  * DTO that represents details about the currency conversion.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * @see com.shelson.domain.model.Currency
+ * @see com.shelson.application.service.CurrencyConversionService
+ * @see org.apache.camel.ProducerTemplate
+ * @author Shelson Ferrari
  */
 @ApiModel(description = "Details about the currency conversion")
 public class CurrencyConversionDTO {

src/main/java/com/shelson/application/processors/ExchangeRateProcessor.java

@@ -32,6 +32,23 @@
  * Processor to handle exchange rates.
  * This processor reads the exchange rate data from the message body,
  * parses it, and sets the parsed rates back into the message body.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * @see org.apache.camel.Processor
+ * @see org.apache.camel.Exchange
+ * @see com.fasterxml.jackson.databind.ObjectMapper
+ * @see com.fasterxml.jackson.core.type.TypeReference
+ * @see org.slf4j.Logger
+ * @see org.slf4j.LoggerFactory
+ * @see com.shelson.application.service.CurrencyConversionService
+ * @see com.shelson.application.routes.CurrencyConversionRoute
+ * @see com.shelson.application.dto.CurrencyConversionDTO
+ * @see com.shelson.domain.model.Currency
+ * @see com.shelson.domain.repository.CurrencyConversionRepository
+ * @see com.shelson.infrastructure.exception.BusinessException
+ * @see com.shelson.infrastructure.exception.ResourceNotFoundException
+ * @author Shelson Ferrari
  */
 @Component
 public class ExchangeRateProcessor implements Processor {

src/main/java/com/shelson/application/routes/CurrencyConversionRoute.java

@@ -32,6 +32,17 @@
  * Camel route for handling currency conversion requests.
  * This route takes the source currency, target currency, and amount as headers,
  * processes the conversion using the {@link CurrencyConversionService}, and returns the conversion details.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * 
+ * @author Shelson Ferrari
+ * 
+ * @see com.shelson.application.dto.CurrencyConversionDTO
+ * @see com.shelson.application.service.CurrencyConversionService
+ * @see com.shelson.application.processors.ExchangeRateProcessor
+ * @see org.apache.camel.ProducerTemplate
+ * @see com.shelson.domain.model.Currency
  */
 @Component
 public class CurrencyConversionRoute extends RouteBuilder {

src/main/java/com/shelson/application/routes/package-info.java

@@ -8,8 +8,5 @@
  * which processes the conversion by extracting headers from the request, validating them,
  * and invoking the service to perform the conversion.
  * </p>
- *
- * @since 1.0
- * @version 1.0
  */
 package com.shelson.application.routes;

src/main/java/com/shelson/application/service/CurrencyConversionService.java

@@ -36,9 +36,20 @@
 import com.shelson.infrastructure.exception.ResourceNotFoundException;
 
 /**
- * Service class for handling currency conversion operations.
- * This class uses a Camel route to fetch the latest exchange rates and performs
- * conversions between different currencies.
+ * Camel route for handling currency conversion requests.
+ * This route takes the source currency, target currency, and amount as headers,
+ * processes the conversion using the {@link CurrencyConversionService}, and returns the conversion details.
+ * 
+ * @version 0.6.3
+ * @since 2024-07-24
+ * 
+ * @author Shelson Ferrari
+ * 
+ * @see com.shelson.application.dto.CurrencyConversionDTO
+ * @see com.shelson.application.service.CurrencyConversionService
+ * @see com.shelson.application.processors.ExchangeRateProcessor
+ * @see org.apache.camel.ProducerTemplate
+ * @see com.shelson.domain.model.Currency
  */
 @Service
 public class CurrencyConversionService {