Refactor: naming, removed useless prefix

mkbrv · Mar 21, 2016 · cffe421 · cffe421
1 parent 66bf413
commit cffe421
Show file tree

Hide file tree

Showing 51 changed files with 505 additions and 442 deletions.
diff --git a/cloud/pom.xml b/cloud/pom.xml
@@ -35,6 +35,13 @@
             <artifactId>junit5-api</artifactId>
             <scope>test</scope>
         </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>

diff --git a/cloud/src/main/java/com/mkbrv/orange/cloud/OrangeCloudFilesAPI.java b/cloud/src/main/java/com/mkbrv/orange/cloud/OrangeCloudFilesAPI.java
@@ -1,9 +1,9 @@
 package com.mkbrv.orange.cloud;
 
-import com.mkbrv.orange.client.security.OrangeAccessToken;
+import com.mkbrv.orange.httpclient.security.OrangeAccessToken;
 import com.mkbrv.orange.cloud.model.OrangeFile;
 import com.mkbrv.orange.cloud.model.folder.DefaultOrangeFolder;
-import com.mkbrv.orange.cloud.response.OrangeGenericResponse;
+import com.mkbrv.orange.cloud.response.GenericResponse;
 
 import java.io.File;
 
@@ -19,7 +19,7 @@ public interface OrangeCloudFilesAPI {
      * @param file         file to be uploaded
      * @return
      */
-    OrangeGenericResponse uploadFile(final OrangeAccessToken orangeAccessToken,
+    OrangeFile uploadFile(final OrangeAccessToken orangeAccessToken,
                                      final DefaultOrangeFolder orangeFolder, final File file);
 
     /**
@@ -43,6 +43,6 @@ OrangeGenericResponse uploadFile(final OrangeAccessToken orangeAccessToken,
      * @param orangeFile
      * @return
      */
-    OrangeGenericResponse deleteFile(final OrangeAccessToken orangeAccessToken, final OrangeFile orangeFile);
+    GenericResponse deleteFile(final OrangeAccessToken orangeAccessToken, final OrangeFile orangeFile);
 
 }
diff --git a/cloud/src/main/java/com/mkbrv/orange/cloud/OrangeCloudFoldersAPI.java b/cloud/src/main/java/com/mkbrv/orange/cloud/OrangeCloudFoldersAPI.java
@@ -1,13 +1,11 @@
 package com.mkbrv.orange.cloud;
 
 import com.google.gson.JsonDeserializer;
-import com.mkbrv.orange.client.security.OrangeAccessToken;
+import com.mkbrv.orange.httpclient.security.OrangeAccessToken;
 import com.mkbrv.orange.cloud.model.OrangeFolder;
 import com.mkbrv.orange.cloud.model.freespace.OrangeFreeSpace;
-import com.mkbrv.orange.cloud.request.OrangeFolderFilterParams;
-import com.mkbrv.orange.cloud.request.OrangeFolderRequestParams;
-import com.mkbrv.orange.cloud.response.OrangeGenericResponse;
-
+import com.mkbrv.orange.cloud.request.OptionalFolderParams;
+import com.mkbrv.orange.cloud.response.GenericResponse;
 import java.lang.reflect.Type;
 import java.util.Map;
 
@@ -31,47 +29,71 @@ public interface OrangeCloudFoldersAPI {
      * Orange Cloud API: GET /folders
      *
      * @param orangeAccessToken        Users Access Token used to validate his session;
-     * @param orangeFolderFilterParams Parameters which specify how the data should be returned;
-     * @return OrangeFolder root folder of the user with specifications described in the orangeFolderFilterParams
+     * @param optionalFolderParams Parameters which specify how the data should be returned;
+     * @return OrangeFolder root folder of the user with specifications described in the optionalFolderParams
      */
     OrangeFolder getRootFolder(final OrangeAccessToken orangeAccessToken,
-                               final OrangeFolderFilterParams orangeFolderFilterParams);
+                               final OptionalFolderParams optionalFolderParams);
 
     /**
      * @param orangeAccessToken        Users Access Token used to validate his session;
      * @param orangeFolder             Contains the id of the folder which is required
-     * @param orangeFolderFilterParams Parameters which specify how the data should be returned;
+     * @param optionalFolderParams Parameters which specify how the data should be returned;
      * @return OrangeFolder returned folder
      * Will return null if not found;
      */
     OrangeFolder getFolder(final OrangeAccessToken orangeAccessToken,
-                           final OrangeFolder orangeFolder, final OrangeFolderFilterParams orangeFolderFilterParams);
+                           final OrangeFolder orangeFolder, final OptionalFolderParams optionalFolderParams);
 
     /**
      * @param orangeAccessToken Users Access Token used to validate his session;
      * @param orangeFolder      Contains the name of the created folder and his parent id
      * @return OrangeFolder created folder
      */
-    OrangeFolder createFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolderRequestParams orangeFolder);
+    OrangeFolder createFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder);
 
     /**
      * Rename, move or copy a folder. To rename a folder, use the 'name' attribute. To move a folder,
      * use the 'parentFolderId'. To copy a folder, use both 'parentFolderId' and 'clone' (set to true).
      *
      * @param orangeAccessToken Users Access Token used to validate his session;
      * @param orangeFolder      Folder to update
+     * @param newName           new name for the folder
      * @return OrangeFolder Updated Folder
      */
