added override

Author: pmeisen

dist/breinify-api.js

@@ -13111,6 +13111,96 @@ dependencyScope.jQuery = $;;
 
     var ATTR_CONFIG = BreinifyConfig.ATTRIBUTES;
 
+    /**
+     * As JS don't supports data types, implements an overload method. This implementation is inspired by
+     * https://github.com/myfingersarebroken/aer
+     */
+    function Wrapper() {
+        this.excludeNullType = function (type) {
+            return false;
+        };
+
+        this.toString = function (pointer) {
+            var output = '';
+
+            var keys = Object.keys(pointer);
+            keys.forEach(function (key) {
+                output += '[' + key + '] ';
+            });
+
+            return output;
+        };
+    }
+
+    Wrapper.prototype = {
+        setExcludeNullType: function (func) {
+            if (typeof func == 'function') {
+                this.excludeNullType = func;
+            }
+        },
+
+        overload: function (o, args, context) {
+            return this._$overload(o, args, context, this);
+        },
+
+        _$overload: function (pointer, args, context, wrapper) {
+            var regex = /function\s+(\w+)s*/;
+            var types = [];
+
+            // create a string to identify the structure of the signature
+            var containsRegEx = false;
+            for (var i = 0; i < args.length; i++) {
+                var arg = args[i];
+
+                var type;
+                if (arg === null) {
+                    type = '([A-Za-z0-9_\\-]+)';
+                    containsRegEx = true;
+                } else {
+                    type = regex.exec(arg.constructor.toString())[1];
+                }
+
+                types.push(type);
+            }
+
+            // check which one of the functions can be used
+            var func = null;
+            if (containsRegEx) {
+                var typeRegEx = new RegExp(types.toString(), 'i');
+
+                Object.keys(pointer).forEach(function (key) {
+                    var matches = typeRegEx.exec(key);
+                    if (matches != null) {
+                        var exclude = false;
+                        for (var i = 1; i < matches.length; i++) {
+                            if (wrapper.excludeNullType(matches[i])) {
+                                exclude = true;
+                                break;
+                            }
+                        }
+
+                        if (exclude) {
+                            // nothing to do
+                        } else if (func === null) {
+                            func = pointer[key];
+                        } else {
+                            throw new SyntaxError('Multiple signatures for  (' + types.toString() + ') found in: ' + this.toString(pointer));
+                        }
+                    }
+                });
+            } else {
+                func = pointer[types.toString()];
+            }
+            if (typeof func !== 'function') {
+                throw new SyntaxError('Invalid signature (' + types.toString() + ') found, use one of: ' + this.toString(pointer));
+            }
+
+            return func.apply(context, args);
+        }
+    };
+
+    var overload = new Wrapper();
+
     /*
      * The internally used configuration used for all calls.
      */
@@ -13212,6 +13302,7 @@ dependencyScope.jQuery = $;;
         return _config.all();
     };
 
+    //noinspection JSCommentMatchesSignature,JSValidateJSDoc
     /**
      * Sends an activity to the Breinify server.
      *
@@ -13223,12 +13314,41 @@ dependencyScope.jQuery = $;;
      * @param sign {boolean|null} true if a signature should be added (needs the secret to be configured - not recommended in open systems), otherwise false (can be null or undefined)
      * @param onReady {function|null} function to be executed after triggering the activity
      */
