Utils update

Author: ishaileshmishra

.env

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v1.12.2
+
+### Date: 08-AUG-2023
+
+- Updated Utils SDK to v1.2.3
+
+## v1.12.1
+
+### Date: 07-Jun-2023
+
+- Added Support For Nested Assets
+- General Code Improvement
+
 ## v1.12.0
 
 ### Date: 25-APR-2023

.github/workflows/sast-scan.yml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>1.12.1-SNAPSHOT</version>
+    <version>1.12.2-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API</description>
@@ -22,7 +22,6 @@
         <dotenv-source.version>3.0.0</dotenv-source.version>
         <rxjava-source.version>3.1.6</rxjava-source.version>
         <retrofit-source.version>2.9.0</retrofit-source.version>
-        <converter-gson-source.version>2.9.0</converter-gson-source.version>
         <loggin.version>4.11.0</loggin.version>
         <jococo-plugin.version>0.8.5</jococo-plugin.version>
         <lombok-source.version>1.18.28</lombok-source.version>
@@ -37,7 +36,7 @@
         <json-version>20230227</json-version>
         <jacoco-maven-plugin-version>0.8.7</jacoco-maven-plugin-version>
         <maven-release-plugin-version>2.5.3</maven-release-plugin-version>
-        <contentstack-utils-version>1.2.2</contentstack-utils-version>
+        <contentstack-utils-version>1.2.3</contentstack-utils-version>
     </properties>
 
     <parent>
@@ -129,12 +128,13 @@
             <version>${retrofit-source.version}</version>
             <scope>compile</scope>
         </dependency>
+        <!-- https://mvnrepository.com/artifact/com.squareup.retrofit2/converter-gson -->
         <dependency>
             <groupId>com.squareup.retrofit2</groupId>
             <artifactId>converter-gson</artifactId>
-            <version>${converter-gson-source.version}</version>
-            <scope>compile</scope>
+            <version>${retrofit-source.version}</version>
         </dependency>
+
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>logging-interceptor</artifactId>

.github/workflows/secrets-scan.yml

