Recode library code structure, organization and more

.editorconfig

@@ -4,9 +4,9 @@ root = true
 charset = utf-8
 indent_size = 2
 indent_style = space
-max_line_length = 200
+max_line_length = 121
 
-ij_continuation_indent_size = 4
+ij_continuation_indent_size = 2
 ij_java_class_count_to_use_import_on_demand = 999999
 ij_java_insert_inner_class_imports = false
 ij_java_names_count_to_use_import_on_demand = 999999

.gitignore

@@ -1,8 +1,14 @@
 # Ignore Gradle project-specific cache directory
 .gradle
 
+# Ignore git attributes.
+.gitattributes
+
 # Ignore Gradle build output directory
 build
 
 # Ignore IDE project settings directory.
 .idea
+
+# Ignore assets-download test directory.
+api/downloads

api/build.gradle.kts

@@ -0,0 +1,4 @@
+dependencies {
+  api(libs.annotations)
+  api(libs.gson)
+}

api/src/main/java/io/github/aivruu/repoviewer/api/RequestConstants.java

@@ -0,0 +1,33 @@
+//
+// Copyright (C) 2024 Aivruu - repo-viewer
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+//
+package io.github.aivruu.repoviewer.api;
+
+/**
+ * This class is used to store constants used for https-requests to GitHub's API.
+ *
+ * @since 2.3.4
+ */
+public class RequestConstants {
+  /** The normal url used for common-users to access to GitHub. */
+  public static final String GITHUB_NORMAL_URL = "https://github.com/%s/%s";
+  /** The url used for https-requests to GitHub's API. */
+  public static final String GITHUB_API_URL = "https://api.github.com/repos/%s/%s";
+
+  private RequestConstants() {
+    throw new UnsupportedOperationException("This class is for utility and cannot be instantiated.");
+  }
+}

api/src/main/java/io/github/aivruu/repoviewer/api/codec/CodecProvider.java

@@ -0,0 +1,39 @@
+//
+// Copyright (C) 2024 Aivruu - repo-viewer
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+//
+package io.github.aivruu.repoviewer.api.codec;
+
+import io.github.aivruu.repoviewer.api.http.request.RequestableModel;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * This class is used for the deserialization handling of {@link RequestableModel}s.
+ *
+ * @since 2.3.4
+ */
+public interface CodecProvider {
+  /**
+   * Deserializes the {@code json} given into a specified-type {@link RequestableModel}.
+   *
+   * @param modelType the model-type to create since the given json.
+   * @param json the json to deserialize into a new model.
+   * @param <Model> the model-type specified that must be a {@link RequestableModel} implementation.
+   * @return The deserialized model, or {@code null} if something went wrong, or there's nothing
+   *     to deserialize.
+   * @since 2.3.4
+   */
+  <Model extends RequestableModel> @Nullable Model from(final Class<Model> modelType, final String json);
+}

src/main/java/me/qeklydev/downloader/codec/package-info.java → api/src/main/java/io/github/aivruu/repoviewer/api/codec/package-info.java

@@ -4,4 +4,4 @@
  *
  * @since 0.0.1
  */
-package me.qeklydev.downloader.codec;
+package io.github.aivruu.repoviewer.api.codec;

api/src/main/java/io/github/aivruu/repoviewer/api/download/DownloaderUtils.java

