Merge pull request #10 from contentstack/dev

support of branch and alias added

Author: Shailesh Mishra

pom.xml

@@ -4,13 +4,15 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>cms</artifactId>
+    <packaging>jar</packaging>
     <name>contentstack-management-java</name>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0-alpha-SNAPSHOT</version>
     <description>Contentstack Java Management SDK for Content Management API, Contentstack is a headless CMS with an
         API-first approach
     </description>
     <url>https://github.com/contentstack/contentstack-management-java/</url>
 
+    <!--    release the package using mvn clean deploy -->
     <parent>
         <groupId>org.sonatype.oss</groupId>
         <artifactId>oss-parent</artifactId>
@@ -167,6 +169,17 @@
 
     <build>
         <plugins>
+
+            <!--mvn clean install -U -Dmaven.test.failure.ignore=true-->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>3.0.0-M5</version>
+                <configuration>
+                    <testFailureIgnore>true</testFailureIgnore>
+                </configuration>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jxr-plugin</artifactId>
@@ -200,6 +213,7 @@
                 </executions>
             </plugin>
 
+            <!--  -overview "***REMOVED***tentstack/java/contentstack-management-java/src/main/overview.html" -bottom  "<b>Copyright © 2012-2022 Contentstack </b><sup>TM</sup>"-->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>

src/main/java/com/contentstack/cms/Contentstack.java

@@ -1,20 +1,24 @@
+
+/**
+ * The top most package to access contentstack instance
+ */
 package com.contentstack.cms;
 
 import com.contentstack.cms.core.AuthInterceptor;
-import com.contentstack.cms.models.Error;
 import com.contentstack.cms.core.Util;
+import com.contentstack.cms.models.Error;
 import com.contentstack.cms.models.LoginDetails;
 import com.contentstack.cms.organization.Organization;
 import com.contentstack.cms.stack.Stack;
 import com.contentstack.cms.user.User;
 import com.google.gson.Gson;
 import okhttp3.OkHttpClient;
 import okhttp3.ResponseBody;
+import okhttp3.logging.HttpLoggingInterceptor;
 import org.jetbrains.annotations.NotNull;
 import retrofit2.Response;
 import retrofit2.Retrofit;
 import retrofit2.converter.gson.GsonConverterFactory;
-import okhttp3.logging.HttpLoggingInterceptor;
 
 import java.io.IOException;
 import java.net.Proxy;
@@ -25,7 +29,12 @@
 import static com.contentstack.cms.core.Util.*;
 
 /**
- * The type Contentstack.
+ * <b>Contentstack Java Management SDK</b>
+ * <br>
+ * <b>Contentstack Java Management SDK</b> interact with the Content Management APIs and allow you to create, update,
+ * delete, and fetch content from your Contentstack account. They are read-write in nature.
+ * <br>
+ * You can use them to build your own apps and manage your content from Contentstack.
  */
 public class Contentstack {
 
@@ -63,7 +72,11 @@ public class Contentstack {
      * </pre>
      * <br>
      *
-     * @return User user
+     * @return User
+     * @author ***REMOVED***
+     * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#users">User
+     * </a>
+     * @since 2022-05-19
      */
     public User user() {
         if (this.authtoken == null)
@@ -103,12 +116,15 @@ public User user() {
      * <br>
      *
      * @param emailId
-     *         the email id
+     *         the email id of the user
      * @param password
-     *         the password
-     * @return response the Response type of @{@link LoginDetails}
+     *         the password of the user
+     * @return LoginDetails
      * @throws IOException
-     *         the io exception
+     *         the IOException
+     * @author ***REMOVED***
+     * @see <a href="https://www.contentstack.com/docs/developers/apis/content-management-api/#users">User
+     * </a>
      */
     public Response<LoginDetails> login(String emailId, String password) throws IOException {
         if (this.authtoken != null)
@@ -155,9 +171,16 @@ public Response<LoginDetails> login(String emailId, String password) throws IOEx
      *         the password
      * @param tfaToken
      *         the tfa token
-     * @return response the Response type of @{@link LoginDetails} throws {@link IOException}
+     * @return LoginDetails
      * @throws IOException
      *         the io exception
+     * @throws IOException
+     *         the IOException
+     * @author ***REMOVED***
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#log-in-to-your-account">Login
+     * your account
+     * </a>
      */
     public Response<LoginDetails> login(String emailId, String password, String tfaToken) throws IOException {
         if (this.authtoken != null)
@@ -264,7 +287,7 @@ public Organization organization() {
     public Stack stack() {
         if (this.authtoken == null)
             throw new IllegalStateException(ILLEGAL_USER);
-        return new Stack(this.instance);
+        return new Stack(this.instance, this.authtoken);
     }
 
 
@@ -288,7 +311,9 @@ public Stack stack() {
      */
     public Stack stack(@NotNull Map<String, Object> header) {
         if (this.authtoken == null)
-            throw new IllegalStateException(PLEASE_LOGIN);
+            if (header.size() == 0) {
+                throw new IllegalStateException(PLEASE_LOGIN);
+            }
         return new Stack(this.instance, header);
     }
 
@@ -398,9 +423,11 @@ public Builder() {
          * InetSocketAddress(proxyHost, proxyPort));
          * <br>
          * <pre>
-         *         Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
-         *         Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
-         *     </pre>
+         * {
+         * Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
+         * Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
+         * }
+         * </pre>
          *
          * @param proxy
          *         the proxy

src/main/java/com/contentstack/cms/core/CMSRuntimeException.java

@@ -7,8 +7,6 @@
  * @version 1.0.0
  * @since 2022-05-19
  */
-public class CMSRuntimeException extends Exception {
-    public CMSRuntimeException(String message) {
+public class CMSRuntimeException extends Exception { public CMSRuntimeException(String message) {
         super(message);
-    }
-}
+    }}

src/main/java/com/contentstack/cms/core/CSResponse.java

@@ -9,6 +9,14 @@
 import java.io.IOException;
 import java.util.Objects;
 
+/**
+ * Contentstack Response:
+ *
+ * @author ***REMOVED***
+ * @version 1.0.0
+ * @since 2022-05-19
+ */
+
 public class CSResponse {
 
     private static final String MODEL_NULL_CHECK = "model class == null";

src/main/java/com/contentstack/cms/core/ContentstackResponse.java

@@ -19,7 +19,6 @@ public class ContentstackResponse<T> {
 
     Call<ResponseBody> response;
 
-
     public Response<ResponseBody> fetch(Call<ResponseBody> response) {
         try {
             return response.execute();

src/main/java/com/contentstack/cms/core/ObjectModel.java

@@ -8,7 +8,7 @@
 
 
 /**
- * The Utility class that contains utility common functions
+ * The utility class that contains utility common functions
  *
  * @author ***REMOVED***
  * @version 1.0.0
@@ -80,8 +80,7 @@ public static void assertionError() {
     }
 
     public static RequestBody toRequestBody(String bodyString) {
-        return RequestBody.create(MediaType.parse("application/json; charset=UTF-8"),
-                bodyString);
+        return RequestBody.create(MediaType.parse("application/json; charset=UTF-8"), bodyString);
     }
 
 }

src/main/java/com/contentstack/cms/core/Util.java

@@ -0,0 +1,4 @@
+/**
+ * Useful to access contentstack's core components
+ */
+package com.contentstack.cms.core;

src/main/java/com/contentstack/cms/core/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Useful to access contentstack's models and pojo classes
+ */
+package com.contentstack.cms.models;

src/main/java/com/contentstack/cms/models/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Useful to access contentstack's organizations
+ */
+package com.contentstack.cms.organization;