GUAC-932: Refactor existing REST service JS into single 'rest' module.

guacamole/src/main/webapp/app/rest/services/connectionService.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright (C) 2014 Glyptodon LLC
+ *
+ * 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.
+ */
+
+/**
+ * Service for operating on connections via the REST API.
+ */
+angular.module('rest').factory('connectionService', ['$http', 'authenticationService',
+        function connectionService($http, authenticationService) {
+            
+    var service = {};
+    
+    /**
+     * Makes a request to the REST API to get a single connection, returning a
+     * promise that provides the corresponding @link{Connection} if successful.
+     * 
+     * @param {String} id The ID of the connection.
+     * @returns {Promise.<Connection>}
+     *     A promise which will resolve with a @link{Connection} upon success.
+     * 
+     * @example
+     * 
+     * connectionService.getConnection('myConnection').success(function(connection) {
+     *     // Do something with the connection
+     * });
+     */
+    service.getConnection = function getConnection(id) {
+        return $http.get("api/connection/" + id + "?token=" + authenticationService.getCurrentToken());
+    };
+
+    /**
+     * Makes a request to the REST API to get the list of connections,
+     * returning a promise that can be used for processing the results of the
+     * call.
+     * 
+     * @param {string} parentID The parent ID for the connection.
+     *                          If not passed in, it will query a list of the 
+     *                          connections in the root group.
+     *                          
+     * @returns {Promise.<Connection[]>}
+     *     A promise which will resolve with an array of @link{Connection}
+     *     objects upon success.
+     */
+    service.getConnections = function getConnections(parentID) {
+        
+        var parentIDParam = "";
+        if(parentID !== undefined)
+            parentIDParam = "&parentID=" + parentID;
+        
+        return $http.get("api/connection?token=" + authenticationService.getCurrentToken() + parentIDParam);
+    };
+    
+    /**
+     * Makes a request to the REST API to save a connection, returning a
+     * promise that can be used for processing the results of the call.
+     * 
+     * @param {Connection} connection The connection to update
+     *                          
+     * @returns {Promise}
+     *     A promise for the HTTP call which will succeed if and only if the
+     *     save operation is successful.
+     */
+    service.saveConnection = function saveConnection(connection) {
+        
+        /*
+         * FIXME: This should not be necessary. Perhaps the need for this is a
+         * sign that history should be queried separately, and not reside as
+         * part of the connection object?
+         */
+        // Do not try to save the connection history records
+        var connectionToSave = angular.copy(connection);
+        delete connectionToSave.history;
+        
+        // This is a new connection
+        if(!connectionToSave.identifier) {
+            return $http.post("api/connection/?token=" + authenticationService.getCurrentToken(), connectionToSave).success(
+                function setConnectionID(connectionID){
+                    // Set the identifier on the new connection
+                    connection.identifier = connectionID; // FIXME: Functions with side effects = bad
+                    return connectionID; // FIXME: Why? Where does this value go?
+                });
+        } else {
+            return $http.post(
+                "api/connection/" + connectionToSave.identifier + 
+                "?token=" + authenticationService.getCurrentToken(), 
+            connectionToSave);
+        }
+    };
+    
+    /**
+     * FIXME: Why is this different from save?
+     * 
+     * Makes a request to the REST API to move a connection to a different
+     * group, returning a promise that can be used for processing the results
+     * of the call.
+     * 
+     * @param {Connection} connection The connection to move. 
+     *                          
+     * @returns {Promise}
+     *     A promise for the HTTP call which will succeed if and only if the
+     *     move operation is successful.
+     */
+    service.moveConnection = function moveConnection(connection) {
+        
+        return $http.put(
+            "api/connection/" + connection.identifier + 
+            "?token=" + authenticationService.getCurrentToken() + 
+            "&parentID=" + connection.parentIdentifier, 
+        connection);
+        
+    };
+    
+    /**
+     * Makes a request to the REST API to delete a connection,
+     * returning a promise that can be used for processing the results of the call.
+     * 
+     * @param {Connection} connection The connection to delete
+     *                          
+     * @returns {Promise}
+     *     A promise for the HTTP call which will succeed if and only if the
+     *     delete operation is successful.
+     */
+    service.deleteConnection = function deleteConnection(connection) {
+        return $http['delete'](
+            "api/connection/" + connection.identifier + 
+            "?token=" + authenticationService.getCurrentToken());
+    };
+    
+    return service;
+}]);