http-auth-utils - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

dist/index.js

@@ -26,5 +26,18 @@ 'use strict';
 /**
+ * Basic authentication mecanism.
+ * @type {Object}
+ * @see  {@link module:http-auth-utils/mecanisms/basic}
+ */
+exports.BASIC = _mecanismsBasic2['default'];
+
+/**
+ * Digest authentication mecanism.
+ * @type {Object}
+ * @see  {@link module:http-auth-utils/mecanisms/digest}
+ */
+exports.DIGEST = _mecanismsDigest2['default'];
+
+/**
  * Natively supported authentication mecanisms.
  * @type {Array}
- * @see  The Basic {@link module:http-auth-utils/mecanisms/basic} and Digest {@link module:http-auth-utils/mecanisms/digest}
  */
@@ -31,0 +44,0 @@ var mecanisms = [_mecanismsBasic2['default'], _mecanismsDigest2['default']];

dist/index.mocha.js

@@ -35,2 +35,4 @@ 'use strict';
         data: {
+          username: 'Aladdin',
+          password: 'open sesame',
           hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
@@ -47,3 +49,8 @@ }
     });
+
+    it('should export bot DIGEST and BASIC  mecanisms', function () {
+      (0, _assert2['default'])(_index.BASIC);
+      (0, _assert2['default'])(_index.DIGEST);
+    });
   });
 });

dist/mecanisms/basic.js

@@ -75,3 +75,5 @@ /**
    *   BASIC.parseAuthorizationRest('QWxhZGRpbjpvcGVuIHNlc2FtZQ=='), {
-   *     hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+   *     hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+   *     username: 'Aladdin',
+   *     password: 'open sesame'
    *   }
@@ -85,4 +87,12 @@ * );
     }
+
+    var _BASIC$decodeHash = BASIC.decodeHash(rest);
+
+    var username = _BASIC$decodeHash.username;
+    var password = _BASIC$decodeHash.password;
+
     return {
-      hash: rest
+      hash: rest,
+      username: username,
+      password: password
     };
@@ -104,5 +114,15 @@ },
    */
-  buildAuthorizationRest: function buildAuthorizationRest(_ref) {
+  buildAuthorizationRest: function buildAuthorizationRest() {
+    var _ref = arguments[0] === undefined ? {} : arguments[0];
+
     var hash = _ref.hash;
+    var username = _ref.username;
+    var password = _ref.password;
 
+    if (username && password) {
+      return BASIC.computeHash({ username: username, password: password });
+    }
+    if (!hash) {
+      throw new _yerror2['default']('E_NO_HASH');
+    }
     return hash;
@@ -109,0 +129,0 @@ },

dist/mecanisms/basic.mocha.js

@@ -56,3 +56,5 @@ 'use strict';
       (0, _neatequal2['default'])(_basic2['default'].parseAuthorizationRest('QWxhZGRpbjpvcGVuIHNlc2FtZQ=='), {
-        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+        username: 'Aladdin',
+        password: 'open sesame'
       });
@@ -64,4 +66,11 @@ });
 