-    Breinify.activity = function (user, type, category, description, tags, sign, onReady) {
+    Breinify.activity = function () {
+        var url = _config.get(ATTR_CONFIG.URL) + _config.get(ATTR_CONFIG.ACTIVITY_ENDPOINT);
 
-        Breinify.activityUser(user, type, category, description, tags, sign, function (data) {
-            var url = _config.get(ATTR_CONFIG.URL) + _config.get(ATTR_CONFIG.ACTIVITY_ENDPOINT);
-            _privates.ajax(url, data, onReady, onReady);
-        });
+        overload.overload({
+            'Object,String': function (user, type) {
+                Breinify.activityUser(user, type, null, null, null, false, function (data) {
+                    _privates.ajax(url, data);
+                });
+            },
+            'Object,String,Object': function (user, type, tags) {
+                Breinify.activityUser(user, type, null, null, tags, false, function (data) {
+                    _privates.ajax(url, data);
+                });
+            },
+            'Object,String,String,Object': function (user, type, description, tags) {
+                Breinify.activityUser(user, type, null, description, tags, false, function (data) {
+                    _privates.ajax(url, data);
+                });
+            },
+            'Object,String,String,String,Object': function (user, type, category, description, tags) {
+                Breinify.activityUser(user, type, category, description, tags, false, function (data) {
+                    _privates.ajax(url, data);
+                });
+            },
+            'Object,String,String,String,Object,Function': function (user, type, category, description, tags, callback) {
+                Breinify.activityUser(user, type, category, description, tags, false, function (data) {
+                    _privates.ajax(url, data, callback, callback);
+                });
+            },
+            'Object,String,String,String,Object,Boolean,Function': function (user, type, category, description, tags, sign, callback) {
+                Breinify.activityUser(user, type, category, description, tags, sign, function (data) {
+                    _privates.ajax(url, data, callback, callback);
+                });
+            }
+        }, arguments, this);
     };
 
 
@@ -13302,19 +13422,34 @@ dependencyScope.jQuery = $;;
         });
     };
 
+    //noinspection JSCommentMatchesSignature,JSValidateJSDoc
     /**
      * Sends an temporalData request to the Breinify backend.
      *
      * @param user {object} the user-information
      * @param sign {boolean|null} true if a signature should be added (needs the secret to be configured - not recommended in open systems), otherwise false (can be null or undefined)
      * @param onReady {function|null} function to be executed after triggering the temporalData request
      */