@@ -21,7 +21,7 @@
 public class Constants {
 
     private static final Logger logger = Logger.getLogger(Constants.class.getSimpleName());
-    protected static final String SDK_VERSION = "1.12.1";
+    protected static final String SDK_VERSION = "1.12.2";
     protected static final String ENVIRONMENT = "environment";
     protected static final String CONTENT_TYPE_UID = "content_type_uid";
     protected static final String ENTRY_UID = "entry_uid";

CHANGELOG.md

@@ -0,0 +1,87 @@
+package com.contentstack.sdk;
+
+import io.github.cdimascio.dotenv.Dotenv;
+import io.github.cdimascio.dotenv.DotenvException;
+
+import java.io.File;
+import java.io.IOException;
+import java.rmi.AccessException;
+
+public class Credentials {
+    static Dotenv env = getEnv();
+
+    /**
+     * The provided Java code defines a method named `getEnv()` that attempts to load environment variables from a `.env` file using the `Dotenv` library. If loading the environment variables encounters an exception (specifically, a `DotenvException`), the code takes an alternative path by creating an empty `.env` file in the current working directory.
+     * <p>
+     * Here's a breakdown of what the code is doing step by step:
+     * <p>
+     * 1. The method `public static Dotenv getEnv()` is defined. It returns an instance of the `Dotenv` class, which is used to manage environment variables loaded from the `.env` file.
+     * <p>
+     * 2. Inside the `try` block, the code tries to load environment variables using `Dotenv.load()`. If successful, the loaded environment variables are stored in the `env` variable.
+     * <p>
+     * 3. If loading the environment variables from the `.env` file encounters an exception (a `DotenvException`), the code enters the `catch` block.
+     * <p>
+     * 4. In the `catch` block, it gets the current working directory using `System.getProperty("user.dir")` and creates a `File` object named `envFile` representing the `.env` file in the current directory.
+     * <p>
+     * 5. The code attempts to create an empty `.env` file using `envFile.createNewFile()`.
+     * <p>
+     * 6. If there's an error during the file creation process (an `IOException`), an error message is printed to the standard error output, and the exception's stack trace is printed for debugging purposes.
+     * <p>
+     * 7. Finally, regardless of whether the environment variables were successfully loaded or a new `.env` file was created, the method returns the `env` variable, which may either contain the loaded environment variables or be `null` if an exception occurred during the loading process.
+     * <p>
+     * In summary, this code defines a method that attempts to load environment variables from a `.env` file using the `Dotenv` library. If loading fails due to an exception, it creates an empty `.env` file in the current working directory and then returns the `Dotenv` instance, which may or may not have loaded environment variables depending on whether an exception occurred.
+     *
+     * @return Dotenv
+     */
+    public static Dotenv getEnv() {
+        try {
+            env = Dotenv.load();
+        } catch (DotenvException ex) {
+            String currentDirectory = System.getProperty("user.dir");
+            File envFile = new File(currentDirectory, ".env");
+            try {
+                // Create .env file in the current directory
+                envFile.createNewFile();
+            } catch (IOException e) {
+                System.err.println("An error occurred while creating .env file.");
+                e.printStackTrace();
+            }
+        }
+        return env;
+    }
+
+
+    public final static String pwd = (env.get("PWD") != null) ? env.get("PWD") : "contentstack-java";
+    public final static String HOST = (env.get("HOST") != null) ? env.get("HOST") : "cdn.contentstack.io";
+    public final static String API_KEY = (env.get("API_KEY") != null) ? env.get("API_KEY") : "***REMOVED***";
+    public final static String DELIVERY_TOKEN = (env.get("DELIVERY_TOKEN") != null) ? env.get("DELIVERY_TOKEN") : "***REMOVED***";
+    public final static String ENVIRONMENT = (env.get("ENVIRONMENT") != null) ? env.get("ENVIRONMENT") : "env1";
+    public final static String CONTENT_TYPE = (env.get("contentType") != null) ? env.get("contentType") : "product";
+    public final static String ENTRY_UID = (env.get("assetUid") != null) ? env.get("assetUid") : "blt884786476373";
+
+    private static Stack stack;
+
+    private Credentials() throws AccessException {
+        // Private constructor to prevent direct instantiation
+        throw new AccessException("Can not access credential access");
+    }
+
+    public static Stack getStack() {
+
+        if (stack == null) {
+            synchronized (Credentials.class) {
+                if (stack == null) {
+                    try {
+                        Config config = new Config();
+                        config.setHost(HOST);
+                        stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENVIRONMENT, config);
+                    } catch (IllegalAccessException e) {
+                        throw new RuntimeException(e);
+                    }
+                }
+            }
+        }
+        return stack;
+    }
+
+}

pom.xml

@@ -1,6 +1,5 @@
 package com.contentstack.sdk;
 
-import io.github.cdimascio.dotenv.Dotenv;
 import org.json.JSONObject;
 import org.junit.jupiter.api.*;
 
@@ -11,21 +10,10 @@
 @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 class TestAsset {
 
-    protected String API_KEY, DELIVERY_TOKEN, ENV;
     private final Logger logger = Logger.getLogger(TestAsset.class.getName());
     private String assetUid;
-    private Stack stack;
-
-    @BeforeAll
-    public void initBeforeTests() throws IllegalAccessException {
-        Dotenv dotenv = Dotenv.load();
-        API_KEY = dotenv.get("API_KEY");
-        DELIVERY_TOKEN = dotenv.get("DELIVERY_TOKEN");
-        ENV = dotenv.get("ENVIRONMENT");
-        Config config = new Config();
-        config.setHost(dotenv.get("HOST"));
-        stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV, config);
-    }
+    private Stack stack = Credentials.getStack();
+
 
     @Test
     @Order(1)

src/main/java/com/contentstack/sdk/Constants.java

@@ -1,6 +1,5 @@
 package com.contentstack.sdk;
 
-import io.github.cdimascio.dotenv.Dotenv;
 import org.junit.jupiter.api.*;
 
 import java.util.List;