@@ -0,0 +1,96 @@
+//
+// Copyright (C) 2024 Aivruu - repo-viewer
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+//
+package io.github.aivruu.repoviewer.api.download;
+
+import io.github.aivruu.repoviewer.api.download.status.DownloadStatusProvider;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.net.URI;
+import java.nio.channels.Channels;
+
+/**
+ * This class is used to perform download-operations from given URLs.
+ *
+ * @since 2.3.4
+ */
+public final class DownloaderUtils {
+  private DownloaderUtils() {
+    throw new UnsupportedOperationException("This class is used for utility and cannot be instantiated.");
+  }
+
+  /**
+   * Uses the URL object provided to download the content of that URL and be written into
+   * a specified file.
+   *
+   * @param fileName the name of the file to be written.
+   * @param from the url for the download.
+   * @return A {@link DownloadStatusProvider} with the {@code status-code} and the read {@code bytes-amount}
+   *     for the operation.
+   * @see #fromUrlToFile(File, String)
+   * @since 2.3.4
+   */
+  public static DownloadStatusProvider fromUrlToFileWithDirectory(final File directory, final String fileName,
+                                                                  final String from) {
+    return fromUrlToFile(new File(directory, fileName), from);
+  }
+
+  /**
+   * Downloads the content of the given url to write it into the given {@link File}.
+   *
+   * @param file the file where download's content will be written.
+   * @param from the url from where the content is going to be downloaded.
+   * @return A {@link DownloadStatusProvider} with the {@code status-code} and the read {@code bytes-amount}
+   *     for the operation ending.
+   *     <p>
+   *     - {@link DownloadStatusProvider#assetDownloadFinished(long)} if the download was successful, will
+   *     return it with the read-bytes amount.
+   *     <p>
+   *     - {@link DownloadStatusProvider#unknownAssetToDownload()} if any asset was downloaded, nothing to
+   *     download.
+   *     <p>
+   *     - {@link DownloadStatusProvider#assetDownloadError()} if an error occurred during the downloading
+   *     process.
+   * @see DownloadStatusProvider#ASSET_DOWNLOAD_FINISHED
+   * @see DownloadStatusProvider#UNKNOWN_ASSET_TO_DOWNLOAD
+   * @see DownloadStatusProvider#UNEXISTING_ASSET_DEFAULT_SIZE
+   * @see DownloadStatusProvider#ASSET_DOWNLOAD_ERROR
+   * @see DownloadStatusProvider#INVALID_ASSET_DEFAULT_SIZE
+   * @since 2.3.4
+   */
+  public static DownloadStatusProvider fromUrlToFile(final File file, final String from) {
+    // Using the provided URL we create a new URI object with this
+    // same url, this method will throw an exception if given url
+    // syntax is not valid, and will provide a message for error
+    // description.
+    final var uriFromGiven = URI.create(from);
+    // We convert the URI instance into a URL object, and then we open
+    // the stream for channel data reading and write bytes to this channel
+    // at the given position.
+    try (final var readableByteChannel = Channels.newChannel(uriFromGiven.toURL().openStream());
+         final var fileOutputStream = new FileOutputStream(file)) {
+      final var transferBytesReat = fileOutputStream.getChannel().transferFrom(readableByteChannel,
+        /* The initial position for bytes transfer. */ 0, Long.MAX_VALUE);
+      return (transferBytesReat == 0)
+        ? DownloadStatusProvider.unknownAssetToDownload()
+        : DownloadStatusProvider.assetDownloadFinished(transferBytesReat);
+    } catch (final IOException exception) {
+      return DownloadStatusProvider.assetDownloadError();
+    }
+  }
+}

api/src/main/java/io/github/aivruu/repoviewer/api/download/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * Provides utilities and status-code providers for I/O operations.
+ *
+ * @since 0.0.1
+ */
+package io.github.aivruu.repoviewer.api.download;

api/src/main/java/io/github/aivruu/repoviewer/api/download/status/DownloadStatusProvider.java

