Return resource objects with parameters instead of an array with the name of the resource.

Author: guylabs

README.md

@@ -145,7 +145,7 @@ The `_resources` method takes the following four parameters:
 
 The `_resources` method returns the *Angular* resource "class" object with methods for the default set of resource actions. Read more [here](https://docs.angularjs.org/api/ngResource/service/$resource).
 
-If no parameter is given the `_resources` method will return all available resources on the given object. When for example the following JSON response object is given:
+If no parameter is given the `_resources` method will return all available resources objects of the given object. When for example the following JSON response object is given:
 
 ```javascript
 var response = {
@@ -165,13 +165,31 @@ var response = {
 }
 var processedResponse = new SpringDataRestAdapter(response);
 ```
-Then the following call to the `_resources` method without any parameter will return an array of all the resources available.
+Then the following call to the `_resources` method without any parameter will return an array of all available resource objects.
 
 ```javascript
 var availableResources = processedResponse._resources();
 ```
 
-The above call will result in the following return value: `['self', 'parentCategory']`. This functionality is useful if you want to first check all available resources before using the `_resources` method to retrieve the specific resource.
+The above call will result in the following return value: 
+
+```json
+[
+    {
+        "name":"self",
+        "parameters": {
+            page: undefined,
+            size: undefined,
+            sort: undefined
+        }
+    }
+    {
+        "name":"parentCategory"
+    }
+]   
+``` 
+
+This functionality is useful if you want to first check all available resources before using the `_resources` method to retrieve the specific resource.
 
 ##### Example
 

src/angular-spring-data-rest.js

@@ -117,11 +117,14 @@
                      * @param {object} paramDefaults optional $resource method parameter defaults
                      * @param {object} actions optional $resource method actions
                      * @param {object} options additional $resource method options
-                     * @returns {object|array} the result of the $resource method or the available resources as an array
+                     * @returns {object} the result of the $resource method or the available resources as a resource object array
                      *
                      * @see https://docs.angularjs.org/api/ngResource/service/$resource
                      */
                     var resources = function (resourceObject, paramDefaults, actions, options) {
+                        var resources = this[config.links.key];
+
+                        // if a resource object is given process it
                         if (angular.isObject(resourceObject)) {
                             if (!resourceObject.name) {
                                 throw new Error("The provided resource object must contain a name property.");
@@ -146,18 +149,22 @@
 
                             return callBackend(extractUrl(this, resourceObject.name), parameters, actions, options);
 
-                        } else if (resourceObject in this[config.links.key]) {
+                        } else if (resourceObject in resources) {
                             // get the url out of the resource name and return the backend function
                             return callBackend(extractUrl(this, resourceObject), paramDefaults, actions, options);
                         }
 
-                        // return the available resources if the resource object is not set
-                        var resources = [];
-                        angular.forEach(this[config.links.key], function (value, key) {
-                            resources.push(key);
+                        // return the available resources as resource object array if the resource object parameter is not set
+                        var availableResources = [];
+                        angular.forEach(resources, function (value, key) {
+                            if (value.templated) {
+                                var templateParameters = extractTemplateParameters(value[config.hrefKey]);
+                                availableResources.push({"name": key, "parameters": templateParameters});
+                            } else {
+                                availableResources.push({"name": key});
+                            }
                         });
-                        return resources;
-
+                        return availableResources;
                     };
 
                     /**
@@ -185,6 +192,27 @@
                         return url.replace(/{.*}/g, '');
                     };
 
+                    /**
+                     * Returns the template parameters of the given url as array. e.g. from this url
+                     * 'http://localhost:8080/categories{?page,size,sort}' it will return the following array:
+                     * ['page', 'size', 'sort']
+                     *
+                     * @param {string} url the url with the template parameters
+                     * @returns {object} the array containing the template parameters
+                     */
+                    var extractTemplateParameters = function (url) {
+                        var templateParametersObject = {};
+
+                        var regexp = /{\?(.*)}/g;
+                        var templateParametersArray = regexp.exec(url)[1].split(',');
+
+                        angular.forEach(templateParametersArray, function (value) {
+                            templateParametersObject[value] = undefined;
+                        });
+
+                        return templateParametersObject;
+                    };
+
                     /**
                      * The actual adapter method which processes the given JSON data object and adds
                      * the wrapped resource property to all embedded elements where resources are available.

test/angular-spring-data-rest._test-helper.js

@@ -207,3 +207,20 @@ var mockIndexData = function () {
     );
 };
 
+var mockWithoutTemplateParametersData = function () {
+    return angular.copy(
+        {
+            "_links": {
+                "users": {
+                    "href": "http://localhost:8080/users",
+                    "templated": false
+                },
+                "categories": {
+                    "href": "http://localhost:8080/categories",
+                    "templated": false
+                }
+            }
+        }
+    );
+};
+

test/angular-spring-data-rest.resource.test.js

@@ -119,7 +119,36 @@ describe("the resources property", function () {
         expect(this.response[this.config.resourcesKey]).toBeDefined();
 
         // expect that the resource method returns the available resources on the object
-        expect(this.response[this.config.resourcesKey]()).toEqual(['self']);
+        expect(this.response[this.config.resourcesKey]()).toEqual([
+                {
+                    name: 'self',
+                    parameters: {
+                        page: undefined,
+                        size: undefined,
+                        sort: undefined
+                    }
+                }
+            ]
+        );
+    });
+
+    it("must return the resources of the object with empty parameters if the templated property is false", function () {
+        this.rawResponse = mockWithoutTemplateParametersData();
+        this.response = new SpringDataRestAdapter(this.rawResponse);
+
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // expect that the resource method returns the available resources on the object
+        expect(this.response[this.config.resourcesKey]()).toEqual([
+                {
+                    name: 'users'
+                },
+                {
+                    name: 'categories'
+                }
+            ]
+        );
     });
 
     it("must return the resources of the index response", function () {
@@ -130,7 +159,33 @@ describe("the resources property", function () {
         expect(this.response[this.config.resourcesKey]).toBeDefined();
 
         // expect that the resource method returns the available resources on the index response
-        expect(this.response[this.config.resourcesKey]()).toEqual(['users', 'categories', 'accounts']);
+        expect(this.response[this.config.resourcesKey]()).toEqual([
+                {
+                    name: 'users',
+                    parameters: {
+                        page: undefined,
+                        size: undefined,
+                        sort: undefined
+                    }
+                },
+                {
+                    name: 'categories',
+                    parameters: {
+                        page: undefined,
+                        size: undefined,
+                        sort: undefined
+                    }
+                },
+                {
+                    name: 'accounts',
+                    parameters: {
+                        page: undefined,
+                        size: undefined,
+                        sort: undefined
+                    }
+                }
+            ]
+        );
     });
 
 });