Merge branch 'main' into next

Author: Shailesh Mishra

.github/workflows/sca-scan.yml

@@ -1,15 +1,15 @@
 name: Source Composition Analysis Scan
 on:
   pull_request:
-    types: [opened, synchronize, reopened]
+    types: [ opened, synchronize, reopened ]
 jobs:
   security:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
       - name: Run Snyk to check for vulnerabilities
-        uses: snyk/actions/node@master
+        uses: snyk/actions/maven@master
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
-          args: --all-projects --fail-on=all
+          args: --fail-on=all

README.md

@@ -8,90 +8,79 @@ Before using the **Marketplace** SDK, ensure the following:
 
 1. Java JDK 1.8 or above should be installed on your machine.
 2. You have a valid Contentstack account with access to the Contentstack Marketplace.
-3. You have obtained the necessary credentials, including the organization UID, to interact with the Marketplace API.
+3. You have obtained the necessary credentials like **organization UID** and **authtoken**, to interact with the Marketplace API.
 
 ## Installation
 
 To use the Marketplace SDK in your Java project, follow these steps:
 
 1. Download the contentstack-java SDK and its dependencies from the Contentstack Maven repository. Add the following dependencies to your project's pom.xml file:
 
-```xml
-<!-- https://mvnrepository.com/artifact/com.contentstack.sdk/marketplace -->
-<dependencies>
-    <dependency>
-        <groupId>com.contentstack.sdk</groupId>
-        <artifactId>marketplace</artifactId>
-        <version>x.x.x</version> <!-- Replace 'x.x.x' with the latest version available -->
-    </dependency>
-</dependencies>
-```
+```xml  
+<!-- https://mvnrepository.com/artifact/com.contentstack.sdk/marketplace -->  
+<dependencies>  
+ <dependency> <groupId>com.contentstack.sdk</groupId> 
+     <artifactId>marketplace</artifactId> 
+     <version>x.x.x</version> <!-- Replace 'x.x.x' with the latest version available --> 
+ </dependency>
+</dependencies>  
+
+
+```  
 
 2. Save the pom.xml file.
 
 3. Ensure you have internet connectivity to download the SDK and its dependencies from the central Maven repository.
 
 ## How to Use
 
-1. Import the required packages:
+1. Initialize the Marketplace class with your organization UID:
 
-```java
+```java  
 import com.contentstack.sdk.marketplace.Marketplace;
-import com.contentstack.sdk.marketplace.apps.App;
-import com.contentstack.sdk.marketplace.auths.Auth;
-import com.contentstack.sdk.marketplace.installations.Installation;
-import com.contentstack.sdk.marketplace.request.AppRequest;
-import org.jetbrains.annotations.NotNull;
-import retrofit2.Retrofit;
-```
+Marketplace marketplace = new Marketplace  
+        .Builder(TestClient.ORGANIZATION_UID)  // Required
+        .host(HOST)  // Optional
+        .authtoken("test")  // Optional
+        .login("test@email.com", "*********")  // Optional
+        .region(Region.AZURE_EU)  // Optional
+        .build();  
+```  
 
-2. Initialize the Marketplace class with your organization UID:
-
-```java
-// Replace 'YOUR_ORG_ID' with your Contentstack organization UID
-String organizationUid = "YOUR_ORG_ID";
-Marketplace marketplace = new Marketplace(organizationUid);
-```
-
-3. Use the various methods available in the Marketplace class to interact with the Marketplace API:
+2. Use the various methods available in the Marketplace class to interact with the Marketplace API:
 
 ### Retrieve an instance of the App class:
-
-```java
-// Get an instance of the App class
-App app = marketplace.app();
-
-// Alternatively, you can pass the app UID to retrieve a specific app
-String appUid = "APP_UID";
-App specificApp = marketplace.app(appUid);
-```
+Get an instance of the App class
+```java  
+import com.contentstack.sdk.marketplace.apps.App; 
+App app = marketplace.app();  
+// Alternatively, you can pass the app UID to retrieve a specific app   
+App specificApp = marketplace.app("APP_UID");  
+```  
 
 ### Retrieve an instance of the Auth class:
 
 ```java
-// Get an instance of the Auth class
-Auth auth = marketplace.authorizations();
-```
+import com.contentstack.sdk.marketplace.auths.Auth;  
+// Get an instance of the Auth class  
+Auth auth = marketplace.authorizations();  
+```  
 
 ### Retrieve an instance of the Installation class:
-
+Get an instance of the Installation class
 ```java
-// Get an instance of the Installation class
-Installation installation = marketplace.installation();
-
-// Alternatively, you can pass the installation ID to retrieve a specific installation
-String installationId = "INSTALLATION_ID";
-Installation specificInstallation = marketplace.installation(installationId);
-```
+import com.contentstack.sdk.marketplace.installations.Installation; 
+Installation installation = marketplace.installation();  
+OR 
+Installation specificInstallation = marketplace.installation("INSTALLATION_ID");  
+```  
 
 ### Create an instance of the AppRequest class:
