added tags

Author: pmeisen

README.md

@@ -18,7 +18,7 @@ The following code-snippet shows how easy it is to utilize the different end-poi
 ```html
 
     <!-- load the library -->
-    <script src="https://libs.breinify.com/javascript/breinify-api.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/breinify-api/1.0.6/breinify-api.min.js"></script>
     <script>
         /*
          * Configure the library (see 'further links' for a full list)

dist/breinify-api.js

@@ -12002,7 +12002,6 @@ dependencyScope.jQuery = $;;
     };
 
     var BreinifyUtil = {
-
         loc: {
 
             params: function (paramListSeparator, paramSeparator, paramSplit, url) {
@@ -12238,7 +12237,7 @@ dependencyScope.jQuery = $;;
             }
         },
 
-        setText: function(cssSelector, text) {
+        setText: function (cssSelector, text) {
             var $el = cssSelector instanceof $ ? cssSelector : $(cssSelector);
 
             if ($el.is('input')) {
@@ -12286,6 +12285,46 @@ dependencyScope.jQuery = $;;
             } else {
                 return false;
             }
+        },
+
+        isSimpleObject: function (obj) {
+            if (obj == null) {
+                return true;
+            } else if (!$.isPlainObject(obj)) {
+                return false;
+            }
+
+            // check the values of the object
+            var result = true;
+            $.each(obj, function (key, value) {
+                var type = typeof value;
+                if (value === null || type === 'boolean' || type === 'string' || type === 'number') {
+                    return true;
+                } else if ($.isArray(value)) {
+
+                    var globalArrayType = null;
+                    $.each(value, function (idx, arrayValue) {
+                        var arrayType = typeof arrayValue;
+
+                        if (arrayValue === null) {
+                            return true;
+                        } else if (arrayType !== 'boolean' && arrayType !== 'string' && arrayType !== 'number') {
+                            result = false;
+                        } else if (globalArrayType === null) {
+                            globalArrayType = arrayType;
+                        } else if (globalArrayType !== arrayType) {
+                            result = false;
+                        }
+                        return result;
+                    });
+                } else {
+                    result = false;
+                }
+
+                return result;
+            });
+
+            return result;
         }
     };
 
@@ -12832,43 +12871,45 @@ dependencyScope.jQuery = $;;
         return _config.all();
     };
 
+    /**
+     * Method to create a valid current unix timestamp.
+     * @returns {number} the current unix timestamp (based on the system time)
+     */
+    Breinify.unixTimestamp = function () {
+        return Math.floor(new Date().getTime() / 1000);
+    };
+
     /**
      * Sends an activity to the Breinify server.
      *
      * @param user {object} the user-information
      * @param type {string|null} the type of activity
      * @param category {string|null} the category (can be null or undefined)
      * @param description {string|null} the description for the activity
+     * @param tags {object} added the change to pass in tags
      * @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, sign, onReady) {
+    Breinify.activity = function (user, type, category, description, tags, sign, onReady) {
 
-        Breinify.activityUser(user, type, category, description, sign, function (data) {
+        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);
         });
     };
 
-    /**
-     * Method to create a valid current unix timestamp.
-     * @returns {number} the current unix timestamp (based on the system time)
-     */
-    Breinify.unixTimestamp = function () {
-        return Math.floor(new Date().getTime() / 1000);
-    };
-
     /**
      * Creates a user instance and executes the specified method.
      *
      * @param user {object} the user-information
      * @param type {string|null} the type of activity
      * @param category {string|null} the category (can be null or undefined)
      * @param description {string|null} the description for the activity
+     * @param tags {object} added the change to pass in tags
      * @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 successful user creation
      */
-    Breinify.activityUser = function (user, type, category, description, sign, onReady) {
+    Breinify.activityUser = function (user, type, category, description, tags, sign, onReady) {
 
         var _onReady = function (user) {
             if ($.isFunction(onReady)) {
@@ -12888,6 +12929,7 @@ dependencyScope.jQuery = $;;
             type = typeof type === 'undefined' || type === null ? null : type;
             category = typeof category === 'undefined' || category === null ? _config.get(ATTR_CONFIG.CATEGORY) : category;
             description = typeof description === 'undefined' || description === null ? null : description;
+            tags = BreinifyUtil.isSimpleObject(tags) ? tags : null;
             sign = typeof sign === 'boolean' ? sign : false;
 
             // get the other values needed
@@ -12911,7 +12953,8 @@ dependencyScope.jQuery = $;;
                 'activity': {
                     'type': type,
                     'category': category,
-                    'description': description
+                    'description': description,
+                    'tags': tags
                 },
 
                 'apiKey': _config.get(ATTR_CONFIG.API_KEY),
@@ -13078,7 +13121,8 @@ dependencyScope.jQuery = $;;
         text: function() { return null; },
         setText: function() {},
         md5: function () { return null; },
-        isEmpty: function() { return false; }
+        isEmpty: function() { return false; },
+        isSimpleObject: function() { return false; }
     };
 
     window['Breinify'] = Breinify;

dist/breinify-api.min.js

@@ -53,7 +53,7 @@ The file is integrated within a web-site by adding the needed script-tag, pointi
 It is also possible to omit the download and just point to the library file provided through a CDN (currently we do not publish the library to any CDN, but we will keep you updated) or Breinify's site.
 
 ```html
-<script src="https://libs.breinify.com/javascript/breinify-api.min.js"></script>
+<script src="https://cdn.jsdelivr.net/breinify-api/1.0.6/breinify-api.min.js"></script>
 ```
 
 **Note:** The library can also be loaded asynchroniously using the *async* and *onload* attribute (officially introduced in HTML5). In that case, the configuration of the library and all bindings should be performed after the library is loaded (i.e., within the *onload* function).

documentation/step-by-step.md

@@ -48,7 +48,7 @@ describe('Breinify', function () {
         };
         Breinify.activityUser({
             email: 'email@sample.com'
-        }, 'search', null, null, true, function (data) {
+        }, 'search', null, null, null, true, function (data) {
 
             //noinspection JSUnresolvedFunction
             expect(data.apiKey).toBe('5D8B-064C-F007-4F92-A8DC-D06B-56B4-FAD8');

specs/Breinify-spec.js

@@ -57,7 +57,7 @@ describe('BreinifyUtil', function () {
         expect(Breinify.UTL.cookie.get('undefined')).toBeNull();
         //noinspection JSUnresolvedFunction,JSUnresolvedVariable
         expect(Breinify.UTL.cookie.all()).toEqual({});
-        
+
         // set some cookies
         Breinify.UTL.cookie.set('cookie', 'value');
         Breinify.UTL.cookie.set('cookie', 'lastValue');
@@ -98,4 +98,25 @@ describe('BreinifyUtil', function () {
         //noinspection JSUnresolvedFunction,JSUnresolvedVariable
         expect(Breinify.UTL.isEmpty(null)).toBe(true);
     });
+
+
+    //noinspection JSUnresolvedFunction
+    it('simple object works', function () {
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject(null)).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({})).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'array': ['string1']})).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'array': ['string1', 'string2']})).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'array': [1, 2]})).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'array': [1, 2, null, 3]})).toBe(true);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'array': [1, 2, null, '3']})).toBe(false);
+        //noinspection JSUnresolvedFunction
+        expect(Breinify.UTL.isSimpleObject({'val1': 1, 'val2': 2, 'val3': []})).toBe(true);
+    });
 });