refactor: reorganize SheetClientFactory and DataValue classes, update tests, and remove unused files

Author: codeNilson

src/main/java/io/github/codenilson/gsapi_core/GsAPI.java

@@ -5,16 +5,38 @@
 import java.util.List;
 import java.util.Optional;
 
+import io.github.codenilson.gsapi_core.client.GoogleSheetsClient;
 import io.github.codenilson.gsapi_core.errors.GSAPIError;
+import io.github.codenilson.gsapi_core.models.DataValue;
 
+/**
+ * Main class for interacting with the Google Sheets API.
+ */
 public class GsAPI {
 
     private GoogleSheetsClient client;
 
+    /**
+     * Constructs a new GsAPI with the specified Google Sheets client.
+     *
+     * @param client The Google Sheets client used to interact with the API.
+     * @see GoogleSheetsClient
+     */
     public GsAPI(GoogleSheetsClient client) {
         this.client = client;
     }
 
+    /**
+     * Retrieves data from the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @return An Optional containing a list of {@link DataValue} objects
+     *         representing the data in the specified range,
+     *         or an empty Optional if no data is found.
+     * @throws GSAPIError If an error occurs while retrieving the data.
+     * @see SheetRequest
+     * @see DataValue
+     */
     public Optional<List<DataValue>> retrieveData(SheetRequest request) {
         try {
             List<List<Object>> values = client.fetchValues(request);
@@ -33,6 +55,15 @@ public Optional<List<DataValue>> retrieveData(SheetRequest request) {
         }
     }
 
+    /**
+     * Adds data to the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @param values  The list of {@link DataValue} objects to be added.
+     * @throws GSAPIError If an error occurs while appending the data.
+     * @see SheetRequest
+     * @see DataValue
+     */
     public void addData(SheetRequest request, List<DataValue> values) {
         try {
             List<List<Object>> data = new ArrayList<>();
@@ -46,17 +77,32 @@ public void addData(SheetRequest request, List<DataValue> values) {
         }
     }
 
+    /**
+     * Modifies data in the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @param value   The {@link DataValue} object containing the new data.
+     * @throws GSAPIError If an error occurs while updating the data.
+     * @see SheetRequest
+     * @see DataValue
+     */
     public void modifyData(SheetRequest request, DataValue value) {
         try {
             List<List<Object>> data = new ArrayList<>();
             data.add(value.getValues());
             client.overwriteValues(request, data);
         } catch (IOException e) {
-            throw new GSAPIError("An error occurred while updating the sheet data for range: " + request.getRange(),
-                    e);
+            throw new GSAPIError("An error occurred while updating the sheet data for range: " + request.getRange(), e);
         }
     }
 
+    /**
+     * Clears the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @throws GSAPIError If an error occurs while clearing the data.
+     * @see SheetRequest
+     */
     public void resetRange(SheetRequest request) {
         try {
             client.clearRange(request);
@@ -65,4 +111,4 @@ public void resetRange(SheetRequest request) {
         }
     }
 
-}
+}

src/main/java/io/github/codenilson/gsapi_core/SheetRequest.java

@@ -1,35 +1,70 @@
 package io.github.codenilson.gsapi_core;
 
+/**
+ * Represents a request to interact with a specific range in a Google Sheets
+ * spreadsheet.
+ */
 public class SheetRequest {
     private String spreadsheetId;
     private String range;
 
+    /**
+     * Constructs a new SheetRequest with the specified spreadsheet ID and range.
+     *
+     * @param spreadsheetId The ID of the Google Sheets spreadsheet.
+     * @param range         The range within the spreadsheet to interact with.
+     */
     public SheetRequest(String spreadsheetId, String range) {
         this.spreadsheetId = spreadsheetId;
         this.range = range;
     }
 
+    /**
+     * Gets the ID of the Google Sheets spreadsheet.
+     *
+     * @return The spreadsheet ID.
+     */
     public String getSpreadsheetId() {
         return spreadsheetId;
     }
 
+    /**
+     * Gets the range within the Google Sheets spreadsheet.
+     *
+     * @return The range.
+     */
     public String getRange() {
         return range;
     }
 
+    /**
+     * Sets the ID of the Google Sheets spreadsheet.
+     *
+     * @param spreadsheetId The spreadsheet ID to set.
+     */
     public void setSpreadsheetId(String spreadsheetId) {
         this.spreadsheetId = spreadsheetId;
     }
 
+    /**
+     * Sets the range within the Google Sheets spreadsheet.
+     *
+     * @param range The range to set.
+     */
     public void setRange(String range) {
         this.range = range;
     }
 
+    /**
+     * Returns a string representation of the SheetRequest.
+     *
+     * @return A string containing the spreadsheet ID and range.
+     */
     @Override
     public String toString() {
         return "SheetRequest{" +
                 "spreadsheetId='" + spreadsheetId + '\'' +
                 ", range='" + range + '\'' +
                 '}';
     }
-}
+}

src/main/java/io/github/codenilson/gsapi_core/GoogleSheetsClient.java renamed to src/main/java/io/github/codenilson/gsapi_core/client/GoogleSheetsClient.java

@@ -1,4 +1,4 @@
-package io.github.codenilson.gsapi_core;
+package io.github.codenilson.gsapi_core.client;
 
 import java.io.IOException;
 import java.util.List;
@@ -7,21 +7,47 @@
 import com.google.api.services.sheets.v4.model.ClearValuesRequest;
 import com.google.api.services.sheets.v4.model.ValueRange;
 
+import io.github.codenilson.gsapi_core.SheetRequest;
+
+/**
+ * Client class for interacting with the Google Sheets API.
+ */
 public class GoogleSheetsClient {
 
     private Sheets service;
 
+    /**
+     * Constructs a new GoogleSheetsClient with the specified Sheets service.
+     *
+     * @param service The Sheets service used to interact with the Google Sheets
+     *                API.
+     */
     public GoogleSheetsClient(Sheets service) {
         this.service = service;
     }
 
+    /**
+     * Fetches values from the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @return A list of lists of objects representing the values in the specified
+     *         range.
+     * @throws IOException If an I/O error occurs while fetching the values.
+     */
     public List<List<Object>> fetchValues(SheetRequest request) throws IOException {
         return service.spreadsheets().values()
                 .get(request.getSpreadsheetId(), request.getRange())
                 .execute()
                 .getValues();
     }
 
+    /**
+     * Appends values to the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @param values  The values to be appended.
+     * @throws IOException If an I/O error occurs while appending the values.
+     */
     public void appendValues(SheetRequest request, List<List<Object>> values) throws IOException {
         ValueRange valueRange = new ValueRange().setValues(values);
         service.spreadsheets().values()
@@ -31,6 +57,13 @@ public void appendValues(SheetRequest request, List<List<Object>> values) throws
                 .execute();
     }
 
+    /**
+     * Overwrites values in the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @param values  The values to overwrite the existing values.
+     * @throws IOException If an I/O error occurs while overwriting the values.
+     */
     public void overwriteValues(SheetRequest request, List<List<Object>> values) throws IOException {
         ValueRange valueRange = new ValueRange().setValues(values);
         service.spreadsheets().values()
@@ -39,9 +72,15 @@ public void overwriteValues(SheetRequest request, List<List<Object>> values) thr
                 .execute();
     }
 
+    /**
+     * Clears the specified range in the Google Sheets.
+     *
+     * @param request The request containing the spreadsheet ID and range.
+     * @throws IOException If an I/O error occurs while clearing the range.
+     */
     public void clearRange(SheetRequest request) throws IOException {
         service.spreadsheets().values()
                 .clear(request.getSpreadsheetId(), request.getRange(), new ClearValuesRequest())
                 .execute();
     }
-}
+}

