fix: deploy package and add more javadoc

Author: florianepitech

.github/workflows/publish-package.yml

@@ -21,8 +21,13 @@ jobs:
           server-id: ossrh
           server-username: MAVEN_USERNAME
           server-password: MAVEN_PASSWORD
+      - name: Install GPG key
+        run: cat ${{ secrets.OSSRH_GPG_SECRET_KEY }} | base64 -d | gpg --batch --import
       - name: Publish to the Maven Central Repository
-        run: mvn --batch-mode deploy -Dmaven.test.skip=true
+        run: mvn --batch-mode \
+               clean deploy \
+               -Dmaven.test.skip=true \
+               -Dgpg.passphrase=${{ secrets.OSSRH_GPG_PASSPHRASE }}
         env:
           MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
@@ -32,6 +37,8 @@ jobs:
           java-version: '17'
           distribution: 'temurin'
       - name: Publish to GitHub Packages
-        run: mvn --batch-mode deploy -Dmaven.test.skip=true
+        run: mvn --batch-mode \
+               clean deploy \
+               -Dmaven.test.skip=true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -42,3 +42,7 @@ logs
 .idea
 /src/main/java/net/botlify/brightdata/TestClass.java
 /src/main/java/net/botlify/brightdata/TestClass.java
+/secret.txt
+decode.sh
+base64privKey.txt
+privKey.pem

Makefile

@@ -5,7 +5,7 @@
 ## Generic Makefile for Botlify
 ##
 
-.PHONY: all test clean fclean re
+.PHONY: all test clean fclean re doc
 
 #=================================
 #	Commands
@@ -22,4 +22,7 @@ clean:
 		mvn clean
 
 finstall:
-		mvn install -Dmaven.test.skip=true
+		mvn install -Dmaven.test.skip=true
+
+doc:
+		mvn javadoc:javadoc

README.md

