Merge pull request #2 from cwhenderson20/master

Update for use with webpack/browserify as well in a script tag

Author: sean3z

.gitignore

@@ -0,0 +1 @@
+node_modules

Gruntfile.js

@@ -5,9 +5,14 @@ This is a simple service that will emit a couple of events based on the users' D
 ```bash
 $ bower install angular-activity-monitor
 ```
+or
 
-#### Usage:
+```bash
+$ npm install --save angular-activity-monitor
+```
 
+#### Usage:
+**Bower:** 
 ```js
 angular.module('myModule', ['ActivityMonitor']);
 MyController.$inject = ['ActivityMonitor'];
@@ -18,11 +23,25 @@ function MyController(ActivityMonitor) {
   });
 }
 ```
+
+**npm (with Webpack or Bowserify)** :
+```js
+angular.module('myModule', [require('angular-activity-monitor')]);
+MyController.$inject = ['ActivityMonitor'];
+
+function MyController(ActivityMonitor) {
+  ActivityMonitor.on('inactive', function() {
+    alert("y0, you're inactive!");
+  });
+}
+```
+
 ##### `ActivityMonitor.options` (configuration):
  * `enabled`: whether to regularly check for inactivity (default: `false`) [bool]
  * `keepAlive`: background execution frequency (default: `800`) [seconds]
  * `inactive`: how long until user is considered inactive (default: `900`) [seconds]
  * `warning`: when user is nearing inactive state (deducted from inactive) (default: `60`) [seconds]
+ * `DOMevents`: array of events on the DOM that count as user activity (default: `['mousemove', 'mousedown', 'mouseup', 'keypress', 'wheel', 'touchstart', 'scroll']`)
 
 ##### `ActivityMonitor.user` (information about the user):
  * `action`: timestamp of the users' last action (default: `Date.now()`) [milliseconds]

README.md

@@ -1,10 +1,26 @@
 /*jshint -W116, -W030, latedef: false */
 'use strict';
 
-(function() {
-    angular
-        .module('ActivityMonitor', [])
-        .service('ActivityMonitor', ActivityMonitor);
+(function (root, factory) {
+    if (typeof module !== 'undefined' && module.exports) {
+        // CommonJS
+        if (typeof angular === 'undefined') {
+            factory(require('angular'));
+        } else {
+            factory(angular);
+        }
+        module.exports = 'ActivityMonitor';
+    } else if (typeof define === 'function' && define.amd) {
+        // AMD
+        define(['angular'], factory);
+    } else {
+        // Global variables
+        factory(root.angular);
+    }
+}(this, function (angular) {
+    var m = angular
+            .module('ActivityMonitor', [])
+            .service('ActivityMonitor', ActivityMonitor);
 
     var MILLISECOND = 1000;
     var EVENT_KEEPALIVE = 'keepAlive';
@@ -22,9 +38,12 @@
             keepAlive: 800, /* keepAlive ping invterval (seconds) */
             inactive: 900,  /* how long until user is considered inactive? (seconds) */
             warning: 60,    /* when to warn user when nearing inactive state (deducted from inactive in seconds) */
-            monitor: 3      /* how frequently to check if the user is inactive (seconds) */
+            monitor: 3,     /* how frequently to check if the user is inactive (seconds) */
+            DOMevents: ['mousemove', 'mousedown', 'mouseup', 'keypress', 'wheel', 'touchstart', 'scroll'] /* list of DOM events to determine user's activity */
         };
 
+        var DOMevents = service.options.DOMevents.join(' ');
+
         /* user activity */
         service.user = {
             action: Date.now(), /* timestamp of the users' last action */
@@ -47,9 +66,6 @@
             keepAlive: null     /* setInterval handle for ping handler (options.frequency) */
         };
 
-        /* list of DOM events to determine user's activity */
-        var DOMevents = ['mousemove', 'mousedown', 'keypress', 'wheel', 'touchstart', 'scroll'].join(' ');
-
         return service;
 
         ///////////////
@@ -68,14 +84,14 @@
             service.options.enabled = true;
             service.user.warning = false;
 
-            timer.keepAlive = setInterval(function() {
+            timer.keepAlive = setInterval(function () {
                 publish(EVENT_KEEPALIVE);
             }, service.options.keepAlive * MILLISECOND);
 
-            timer.inactivity = setInterval(function() {
+            timer.inactivity = setInterval(function () {
                 var now = Date.now();
-                var warning = now - ((service.options.inactive - service.options.warning) * MILLISECOND);
-                var inactive = now - (service.options.inactive * MILLISECOND);
+                var warning = now - (service.options.inactive - service.options.warning) * MILLISECOND;
+                var inactive = now - service.options.inactive * MILLISECOND;
 
                 /* should we display warning */
                 if (!service.user.warning && service.user.action <= warning) {
@@ -109,7 +125,7 @@
             if (!service.options.enabled) return;
             var spaces = Object.keys(events[event]);
             if (!event || !spaces.length) return;
-            spaces.forEach(function(space) {
+            spaces.forEach(function (space) {
                 events[event][space] && events[event][space]();
             });
         }
@@ -147,4 +163,6 @@
             };
         }
     }
-})();
+
+    return m;
+}));

activity-monitor.js

@@ -0,0 +1,58 @@
+'use strict';
+
+module.exports = function(config) {
+  config.set({
+
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: '',
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha', 'chai'],
+
+    // list of files / patterns to load in the browser
+    files: [
+      'node_modules/angular/angular.min.js',
+      'node_modules/angular-mocks/angular-mocks.js',
+      'activity-monitor.js',
+      'test/*.js'
+    ],
+
+    // list of files to exclude
+    exclude: [],
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {},
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ['progress'],
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+    // start these browsers
+    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
+    browsers: ['PhantomJS'],
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: true,
+
+    // Concurrency level
+    // how many browser should be started simultaneous
+    concurrency: Infinity
+  })
+}

activity-monitor.min.js

@@ -7,7 +7,8 @@
     "test": "test"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "karma start",
+    "build": "uglifyjs activity-monitor.js -o activity-monitor.min.js --screw-ie8 -c -m"
   },
   "repository": {
     "type": "git",
@@ -28,14 +29,18 @@
   },
   "homepage": "https://github.com/sean3z/angular-activity-monitor#readme",
   "devDependencies": {
-    "chai": "^3.4.1",
-    "grunt": "^0.4.5",
-    "grunt-cli": "^0.1.13",
-    "grunt-contrib-jshint": "^0.12.0",
-    "grunt-jscs": "^2.6.0",
-    "jit-grunt": "^0.9.1",
-    "jscs": "^2.8.0",
-    "jshint": "^2.9.1",
-    "mocha": "^2.3.4"
+    "angular": "~1.4.9",
+    "angular-mocks": "~1.4.9",
+    "chai": "~3.5.0",
+    "karma": "~0.13.19",
+    "karma-chai": "~0.1.0",
+    "karma-mocha": "~0.2.1",
+    "karma-phantomjs-launcher": "~1.0.0",
+    "mocha": "^2.3.4",
+    "phantomjs-prebuilt": "~2.1.3"
+  },
+  "dependencies": {
+    "eslint": "~1.10.3",
+    "uglify-js": "~2.6.1"
   }
 }