licenses - npm Package Compare versions

Comparing version 0.0.7 to 0.0.9

github.js

@@ -32,2 +32,3 @@ 'use strict';
     'license',
+    'licence',
     'readme',
@@ -38,3 +39,3 @@ ].concat([
   ].reduce(function flatten(slim, extension) {
-    slim.push('license.'+ extension, 'readme.'+ extension);
+    slim.push('license.'+ extension, 'readme.'+ extension, 'licence.'+ extension);
     return slim;
@@ -92,2 +93,6 @@ }, [])),
           });
+        }).sort(function sort(a, b) {
+          if (a.name > b.name) return 1;
+          if (b.name < b.name) return -1;
+          return 0;
         });
@@ -94,0 +99,0 @@

index.js

 'use strict';
 
 var debug = require('debug')('licenses::parse')
-  , request = require('request')
+  , Registry = require('npm.js')
   , async = require('async')
@@ -9,3 +9,12 @@ , url = require('url');
 /**
- * @param {String} name The module name or the package.json contents.
+ * Start searching for license information for the given module name.
+ *
+ * Options:
+ *
+ * - githulk: A pre-configured githulk instance.
+ * - order: The order of resolving license information.
+ * - npmjs: A pre-configured npm.js instance.
+ * - registry: A registry to use for the npmjs instance.
+ *
+ * @param {Mixed} name The module name or the package.json contents.
  * @param {Object} options Configuration of the parse process.
@@ -22,5 +31,9 @@ * @param {Function} fn Callback.
   options = options || {};
-  options.registry = options.registry || 'http://registry.nodejitsu.com';
-  options.order = options.order || ['registry', 'content', 'github'];
   options.githulk = options.githulk || null;
+  options.order = options.order || ['registry', 'github', 'content'];
+  options.registry = options.registy || Registry.mirrors.nodejitsu;
+  options.npmjs = options.npmjs || new Registry({
+    registry: options.registry,
+    githulk: options.githulk
+  });
 
@@ -35,33 +48,3 @@ async.waterfall([
 
-      debug('was given a string, retreiving package from npm : %s', options.registry);
-
-      request({
-        uri: url.resolve(options.registry, name),
-        method: 'GET',
-        json: true
-      }, function fetched(err, res, data) {
-        if (err) return next(err);
-        if (res.statusCode !== 200) return next(new Error('Invalid statusCode: '+ res.statusCode));
-
-        //
-        // With npm you can never be sure of the data structure. We want to get
-        // the latest package from the data structure so we need double, triple
-        // checks.
-        //
-        if (
-             'object' === typeof data
-          && 'dist-tags' in data
-          && 'object' === typeof data.versions
-          && 'latest' in data['dist-tags']
-          && data['dist-tags'].latest in data.versions
-        ) {
-          var readme = data.readme;
-          data = data.versions[data['dist-tags'].latest];
-          data.readme = data.readme || readme;
-
-          debug('found "dist-tags" updating data to latest version');
-        }
-
-        next(err, data);
-      });
+      options.npmjs.packages.get(name, next);
     },
@@ -74,3 +57,6 @@
       if (!options.order.length) return next();
+      if (Array.isArray(data)) data = data[0];
 
+      debug('searching for licensing information for %s', data.name);
+
       var parser, result, name;
@@ -96,3 +82,4 @@
         return !result && options.order.length;
-      }, function done(err) {
+      }, function cleanup(err) {
+        options = null;
         next(err, result, name);
@@ -99,0 +86,0 @@ });

package.json

 {
   "name": "licenses",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A small tool that detects licensing information for a given Node.js module",
@@ -24,3 +24,3 @@ "main": "index.js",
     "githulk": "0.0.x",
-    "request": "2.33.x"
+    "npm.js": "0.0.x"
   },
@@ -27,0 +27,0 @@ "devDependencies": {

parser.js

@@ -32,3 +32,2 @@ 'use strict';
 Parser.readable('async', require('async'));
-Parser.readable('request', require('request'));
 
@@ -35,0 +34,0 @@ /**

registry.js

@@ -50,2 +50,4 @@ 'use strict';
   /**
+   * Return the possible location of license information.
+   *
    * @param {Object} data The object that should contain the license.
@@ -52,0 +54,0 @@ * @returns {String}

test/parser.test.js

@@ -7,5 +7,9 @@ describe('Parser', function () {
 
-  var Parser = require('../').Parser
+  var licenses = require('../')
+    , Parser = licenses.Parser
     , parser = new Parser();
 
+  var Registry = require('npm.js')
+    , npmjs = new Registry({ registry: Registry.mirrors.npmjs });
+
   it('exposes the `async` module', function () {
@@ -15,6 +19,2 @@ expect(parser.async).to.equal(require('async'));
 
-  it('exposes the `request` module', function () {
-    expect(parser.request).to.equal(require('request'));
-  });
-
   describe('#test', function () {
@@ -111,2 +111,35 @@ it('provides basic checks of license fragments');
   });
+
+  describe('actual detection', function () {
+    //
+    // Bump the timeout limit for these tests as we need to resolve a lot of
+    // information and API endpoints in order to get accurate information.
+    //
+    this.timeout(20000);
+
+    it('detects multiple licenses for metawidget', function (next) {
+      licenses('metawidget', { npmjs: npmjs }, function resolved(err, licenses) {
+        if (err) return next(err);
+
+        expect(licenses.length).to.equal(3);
+
+        expect(licenses).to.include('LGPL');
+        expect(licenses).to.include('EPL');
+        expect(licenses).to.include('Commercial');
+
+        next();
+      });
+    });
+
+    it('detects MIT for eventemitter3', function (next) {
+      licenses('eventemitter3', { npmjs: npmjs }, function resolved(err, licenses) {
+        if (err) return next(err);
+
+        expect(licenses.length).to.equal(1);
+        expect(licenses).to.include('MIT');
+
+        next();
+      });
+    });
+  });
 });

No alert changes

Improved metrics

Total package byte prevSize

1172861

increased by0.03%

Lines of code

4410

increased by0.2%

Worsened metrics

Number of package files

40

decreased by-2.44%

Dependency changes

• + Addednpm.js@0.0.x

• + Addedajv@6.12.6(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedpsl@1.15.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• - Removedrequest@2.33.x

• - Removedasn1@0.1.11(transitive)

• - Removedassert-plus@0.1.5(transitive)

• - Removedasync@0.9.2(transitive)

• - Removedaws-sign2@0.5.0(transitive)

• - Removedboom@0.4.2(transitive)

• - Removedcombined-stream@0.0.7(transitive)

• - Removedcryptiles@0.2.2(transitive)

• - Removedctype@0.5.3(transitive)

• - Removeddelayed-stream@0.0.5(transitive)

• - Removedforever-agent@0.5.2(transitive)

• - Removedform-data@0.1.4(transitive)

• - Removedhawk@1.0.0(transitive)

• - Removedhoek@0.9.1(transitive)

• - Removedhttp-signature@0.10.1(transitive)

• - Removedmime@1.2.11(transitive)

• - Removednode-uuid@1.4.8(transitive)

• - Removedoauth-sign@0.3.0(transitive)

• - Removedqs@0.6.6(transitive)

• - Removedrequest@2.33.0(transitive)

• - Removedsntp@0.2.4(transitive)

• - Removedtldts@6.1.77(transitive)

• - Removedtldts-core@6.1.77(transitive)

• - Removedtough-cookie@5.1.1(transitive)

• - Removedtunnel-agent@0.3.0(transitive)