Merge pull request #143 from contentstack/staging

21st Oct 2024 Release

Author: reeshika-h

.github/workflows/maven--package-publish.yml

@@ -0,0 +1,31 @@
+name: Publishing to Maven Packages
+#on: [ push ]  # Trigger the workflow when a push (commit) event occurs
+on:
+  release:
+    types: [ created ]
+jobs:
+  publish-maven:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Maven Central Repository
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+          gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+          gpg-passphrase: GPG_PASSPHRASE
+      - name: Publish to Maven Central Repository
+        run: mvn --batch-mode -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }} deploy
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+          GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+
+#        run: mvn --batch-mode deploy

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v2.0.1
+
+### Date: 21-October-2024
+
+-Github Issues fixed
+-Issue with field ordering in SDK response
+
 ## v2.0.0
 
 ### Date: 27-August-2024

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API</description>
@@ -17,7 +17,7 @@
         <maven.compiler.source>1.8</maven.compiler.source>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <surefire-report-plugin.version>2.22.0</surefire-report-plugin.version>
-        <maven-source-plugin.version>2.2.1</maven-source-plugin.version>
+        <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
         <maven-javadoc-plugin.version>3.4.1</maven-javadoc-plugin.version>
         <dotenv-source.version>3.0.0</dotenv-source.version>
         <rxjava-source.version>3.1.8</rxjava-source.version>
@@ -183,6 +183,12 @@
             <version>${json-simple-version}</version>
             <scope>compile</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.15.2</version>
+        </dependency>
     </dependencies>
 
     <build>

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

@@ -2,15 +2,18 @@
 
 import okhttp3.Request;
 import okhttp3.ResponseBody;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
+
 import retrofit2.Call;
 import retrofit2.Response;
 
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
+import java.net.SocketTimeoutException;
 import java.nio.charset.StandardCharsets;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -19,6 +22,10 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.IntStream;
+import com.fasterxml.jackson.databind.ObjectMapper; // Jackson for JSON parsing
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.databind.type.MapType;
 
 import static com.contentstack.sdk.Constants.*;
 
@@ -185,6 +192,14 @@ public void send() {
         }
     }
 
+    private JSONObject createOrderedJSONObject(Map<String, Object> map) {
+        JSONObject json = new JSONObject();
+        for (Map.Entry<String, Object> entry : map.entrySet()) {
+            json.put(entry.getKey(), entry.getValue());
+        }
+        return json;
+    }
+
     private void getService(String requestUrl) throws IOException {
 
         this.headers.put(X_USER_AGENT_KEY, "contentstack-delivery-java/" + SDK_VERSION);
@@ -202,22 +217,41 @@ private void getService(String requestUrl) throws IOException {
             requestUrl = request.url().toString();
         }
 
-        Response<ResponseBody> response = this.service.getRequest(requestUrl, this.headers).execute();
-        if (response.isSuccessful()) {
-            assert response.body() != null;
-            if (request != null) {
-                response = pluginResponseImp(request, response);
-            }
-            responseJSON = new JSONObject(response.body().string());
-            if (this.config.livePreviewEntry != null && !this.config.livePreviewEntry.isEmpty()) {
-                handleJSONArray();
+        try {
+            Response<ResponseBody> response = this.service.getRequest(requestUrl, this.headers).execute();
+            if (response.isSuccessful()) {
+                assert response.body() != null;
+                if (request != null) {
+                    response = pluginResponseImp(request, response);
+                }
+                try {
+                    // Use Jackson to parse the JSON while preserving order
+                    ObjectMapper mapper = JsonMapper.builder().build();
+                    MapType type = mapper.getTypeFactory().constructMapType(LinkedHashMap.class, String.class,
+                            Object.class);
+                    Map<String, Object> responseMap = mapper.readValue(response.body().string(), type);
+
+                    // Use the custom method to create an ordered JSONObject
+                    responseJSON = createOrderedJSONObject(responseMap);
+                    if (this.config.livePreviewEntry != null && !this.config.livePreviewEntry.isEmpty()) {
+                        handleJSONArray();
+                    }
+                    connectionRequest.onRequestFinished(CSHttpConnection.this);
+                } catch (JSONException e) {
+                    // Handle non-JSON response
+                    setError("Invalid JSON response");
+                }
+            } else {
+                assert response.errorBody() != null;
+                setError(response.errorBody().string());
             }
-            connectionRequest.onRequestFinished(CSHttpConnection.this);
-        } else {
-            assert response.errorBody() != null;
-            setError(response.errorBody().string());
+        } catch (SocketTimeoutException e) {
+            // Handle timeout
+            setError("Request timed out: " + e.getMessage());
+        } catch (IOException e) {
+            // Handle other IO exceptions
+            setError("IO error occurred: " + e.getMessage());
         }
-
     }
 
     private Request pluginRequestImp(String requestUrl) {
@@ -261,7 +295,13 @@ void handleJSONObject(JSONArray arrayEntry, JSONObject jsonObj, int idx) {
     }
 
     void setError(String errResp) {
-        responseJSON = new JSONObject(errResp); // Parse error string to JSONObject
+        try {
+            responseJSON = new JSONObject(errResp);
+        } catch (JSONException e) {
+            // If errResp is not valid JSON, create a new JSONObject with the error message
+            responseJSON = new JSONObject();
+            responseJSON.put(ERROR_MESSAGE, errResp);
+        }
         responseJSON.put(ERROR_MESSAGE, responseJSON.optString(ERROR_MESSAGE));
         responseJSON.put(ERROR_CODE, responseJSON.optString(ERROR_CODE));
         responseJSON.put(ERRORS, responseJSON.optString(ERRORS));

src/main/overview.html

@@ -20,7 +20,7 @@ <h1 id="java-sdk-for-contentstack">Java SDK for Contentstack</h1>
         resources to get started with our Java SDK.</p>
     <h2 id="prerequisite">Prerequisite</h2>
     <p>You will need JDK installed on your machine. You can install it from <a
-            href="http://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html">here</a>.</p>
+            href="https://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html">here</a>.</p>
     <h3 id="setup-and-installation">Setup and Installation</h3>
     <p>To use the Contentstack Java SDK to your existing project, perform the steps given below:</p>
     <p>Group id: <code>com.contentstack.sdk</code></p>