-    OrangeFolder updateFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder,
-                              final OrangeFolderRequestParams orangeFolderRequestParams);
+    OrangeFolder renameFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder,
+                              final String newName);
+
+
+    /**
+     * Copies the folder to a new folder while maintaining the original
+     *
+     * @param orangeAccessToken Users Access Token used to validate his session;
+     * @param orangeFolder      folder to be cloned (copied)
+     * @param newParentFolder   parent of the new folder after copy
+     * @return the new folder after it was cloned
+     */
+    OrangeFolder copyFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder,
+                            final OrangeFolder newParentFolder);
+
+    /**
+     * Clones the folder into a new parent folder;
+     *
+     * @param orangeAccessToken Users Access Token used to validate his session;
+     * @param orangeFolder      folder to be moved
+     * @param newParentFolder   new parent folder
+     * @return the new folder after being moved
+     */
+    OrangeFolder moveFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder,
+                            final OrangeFolder newParentFolder);
 
 
     /**
      * @param orangeAccessToken Users Access Token used to validate his session;
      * @param orangeFolder      Folder to be removed
-     * @return OrangeGenericResponse
+     * @return GenericResponse
      */
-    OrangeGenericResponse deleteFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder);
+    GenericResponse deleteFolder(final OrangeAccessToken orangeAccessToken, final OrangeFolder orangeFolder);
 
 
     /**
@@ -92,6 +114,8 @@ class Constants {
         public static final String LIMIT = "limit";
         public static final String OFFSET = "offset";
 
+        public static final String FREESPACE = "freespace";
+
         public static final Integer ORANGE_DELETE_OK_STATUS = 204;
 
     }

diff --git a/...ud/model/file/OrangeFileDeserializer.java → ...ge/cloud/model/file/FileDeserializer.java b/...ud/model/file/OrangeFileDeserializer.java → ...ge/cloud/model/file/FileDeserializer.java
@@ -6,19 +6,19 @@
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParseException;
 import com.mkbrv.orange.cloud.model.OrangeFile;
+import com.mkbrv.orange.cloud.util.JsonTranslator;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.lang.reflect.Type;
-import java.util.Date;
 
 /**
  * Deserializer for an Orange File;
  * Created by mkbrv on 26/02/16.
  */
