Merge pull request #17 from contentstack/dev

🎉 stacks and assets

Author: ishaileshmishra

pom.xml

@@ -256,8 +256,16 @@
                     <source>8</source>
                     <target>8</target>
                     <compilerArgument>-Xlint:all</compilerArgument>
-                    <showWarnings>true</showWarnings>
                     <showDeprecation>true</showDeprecation>
+                    <showWarnings>true</showWarnings>
+                    <compilerArgs>
+                        <!-- We turn off:
+                            - `serial` because we don't use Java serialization
+                              (and all it does is stupidly complain about the serialVersionUID)
+                            - `processing` because it complains about every annotation
+                        -->
+                        <arg>-Xlint:all,-serial,-processing</arg>
+                    </compilerArgs>
                 </configuration>
             </plugin>
             <plugin>
@@ -287,7 +295,22 @@
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
                 <version>${jococo-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>generate-code-coverage-report</id>
+                        <phase>test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
             </plugin>
+
         </plugins>
 
         <pluginManagement>

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

@@ -282,7 +282,7 @@ public Organization organization() {
      * <pre>
      * Contentstack contentstack = new Contentstack.Builder().build();
      * Organization org = contentstack.organization();
-     *     </pre>
+     *  </pre>
      */
     public Organization organization(@NotNull String organizationUid) {
         if (this.authtoken == null)
@@ -309,7 +309,7 @@ public Organization organization(@NotNull String organizationUid) {
     public Stack stack() {
         if (this.authtoken == null)
             throw new IllegalStateException(ILLEGAL_USER);
-        return new Stack(this.instance, this.authtoken);
+        return new Stack(this.instance);
     }
 
 
@@ -321,10 +321,8 @@ public Stack stack() {
      * <b> Example </b>
      *
      * <pre>
-     * ```
      * Contentstack client = new Contentstack.Builder().build();
      * Stack org = client.stack();
-     * ```
      * </pre>
      *
      * @param header

src/main/java/com/contentstack/cms/stack/Asset.java

@@ -30,19 +30,19 @@ public class Asset {
     private final Retrofit instance;
     private String assetUid;
 
-    protected Asset(Retrofit instance) {
+    protected Asset(Retrofit instance, Map<String, Object> header) {
         this.headers = new HashMap<>();
-        this.headers.put("Content-Type", "application/json");
+        this.headers.putAll(header);
         this.params = new HashMap<>();
         this.instance = instance;
         this.service = instance.create(AssetService.class);
     }
 
-    protected Asset(Retrofit instance, String uid) {
+    protected Asset(Retrofit instance, Map<String, Object> header, String uid) {
         this.instance = instance;
         this.assetUid = uid;
         this.headers = new HashMap<>();
-        this.headers.put("Content-Type", "application/json");
+        this.headers.putAll(header);
         this.params = new HashMap<>();
         this.service = instance.create(AssetService.class);
     }
@@ -99,6 +99,7 @@ protected void clearParams() {
 
     /**
      * Gets folder instance
+     *
      * @return Folder
      */
     public Folder folder() {
@@ -107,6 +108,7 @@ public Folder folder() {
 
     /**
      * Gets folder instance
+     *
      * @param folderUid
      *         The UID of the folder that you want to either update or move
      * @return Folder
@@ -258,17 +260,18 @@ public Call<ResponseBody> subfolder(
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0<br>
      */
-    public Call<ResponseBody> uploadAsset(@NotNull String filePath, @NotNull RequestBody requestBody) {
+    public Call<ResponseBody> uploadAsset(@NotNull String filePath, String description) {
+        RequestBody body = RequestBody.create(MediaType.parse("multipart/form-data"), description);
         MultipartBody.Part assetPath = uploadFile(filePath);
-        return this.service.uploadAsset(this.headers, assetPath, requestBody, this.params);
+        return this.service.uploadAsset(this.headers, assetPath, body, this.params);
     }
 
     private MultipartBody.Part uploadFile(@NotNull String filePath) {
         if (!filePath.isEmpty()) {
             File file = new File(filePath);
             if (file.exists()) {
-                RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), file);
-                return MultipartBody.Part.createFormData("asset[upload]", file.getName(), requestFile);
+                RequestBody body = RequestBody.create(MediaType.parse("multipart/form-data"), file);
+                return MultipartBody.Part.createFormData("asset[upload]", file.getName(), body);
             }
         }
         return null;
@@ -291,9 +294,43 @@ private MultipartBody.Part uploadFile(@NotNull String filePath) {
      * @see #addParam(String, Object) to add query params
      * @since 1.0.0<br>
      */
-    public Call<ResponseBody> replace() {
+    public Call<ResponseBody> replace(@NotNull String filePath, @NotNull String description) {
         this.validate();
-        return this.service.replace(this.headers, this.assetUid, this.params);
+        MultipartBody.Part assetPath = uploadFile(filePath);
+//        if (this.headers.containsKey(Util.CONTENT_TYPE)) {
+//            this.headers.remove(Util.CONTENT_TYPE);
+//            this.headers.put(Util.CONTENT_TYPE, "multipart/form-data");
+//        }
+
+        RequestBody body = RequestBody.create(MediaType.parse(String.valueOf(MultipartBody.FORM)), description);
+        return this.service.replace(this.headers, this.assetUid, assetPath, body, this.params);
+    }
+
+    /**
+     * It helps to replace data with custom file title, file description and path
+     *
+     * @param filePath
+     *         The filePath of the payload
+     * @param fileTitle
+     *         Title of the payload
+     * @param fileDescription
+     *         Description of the payload
+     * @return RequestBody
+     */
+    private RequestBody createPayload(@NotNull String filePath, String fileTitle, String fileDescription) {
+        if (!filePath.isEmpty()) {
+            File file = new File(filePath);
+            if (file.exists()) {
+                fileTitle = (fileTitle != null) ? fileTitle : file.getName();
+                return new MultipartBody.Builder().setType(MultipartBody.FORM)
+                        .addFormDataPart("asset[upload]", file.getName(),
+                                RequestBody.create(MediaType.parse("application/octet-stream"), file))
+                        .addFormDataPart("asset[title]", fileTitle)
+                        .addFormDataPart("asset[description]", fileDescription).build();
+            }
+            return null;
+        }
+        return null;
     }
 
     /**

src/main/java/com/contentstack/cms/stack/AssetService.java

@@ -40,10 +40,13 @@ Call<ResponseBody> uploadAsset(
             @Part("asset[description]") RequestBody description,
             @QueryMap(encoded = true) Map<String, Object> query);
 
+    @Multipart
     @PUT("assets/{asset_uid}")
     Call<ResponseBody> replace(
             @HeaderMap Map<String, Object> headers,
             @Path("asset_uid") String uid,
+            @Part MultipartBody.Part file,
+            @Part("asset[description]") RequestBody description,
             @QueryMap(encoded = true) Map<String, Object> query);
 
     @PUT("assets/{asset_uid}")
@@ -65,8 +68,9 @@ Call<ResponseBody> delete(
             @Path("asset_uid") String uid);
 
     @GET("assets/rt")
-    Call<ResponseBody> rteInfo(@HeaderMap Map<String, Object> headers,
-                               @QueryMap(encoded = true) Map<String, Object> query);
+    Call<ResponseBody> rteInfo(
+            @HeaderMap Map<String, Object> headers,
+            @QueryMap(encoded = true) Map<String, Object> query);
 
     @POST("assets/{asset_uid}/versions/{version_number}/name")
     Call<ResponseBody> setVersionName(

src/main/java/com/contentstack/cms/stack/Stack.java

@@ -1,6 +1,5 @@
 package com.contentstack.cms.stack;
 
-import com.contentstack.cms.core.Util;
 import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
@@ -31,12 +30,9 @@ public class Stack {
      *
      * @param client
      *         the Retrofit instance
-     * @param authtoken
-     *         The authtoken
      */
-    public Stack(@NotNull Retrofit client, String authtoken) {
+    public Stack(@NotNull Retrofit client) {
         this.headers = new HashMap<>();
-        this.headers.put("authtoken", authtoken);
         this.client = client;
         this.params = new HashMap<>();
         this.service = client.create(StackService.class);
@@ -151,11 +147,72 @@ public ContentType contentType(@NotNull String contentTypeUid) {
      * repository for future use.
      * <p>
      * These files can be attached and used in multiple entries.
+     * <ul>
+     *     <li>
+     *     folder(optional)
+     * Enter either the UID of a specific folder to get the assets of that folder, or enter ‘cs_root’ to get all assets and their folder details from the root folder.
+     * <p>
+     * Example:bltd899999999
+     * </li>
+     * <li>
+     * include_folders(optional)
+     * Set this parameter to ‘true’ to include the details of the created folders along with the details of the assets.
+     * <p>
+     * Example:true
+     * </li>
+     * <li>
+     * environment(optional)
+     * Enter the name of the environment to retrieve the assets published on them. You can enter multiple environments.
+     * <p>
+     * Example:production
+     * </li>
+     * <li>
+     * version(optional)
+     * Specify the version number of the asset that you want to retrieve. If the version is not specified, the details of the latest version will be retrieved.
+     * <p>
+     * Example:1
+     * </li>
+     *  <li>
+     * include_publish_details(optional)
+     * Enter 'true' to include the publish details of the entry.
+     * <p>
+     * Example:true
+     * </li>
+     *  <li>
+     * include_count(optional)
+     * Set this parameter to 'true' to include the total number of assets available in your stack in the response body.
+     * <p>
+     * Example:false
+     * </li>
+     *  <li>
+     * relative_urls(optional)
+     * Set this to 'true' to display the relative URL of the asset.
+     * <p>
+     * Example:false
+     * </li>
+     *        <li>
+     * asc_field_uid(optional)
+     * Enter the unique ID of the field for sorting the assets in ascending order by that field.
+     * <p>
+     * Example:created_at
+     * </li>
+     *        <li>
+     * desc_field_uid(optional)
+     * Enter the unique ID of the field for sorting the assets in descending order by that field.
+     * <p>
+     * Example:file_size
+     * </li>
+     *        <li>
+     * include_branch(optional)
+     * Set this to 'true' to include the <b>_branch</b> top-level key in the response. This key states the unique ID of the branch where the concerned Contentstack module resides.
+     * <p>
+     * Example:false
+     * </ul>
      *
      * @return Asset
      */
     public Asset asset() {
-        return new Asset(this.client);
+        return new Asset(this.client, this.headers);
     }
 
     /**
@@ -164,11 +221,72 @@ public Asset asset() {
      * repository for future use.
      * <p>
      * These files can be attached and used in multiple entries.
+     * <ul>
+     *     <li>
+     *     folder(optional)
+     * Enter either the UID of a specific folder to get the assets of that folder, or enter ‘cs_root’ to get all assets and their folder details from the root folder.
+     * <p>
+     * Example:bltd899999999
+     * </li>
+     * <li>
+     * include_folders(optional)
+     * Set this parameter to ‘true’ to include the details of the created folders along with the details of the assets.
+     * <p>
+     * Example:true
+     * </li>
+     * <li>
+     * environment(optional)
+     * Enter the name of the environment to retrieve the assets published on them. You can enter multiple environments.
+     * <p>
+     * Example:production
+     * </li>
+     * <li>
+     * version(optional)
+     * Specify the version number of the asset that you want to retrieve. If the version is not specified, the details of the latest version will be retrieved.
+     * <p>
+     * Example:1
+     * </li>
+     *  <li>
+     * include_publish_details(optional)
+     * Enter 'true' to include the publish details of the entry.
+     * <p>
+     * Example:true
+     * </li>
+     *  <li>
+     * include_count(optional)
+     * Set this parameter to 'true' to include the total number of assets available in your stack in the response body.
+     * <p>
+     * Example:false
+     * </li>
+     *  <li>
+     * relative_urls(optional)
+     * Set this to 'true' to display the relative URL of the asset.
+     * <p>
+     * Example:false
+     * </li>
+     *        <li>
+     * asc_field_uid(optional)
+     * Enter the unique ID of the field for sorting the assets in ascending order by that field.
+     * <p>
+     * Example:created_at
+     * </li>
+     *        <li>
+     * desc_field_uid(optional)
+     * Enter the unique ID of the field for sorting the assets in descending order by that field.
+     * <p>
+     * Example:file_size
+     * </li>
+     *        <li>
+     * include_branch(optional)
+     * Set this to 'true' to include the <b>_branch</b> top-level key in the response. This key states the unique ID of the branch where the concerned Contentstack module resides.
+     * <p>
+     * Example:false
+     * </ul>
      *
      * @return Asset
      */
     public Asset asset(String assetUid) {
-        return new Asset(this.client, assetUid);
+        return new Asset(this.client, this.headers, assetUid);
     }
 
 
@@ -697,17 +815,19 @@ public Call<ResponseBody> transferOwnership(@NotNull JSONObject body) {
      * <a href=
      * "https://www.contentstack.com/docs/developers/apis/content-management-api/#transfer-stack-ownership-to-other-users">
      * (Read more) </a>
+     * <br>
+     * <b>uid</b> and <b>api_key</b> is required to get the acceptOwnership information
+     * <ul>
+     *     <li> To Accept stack owned by other user, user {@link #addParam(String, Object)} to add query parameters </li>
+     *     <li> To Add Header use {@link #addHeader(String, Object)} </li>
+     * </ul>
      *
      * @param ownershipToken
      *         the ownership token received via email by another user.
-     * @param uid
-     *         the user uid.
      * @return the stack
      */
     public Call<ResponseBody> acceptOwnership(
-            @NotNull String ownershipToken, @NotNull String uid) {
-        this.params.put("api_key", this.headers.get(Util.API_KEY));
-        this.params.put("uid", uid);
+            @NotNull String ownershipToken) {
         return service.acceptOwnership(this.headers, ownershipToken, this.params);
     }