Add ability to exchange underlying call to backend. Restructure source and test files. Update the package.json and bower.json. Update the grunt and the karma configs.

Author: guylabs

Gruntfile.js

@@ -4,7 +4,8 @@ module.exports = function (grunt) {
 		pkg: grunt.file.readJSON("package.json"),
         concat: {
             options: {
-                separator: '\n'
+                separator: '\n',
+                process: true
             },
             dist: {
                 src: [
@@ -13,7 +14,7 @@ module.exports = function (grunt) {
                     'src/angular-spring-data-rest-interceptor-provider.js',
                     'src/angular-spring-data-rest-utils.js',
                 ],
-                dest: 'dist/<%= pkg.name %>.<%= pkg.version %>.js'
+                dest: 'dist/<%= pkg.name %>.js'
             }
         },
 		uglify: {
@@ -22,7 +23,7 @@ module.exports = function (grunt) {
 			},
             dist: {
                 files: {
-                    'dist/<%= pkg.name %>.<%= pkg.version %>.min.js': ['<%= concat.dist.dest %>']
+                    'dist/<%= pkg.name %>.min.js': ['<%= concat.dist.dest %>']
                 }
             }
 		},

README.md

@@ -1,6 +1,6 @@
 # angular-spring-data-rest
 
-> An AngularJS module with an additional interceptor which wraps the Angular [$resource](https://docs.angularjs.org/api/ngResource/service/$resource) function and therefore eases the use with a [Spring Data REST](http://projects.spring.io/spring-data-rest) backend.
+> An AngularJS module with an additional interceptor which eases the work with a [Spring Data REST](http://projects.spring.io/spring-data-rest) backend.
 
 #Table of contents
 
@@ -9,7 +9,8 @@
     - [Usage of `SpringDataRestAdapter`](#usage-of-springdatarestadapter)
     - [Usage of `_resources` method](#usage-of-_resources-method)
         - [The `_resources` method parameters and return type](#the-_resources-method-parameters-and-return-type)
-            - [`_resources` usage example](#_resources-usage-example)
+        - [`_resources` usage example](#_resources-usage-example)
+        - [Exchange the underlying Angular `$resource` function](#exchange-the-underlying-angular-$resource-function)
     - [Usage of `_embeddedItems` property](#usage-of-_embeddeditems-property)
         - [`_embeddedItems` usage example](#_embeddeditems-usage-example)
     - [Configuration of the `SpringDataRestAdapter`](#configuration-of-the-springdatarestadapter)
@@ -81,7 +82,7 @@ This *Angular* module provides two ways of processing a response from the *Sprin
 
 The `spring-data-rest` *Angular* module provides a provider for the `SpringDataRestAdapter` object. This object is the core of the module and it processes a given response and adds the following additional properties/methods to it:
 
-1. `_resources`: this method wraps the *Angular* `$resource` function and adds an easy way to retrieve the resources defined in the `_links` property. It is also used to retrieve all available resources of the given object. Read more about this property [here](#usage-of-_resources-property).
+1. `_resources`: this method wraps the *Angular* `$resource` function by default (this is [exchangeable](#exchange-the-underlying-angular-$resource-function)) and adds an easy way to retrieve the resources defined in the `_links` property. It is also used to retrieve all available resources of the given object. Read more about this property [here](#usage-of-_resources-property).
 2. `_embeddedItems`: this property replaces the `_embedded` property and sets the named array (`categories` in the upper example response) with the embedded items as its value. Read more about this property [here](#usage-of-_embeddedItems-property).
 
 Spring Data REST also generates an index response when you make a `GET` response to the configured base url of the dispatcher servlet. This response looks like the following example:
@@ -169,7 +170,7 @@ var resourceObject = {
 processedResponse._resources(resourceObject, paramDefaults, actions, options);
 ```
 
-This will call *Angular* `$resource` method with the `href` of the `self` resource and will add the parameters `size` and `sort` as query string to the URL. If the resource object parameters and the `paramDefaults` parameters are set, then these two objects are merged such that the resource object parameters appear first in the new object and the `paramDefaults` parameters last.
+This will call *Angular* `$resource` method by default (this is [exchangeable](#exchange-the-underlying-angular-$resource-function)) with the `href` of the `self` resource and will add the parameters `size` and `sort` as query string to the URL. If the resource object parameters and the `paramDefaults` parameters are set, then these two objects are merged such that the resource object parameters appear first in the new object and the `paramDefaults` parameters last.
 
 * `paramDefaults`: the default values for url parameters. Read more  [here](https://docs.angularjs.org/api/ngResource/service/$resource).
 * `actions`: custom action that should extend the default set of the `$resource` actions. Read more [here](https://docs.angularjs.org/api/ngResource/service/$resource).
@@ -238,6 +239,26 @@ var parentCategory = parentCategoryResource.get(function() {
 });
 ```
 
+#### Exchange the underlying Angular `$resource` function
+
+If you want to exchange the underlying call to the *Angular* `$resource` method then you are able to do this within the configuration of the `SpringDataRestAdapter`. By default it will use the *Angular* `$resource` function.
+
+The following example shows how to set a custom function:
+
+```javascript
+myApp.config(function (SpringDataRestAdapterProvider) {
+
+    // set the new resource function
+    SpringDataRestAdapterProvider.config({
+        'resourcesFunction': function (url, paramDefaults, actions, options) {
+            // do the call to the backend and return your desired object
+        }
+    });
+});
+```
+
+The description of the parameters you will find [here](#the-_resources-method-parameters-and-return-type). You can also read more about the configuration of the `SpringDataRestAdapter` [here](#configuration-of-the-springdatarestadapter)
+
 ### Usage of `_embeddedItems` property
 
 The `_embeddedItems` property is just a convention property created by the `SpringDataRestAdapter` to easily iterate over the `_emebedded` items in the response. Like with the `_resources` method, the `SpringDataRestAdapter` will recursively create an `_embeddedItems` property on the same level as a `_embedded` property exists for all the JSON response properties.
@@ -267,6 +288,7 @@ The `SpringDataRestAdapter` is designed to be configurable and you are able to c
 * `embedded.value` (default: `_embeddedItems`): the property name where the array of embedded items are stored.
 * `hrefKey` (default: `href`): the property name where the url is stored under each specific link.
 * `resourcesKey` (default: `_resources`): the property name where the resource method is stored.
+* `resourcesFunction` (default: `undefined`): the function to use to call the backend. Read more how to do this [here](#exchange-the-underlying-angular-$resource-function)
 
 You are able to configure the `SpringDataRestAdapter` provider in a *Angular* configuration block in the following way:
 
@@ -294,11 +316,11 @@ The config method of the `SpringDataRestAdapterProvider` takes a configuration o
         "value': "_embeddedItems"
     },
     "hrefKey": "href",
-    "resourcesKey": "_resources"
+    "resourcesKey": "_resources",
+    "resourcesFunction": undefined
 }
 ```
 
-
 ## The `SpringDataRestInterceptor`
 
 If you want to use the `SpringDataRestAdapter` for all responses of the *Angular* `$http` service then you can add the `SpringDataRestInterceptor` to the `$httpProvider.interceptors` in an *Angular* configuration block:

RELEASENOTES.md

@@ -1,5 +1,16 @@
 # Release notes of angular-spring-data-rest
 
+## Version 0.2.0
+
+* Tag: [0.2.0](https://github.com/guylabs/angular-spring-data-rest/tree/0.2.0)
+* Release: [angular-spring-data-rest-0.2.0.zip](https://github.com/guylabs/angular-spring-data-rest/releases/download/0.2.0/angular-spring-data-rest-0.2.0.zip)
+
+### Changes
+
+* Add ability to exchange the *Angular* ``$resource`` method with an own implementation 
+* Updated source and test files structure
+* Add package to bower repository
+
 ## Version 0.1.0
 
 * Tag: [0.1.0](https://github.com/guylabs/angular-spring-data-rest/tree/0.1.0)

bower.json

@@ -1,28 +1,45 @@
 {
     "name": "angular-spring-data-rest",
-    "version": "0.1.0",
-    "authors": [
-        "Guy Brûlé <admin@guylabs.org>"
+    "description": "An AngularJS module to ease the work with a Spring Data REST backend.",
+    "main": "dist/angular-spring-data-rest.js",
+    "license": "MIT",
+    "ignore": [
+        "**/.*",
+        "node_modules",
+        "bower_components",
+        "dist",
+        ".idea",
+        "*.iml"
     ],
-    "description": "An AngularJS module for using `$resource` with a Spring Data REST backend.",
     "keywords": [
         "angular",
-        "resource",
+        "angularjs",
         "spring",
         "spring data",
         "spring data rest",
         "rest",
         "api"
     ],
-    "license": "MIT",
-    "homepage": "https://github.com/guylabs/angular-spring-data-rest",
-    "main": "src/angular-spring-data-rest.js",
-    "ignore": [
-        "**/.*",
-        "node_modules",
-        "bower_components",
-        "dist",
-        ".idea",
-        "*.iml"
-    ]
+    "authors": [
+        "Guy Brûlé <admin@guylabs.org>"
+    ],
+    "homepage": "http://guylabs.ch/project/angular-spring-data-rest",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/guylabs/angular-spring-data-rest.git"
+    },
+    "devDependencies": {
+        "grunt": "0.4.5",
+        "grunt-contrib-uglify": "0.5.1",
+        "grunt-contrib-concat": "0.5.0",
+        "grunt-karma": "0.8.3",
+        "karma": "0.12.22",
+        "karma-chrome-launcher": "0.1.4",
+        "karma-coffee-preprocessor": "0.2.1",
+        "karma-firefox-launcher": "0.1.3",
+        "karma-jasmine": "0.1.5",
+        "karma-phantomjs-launcher": "0.1.3",
+        "karma-requirejs": "0.2.2",
+        "requirejs": "2.1.14"
+    }
 }

package.json

@@ -1,13 +1,13 @@
 {
     "name": "angular-spring-data-rest",
     "version": "0.1.0",
-    "description": "An AngularJS module for a Spring Data REST backend.",
+    "description": "An AngularJS module to ease the work with a Spring Data REST backend.",
     "keywords": ["AngularJS", "angular", "Spring", "Spring Data", "REST", "Spring Data REST"],
-    "homepage": "https://github.com/guylabs/angular-spring-data-rest",
+    "homepage": "http://guylabs.ch/project/angular-spring-data-rest",
     "bugs": "https://github.com/guylabs/angular-spring-data-rest/issues",
     "author": {
         "name": "Guy Brûlé",
-        "email": "adming@guylabs.org",
+        "email": "admin@guylabs.org",
         "url": "http://guylabs.ch"
     },
     "repository": {

src/angular-spring-data-rest-interceptor-provider.js

@@ -1,6 +1,6 @@
 /**
  * @module spring-data-rest
- * @version 0.1.0
+ * @version <%= pkg.version %>
  *
  * Provider for the interceptor which wraps the SpringDataRestAdapter around the response object.
  */

src/angular-spring-data-rest-module.js

@@ -1,7 +1,7 @@
 /**
  * @module spring-data-rest
- * @version 0.1.0
+ * @version <%= pkg.version %>
  *
- * An AngularJS module for using `$resource` with a Spring Data REST backend.
+ * An AngularJS module to ease the work with a Spring Data REST backend.
  */
 angular.module("spring-data-rest", ["ngResource"]);

src/angular-spring-data-rest-provider.js

@@ -1,6 +1,6 @@
 /**
  * @module spring-data-rest
- * @version 0.1.0
+ * @version <%= pkg.version %>
  *
  * Provider for the SpringDataRestAdapter which is the core of this module.
  */
@@ -18,7 +18,8 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
             'value': '_embeddedItems'
         },
         'hrefKey': 'href',
-        'resourcesKey': '_resources'
+        'resourcesKey': '_resources',
+        'resourcesFunction': undefined
     };
 
     return {
@@ -34,8 +35,14 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
             if (typeof newConfig !== 'undefined') {
                 // throw an error if the given configuration is not an object
                 if (!angular.isObject(newConfig)) {
-                    throw new Error("The given configuration " + newConfig + " is not an object.");
+                    throw new Error("The given configuration '" + newConfig + "' is not an object.");
                 }
+
+                // check if the given resource function is not undefined and is of type function
+                if (newConfig.resourcesFunction != undefined && typeof(newConfig.resourcesFunction) != "function") {
+                    throw new Error("The given resource function '" + newConfig.resourcesFunction + "' is not of type function.")
+                }
+
                 // override the default configuration properties with the given new configuration
                 config = deepExtend(config, newConfig);
             }
@@ -54,7 +61,11 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
              * @returns {*}
              */
             function callBackend(url, paramDefaults, actions, options) {
-                return $injector.get("$resource")(url, paramDefaults, actions, options);
+                if (config.resourcesFunction == undefined) {
+                    return $injector.get("$resource")(url, paramDefaults, actions, options);
+                } else {
+                    return config.resourcesFunction(url, paramDefaults, actions, options);
+                }
             }
 
             /**
@@ -88,7 +99,7 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
                             throw new Error("The provided resource object must contain a name property.");
                         }
 
-                        var parameters = undefined;
+                        var parameters = paramDefaults;
                         var resourceObjectParameters = resourceObject.parameters;
 
                         // if the default parameters and the resource object parameters are objects, then merge these two objects
@@ -105,12 +116,12 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
                             }
                         }
 
-                        return callBackend(extractUrl(this, data[config.links.key][resourceObject.name][config.hrefKey],
+                        return callBackend(extractUrl(data[config.links.key][resourceObject.name][config.hrefKey],
                             data[config.links.key][resourceObject.name].templated), parameters, actions, options);
 
                     } else if (resourceObject in resources) {
                         // get the url out of the resource name and return the backend function
-                        return callBackend(extractUrl(this, data[config.links.key][resourceObject][config.hrefKey],
+                        return callBackend(extractUrl(data[config.links.key][resourceObject][config.hrefKey],
                             data[config.links.key][resourceObject].templated), paramDefaults, actions, options);
                     }
 

src/angular-spring-data-rest-utils.js

@@ -41,14 +41,14 @@ var moveArray = function (object, sourceKey, destinationKey) {
 };
 
 /**
- * Extracts the url out of a resource object. If template parameters exist, they will be removed from the
+ * Extracts the url out of a url string. If template parameters exist, they will be removed from the
  * returned url.
  *
- * @param {object} data the data object to get the resource object from
- * @param {string} resourceName the name of the resource
+ * @param {string} url the url string from which to extract the url
+ * @param {boolean} templated true if the url is templated
  * @returns {string} the url of the resource object
  */
-function extractUrl(data, url, templated) {
+function extractUrl(url, templated) {
     if (templated) {
         url = removeTemplateParameters(url)
     }