-public class OrangeFileDeserializer implements JsonDeserializer<OrangeFile> {
+public class FileDeserializer implements JsonDeserializer<OrangeFile>, JsonTranslator {
 
-    private final Logger LOG = LoggerFactory.getLogger(OrangeFileDeserializer.class);
+    private final Logger LOG = LoggerFactory.getLogger(FileDeserializer.class);
 
     public static class Params {
         public static final String NAME = "name";
@@ -81,20 +81,6 @@ private OrangeFileMetadata getMetaData(final JsonObject jsonObject) {
         return orangeFileMetadata;
     }
 
-    /**
-     * Prevents NPE from the json deserializer
-     *
-     * @param key
-     * @param jsonObject
-     * @return
-     */
-    private String notNull(final String key, final JsonObject jsonObject) {
-        if (jsonObject.has(key)) {
-            return jsonObject.get(key).getAsString();
-        }
-        return null;
-    }
-
 
     /**
      * @param key
@@ -107,15 +93,4 @@ private void addMetaData(final String key, final JsonObject jsonObject, final Or
         }
     }
 
-
-    /**
-     * @param date
-     * @return
-     */
-    private Date parseDate(final JsonElement date, final JsonDeserializationContext jsonDeserializationContext) {
-        if (date == null) {
-            return null;
-        }
-        return jsonDeserializationContext.deserialize(date, Date.class);
-    }
 }
diff --git a/...odel/folder/OrangeFolderDeserializer.java → ...loud/model/folder/FolderDeserializer.java b/...odel/folder/OrangeFolderDeserializer.java → ...loud/model/folder/FolderDeserializer.java
@@ -7,13 +7,14 @@
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParseException;
 import com.mkbrv.orange.cloud.model.OrangeFile;
+import com.mkbrv.orange.cloud.util.JsonTranslator;
 
 import java.lang.reflect.Type;
 
 /**
  * Created by mkbrv on 26/02/16.
  */
-public class OrangeFolderDeserializer implements JsonDeserializer<DefaultOrangeFolder> {
+public class FolderDeserializer implements JsonDeserializer<DefaultOrangeFolder>, JsonTranslator {
 
     public static class Params {
         public static final String NAME = "name";

diff --git a/cloud/src/main/java/com/mkbrv/orange/cloud/model/folder/FolderSerializer.java b/cloud/src/main/java/com/mkbrv/orange/cloud/model/folder/FolderSerializer.java
@@ -0,0 +1,34 @@
+package com.mkbrv.orange.cloud.model.folder;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonSerializationContext;
+import com.google.gson.JsonSerializer;
+import com.mkbrv.orange.cloud.model.OrangeFolder;
+import com.mkbrv.orange.cloud.util.JsonTranslator;
+
+import java.lang.reflect.Type;
+
+/**
+ * Currently used only for create folder
+ * Created by mkbrv on 16/03/16.
+ */
+public class FolderSerializer implements JsonSerializer<OrangeFolder>, JsonTranslator {
+
+    public static class Params {
+        public static final String PARENT_FOLDER_ID = "parentFolderId";
+        public static final String NAME = "name";
+
+    }
+
+
+    @Override
+    public JsonElement serialize(final OrangeFolder orangeFolder,
+                                 final Type type,
+                                 final JsonSerializationContext jsonSerializationContext) {
+        JsonObject jsonElement = new JsonObject();
+        this.addStringParamIfNotNull(jsonElement, Params.PARENT_FOLDER_ID, orangeFolder.getParentFolderId());
+        this.addStringParamIfNotNull(jsonElement, Params.NAME, orangeFolder.getParentFolderId());
+        return jsonElement;
+    }
+}
diff --git a/...reespace/OrangeFreeSpaceDeserializer.java → ...odel/freespace/FreeSpaceDeserializer.java b/...reespace/OrangeFreeSpaceDeserializer.java → ...odel/freespace/FreeSpaceDeserializer.java
@@ -5,13 +5,14 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParseException;
+import com.mkbrv.orange.cloud.util.JsonTranslator;
 
 import java.lang.reflect.Type;
 
 /**
  * Created by mkbrv on 20/02/16.
  */
-public class OrangeFreeSpaceDeserializer implements JsonDeserializer<OrangeFreeSpace> {
+public class FreeSpaceDeserializer implements JsonDeserializer<OrangeFreeSpace>, JsonTranslator {
 
     public static class Params {
         public static final String FREESPACE = "freespace";

diff --git a/cloud/src/main/java/com/mkbrv/orange/cloud/model/freespace/OrangeFreeSpace.java b/cloud/src/main/java/com/mkbrv/orange/cloud/model/freespace/OrangeFreeSpace.java
@@ -7,7 +7,7 @@ public class OrangeFreeSpace {
 
     private final Long availableSpace;
 
-    public OrangeFreeSpace(Long availableSpace) {
+    public OrangeFreeSpace(final Long availableSpace) {
         this.availableSpace = availableSpace;
     }
 
@@ -30,7 +30,6 @@ public boolean equals(Object o) {
         OrangeFreeSpace that = (OrangeFreeSpace) o;
 
         return availableSpace.equals(that.availableSpace);
-
     }
 
     @Override

diff --git a/...oud/request/OrangeFolderFilterParams.java → ...e/cloud/request/OptionalFolderParams.java b/...oud/request/OrangeFolderFilterParams.java → ...e/cloud/request/OptionalFolderParams.java
@@ -6,7 +6,7 @@
  * Optional parameters for the folder request;
  * Created by mkbrv on 26/02/16.
  */
-public class OrangeFolderFilterParams {
+public class OptionalFolderParams {
 
     /**
      * Set this as empty string to work;
@@ -53,7 +53,7 @@ public String getRestrictedMode() {
         return restrictedMode;
     }
 
-    public OrangeFolderFilterParams setRestrictedMode(String restrictedMode) {
+    public OptionalFolderParams setRestrictedMode(String restrictedMode) {
         this.restrictedMode = restrictedMode;
         return this;
     }
@@ -62,7 +62,7 @@ public String getShowThumbnails() {
         return showThumbnails;
     }
 
-    public OrangeFolderFilterParams setShowThumbnails(String showThumbnails) {
+    public OptionalFolderParams setShowThumbnails(String showThumbnails) {
         this.showThumbnails = showThumbnails;
         return this;
     }
@@ -71,7 +71,7 @@ public OrangeFileType getFilter() {
         return filter;
     }
 
-    public OrangeFolderFilterParams setFilter(OrangeFileType filter) {
+    public OptionalFolderParams setFilter(OrangeFileType filter) {
         this.filter = filter;
         return this;
     }
@@ -80,7 +80,7 @@ public Boolean getFlat() {
         return flat;
     }
 
-    public OrangeFolderFilterParams setFlat(Boolean flat) {
+    public OptionalFolderParams setFlat(Boolean flat) {
         this.flat = flat;
         return this;
     }
@@ -89,7 +89,7 @@ public Boolean getTree() {
         return tree;
     }
 
-    public OrangeFolderFilterParams setTree(Boolean tree) {
+    public OptionalFolderParams setTree(Boolean tree) {
         this.tree = tree;
         return this;
     }
@@ -98,7 +98,7 @@ public Integer getLimit() {
         return limit;
     }
 
-    public OrangeFolderFilterParams setLimit(Integer limit) {
+    public OptionalFolderParams setLimit(Integer limit) {
         this.limit = limit;
         return this;
     }
@@ -107,7 +107,7 @@ public Integer getOffset() {
         return offset;
     }
 
-    public OrangeFolderFilterParams setOffset(Integer offset) {
+    public OptionalFolderParams setOffset(Integer offset) {
         this.offset = offset;
         return this;
     }