-
+Get an instance of the AppRequest class
 ```java
-// Get an instance of the AppRequest class
-AppRequest appRequest = marketplace.request();
-```
-
-**Note:** Replace **YOUR_ORG_ID**, **APP_UID**, and **INSTALLATION_ID** with actual values from your Contentstack organization.
+import com.contentstack.sdk.marketplace.request.AppRequest;  
+AppRequest appRequest = marketplace.request();  
+```   
 
 ## License
 
@@ -102,4 +91,4 @@ Copyright © 2012-2023 [Contentstack](https://www.contentstack.com/). All Rights
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-```
+```

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>marketplace</artifactId>
-    <version>1.0.0-alpha-SNAPSHOT</version>
+    <version>1.0.0</version>
     <description>Contentstack Java Management SDK for Content Management API</description>
     <url>https://github.com/contentstack/contentstack-management-java/</url>
 
@@ -23,7 +23,7 @@
         <converter-gson-version>2.9.0</converter-gson-version>
         <logging.version>4.10.0</logging.version>
         <jococo-plugin.version>0.8.7</jococo-plugin.version>
-        <lombok-source.version>1.18.28</lombok-source.version>
+        <lombok-source.version>1.18.30</lombok-source.version>
         <junit-jupiter.version>5.10.0</junit-jupiter.version>
         <junit-jupiter-engine.version>5.8.0-M1</junit-jupiter-engine.version>
         <junit-vintage-engine.version>5.10.0</junit-vintage-engine.version>

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

@@ -2,6 +2,9 @@
 
 public class Constants {
     final public static String ERROR_NO_ORGANIZATION_UID = "Organization uid could not be empty";
+    final public static String DEFAULT_HOST = "developerhub-api.contentstack.com";
+    final public static String MISSING_ORG_ID = "organization uid is required";
+
 
     final public static String ORGANIZATION_UID = "organization_uid";
     final public static String AUTHTOKEN = "authtoken";

src/main/java/com/contentstack/sdk/marketplace/Marketplace.java

@@ -26,7 +26,6 @@ public class Marketplace {
     protected final String orgId;
     private final String host;
 
-    private static final String DEFAULT_HOST = "developerhub-api.contentstack.com";
     private final String authtoken;
 
     private Marketplace(String authtoken, String organizationUid, String host, Region region) {
@@ -35,7 +34,7 @@ private Marketplace(String authtoken, String organizationUid, String host, Regio
         if (region != null) {
             host = region.name().toLowerCase() + "-" + host;
         }
-        this.host = host.isEmpty() ? DEFAULT_HOST : host;
+        this.host = host.isEmpty() ? Constants.DEFAULT_HOST : host;
         this.client = Client.getInstance(this.host);
     }
 

src/main/java/com/contentstack/sdk/marketplace/apps/App.java

@@ -54,7 +54,7 @@ public App(Retrofit client, String authtoken, @NotNull String organizationUid) {
         this.params = new HashMap<>();
         Objects.requireNonNull(organizationUid, Constants.ERROR_NO_ORGANIZATION_UID);
         this.headers.put(Constants.ORGANIZATION_UID, organizationUid);
-        if (authtoken!=null){
+        if (authtoken != null) {
             this.headers.put(Constants.AUTHTOKEN, authtoken);
         }
         this.service = client.create(AppService.class);
@@ -83,7 +83,7 @@ public App(Retrofit client, String authtoken, @NotNull String organizationUid, @
         this.params = new HashMap<>();
         Objects.requireNonNull(organizationUid, ERROR_NO_ORGANIZATION_UID);
         this.headers.put(Constants.ORGANIZATION_UID, organizationUid);
-        if (authtoken!=null){
+        if (authtoken != null) {
             this.headers.put(Constants.AUTHTOKEN, authtoken);
         }
         Objects.requireNonNull(uid, "Manifest uid is required");

src/main/java/com/contentstack/sdk/marketplace/auths/Auth.java

@@ -35,7 +35,7 @@ public Auth(Retrofit clientInstance, String authtoken, String organizationUid) {
         this.params = new HashMap<>();
         Objects.requireNonNull(organizationUid, "Organization uid could not be empty");
         this.headers.put(Constants.ORGANIZATION_UID, organizationUid);
-        if (authtoken!=null){
+        if (authtoken != null) {
             this.headers.put(Constants.AUTHTOKEN, authtoken);
         }
         this.service = clientInstance.create(AuthService.class);

src/main/java/com/contentstack/sdk/marketplace/installations/Installation.java

@@ -20,7 +20,6 @@ public class Installation implements BaseImplementation<Installation> {
     /**
      * The Missing org id.
      */
-    public final String MISSING_ORG_ID = "organization uid is required";
     private String installationId;
     private String organisationId;
     private InstallationService service;
@@ -59,7 +58,7 @@ public Installation(Retrofit client, String authtoken, @NotNull String organisat
      */
     protected void checkOrganisationId(String organisationId) {
         if (organisationId.isEmpty()) {
-            throw new NullPointerException(MISSING_ORG_ID);
+            throw new NullPointerException(Constants.MISSING_ORG_ID);
         }
     }
 
@@ -115,7 +114,7 @@ private void init(Retrofit client, String authtoken, @NotNull String organisatio
         this.organisationId = organisationId;
         this.client = client;
         this.headers.put(Constants.ORGANIZATION_UID, organisationId);
-        if (authtoken!=null){
+        if (authtoken != null) {
             this.headers.put(Constants.AUTHTOKEN, authtoken);
         }
         this.service = this.client.create(InstallationService.class);