Rename main file to ng-navigation-service.js

* Rename main file to ng-navigation-service so it matches the package
name.
* Update to README for better explanation of dependency on
ng-authentication-service.
* Update version to 1.0.0.

Author: justinsa

README.md

@@ -9,54 +9,57 @@ A navigation helper service for Angular client applications.
 
 * AngularJS - http://angularjs.org
 * Lodash - http://lodash.com
+* ng-authentication-service - https://github.com/justinsa/angular-authentication-service
+
+The ng-navigation-service was designed in tandem with the ng-authentication-service, but it is not a hard requirement. The configured security service must support the following API:
+
+  1. ```boolean isAuthenticated()```
+  2. ```[String] roles()```
 
 ##Basic Setup
 
-1. Add this module to your app as a dependency:
+Add this module to your app as a dependency:
 ```JAVASCRIPT
 var app = angular.module('yourApp', ['navigation.service']);
 ```
-2. Configure a security service to use with the navigation provider:
+
+Configure a security service to use with the navigation provider:
 ```JAVASCRIPT
 app.config(['$navigationProvider', function ($navigationProvider) {
   $navigationProvider.configure({
-    securityService: 'authentication.service'
+    securityService: '$authentication'
   });
 }]);
 ```
-3. Inject $navigation as a parameter in declarations that require it:
+
+Inject $navigation as a parameter in declarations that require it:
 ```JAVASCRIPT
 app.controller('yourController', function($scope, $navigation){ ... });
 ```
 
 ##Configuration Options
 
-The default configuration is:
+To override the default configuration options, configure the module with an options argument during application configuration and provide overrides for any of the following options.
 
-1. securityService: undefined - this string value must be provided during configuration and must be a loaded service that supports the following API:
-  1. function ```isAuthenticated()```
-  2. function ```roles()```
-2. roleToAudienceMapFunction: function returns the userRole provided.
-3. inAudienceValidationFunction: function determines if the userRoles are in the audiences.
-4. activeLinkDecorator: mixed
-5. inactiveLinkDecorator: mixed
-
-To override the default configuration options, configure the module with an options argument during application configuration:
 ```JAVASCRIPT
 app.config(['$navigationProvider', function ($navigationProvider) {
   $navigationProvider.configure({
-    securityService: 'authentication.service',
-    roleToAudienceMapFunction: function (userRole) { ... },
-    inAudienceValidationFunction: function (userRoles, audiences) { ... }
+    activeLinkDecorator: undefined,
+    inactiveLinkDecorator: undefined,
+    securityService: undefined,
+    roleToAudienceMapFunction: function (userRole) {
+      return userRole;
+    },
+    inAudienceValidationFunction: function (userRoles, audiences) {
+      var userAudiences = _.flatten(userRoles, this.roleToAudienceMapFunction);
+      return !_.isEmpty(userAudiences) && !_.isEmpty(audiences) &&
+        (_.find(audiences, function (audience) { return _.includes(userAudiences, audience); }) !== undefined);
+    }
   });
 }]);
 ```
 
-The ng-navigation-service was designed in tandem with the following projects:
-
-* https://github.com/justinsa/angular-authentication-service
-
-##Basic Usage
+##API
 
 ###inAudience
 ```JAVASCRIPT

bower.json

@@ -12,7 +12,7 @@
   ],
   "homepage": "https://github.com/justinsa/angular-navigation-service",
   "license": "MIT",
-  "main": "./angular-navigation-service.js",
+  "main": "./ng-navigation-service.js",
   "ignore": [
     ".jshintrc",
     "gulpfile.js",

gulpfile.js

@@ -2,7 +2,7 @@
 var gulp = require('gulp');
 var jshint = require('gulp-jshint');
 gulp.task('js:lint', function() {
-  return gulp.src(['./angular-navigation-service.js', './gulpfile.js', './tests.js'])
+  return gulp.src(['./ng-navigation-service.js', './gulpfile.js', './tests.js'])
     .pipe(jshint())
     .pipe(jshint.reporter('default'));
 });

angular-navigation-service.js renamed to ng-navigation-service.js

@@ -2,14 +2,10 @@
 (function (root, factory) {
   'use strict';
   if (typeof module !== 'undefined' && module.exports) {
-    if (typeof angular === 'undefined') {
-      factory(
-        typeof _ === 'undefined' ? require('lodash') : root._,
-        require('angular')
-      );
-    } else {
-      factory(root._, root.angular);
-    }
+    factory(
+      typeof _ === 'undefined' ? require('lodash') : root._,
+      typeof angular === 'undefined' ? require('angular') : root.angular
+    );
     module.exports = 'ng-navigation-service';
   } else if (typeof define === 'function' && define.amd) {
     define(['lodash', 'angular'], factory);
@@ -55,7 +51,7 @@
           secService = $injector.get(configuration.securityService);
           _.each(['isAuthenticated', 'roles'], function (methodName) {
             if (!_.has(secService, methodName)) {
-              $log.error('Matching service is missing method: ', methodName);
+              $log.error('Matching securityService is missing method: ', methodName);
               return undefined;
             }
           });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ng-navigation-service",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "author": "Justin Saunders (https://github.com/justinsa)",
   "contributors": [
     "Justin Saunders (https://github.com/justinsa)"

test.html

@@ -18,7 +18,7 @@
     <script src="./node_modules/angular/angular.js"></script>
     <script src="./node_modules/angular-mocks/angular-mocks.js"></script>
 
-    <script src="./angular-navigation-service.js"></script>
+    <script src="./ng-navigation-service.js"></script>
 
     <script src="./tests.js"></script>