Upgrading to html5-desktop-notifications 3.0.0

Author: sagiegurari

angular-web-notification.js

@@ -16,9 +16,9 @@
  * @description
  * Initializes the angular web notification service.
  *
- * @param {object} notifyLib - The HTML5 notification library instance
+ * @param {object} NotifyLib - The HTML5 notification library instance
  */
-(function initWebNotification(notifyLib) {
+(function initWebNotification(NotifyLib) {
     'use strict';
 
     var webNotification = window.angular.module('angular-web-notification', []);
@@ -36,6 +36,15 @@
     webNotification.factory('webNotification', function onCreateService() {
         var service = {};
 
+        /**
+         * The internal Notification library used by this angular module.
+         *
+         * @memberof! webNotification
+         * @alias webNotification.lib
+         * @private
+         */
+        service.lib = NotifyLib;
+
         /**
          * True to enable automatic requesting of permissions if needed.
          *
@@ -56,7 +65,7 @@
              * @returns {boolean} True if permission is granted, else false
              */
             get: function getPermission() {
-                var permission = notifyLib.permissionLevel();
+                var permission = NotifyLib.permission;
 
                 /**
                  * True if permission is granted, else false.
@@ -66,7 +75,7 @@
                  * @public
                  */
                 var permissionGranted = false;
-                if (permission === notifyLib.PERMISSION_GRANTED) {
+                if (permission === 'granted') {
                     permissionGranted = true;
                 }
 
@@ -104,13 +113,7 @@
          * @returns {boolean} True if allowed to show web notifications
          */
         var isEnabled = function () {
-            var enabled = notifyLib.isSupported;
-
-            if (enabled) {
-                enabled = service.permissionGranted;
-            }
-
-            return enabled;
+            return service.permissionGranted;
         };
 
         /**
@@ -132,28 +135,31 @@
          */
         var createAndDisplayNotification = function (title, options) {
             var autoClose = 0;
-            if (options && options.autoClose && (typeof options.autoClose === 'number')) {
+            if (options.autoClose && (typeof options.autoClose === 'number')) {
                 autoClose = options.autoClose;
             }
-            notifyLib.config({
-                autoClose: autoClose
-            });
 
             //defaults the notification icon to the website favicon.ico
             if (!options.icon) {
                 options.icon = '/favicon.ico';
             }
 
-            var notification = notifyLib.createNotification(title, options);
+            var notification = new NotifyLib(title, options);
 
             //add onclick handler
-            if (options.onClick && notification && notification.webNotification) {
-                notification.webNotification.onclick = options.onClick;
+            if (options.onClick && notification) {
+                notification.onclick = options.onClick;
             }
 
-            return function hideNotification() {
+            var hideNotification = function () {
                 notification.close();
             };
+
+            if (autoClose) {
+                setTimeout(hideNotification, autoClose);
+            }
+
+            return hideNotification;
         };
 
         /**
@@ -255,7 +261,7 @@
                     hideNotification = createAndDisplayNotification(title, options);
                     callback(null, hideNotification);
                 } else if (service.allowRequest) {
-                    notifyLib.requestPermission(function onRequestDone() {
+                    NotifyLib.requestPermission(function onRequestDone() {
                         if (isEnabled()) {
                             hideNotification = createAndDisplayNotification(title, options);
                             callback(null, hideNotification);
@@ -271,4 +277,4 @@
 
         return service;
     });
-}(window.notify));
+}(window.Notification));

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "AngularJS service for displaying web notifications.",
   "authors": [
     "Sagie Gur-Ari <sagiegurari@gmail.com>"
@@ -24,7 +24,7 @@
     "target"
   ],
   "dependencies": {
-    "HTML5-Desktop-Notifications2": "1.0.1",
+    "html5-desktop-notifications": "3.0.0",
     "angular": "~1"
   },
   "devDependencies": {

docs/CHANGELOG.md

@@ -1,5 +1,6 @@
 | Date        | Version | Description |
 | ----------- | ------- | ----------- |
+| 2016-11-04  | v1.0.16 | Upgrading to html5-desktop-notifications 3.0.0 |
 | 2016-10-16  | v1.0.15 | Maintenance |
 | 2016-09-10  | v1.0.6  | Default to website favicon.ico if icon not provided in options |
 | 2016-09-07  | v1.0.4  | Callback is now optional |

docs/index.html

@@ -5,8 +5,9 @@
         <title>Angular Web Notification Example</title>
         <script type="text/javascript" src="https://code.jquery.com/jquery-3.1.0.min.js"></script>
         <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/angularjs/1.5.6/angular.min.js"></script>
-        <script type="text/javascript" src="https://rawgit.com/sagiegurari/HTML5-Desktop-Notifications/master/desktop-notify.js"></script>
-        <script type="text/javascript" src="https://rawgit.com/sagiegurari/angular-web-notification/master/angular-web-notification.js"></script>
+        <script type="text/javascript" src="https://rawgit.com/ttsvetko/HTML5-Desktop-Notifications/master/dist/Notification.js"></script>
+        <script type="text/javascript" src="../angular-web-notification.js"></script>
+        <!--TODO <script type="text/javascript" src="https://rawgit.com/sagiegurari/angular-web-notification/master/angular-web-notification.js"></script>-->
         <script type="text/javascript" src="example/example.js"></script>
 
         <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet"/>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "AngularJS service for displaying web notifications.",
   "author": {
     "name": "Sagie Gur-Ari",

test/helpers/notify-mock.js

@@ -1,81 +1,60 @@
-window.notify = (function () {
+window.Notification = (function Notification() {
     'use strict';
 
-    var notifyOptions;
-    var permission;
-    var lib = {
-        PERMISSION_GRANTED: 'granted',
-        config: function (options) {
-            notifyOptions = options;
-        },
-        requestPermission: function (callback) {
-            setTimeout(function mockDelay() {
-                callback();
-            }, 5);
-        },
-        permissionLevel: function () {
-            return permission;
-        },
-        getConfig: function () {
-            return notifyOptions;
-        }
+    var permissionInfo = {
+        value: null
     };
 
-    lib.createNotification = function (title, options) {
-        lib.validateNotification(title, options);
+    var oncePermission;
 
-        var notification = {
-            close: function mockClose() {
-                if (options.onClick) {
-                    this.webNotification.onclick();
-                }
+    var Lib = function (title, options) {
+        Lib.validateNotification(title, options);
 
-                return undefined;
-            },
-            webNotification: {}
+        var self = this;
+        self.close = function () {
+            if (options.onClick) {
+                self.onclick();
+            }
         };
-
-        return notification;
     };
 
-    lib.setValidationNotification = function (validateNotification) {
-        lib.validateNotification = validateNotification || function () {
-            return undefined;
-        };
-    };
+    Lib.MOCK_NOTIFY = true;
 
-    lib.setAllowed = function (validateNotification) {
-        lib.setValidationNotification(validateNotification);
+    Object.defineProperty(Lib, 'permission', {
+        enumerable: true,
+        get: function () {
+            return permissionInfo.value;
+        }
+    });
 
-        lib.isSupported = true;
-        permission = 'granted';
-    };
+    Lib.requestPermission = function (callback) {
+        if (oncePermission) {
+            oncePermission();
+            oncePermission = null;
+        }
 
-    lib.setSupportedOnly = function () {
-        lib.setValidationNotification(null);
-        lib.isSupported = true;
-        permission = 'not-granted';
+        setTimeout(callback, 5);
     };
 
-    lib.setNotSupported = function () {
-        lib.setValidationNotification(null);
-        lib.isSupported = false;
-        permission = 'not-granted';
+    Lib.setValidationNotification = function (validateNotification) {
+        Lib.validateNotification = validateNotification || function noop() {
+            return undefined;
+        };
     };
 
-    lib.setFirstTimePermissions = function (validateNotification) {
-        lib.orgRequestPermission = lib.requestPermission;
-        lib.setValidationNotification(validateNotification);
-
-        lib.requestPermission = function (callback) {
-            permission = 'granted';
+    Lib.setAllowed = function (validateNotification) {
+        Lib.setValidationNotification(validateNotification);
+        permissionInfo.value = 'granted';
+    };
 
-            lib.orgRequestPermission(callback);
-            lib.requestPermission = lib.orgRequestPermission;
-        };
+    Lib.setNotAllowed = function (validateNotification) {
+        Lib.setValidationNotification(validateNotification);
+        permissionInfo.value = 'not-granted';
+    };
 
-        lib.setSupportedOnly();
+    Lib.onceRequestPermission = function (callback) {
+        oncePermission = callback;
     };
 
-    return lib;
+    return Lib;
 }());