-    it('should work', function () {
+    it('should work with credentials', function () {
       _assert2['default'].equal(_basic2['default'].buildAuthorizationRest({
+        username: 'Aladdin',
+        password: 'open sesame'
+      }), 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==');
+    });
+
+    it('should work with just the hash', function () {
+      _assert2['default'].equal(_basic2['default'].buildAuthorizationRest({
         hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
@@ -73,5 +82,9 @@ }), 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==');
       (0, _neatequal2['default'])(_basic2['default'].parseAuthorizationRest(_basic2['default'].buildAuthorizationRest({
-        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+        username: 'Aladdin',
+        password: 'open sesame'
       })), {
-        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+        hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+        username: 'Aladdin',
+        password: 'open sesame'
       });
@@ -78,0 +91,0 @@ });

package.json

 {
   "name": "http-auth-utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Parse, build and deal with HTTP auth headers.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -51,3 +51,2 @@ # http-auth-utils
 **Kind**: static constant of <code>[http-auth-utils](#module_http-auth-utils)</code>
-**See**: The Basic [http-auth-utils/mecanisms/basic](#module_http-auth-utils/mecanisms/basic) and Digest [http-auth-utils/mecanisms/digest](#module_http-auth-utils/mecanisms/digest)
 <a name="module_http-auth-utils.parseWWWAuthenticateHeader"></a>
@@ -54,0 +53,0 @@ ### http-auth-utils.parseWWWAuthenticateHeader ⇒ <code>Object</code>

src/index.js

@@ -11,5 +11,18 @@ import YError from 'yerror';
 /**
+ * Basic authentication mecanism.
+ * @type {Object}
+ * @see  {@link module:http-auth-utils/mecanisms/basic}
+ */
+export {BASIC as BASIC};
+
+/**
+ * Digest authentication mecanism.
+ * @type {Object}
+ * @see  {@link module:http-auth-utils/mecanisms/digest}
+ */
+export {DIGEST as DIGEST};
+
+/**
  * Natively supported authentication mecanisms.
  * @type {Array}
- * @see  The Basic {@link module:http-auth-utils/mecanisms/basic} and Digest {@link module:http-auth-utils/mecanisms/digest}
  */
@@ -16,0 +29,0 @@ export const mecanisms = [BASIC, DIGEST];

src/index.mocha.js

@@ -6,3 +6,5 @@ import assert from 'assert';
   parseAuthorizationHeader,
-  mecanisms
+  mecanisms,
+  BASIC,
+  DIGEST
 } from './index';
@@ -34,2 +36,4 @@
           data: {
+          username: 'Aladdin',
+          password: 'open sesame',
             hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
@@ -52,4 +56,9 @@ }
 
+    it('should export bot DIGEST and BASIC  mecanisms', function() {
+      assert(BASIC);
+      assert(DIGEST);
+    });
+
   });
 
 });

src/mecanisms/basic.js

@@ -66,3 +66,5 @@ /**
    *   BASIC.parseAuthorizationRest('QWxhZGRpbjpvcGVuIHNlc2FtZQ=='), {
-   *     hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+   *     hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+   *     username: 'Aladdin',
+   *     password: 'open sesame'
    *   }
@@ -76,4 +78,7 @@ * );
     }
+    let {username, password} = BASIC.decodeHash(rest);
     return {
-      hash: rest
+      hash: rest,
+      username,
+      password
     };
@@ -95,3 +100,9 @@ },
    */
-  buildAuthorizationRest: function buildAuthorizationRest({hash}) {
+  buildAuthorizationRest: function buildAuthorizationRest({hash, username, password} = {}) {
+    if(username && password) {
+      return BASIC.computeHash({username, password});
+    }
+    if(!hash) {
+      throw new YError('E_NO_HASH');
+    }
     return hash;
@@ -98,0 +109,0 @@ },

src/mecanisms/basic.mocha.js

@@ -56,3 +56,5 @@ import assert from 'assert';
         BASIC.parseAuthorizationRest('QWxhZGRpbjpvcGVuIHNlc2FtZQ=='), {
-          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+          username: 'Aladdin',
+          password: 'open sesame'
         }
@@ -66,5 +68,15 @@ );
 
-    it('should work', function() {
+    it('should work with credentials', function() {
       assert.equal(
         BASIC.buildAuthorizationRest({
+          username: 'Aladdin',
+          password: 'open sesame'
+        }),
+        'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+      );
+    });
+
+    it('should work with just the hash', function() {
+      assert.equal(
+        BASIC.buildAuthorizationRest({
           hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
@@ -80,6 +92,10 @@ }),
           BASIC.buildAuthorizationRest({
-          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+          username: 'Aladdin',
+          password: 'open sesame'
           })
         ), {
-          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ=='
+          hash: 'QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
+          username: 'Aladdin',
+          password: 'open sesame'
       });
@@ -86,0 +102,0 @@ });

No alert changes

Improved metrics

Total package byte prevSize

89972

increased by27.58%

Number of package files

22

increased by4.76%

Lines of code

1515

increased by6.32%

Worsened metrics

Number of lines in readme file

454

decreased by-0.22%

No dependency changes