src/main/java/io/github/codenilson/gsapi_core/SheetClientFactory.java renamed to src/main/java/io/github/codenilson/gsapi_core/client/SheetClientFactory.java

@@ -1,4 +1,4 @@
-package io.github.codenilson.gsapi_core;
+package io.github.codenilson.gsapi_core.client;
 
 import java.io.IOException;
 import java.security.GeneralSecurityException;
@@ -35,4 +35,4 @@ public static Sheets getSheetsService(HttpRequestInitializer initializer, String
                 .setApplicationName(applicationName)
                 .build();
     }
-}
+}

src/main/java/io/github/codenilson/gsapi_core/DataValue.java renamed to src/main/java/io/github/codenilson/gsapi_core/models/DataValue.java

@@ -1,4 +1,4 @@
-package io.github.codenilson.gsapi_core;
+package io.github.codenilson.gsapi_core.models;
 
 import java.util.ArrayList;
 import java.util.List;

src/main/java/io/github/codenilson/gsapi_core/Authenticator.java renamed to src/main/java/io/github/codenilson/gsapi_core/utils/Authenticator.java

@@ -1,4 +1,4 @@
-package io.github.codenilson.gsapi_core;
+package io.github.codenilson.gsapi_core.utils;
 
 import java.io.IOException;
 import java.io.InputStream;

src/test/java/io/github/codenilson/gsapi_core/AuthenticatorTest.java

@@ -18,6 +18,7 @@
 import com.google.auth.oauth2.GoogleCredentials;
 
 import io.github.codenilson.gsapi_core.errors.GSAPIError;
+import io.github.codenilson.gsapi_core.utils.Authenticator;
 
 class AuthenticatorTest {
 

src/test/java/io/github/codenilson/gsapi_core/DataValueTest.java

@@ -7,6 +7,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import io.github.codenilson.gsapi_core.models.DataValue;
+
 public class DataValueTest {
 
     private DataValue dataValue;