-    Breinify.temporalData = function (user, sign, onReady) {
+    Breinify.temporalData = function () {
+        var url = _config.get(ATTR_CONFIG.URL) + _config.get(ATTR_CONFIG.TEMPORAL_DATA_ENDPOINT);
 
-        Breinify.temporalDataUser(user, sign, function (data) {
-            var url = _config.get(ATTR_CONFIG.URL) + _config.get(ATTR_CONFIG.TEMPORAL_DATA_ENDPOINT);
-            _privates.ajax(url, data, onReady, onReady);
-        });
+        overload.overload({
+            'Function': function (callback) {
+                Breinify.temporalDataUser({}, false, function (data) {
+                    _privates.ajax(url, data, callback, callback);
+                });
+            },
+            'Boolean,Function': function (sign, callback) {
+                Breinify.temporalDataUser({}, sign, function (data) {
+                    _privates.ajax(url, data, callback, callback);
+                });
+            },
+            'Object,Boolean,Function': function (user, sign, callback) {
+                Breinify.temporalDataUser(user, sign, function (data) {
+                    _privates.ajax(url, data, callback, callback);
+                });
+            }
+        }, arguments, this);
     };
 
     /**
@@ -13356,7 +13491,7 @@ dependencyScope.jQuery = $;;
 
                     var message = _privates.generateTemporalDataMessage(unixTimestamp, localDateTime, timezone);
                     console.log(message);
-                    console.log( _config.get(ATTR_CONFIG.SECRET));
+                    console.log(_config.get(ATTR_CONFIG.SECRET));
                     signature = _privates.determineSignature(message, _config.get(ATTR_CONFIG.SECRET))
                 } else {
                     _onReady(null);

dist/breinify-api.min.js

@@ -18,6 +18,7 @@ This documentation is organized as following:
   * Breinify.setConfig(config)
 * [API](#api)
   * Breinify.activity(user, type, category, description, tags, sign, onReady)
+  * Breinify.temporaldata(user, sign, onReady)
   * Breinify.lookup(user, dimensions, sign, onLookUp)
 * [Utilities (UTL)](#utilities-utl)
   * [Breinify.UTL (general functions)](#breinifyutl-general-functions)
@@ -27,6 +28,9 @@ This documentation is organized as following:
     * Breinify.UTL.md5(value)
     * Breinify.UTL.isEmpty(value)
     * Breinify.UTL.isSimpleObject(obj)
+    * Breinify.UTL.unixTimestamp()
+    * Breinify.UTL.timezone()
+    * Breinify.UTL.localDateTime()
   * [Breinify.UTL.events](#breinifyutlevents)
     * Breinify.UTL.events.click(selector, func, onlyOnce)
     * Breinify.UTL.events.pageloaded(func)
@@ -79,6 +83,8 @@ This documentation is organized as following:
 
   {string} **apiKey**: The API-key to be used (mandatory).
 
+  {string} **temporaldataEndpoint**: The end-point of the API to retrieve temporal-data results.
+  
   {string} **lookupEndpoint**: The end-point of the API to retrieve lookup results.
 
   {string} **secret**: The secret attached to the API-key (should always be null utilizing this type of library).
@@ -129,7 +135,7 @@ This documentation is organized as following:
 
   {boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
 
-  {function|null} **onReady**: A function which is triggered after the activity was sent to the user. The function has the information sent as the first parameter.
+  {function|null} **onReady**: A function which is triggered after the activity was sent. The function has the retrieved answer as the first parameter.
 
   **Example Usage**:
   ```javascript
@@ -145,6 +151,26 @@ This documentation is organized as following:
   ```
   <br/>
 
+* **Breinify.temporaldata(user, sign, onReady)**:<br/>
+  Retrieves temporal information about the passed user information. 
+  
+  **Parameters**:
+
+  {object} **user**: A plain object specifying the user information the temporal data should be retrieved for. More information about the structure can be found [here](./user.md).
+
+  {boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
+
+  {function|null} **onReady**: A function which is triggered after the answer of the call was received. The function has the retrieved information as first parameter.
+
+  **Example Usage**:
+  ```
+  Breinify.temporalData({}, false, function (data) {
+    console.log(data);
+  });
+  ```
+  <br/>
+  
+
 * **Breinify.lookup(user, dimensions, sign, onLookUp)**:<br/>
   Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.
 
@@ -269,6 +295,15 @@ The utility library provides general functionality, which makes it easy to retri
     'null': null
   }
   ```
+  
+* {number} **Breinify.UTL.unixTimestamp()**:<br/>
+  Returns the current unix time-stamp (also called epoch time).
+  
+* {string} **Breinify.UTL.timezone()**:<br/>
+  Determines the clients timezone. 
+  
+* {string} **Breinify.UTL.localDateTime()**:<br/>
+  Creates a string representing the current local date and time.
 
 ##### Breinify.UTL.events
 

documentation/api.md

@@ -266,7 +266,7 @@ <h1>Current Configuration</h1>
             var product = Breinify.UTL.text(Breinify.UTL.select(this, 'td:first'), false);
             Breinify.activity({
                 'email': userEmail
-            }, 'selectProduct', null, product, false, function () {
+            }, 'selectProduct', null, product, null, false, function () {
                 show('Sent activity "selectProduct" with product "' + product + '".');
             });
         }
@@ -287,7 +287,7 @@ <h1>Current Configuration</h1>
         if (!Breinify.UTL.isEmpty(userEmail)) {
             Breinify.activity({
                 'email': userEmail
-            }, 'login', null, null, false, function () {
+            }, 'login', null, null, null, false, function () {
                 lookUp(userEmail);
                 show('Sent activity "login" with user "' + userEmail + '".');
             });
@@ -314,10 +314,10 @@ <h1>Current Configuration</h1>
                 Breinify.UTL.setText('#dimension-email td:nth-child(2)', val);
             });
         }
-    }
+    };
 
     var temporalData = function () {
-        Breinify.temporalData({}, false, function (data) {
+        Breinify.temporalData({}, null, function (data) {
 
             var $template = $('#temporal-data-template');