@@ -11,21 +10,9 @@
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 class TestAssetLibrary {
-
-    protected String API_KEY, DELIVERY_TOKEN, ENV;
     private final Logger logger = Logger.getLogger(TestAssetLibrary.class.getName());
-    private Stack stack;
+    private final Stack stack = Credentials.getStack();
 
-    @BeforeAll
-    public void initBeforeTests() throws IllegalAccessException {
-        Dotenv dotenv = Dotenv.load();
-        API_KEY = dotenv.get("API_KEY");
-        DELIVERY_TOKEN = dotenv.get("DELIVERY_TOKEN");
-        ENV = dotenv.get("ENVIRONMENT");
-        Config config = new Config();
-        config.setHost(dotenv.get("HOST"));
-        stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV, config);
-    }
 
     @Test
     @Order(1)
@@ -55,7 +42,6 @@ void testAssetSetHeader() {
         AssetLibrary assetLibrary = stack.assetLibrary();
         assetLibrary.setHeader("headerKey", "headerValue");
         Assertions.assertTrue(assetLibrary.headers.containsKey("headerKey"));
-        logger.info("passed...");
     }
 
     @Test
@@ -64,57 +50,49 @@ void testAssetRemoveHeader() {
         assetLibrary.setHeader("headerKey", "headerValue");
         assetLibrary.removeHeader("headerKey");
         Assertions.assertFalse(assetLibrary.headers.containsKey("headerKey"));
-        logger.info("passed...");
     }
 
     @Test
     void testAssetSortAscending() {
         AssetLibrary assetLibrary = stack.assetLibrary().sort("ascending", AssetLibrary.ORDERBY.ASCENDING);
         Assertions.assertFalse(assetLibrary.headers.containsKey("asc"));
-        logger.info("passed...");
     }
 
     @Test
     void testAssetSortDescending() {
         AssetLibrary assetLibrary = stack.assetLibrary();
         assetLibrary.sort("descending", AssetLibrary.ORDERBY.DESCENDING);
         Assertions.assertFalse(assetLibrary.headers.containsKey("desc"));
-        logger.info("passed...");
     }
 
     @Test
     void testAssetIncludeCount() {
         AssetLibrary assetLibrary = stack.assetLibrary().includeCount();
         Assertions.assertFalse(assetLibrary.headers.containsKey("include_count"));
-        logger.info("passed...");
     }
 
     @Test
     void testAssetIncludeRelativeUrl() {
         AssetLibrary assetLibrary = stack.assetLibrary();
         assetLibrary.includeRelativeUrl();
         Assertions.assertFalse(assetLibrary.headers.containsKey("relative_urls"));
-        logger.info("passed...");
     }
 
     @Test
     void testAssetGetCount() {
         AssetLibrary assetLibrary = stack.assetLibrary().includeRelativeUrl();
         Assertions.assertEquals(0, assetLibrary.getCount());
-        logger.info("passed...");
     }
 
     @Test
     void testIncludeFallback() {
         AssetLibrary assetLibrary = stack.assetLibrary().includeFallback();
         Assertions.assertFalse(assetLibrary.headers.containsKey("include_fallback"));
-        logger.info("passed...");
     }
 
     @Test
     void testIncludeOwner() {
         AssetLibrary assetLibrary = stack.assetLibrary().includeMetadata();
         Assertions.assertFalse(assetLibrary.headers.containsKey("include_owner"));
-        logger.info("passed...");
     }
 }

src/test/java/com/contentstack/sdk/Credentials.java

@@ -1,6 +1,5 @@
 package com.contentstack.sdk;
 
-import io.github.cdimascio.dotenv.Dotenv;
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.junit.jupiter.api.*;
@@ -11,18 +10,8 @@
 @TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 class TestContentType {
 
-    protected String API_KEY, DELIVERY_TOKEN, ENV;
     private final Logger logger = Logger.getLogger(TestContentType.class.getName());
-    private Stack stack;
-
-    @BeforeAll
-    public void initBeforeTests() throws IllegalAccessException {
-        Dotenv dotenv = Dotenv.load();
-        API_KEY = dotenv.get("API_KEY");
-        DELIVERY_TOKEN = dotenv.get("DELIVERY_TOKEN");
-        ENV = dotenv.get("ENVIRONMENT");
-        stack = Contentstack.stack(API_KEY, DELIVERY_TOKEN, ENV);
-    }
+    private final Stack stack = Credentials.getStack();
 
     @Test
     @Order(1)