Improve resources method to allow pass parameters in the resource object. Add tests for the resources method and scope the use strict call.

Author: guylabs

src/angular-spring-data-rest.js

@@ -37,21 +37,25 @@ var beforeEachFunction = function () {
  *
  * @param {object} data the data object in which the resource key exists
  * @param {string} resourcesKey the resource key
- * @param {string} inLinkName the link name for which the correct link href must be used
+ * @param {string} expectedUrl the expected url
+ * @param {object} httpBackend the angular http backend object
+ * @param {string|object} inResourceName the resource name or the resource object
+ * @param {object} parameters the parameter object
  */
-var spyOnResourceExecution = function (data, resourcesKey, inLinkName) {
-    spyOn(data, resourcesKey);
+var expectResourceExecution = function (data, resourcesKey, expectedUrl, httpBackend, inResourceName, parameters) {
+    // create resource name and parameters
+    var resourceName = (inResourceName == undefined) ? "self" : inResourceName;
 
-    // create parameters
-    var linkName = (inLinkName == undefined) ? "linkName" : inLinkName;
-    var paramDefaults = {userId: 123, cardId: '@id'};
-    var actions = { charge: {method: 'POST', params: {charge: true}} };
+    // remove template parameters from url
+    expectedUrl = expectedUrl.replace(/{.*}/g, '');
 
-    // call the resource method
-    data[resourcesKey](linkName, paramDefaults, actions);
+    // expect the url
+    httpBackend.whenGET(expectedUrl).respond(200);
+    httpBackend.expectGET(expectedUrl);
 
-    // expect that the resource method has been called with the given parameters
-    expect(data[resourcesKey]).toHaveBeenCalledWith(linkName, paramDefaults, actions);
+    // call the resource method
+    data[resourcesKey](resourceName, parameters).get();
+    httpBackend.flush();
 };
 
 var mockData = function () {

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

@@ -26,7 +26,8 @@ describe("the response with the embedded values", function () {
             expect(this.response[this.config.embedded.value][key][this.config.resourcesKey]).toBeDefined();
 
             // the resource value must be a valid function with the given parameters
-            spyOnResourceExecution(this.response[this.config.embedded.value][key], this.config.resourcesKey);
+            expectResourceExecution(this.response[this.config.embedded.value][key], this.config.resourcesKey,
+                this.response[this.config.embedded.value][key][this.config.links.key]["self"].href, this.httpBackend, "self");
         }
     });
 

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

@@ -1,11 +1,120 @@
-describe("the resource property", function () {
+describe("the resources property", function () {
 
     beforeEach(beforeEachFunction);
 
-    it("must return the resources of the object", function () {
-        this.rawResponse = mockData();
-        this.response = new SpringDataRestAdapter(this.rawResponse);
+    it("must contain the 'links key' key", function () {
+        expect(this.response[this.config.links.key]).toBeDefined();
+    });
+
+    it("must call the correct href url if a resource name is passed to the $resource method", function () {
+
+        // define the resource name and the correct resource href url
+        var resourceName = "self";
+        var resourceHref = "http://localhost:8080/categories";
+
+        // check if the underlying $resource method is called with the correct href url
+        var expectedResult = {categoryId: '123'};
+        this.httpBackend.whenGET(resourceHref).respond(200, expectedResult);
+        this.httpBackend.expectGET(resourceHref);
+        var result = this.response[this.config.resourcesKey](resourceName).get(function () {
+            expect(result.categoryId).toEqual(expectedResult.categoryId);
+        });
+        this.httpBackend.flush();
+    });
+
+    it("must call the correct href url if a resource object is passed to the $resource method", function () {
+
+        // define the resource object and the correct link href url
+        var resourceObject = {
+            'name': 'self'
+        };
+        var resourceHref = "http://localhost:8080/categories";
+
+        // check if the underlying $resource method is called with the correct href url
+        var expectedResult = {categoryId: '123'};
+        this.httpBackend.whenGET(resourceHref).respond(200, expectedResult);
+        this.httpBackend.expectGET(resourceHref);
+        var result = this.response[this.config.resourcesKey](resourceObject).get(function () {
+            expect(result.categoryId).toEqual(expectedResult.categoryId);
+        });
+        this.httpBackend.flush();
+    });
+
+    it("must throw an exception if a wrong resource object is given", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        var thisResponse = this.response;
+        var thisResourceKey = this.config.resourcesKey;
+        var thisHttpBackend = this.httpBackend;
+
+        // it must throw an exception if a wrong resource object is given
+        expect(function () {
+            expectResourceExecution(thisResponse, thisResourceKey,
+                "expectedUrl", thisHttpBackend, {'wrongPropertyName': 'value'});
+        }).toThrow("The provided resource object must contain a name property.");
+    });
+
+    it("must not use any parameters if the resource object is a string and no parameters are given", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the parameters must not be used in the resources method
+        expectResourceExecution(this.response, this.config.resourcesKey,
+            this.response[this.config.links.key]["self"].href, this.httpBackend, "self")
+    });
+
+    it("must use the given parameters if the resource object is a string", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the given parameters must be used in the resources method
+        expectResourceExecution(this.response, this.config.resourcesKey,
+                this.response[this.config.links.key]["self"].href + "?parameterName=parameterValue", this.httpBackend, "self",
+            {'parameterName': 'parameterValue'});
+    });
+
+    it("must use the resource name if the correct resource object is given", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the given resource name must be used
+        expectResourceExecution(this.response, this.config.resourcesKey,
+            this.response[this.config.links.key]["self"].href, this.httpBackend, {'name': 'self'})
+    });
+
+    it("must use the correct resource object name and the given parameters", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the given parameters must be used in the resources method
+        expectResourceExecution(this.response, this.config.resourcesKey,
+                this.response[this.config.links.key]["self"].href + "?parameterName=parameterValue",
+            this.httpBackend, {'name': 'self'}, {'parameterName': 'parameterValue'})
+    });
+
+    it("must use the correct resource object name and parameters", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the given parameters must be used in the resources method
+        expectResourceExecution(this.response, this.config.resourcesKey,
+                this.response[this.config.links.key]["self"].href + "?parameterName=parameterValue",
+            this.httpBackend, {'name': 'self', 'parameters': {'parameterName': 'parameterValue'}})
+    });
 
+    it("must use the correct resource object name and merge the  resource object parameters with the given parameters", function () {
+        // expect that the resources method is present
+        expect(this.response[this.config.resourcesKey]).toBeDefined();
+
+        // the given parameters must be used in the resources method
+        expectResourceExecution(this.response, this.config.resourcesKey,
+                this.response[this.config.links.key]["self"].href + "?objectParameterName=objectParameterValue&parameterName=parameterValue",
+            this.httpBackend, {'name': 'self', 'parameters': {'objectParameterName': 'objectParameterValue'}},
+            {'parameterName': 'parameterValue'})
+    });
+
+    it("must return the resources of the object", function () {
         // expect that the resources method is present
         expect(this.response[this.config.resourcesKey]).toBeDefined();
 

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

@@ -17,7 +17,7 @@ describe("the response", function () {
         expect(this.response[this.config.resourcesKey]).toBeDefined();
 
         // the resource value must be a valid function with the given parameters
-        spyOnResourceExecution(this.response, this.config.resourcesKey);
+        expectResourceExecution(this.response, this.config.resourcesKey, this.response[this.config.links.key]["self"].href, this.httpBackend, "self");
     });
 
     it("must retain all original object properties", function () {