@@ -29,6 +29,13 @@ If you want to run the tests, you need to set the API key in the environment var
 mvn clean install
 ```
 
+### How to get the java documentation ?
+
+To generete the site for the java documentation please use the following command:
+```bash
+mvn javadoc:javadoc
+```
+
 ### How to use ?
 
 Add the dependency in your pom.xml:

pom.xml

@@ -25,6 +25,14 @@
     </license>
   </licenses>
 
+  <developers>
+    <developer>
+      <organization>Botlify</organization>
+      <url>https://github.com/botlify-net</url>
+      <timezone>Europe/Paris</timezone>
+    </developer>
+  </developers>
+
   <distributionManagement>
     <snapshotRepository>
       <id>ossrh</id>
@@ -95,6 +103,40 @@
 
   <build>
     <plugins>
+      <plugin>
+        <!-- Build the JavaDoc -->
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>3.2.1</version>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
+      <!-- Build the JavaDoc -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.5.0</version>
+        <configuration>
+          <source>1.8</source>
+        </configuration>
+        <executions>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+
+      <!-- Maven compiler plugin -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
@@ -104,17 +146,40 @@
           <target>1.8</target>
         </configuration>
       </plugin>
+
+      <!-- Sonatype OSSRH -->
       <plugin>
         <groupId>org.sonatype.plugins</groupId>
         <artifactId>nexus-staging-maven-plugin</artifactId>
-        <version>1.6.7</version>
+        <version>1.6.13</version>
         <extensions>true</extensions>
         <configuration>
           <serverId>ossrh</serverId>
           <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
           <autoReleaseAfterClose>true</autoReleaseAfterClose>
         </configuration>
       </plugin>
+      <!-- Maven GPG plugin -->
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-gpg-plugin</artifactId>
+        <version>3.0.1</version>
+        <executions>
+          <execution>
+            <id>sign-artifacts</id>
+            <phase>verify</phase>
+            <configuration>
+              <gpgArguments>
+                <arg>--pinentry-mode</arg>
+                <arg>loopback</arg>
+              </gpgArguments>
+            </configuration>
+            <goals>
+              <goal>sign</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

src/main/java/net/botlify/brightdata/AccountAPI.java

@@ -29,6 +29,7 @@ public class AccountAPI extends SubAPI {
      *     Link to the documentation
      * </a>.
      * @return The {@link BalanceResponse} object response.
+     * @throws IOException If an error occurred during the request.
      */
     public @NotNull BalanceResponse getBalance() throws IOException {
         final String url = BrightDataAPI.getBrightDataHost() + "/api/customer/balance";

src/main/java/net/botlify/brightdata/BrightDataAPI.java

@@ -62,6 +62,10 @@ public class BrightDataAPI {
     @NotNull
     private final RateLimiter rateLimiter = RateLimiter.create(1.5);
 
+    /**
+     * Construct a new API with the given API key.
+     * @param apiKey The BrightData API key.
+     */
     public BrightDataAPI(@NotNull final String apiKey) {
         if (apiKey.isEmpty())
             throw (new IllegalArgumentException("The API key cannot be empty."));

src/main/java/net/botlify/brightdata/ZoneAPI.java

@@ -428,6 +428,16 @@ public boolean whitelistAnyIP(@NotNull final String zone) throws IOException {
         }
     }
 
+    /**
+     * This method will request to remove the specified IP to the specified zone.<br />
+     * <a href="https://help.brightdata.com/hc/en-us/articles/4419834577041-Remove-Static-Datacenter-ISP-IPs">
+     *     Link to the documentation
+     * </a>
+     * @param zoneName The name of the zone to remove IP.
+     * @param ips The list of IP to remove.
+     * @return A new list of IP removed from the specified zone.
+     * @throws IOException A network error occurred.
+     */
     public @NotNull List<String> removeIpInZone(@NotNull final String zoneName,
                                                 @NotNull final String... ips)
             throws IOException {

src/main/java/net/botlify/brightdata/enums/BandwidthType.java

@@ -4,9 +4,19 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * The type of bandwidth used in a zone.
+ */
 public enum BandwidthType {
 
+    /**
+     * The bandwidth type pay per usage mode.
+     */
     PAYPERUSAGE("payperusage"),
+
+    /**
+     * The bandwidth type is unlimited. Limited to 100gb.
+     */
     UNLIMITED("unlimited");
 
     @NotNull @Getter
@@ -16,6 +26,11 @@ public enum BandwidthType {
         this.type = type;
     }
 
+    /**
+     * Get the bandwidth type from a string.
+     * @param type The string to parse.
+     * @return The bandwidth type, or null if not found.
+     */
     public static @Nullable BandwidthType fromString(@NotNull final String type) {
         for (BandwidthType t : BandwidthType.values()) {
             if (t.type.equalsIgnoreCase(type))
@@ -24,7 +39,10 @@ public enum BandwidthType {
         return (null);
     }
 
-
+    /**
+     * Get the string representation of the bandwidth type.
+     * @return The string representation of the bandwidth type.
+     */
     @Override
     public @NotNull String toString() {
         return (type);

src/main/java/net/botlify/brightdata/enums/IpAllocPresetType.java

@@ -4,19 +4,38 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * The type of ip allocation preset.
+ */
 public enum IpAllocPresetType {
 
+    /**
+     * The ip allocation preset type is shared.
+     */
     SHARED_BLOCK("shared_block"),
+
+    /**
+     * The ip allocation preset type is shared residential.
+     */
     SHARED_RES_BLOCK("shared_res_block");
 
     @NotNull
     @Getter
     private final String type;
 
+    /**
+     * Construct an ip allocation preset type.
+     * @param type The string representation of the ip allocation preset type.
+     */
     IpAllocPresetType(@NotNull final String type) {
         this.type = type;
     }
 
+    /**
+     * Get the ip allocation preset type from a string.
+     * @param type The string to parse.
+     * @return The ip allocation preset type, or null if not found.
+     */
     public static @Nullable IpAllocPresetType fromString(@NotNull final String type) {
         for (IpAllocPresetType t : IpAllocPresetType.values()) {
             if (t.type.equalsIgnoreCase(type))
@@ -26,6 +45,10 @@ public enum IpAllocPresetType {
     }
 
 
+    /**
+     * Get the string representation of the ip allocation preset type.
+     * @return The string representation of the ip allocation preset type.
+     */
     @Override
     public @NotNull String toString() {
         return (type);