Refactor to ES module

- bundling with rollup
- updating `package.json`
- updating tests
- setup linter
- updating ci config

Author: vladimyr

.eslintignore

@@ -0,0 +1 @@
+lib

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: 'semistandard',
+  rules: {
+    'prefer-const': 'error',
+    'space-before-function-paren': ['error', {
+      anonymous: 'always',
+      named: 'never'
+    }]
+  }
+};

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+lib
 .tmp_*~
 *#
 .#*

.travis.yml

@@ -1,5 +1,11 @@
 language: node_js
+
+script:
+  - yarn run lint
+  - yarn test
+
 node_js:
   - 8
+  - 10
   - node
   - lts/*

index.js

@@ -3,17 +3,22 @@
   "description": "Gravatar Node.js library",
   "keywords": [
     "gravatar",
-    "avatar",
-    "package.json"
+    "avatar"
   ],
   "version": "1.8.0",
   "author": "Emerson Macedo <emerleite@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git://github.com/emerleite/node-gravatar.git"
   },
+  "files": [
+    "lib"
+  ],
   "dependencies": {
-    "blueimp-md5": "^2.3.0",
+    "normalize-url": "^4.3.0",
+    "yargs": "^13.2.4"
+  },
+  "devDependencies": {
     "email-validator": "^2.0.4",
     "eslint": "^5.16.0",
     "eslint-config-semistandard": "^13.0.0",
@@ -22,19 +27,20 @@
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^4.0.0",
-    "path": "^0.12.7",
-    "querystring": "0.2.0",
-    "yargs": "^13.2.4"
-  },
-  "devDependencies": {
     "mocha": "6.1.4",
     "nixt": "^0.5.1",
+    "rollup": "^1.15.2",
+    "rollup-plugin-commonjs": "^10.0.0",
+    "rollup-plugin-node-resolve": "^5.0.1",
     "should": "13.2.3"
   },
-  "main": "index.js",
+  "main": "lib/gravatar.js",
+  "module": "lib/gravatar.esm.js",
   "scripts": {
     "lint": "eslint .",
-    "test": "node_modules/mocha/bin/mocha -R spec"
+    "build": "rollup -c rollup.config.js",
+    "pretest": "yarn run build",
+    "test": "mocha -R spec"
   },
   "license": "MIT",
   "engines": {

lib/gravatar.js

@@ -0,0 +1,29 @@
+import commonJs from 'rollup-plugin-commonjs';
+import path from 'path';
+import resolve from 'rollup-plugin-node-resolve';
+
+/** @type import('rollup').RollupOptions */
+const baseConfig = {
+  input: 'src/gravatar.js',
+  plugins: [
+    resolve({ preferBuiltins: true }),
+    commonJs()
+  ]
+};
+
+/** @type Array<import('rollup').RollupOptions> */
+const config = [{
+  ...baseConfig,
+  output: {
+    format: 'esm',
+    file: path.join(__dirname, 'lib/gravatar.esm.js')
+  }
+}, {
+  ...baseConfig,
+  output: {
+    format: 'cjs',
+    file: path.join(__dirname, 'lib/gravatar.js')
+  }
+}];
+
+export default config;

package.json

@@ -0,0 +1,65 @@
+import crypto from 'crypto';
+import { deprecate } from 'util';
+import normalizeUrl from 'normalize-url';
+import { URLSearchParams } from 'url';
+
+const isBoolean = arg => typeof arg === 'boolean';
+const isString = arg => typeof arg === 'string';
+const isUndefined = arg => typeof arg === 'undefined';
+const md5 = val => crypto.createHash('md5').update(val, 'utf8').digest('hex');
+
+const BASE_URL = '//gravatar.com';
+const RE_MD5 = /^[0-9a-f]{32}$/;
+
+function proto({ protocol } = {}) {
+  if (isBoolean(protocol)) return protocol;
+  if (protocol === 'https') return true;
+  if (protocol === 'http') return false;
+}
+
+function getHash(email) {
+  email = isString(email) ? email.trim().toLowerCase() : 'unspecified';
+  if (RE_MD5.test(email)) return email;
+  return md5(email);
+}
+
+function getQuery({ format, protocol, cdn, ...options } = {}) {
+  const entries = Object.entries(options);
+  if (!entries.length) return '';
+  const searchParams = new URLSearchParams(entries);
+  return `?${searchParams}`;
+}
+function url(email, { cdn, ...options } = {}, protocol = proto(options)) {
+  let url;
+  if (cdn) {
+    url = `${cdn}/avatar`;
+  } else {
+    url = `${BASE_URL}/avatar`;
+    if (!isUndefined(protocol)) {
+      url = normalizeUrl(url, { forceHttps: protocol });
+    }
+  }
+  const hash = getHash(email);
+  const query = getQuery(options);
+  return `${url}/${hash}${query}`;
+}
+
+function profileUrl(email, { cdn, format = 'json', ...options } = {}, protocol = proto(options)) {
+  let url = '';
+  if (cdn) {
+    url = `${cdn}`;
+  } else {
+    url = BASE_URL;
+    const defaultProtocol = protocol ? 'https:' : 'http:';
+    url = normalizeUrl(url, { defaultProtocol });
+  }
+  const hash = getHash(email);
+  const query = getQuery(options);
+  return `${url}/${hash}.${format}${query}`;
+}
+
+export default {
+  url,
+  profileUrl,
+  profile_url: deprecate(profileUrl, 'profile_url() is deprecated. Use profileUrl() instead.')
+};

