renamings

Author: Fabian Hoffmann

index.js

@@ -22,12 +22,12 @@ var utils = function() {
         }
     };
 
-    var healthCheckBody = function(customCallback) {
+    var healthCheckAction = function(customAction) {
         // provide the health check function which is used from nodejs health check endpoint
-        // and add custom callback to it
+        // and add custom action to it
         return function(req, res) {
-            if (customCallback) {
-                customCallback(req, res);
+            if (customAction) {
+                customAction(req, res);
             }
             res.send("UP");
         };
@@ -37,19 +37,18 @@ var utils = function() {
      * Adds a health check to a nodejs application object.
      *
      * @param app nodejs application.
-     * @param customCallback optional callback which will be executed if
-     *                       the health check is called.
+     * @param customAction optional callback which will be executed if
+     *                     the health check is called.
      */
-    var addHealthCheck = function(app, customCallback) {
-        app.get("/health", healthCheckBody(customCallback));
+    var registerHealthCheckEndpoint = function(app, customAction) {
+        app.get("/health", healthCheckAction(customAction));
     };
 
-    var notifyBody = function(customCallback) {
-        // enhance the notification api with a custom
-        // callback
+    var notificationAction = function(customAction) {
+        // enhance the notification api with a custom action
         return function(req, res) {
-            if (customCallback) {
-                customCallback(req, res);
+            if (customAction) {
+                customAction(req, res);
             }
             res.send("OK");
         };
@@ -59,17 +58,17 @@ var utils = function() {
      * Adds a notification endpoint.
      *
      * @param app nodejs application.
-     * @param customCallback optional callback which will be executed if
-     *                       the notification is received.
+     * @param customAction optional callback which will be executed if
+     *                     the notification is received.
      */
-    var addNotifyEndpoint = function(app, customCallback) {
-        app.post("/notify", notifyBody(customCallback));
+    var registerNotificationEndpoint = function(app, customAction) {
+        app.post("/notify", notificationAction(customAction));
     };
 
     return {
         currentAddress: currentAddress,
-        addHealthCheck: addHealthCheck,
-        addNotifyEndpoint: addNotifyEndpoint
+        registerHealthCheckEndpoint: registerHealthCheckEndpoint,
+        registerNotificationEndpoint: registerNotificationEndpoint
     };
 };
 

test/index.js

@@ -53,15 +53,15 @@ describe("utils", function(){
             var appSpy = sinon.spy(app, "get");
 
             // when
-            utils.addHealthCheck(app);
+            utils.registerHealthCheckEndpoint(app);
 
             // then
             assert(appSpy.withArgs("/health", sinon.match.func).calledOnce);
         });
 
-        it("should set up health check body and call custom callback", function() {
+        it("should set up health check body and call custom action", function() {
             // given
-            var customCallbackSpy = sinon.spy();
+            var customActionSpy = sinon.spy();
             var res = {send: function() {}};
             var resSpy = sinon.spy(res, "send");
             var app = {
@@ -71,23 +71,23 @@ describe("utils", function(){
             };
 
             // when
-            utils.addHealthCheck(app, customCallbackSpy);
+            utils.registerHealthCheckEndpoint(app, customActionSpy);
 
             // then
-            assert(customCallbackSpy.calledOnce);
+            assert(customActionSpy.calledOnce);
             assert(resSpy.withArgs("UP").calledOnce);
         });
 
-        it("should set up health check body and don't call custom callback if undefined", function() {
+        it("should set up health check body and don't call custom action if undefined", function() {
             // given
             var app = {
-                get: function(path, healthCheckBody) {
-                    healthCheckBody({}, {send: function() {}});
+                get: function(path, healthCheckAction) {
+                    healthCheckAction({}, {send: function() {}});
                 }
             };
 
             // when
-            utils.addHealthCheck(app, undefined);
+            utils.registerHealthCheckEndpoint(app, undefined);
 
             // then
             // nothing to check, will fail if undefined would be executed
@@ -103,41 +103,41 @@ describe("utils", function(){
             var appSpy = sinon.spy(app, "post");
 
             // when
-            utils.addNotifyEndpoint(app);
+            utils.registerNotificationEndpoint(app);
 
             // then
             assert(appSpy.withArgs("/notify", sinon.match.func).calledOnce);
         });
 
-        it("should set up notify body and call custom callback", function() {
+        it("should set up notify body and call custom action", function() {
             // given
-            var customCallbackSpy = sinon.spy();
+            var customActionSpy = sinon.spy();
             var res = {send: function() {}};
             var resSpy = sinon.spy(res, "send");
             var app = {
-                post: function(path, notifyBody) {
-                    notifyBody({}, res);
+                post: function(path, notifyAction) {
+                    notifyAction({}, res);
                 }
             };
 
             // when
-            utils.addNotifyEndpoint(app, customCallbackSpy);
+            utils.registerNotificationEndpoint(app, customActionSpy);
 
             // then
-            assert(customCallbackSpy.calledOnce);
+            assert(customActionSpy.calledOnce);
             assert(resSpy.withArgs("OK").calledOnce);
         });
 
-        it("should set up notify body and don't call custom callback if undefined", function() {
+        it("should set up notify body and don't call custom action if undefined", function() {
             // given
             var app = {
-                post: function(path, notifyBody) {
-                    notifyBody({}, {send: function() {}});
+                post: function(path, notificationAction) {
+                    notificationAction({}, {send: function() {}});
                 }
             };
 
             // when
-            utils.addNotifyEndpoint(app, undefined);
+            utils.registerNotificationEndpoint(app, undefined);
 
             // then
             // nothing to check, will fail if undefined would be executed