Merge pull request #12 from contentstack/development

Development

Author: ishaileshmishra

CHANGELOG.md

@@ -3,6 +3,15 @@
 
 ------------------------------------------------
 
+## Version 1.5.0
+   ###### Date: 15-Nov-2019
+   - [Stack]: Added support for function getContentType()
+   - [ContentType]: updated function fetch()
+   - [Query]: Updated support of whereIn(String KEY, Query queryObject)
+   - [Query]: Updated support of whereNotIn(String KEY, Query queryObject)
+
+------------------------------------------------
+
 ## Version 1.4.2
    ###### Date: 03-Sept-2019
    - [Config] - Added support for Region in Config.   

README.md

@@ -20,13 +20,13 @@ To use the Contentstack Java SDK to your existing project, perform the steps giv
 <dependency>
   <groupId>com.contentstack.sdk</groupId>
   <artifactId>java</artifactId>
-  <version>1.4.2</version>
+  <version>1.5.0-SNAPSHOT</version>
 </dependency>
 ```
 
 2. **Gradle**
 ```
-implementation 'com.contentstack.sdk:java:1.4.2'
+implementation 'com.contentstack.sdk:java:1.5.0'
 ```
 
 ### Key Concepts for using Contentstack

pom.properties

@@ -1,4 +1,4 @@
 # Written manually.
-version=1.4.2
+version=1.5.0
 groupId=com.contentstack.sdk
 artifactId=java

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>1.4.2</version>
+    <version>1.5.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>contentstack-java</name>
@@ -43,7 +43,7 @@
         <url>https://github.com/contentstack/contentstack-java/tree/master</url>
         <connection>scm:git:git://github.com/contentstack/contentstack-java.git</connection>
         <developerConnection>scm:git:ssh://github.com:contentstack/contentstack-java.git</developerConnection>
-        <tag>v1.4.2</tag>
+        <tag>v1.5.0</tag>
     </scm>
 
     <issueManagement>

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

@@ -255,9 +255,7 @@ public void send() {
 
         try {
             sendGET(url);
-        } catch (IOException e) {
-            e.printStackTrace();
-        } catch (JSONException e) {
+        } catch (IOException | JSONException e) {
             e.printStackTrace();
         }
     }
@@ -286,9 +284,9 @@ private void sendGET(String GET_URL) throws IOException, JSONException {
         if (responseCode == HttpURLConnection.HTTP_OK) { // success
             BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
             String inputLine;
-            StringBuffer response = new StringBuffer();
+            StringBuilder response = new StringBuilder();
             while ((inputLine = in.readLine()) != null) {
-                response.append(inputLine);
+                StringBuilder append = response.append(inputLine);
             }
             in.close();
 

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

@@ -38,16 +38,18 @@ public enum ContentstackRegion { US, EU }
 
     /**
      * Sets region allow you to set your region for the Contentstack server.
-     *
-     * @param region
+     * @param region type {@link ContentstackRegion}
+     * @return ContentstackRegion
      *
      * <p>
-     * <b>Note:</b> Default region sets to us </a>
+     * <b>Note:</b>
+     * Default region sets to us
      *
      * <br><br><b>Example :</b><br>
      * <pre class="prettyprint">
      * config.setRegion(ContentstackRegion.US);
      * </pre>
+
      */
 
     public ContentstackRegion setRegion(ContentstackRegion region) {

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

@@ -168,11 +168,15 @@ public Query query(){
     /**
      *
      * This call returns information of a specific content type. It returns the content type schema, but does not include its entries.
+     * @param params query parameters
      * @param callback {@link ContentTypesCallback}
      *  <br><br><b>Example :</b><br>
      *  <pre class="prettyprint">
      * ContentType  contentType = stack.contentType("content_type_uid");
-     * contentType.fetch(new ContentTypesCallback() {
+     * JSONObject params = new JSONObject();
+     * params.put("include_snippet_schema", true);
+     * params.put("limit", 3);
+     * contentType.fetch(params, new ContentTypesCallback() {
      *
      * public void onCompletion(ContentTypesModel contentTypesModel, Error error) {
      * if (error==null){
@@ -186,19 +190,30 @@ public Query query(){
      */
 
 
-    public void fetch(final ContentTypesCallback callback) {
+    public void fetch(JSONObject params, final ContentTypesCallback callback) {
 
         try {
 
             String URL = "/" + stackInstance.VERSION + "/content_types/"+contentTypeName;
             HashMap<String, Object> headers = getHeader(localHeader);
-            JSONObject param = new JSONObject();
+            if (params == null){ params = new JSONObject(); }
+
+            Iterator keys = params.keys();
+            while(keys.hasNext()) {
+                // loop to get the dynamic key
+                String key = (String)keys.next();
+                // get the value of the dynamic key
+                Object value = params.opt(key);
+                // do something here with the value...
+                params.put(key, value);
+            }
+
             if (headers.containsKey("environment")) {
-                param.put("environment", headers.get("environment"));
+                params.put("environment", headers.get("environment"));
             }
 
-            if (contentTypeName!=null) {
-                fetchContentTypes(URL, param, headers, callback );
+            if (contentTypeName!=null && !contentTypeName.isEmpty()) {
+                fetchContentTypes(URL, params, headers, callback );
             }else {
                 Error error = new Error();
                 error.setErrorMessage(CSAppConstants.ErrorMessage_JsonNotProper);

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

@@ -1192,7 +1192,6 @@ private void setIncludeJSON(JSONObject mainJson, ResultCallBack callBack){
             if(objectUidForOnly!= null && objectUidForOnly.length() > 0){
                 mainJson.put("only[BASE][]", objectUidForOnly);
                 objectUidForOnly = null;
-
             }
 
             if(objectUidForExcept != null && objectUidForExcept.length() > 0){
@@ -1332,4 +1331,29 @@ public Entry includeReferenceContentTypeUID(){
     }
 
 
+    /**
+     * Include Content Type of all returned objects along with objects themselves.
+     * @return {@link Entry} object, so you can chain this call.
+     * <br><br><b>Example :</b><br>
+     * <pre class="prettyprint">
+     *     //'blt5d4sample2633b' is a dummy Stack API key
+     *     //'blt6d0240b5sample254090d' is dummy access token.
+     *     Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
+     *     final Entry entry = stack.contentType("user").entry("blt3b0aaebf6f1c3762");
+     *     entry.includeContentType();
+     * </pre>
+     */
+    public Entry includeContentType(){
+        try {
+            if (otherPostJSON.has("include_schema")){
+                otherPostJSON.remove("include_schema");
+            }
+            otherPostJSON.put("include_content_type",true);
+            otherPostJSON.put("include_global_field_schema",true);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+        return this;
+    }
+
 }

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

@@ -1093,6 +1093,7 @@ public Query includeContentType(){
                 urlQueries.remove("include_schema");
             }
             urlQueries.put("include_content_type",true);
+            urlQueries.put("include_global_field_schema",true);
         } catch (Exception e) {
             throwException("include_content_type", CSAppConstants.ErrorMessage_QueryFilterException, e);
         }
@@ -1875,28 +1876,32 @@ public Query includeReferenceContentTypUid(){
 
 
     /**
-     * Get entries having values based on referenced fields. This query retrieves all entries that satisfy the query conditions made on referenced fields.
+     *
+     * Get entries having values based on referenced fields.
+     * This query retrieves all entries that satisfy the query conditions made on referenced fields.
      * @param key The key to be constrained
-     * @return {@link Query} object, so you can chain this call.
+     * @param queryObject {@link Query} object, so you can chain this call
+     * @return {@link Query} object, so you can chain this call
      *
      * <br><br><b>Example :</b><br>
      * <pre class="prettyprint">
      *     //'blt5d4sample2633b' is a dummy Stack API key
      *     //'blt6d0240b5sample254090d' is dummy access token.
      *     Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
      *     Query csQuery = stack.contentType("contentType_name").query();
-     *     csQuery.whereIn("due_date");
+     *     csQuery.whereIn("due_date", csQuery);
      * </pre>
+
+
      */
-    public Query whereIn(String key){
+    public Query whereIn(String key, Query queryObject){
 
         if(key != null){
 
             try{
 
                 JSONObject inQueryObj = new JSONObject();
-                inQueryObj.put("$in_query", queryValueJSON);
-                queryValueJSON = new JSONObject();
+                inQueryObj.put("$in_query", queryObject.queryValueJSON.toString());
                 queryValueJSON.put(key, inQueryObj);
             }catch(Exception e){
                 throwException("in_query",CSAppConstants.ErrorMessage_QueryFilterException, e);
@@ -1912,25 +1917,24 @@ public Query whereIn(String key){
     /**
      * Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.
      * @param key The key to be constrained
-     * @return {@link Query} object, so you can chain this call.
+     * @param queryObject {@link Query} object, so you can chain this call
+     * @return {@link Query} object, so you can chain this call
      *
      * <br><br><b>Example :</b><br>
      * <pre class="prettyprint">
      *     //'blt5d4sample2633b' is a dummy Stack API key
      *     //'blt6d0240b5sample254090d' is dummy access token.
      *     Stack stack = Contentstack.stack(context, "blt5d4sample2633b", "blt6d0240b5sample254090d", "stag", false);
      *     Query csQuery = stack.contentType("contentType_name").query();
-     *     csQuery.whereNotIn("due_date");
+     *     csQuery.whereNotIn("due_date", csQuery);
      * </pre>
      */
-    public Query whereNotIn(String key){
+    public Query whereNotIn(String key, Query queryObject){
 
         if(key != null){
-
             try{
                 JSONObject inQueryObj = new JSONObject();
-                inQueryObj.put("$nin_query", queryValueJSON);
-                queryValueJSON = new JSONObject();
+                inQueryObj.put("$nin_query", queryObject.queryValueJSON.toString());
                 queryValueJSON.put(key, inQueryObj);
             }catch(Exception e){
                 throwException("nin_query",CSAppConstants.ErrorMessage_QueryFilterException, e);

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

@@ -1,13 +1,11 @@
 package com.contentstack.sdk;
-
 import com.contentstack.sdk.utility.CSAppConstants;
 import com.contentstack.sdk.utility.CSController;
 import org.apache.log4j.Level;
 import org.apache.log4j.LogManager;
 import org.apache.log4j.Logger;
 import org.json.JSONException;
 import org.json.JSONObject;
-
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.text.DateFormat;
@@ -235,33 +233,49 @@ private String getImageUrl() {
 
 
     /**
+     * @param params query parameters
      * @param callback ContentTypesCallback
      * This call returns comprehensive information of all the content types available in a particular stack in your account.
      *
      *  <br><br><b>Example :</b><br>
      *  <pre class="prettyprint">
+     *
+     * JSONObject params = new JSONObject();
+     * params.put("include_snippet_schema", true);
+     * params.put("limit", 3);
      * stack.getContentTypes(new ContentTypesCallback() {
      * public void onCompletion(ContentTypesModel contentTypesModel, Error error) {
-     * Stack.log(TAG,"contentTypesModel: "+ contentTypesModel.getResponseJSON());
-     * include_count = contentTypesModel.getCount();
-     *
+     *  if (error == null){
+     *     // do your stuff.
+     *  }
      * }
      * });
      *</pre>
      */
 
-    public void getContentTypes( final ContentTypesCallback callback) {
+    public void getContentTypes(JSONObject params, final ContentTypesCallback callback) {
 
         try {
-            String URL = "/" + this.VERSION + "/content_types/";
+            String URL = "/" + this.VERSION + "/content_types";
             HashMap<String, Object> headers = getHeader(localHeader);
-            JSONObject content_type_param = new JSONObject();
+            if (params == null){ params = new JSONObject(); }
+
+            Iterator keys = params.keys();
+            while(keys.hasNext()) {
+                // loop to get the dynamic key
+                String key = (String)keys.next();
+                // get the value of the dynamic key
+                Object value = params.opt(key);
+                // do something here with the value...
+                params.put(key, value);
+            }
+
             if (headers.containsKey("environment")) {
-                content_type_param.put("environment", headers.get("environment"));
-                content_type_param.put("include_count", true);
+                params.put("environment", headers.get("environment"));
+                params.put("include_count", true);
             }
 
-            fetchContentTypes(URL, content_type_param, headers, callback );
+            fetchContentTypes(URL, params, headers, callback );
 
         }catch (Exception e){