rollup.config.js

@@ -1,15 +1,21 @@
-/* eslint-disable */
-const should = require('should');
-const url = require('url');
+'use strict';
+
+/* eslint-env mocha */
+
+require('should');
+const { URL } = require('url');
+const gravatar = require('..');
 const nixt = require('nixt');
-const gravatar = require('../lib/gravatar');
+const normalizeUrl = require('normalize-url');
+
+const parseUrl = url => new URL(normalizeUrl(url));
 
 describe('gravatar', function () {
-  const baseNoProtocolURL = '//www.gravatar.com/avatar/';
-  const baseUnsecureURL = 'http://www.gravatar.com/avatar/';
-  const baseSecureURL = 'https://s.gravatar.com/avatar/';
-  const profileURL = 'http://www.gravatar.com/';
-  const profileSecureURL = 'https://secure.gravatar.com/';
+  const baseNoProtocolURL = '//gravatar.com/avatar/';
+  const baseUnsecureURL = 'http://gravatar.com/avatar/';
+  const baseSecureURL = 'https://gravatar.com/avatar/';
+  const profileURL = 'http://gravatar.com/';
+  const profileSecureURL = 'https://gravatar.com/';
   const unspecifiedHash = 'd415f0e30c471dfdd9bc4f827329ef48';
 
   it('should gererate correct uri given an email', function () {
@@ -30,11 +36,11 @@ describe('gravatar', function () {
 
   it('should generate uri with user passed parameters', function () {
     const gravatarURL = gravatar.url('emerleite@gmail.com', { s: '200', f: 'y', r: 'g', d: '404' });
-    const queryString = url.parse(gravatarURL, true).query;
-    queryString.s.should.equal('200');
-    queryString.f.should.equal('y');
-    queryString.r.should.equal('g');
-    queryString.d.should.equal('404');
+    const { searchParams } = parseUrl(gravatarURL);
+    searchParams.get('s').should.equal('200');
+    searchParams.get('f').should.equal('y');
+    searchParams.get('r').should.equal('g');
+    searchParams.get('d').should.equal('404');
   });
 
   it('should force http protocol on gravatar uri generation', function () {
@@ -48,9 +54,11 @@ describe('gravatar', function () {
   });
 
   it('should handle falsey values for the email property', function () {
+    /* eslint-disable no-unused-expressions */
     gravatar.url(null).should.be.ok;
     gravatar.url(undefined).should.be.ok;
     gravatar.url('').should.be.ok;
+    /* eslint-enable */
   });
 
   it('should handle non string values for the email property', function () {
@@ -82,11 +90,11 @@ describe('gravatar', function () {
 
   it('should generate uri with user passed parameters and protocol in options', function () {
     const gravatarURL = gravatar.url('emerleite@gmail.com', { protocol: 'https', s: '200', f: 'y', r: 'g', d: '404' });
-    const queryString = url.parse(gravatarURL, true).query;
-    queryString.s.should.equal('200');
-    queryString.f.should.equal('y');
-    queryString.r.should.equal('g');
-    queryString.d.should.equal('404');
+    const { searchParams } = parseUrl(gravatarURL);
+    searchParams.get('s').should.equal('200');
+    searchParams.get('f').should.equal('y');
+    searchParams.get('r').should.equal('g');
+    searchParams.get('d').should.equal('404');
   });
 
   it('should generate profile url with protocol in options', function () {
@@ -112,7 +120,7 @@ describe('CLI', function () {
     it('accepts an email argument with options and writes gravatar URL to STDOUT', function (done) {
       nixt()
         .run('./cli.js zeke@sikelianos.com -p https -s 500 -d retro')
-        .stdout('Gravatar (avatar):\nhttps://s.gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?default=retro&size=500')
+        .stdout('Gravatar (avatar):\nhttps://gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?default=retro&size=500')
         .end(done);
     });
     it('outputs usage if -h arg is present', function (done) {
@@ -127,7 +135,7 @@ describe('CLI', function () {
     it('accepts an email argument with options and writes gravatar URL to STDOUT', function (done) {
       nixt()
         .run('./cli.js avatar zeke@sikelianos.com -p https -s 500 -d retro')
-        .stdout('Gravatar (avatar):\nhttps://s.gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?default=retro&size=500')
+        .stdout('Gravatar (avatar):\nhttps://gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?default=retro&size=500')
         .end(done);
     });
   });
@@ -136,7 +144,7 @@ describe('CLI', function () {
     it('accepts an email argument with options and writes gravatar profile URL to STDOUT', function (done) {
       nixt()
         .run('./cli.js profile zeke@sikelianos.com -p https -c doSomething')
-        .stdout('Gravatar (profile):\nhttps://secure.gravatar.com/8f344b1c4bdcfc28bd848e97e94c3523.json?callback=doSomething')
+        .stdout('Gravatar (profile):\nhttps://gravatar.com/8f344b1c4bdcfc28bd848e97e94c3523.json?callback=doSomething')
         .end(done);
     });
   });