@@ -0,0 +1,102 @@
+//
+// Copyright (C) 2024 Aivruu - repo-viewer
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+//
+package io.github.aivruu.repoviewer.api.download.status;
+
+/**
+ * This record is used as provider for status-code w/ results creation used for
+ * assets-download operations at {@link io.github.aivruu.repoviewer.api.download.DownloaderUtils}.
+ *
+ * @param status the status-code for the instance.
+ * @param result the read-bytes number to return as result for this instance.
+ * @since 2.3.4
+ */
+public record DownloadStatusProvider(byte status, long result) {
+  /** The asset was downloaded correctly. */
+  public static final byte ASSET_DOWNLOAD_FINISHED = 0;
+  /** The asset wasn't downloaded because of non-existing. */
+  public static final byte UNKNOWN_ASSET_TO_DOWNLOAD = 1;
+  /** The asset wasn't downloaded due to an error. */
+  public static final byte ASSET_DOWNLOAD_ERROR = 2;
+  /** Cached default-size to return for non-existing assets. */
+  public static final long UNEXISTING_ASSET_DEFAULT_SIZE = 0;
+  /** Cached default-size to return for non-downloaded assets. */
+  public static final long INVALID_ASSET_DEFAULT_SIZE = -1;
+
+  /**
+   * Creates a new {@link DownloadStatusProvider} with the {@link #ASSET_DOWNLOAD_FINISHED}
+   * status-code.
+   *
+   * @param result the read-bytes amount for the downloaded asset.
+   * @return The {@link DownloadStatusProvider} with the {@link #ASSET_DOWNLOAD_FINISHED} status-code.
+   * @since 2.3.4
+   */
+  public static DownloadStatusProvider assetDownloadFinished(final long result) {
+    return new DownloadStatusProvider(ASSET_DOWNLOAD_FINISHED, result);
+  }
+
+  /**
+   * Creates a new {@link DownloadStatusProvider} with the {@link #UNKNOWN_ASSET_TO_DOWNLOAD}
+   * status-code, and using the default {@link #UNEXISTING_ASSET_DEFAULT_SIZE}.
+   *
+   * @return The {@link DownloadStatusProvider} with the {@link #UNEXISTING_ASSET_DEFAULT_SIZE} status-code.
+   * @since 2.3.4
+   */
+  public static DownloadStatusProvider unknownAssetToDownload() {
+    return new DownloadStatusProvider(UNKNOWN_ASSET_TO_DOWNLOAD, UNEXISTING_ASSET_DEFAULT_SIZE);
+  }
+
+  /**
+   * Creates a new {@link DownloadStatusProvider} with the {@link #ASSET_DOWNLOAD_ERROR}
+   * status-code, and using the default {@link #INVALID_ASSET_DEFAULT_SIZE}.
+   *
+   * @return The {@link DownloadStatusProvider} with the {@link #ASSET_DOWNLOAD_ERROR} status-code.
+   * @since 2.3.4
+   */
+  public static DownloadStatusProvider assetDownloadError() {
+    return new DownloadStatusProvider(ASSET_DOWNLOAD_ERROR, INVALID_ASSET_DEFAULT_SIZE);
+  }
+
+  /**
+   * Returns a boolean-state indicating if this provider's current status-code is {@link #ASSET_DOWNLOAD_FINISHED}.
+   *
+   * @return Whether this provider's current status-code is {@link #ASSET_DOWNLOAD_FINISHED}.
+   * @since 2.3.4
+   */
+  public boolean finished() {
+    return this.status == ASSET_DOWNLOAD_FINISHED;
+  }
+
+  /**
+   * Returns a boolean-state indicating if this provider's current status-code is {@link #UNKNOWN_ASSET_TO_DOWNLOAD}.
+   *
+   * @return Whether this provider's current status-code is {@link #UNKNOWN_ASSET_TO_DOWNLOAD}.
+   * @since 2.3.4
+   */
+  public boolean unknown() {
+    return this.status == UNKNOWN_ASSET_TO_DOWNLOAD;
+  }
+
+  /**
+   * Returns a boolean-state indicating if this provider's current status-code is {@link #ASSET_DOWNLOAD_ERROR}.
+   *
+   * @return Whether this provider's current status-code is {@link #ASSET_DOWNLOAD_ERROR}.
+   * @since 2.3.4
+   */
+  public boolean error() {
+    return this.status == ASSET_DOWNLOAD_ERROR;
+  }
+}