make prettier

.gitignore

@@ -1,2 +1,78 @@
-node_modules
+# ---> Node
-package-lock.json
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+# FuseBox cache
+.fusebox/
+

README.md

@@ -2,7 +2,6 @@
 
 NameCheap DNS + Let's Encrypt
 
-
 This handles ACME dns-01 challenges, compatible with ACME.js and Greenlock.js.
 Passes [acme-dns-01-test](https://git.rootprojects.org/root/acme-dns-01-test.js).
 
@@ -22,7 +21,7 @@ var dns01 = require('acme-dns-01-namecheap').create({
 	apiKey: 'xxxx',
 	clientIp: 'public ip',
 	username: 'api user',
-	baseUrl: 'sandbox or production', // default production
+	baseUrl: 'sandbox or production' // default production
 });
 ```
 
@@ -63,10 +62,10 @@ dns01
 		dnsAuthorization: 'xxx_secret_xxx'
 	})
 	.then(function() {
-    console.log("TXT record set");
+		console.log('TXT record set');
 	})
 	.catch(function() {
-    console.log("Failed to set TXT record");
+		console.log('Failed to set TXT record');
 	});
 ```
 
@@ -77,6 +76,5 @@ for more implementation details.
 
 ```bash
 # node ./test.js domain-zone api-user api-key client-ip username [username is optional if similar to api-user]
-node ./test.js example.com demo 45.77.4.126 d41474b94e7d4536baabb074a09c96bd
+node ./test.js example.com demo d41474b94e7d4536baabb074a09c96bd 45.77.4.126
-
 ```

example.env

@@ -0,0 +1,6 @@
+ZONE=example.co.uk
+
+API_USER=exampleuser
+API_KEY=xxxxxxxxxxxxxxx
+USERNAME=exampleuser
+CLIENT_IP=121.22.123.22

lib/index.js

@@ -5,11 +5,9 @@ var request; // = require('@root/request');
 var parseString = require('xml2js').parseString;
 parseString = util.promisify(parseString);
 
-
 const SANDBOX_URL = 'https://api.sandbox.namecheap.com/xml.response';
 const PRODUCTION_URL = 'https://api.namecheap.com/xml.response';
 
-
 var defaults = {
 	baseUrl: SANDBOX_URL
 };
@@ -25,13 +23,19 @@ function extend(obj) {
 }
 
 function assign(obj1, obj2) {
-    for (var attrname in obj2) { obj1[attrname] = obj2[attrname]; }
+	for (var attrname in obj2) {
+		obj1[attrname] = obj2[attrname];
+	}
 }
 
 function requestUrl(baseUrl, params) {
-    var queryString = Object.keys(params).map(function (key) {
+	var queryString = Object.keys(params)
-        return encodeURIComponent(key) + '=' + encodeURIComponent(params[key]);
+		.map(function(key) {
-    }).join('&');
+			return (
+				encodeURIComponent(key) + '=' + encodeURIComponent(params[key])
+			);
+		})
+		.join('&');
 	// console.debug(queryString);
 	return baseUrl + '?' + queryString;
 }
@@ -54,23 +58,39 @@ module.exports.create = function (config) {
 
 		var url = requestUrl(baseUrl, requestParams);
 		console.log('DEBUG >>> url: ' + url);
-        console.log('DEBUG >>> requestParams: ' + JSON.stringify(requestParams, null, 2));
+		console.log(
+			'DEBUG >>> requestParams: ' + JSON.stringify(requestParams, null, 2)
+		);
 
 		return request({
 			method: 'POST',
-            url: url,
+			url: url
 		}).then(function(response) {
 			var responseBody = response.body;
 			// console.log(responseBody);
 			return parseString(responseBody).then(function(result) {
 				// check response status
 				if (result['ApiResponse']['$']['Status'] === 'ERROR') {
-                    for (let i = 0; i < result['ApiResponse']['Errors'].length; i++) {
+					for (
-                        console.log('DEBUG >>> error: ' + JSON.stringify(result['ApiResponse']['Errors'][i]['Error'][0], null, 2));
+						let i = 0;
+						i < result['ApiResponse']['Errors'].length;
+						i++
+					) {
+						console.log(
+							'DEBUG >>> error: ' +
+								JSON.stringify(
+									result['ApiResponse']['Errors'][i][
+										'Error'
+									][0],
+									null,
+									2
+								)
+						);
 					}
 					throw new Error('API Error');
-                } else { // Status="OK"
+				} else {
-                    return result['ApiResponse']['CommandResponse'][0]
+					// Status="OK"
+					return result['ApiResponse']['CommandResponse'][0];
 				}
 			});
 		});
@@ -83,13 +103,14 @@ module.exports.create = function (config) {
 		},
 
 		zones: function(data) {
-            return api('namecheap.domains.getList',{}).then(function (zonesResponse) {
+			return api('namecheap.domains.getList', {}).then(function(
+				zonesResponse
+			) {
 				// console.log('zones');
 				// console.log(zonesResponse);
 				return zonesResponse['DomainGetListResult'].map(function(x) {
 					return x['Domain'][0]['$']['Name'];
 				});
-
 			});
 		},
 
@@ -121,12 +142,18 @@ module.exports.create = function (config) {
 			// setting a host record overwrites all existing,
 			// adding a new records means you've have to send back all previous records too
 
-            return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
+			return api('namecheap.domains.dns.getHosts', params).then(function(
-                var currentHostRecordsCount = hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
+				hostsResponse
+			) {
+				var currentHostRecordsCount =
+					hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
 
 				for (var i = 0; i < currentHostRecordsCount; i++) {
 					// console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]);
-                    var currentEntry =  hostsResponse['DomainDNSGetHostsResult'][0]['host'][i]['$'];
+					var currentEntry =
+						hostsResponse['DomainDNSGetHostsResult'][0]['host'][i][
+							'$'
+						];
 
 					params['HostName' + (i + 1)] = currentEntry['Name'];
 					params['RecordType' + (i + 1)] = currentEntry['Type'];
@@ -134,22 +161,26 @@ module.exports.create = function (config) {
 					params['TTL' + (i + 1)] = currentEntry['TTL'];
 				}
 
-                params['HostName'+(currentHostRecordsCount+1)] = ch.dnsPrefix;
+				params['HostName' + (currentHostRecordsCount + 1)] =
+					ch.dnsPrefix;
 				params['RecordType' + (currentHostRecordsCount + 1)] = 'TXT';
 				params['Address' + (currentHostRecordsCount + 1)] = txt;
 				params['TTL' + (currentHostRecordsCount + 1)] = 100; // in minutes
 
 				// console.log(params);
 
-                return api('namecheap.domains.dns.setHosts',params).then(function (setHostResponse) {
+				return api('namecheap.domains.dns.setHosts', params)
+					.then(function(setHostResponse) {
 						// console.log('setHost');
 						// console.log(setHostResponse);
-                    return true
+						return true;
-                }).catch(function (err) {
+					})
-                    throw new Error('record did not set. check subdomain, api key, etc');
+					.catch(function(err) {
+						throw new Error(
+							'record did not set. check subdomain, api key, etc'
+						);
 					});
 			});
-
 		},
 		remove: function(data) {
 			var ch = data.challenge;
@@ -164,12 +195,18 @@ module.exports.create = function (config) {
 			// setting a host record overwrites all existing,
 			// removing a new records means you've have to send back all previous records without removed
 
-            return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
+			return api('namecheap.domains.dns.getHosts', params).then(function(
-                var currentHostRecordsCount = hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
+				hostsResponse
+			) {
+				var currentHostRecordsCount =
+					hostsResponse['DomainDNSGetHostsResult'][0]['host'].length;
 
 				for (var i = 0; i < currentHostRecordsCount; i++) {
 					// console.log(hostsResponse['DomainDNSGetHostsResult'][i]['host'][0]);
-                    var currentEntry =  hostsResponse['DomainDNSGetHostsResult'][0]['host'][i]['$'];
+					var currentEntry =
+						hostsResponse['DomainDNSGetHostsResult'][0]['host'][i][
+							'$'
+						];
 					if (currentEntry['Address'] != ch.dnsAuthorization) {
 						params['HostName' + (i + 1)] = currentEntry['Name'];
 						params['RecordType' + (i + 1)] = currentEntry['Type'];
@@ -178,15 +215,18 @@ module.exports.create = function (config) {
 					}
 				}
 
-                return api('namecheap.domains.dns.setHosts',params).then(function (setHostResponse) {
+				return api('namecheap.domains.dns.setHosts', params)
+					.then(function(setHostResponse) {
 						// console.log('setHost');
 						// console.log(setHostResponse);
-                    return true
+						return true;
-                }).catch(function (err) {
+					})
-                    throw new Error('record did not remove. check subdomain, api key, etc');
+					.catch(function(err) {
+						throw new Error(
+							'record did not remove. check subdomain, api key, etc'
+						);
 					});
 			});
-
 		},
 		get: function(data) {
 			var ch = data.challenge;
@@ -198,10 +238,13 @@ module.exports.create = function (config) {
 			params['TLD'] = domains[domains.length - 1];
 			params['SLD'] = domains[domains.length - 2];
 
-            return api('namecheap.domains.dns.getHosts',params).then(function (hostsResponse) {
+			return api('namecheap.domains.dns.getHosts', params).then(function(
+				hostsResponse
+			) {
 				// console.log('hosts');
 				// console.log(hostsResponse);
-                var currentHostRecords = hostsResponse['DomainDNSGetHostsResult'][0]['host'];
+				var currentHostRecords =
+					hostsResponse['DomainDNSGetHostsResult'][0]['host'];
 
 				var entries = currentHostRecords.filter(function(x) {
 					return x['$']['Type'] === 'TXT';
@@ -218,9 +261,7 @@ module.exports.create = function (config) {
 				} else {
 					return null;
 				}
-
 			});
-
 		}
 	};
 };

package-lock.json

@@ -0,0 +1,49 @@
+{
+	"name": "acme-dns-01-namecheap",
+	"version": "3.0.0",
+	"lockfileVersion": 1,
+	"requires": true,
+	"dependencies": {
+		"@root/request": {
+			"version": "1.3.11",
+			"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
+			"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw=="
+		},
+		"acme-challenge-test": {
+			"version": "3.3.2",
+			"resolved": "https://registry.npmjs.org/acme-challenge-test/-/acme-challenge-test-3.3.2.tgz",
+			"integrity": "sha512-0AbMcaON20wpI5vzFDAqwcv2VerY4xIlNCqX0w1xEJUIu/EQtQNmkje+rKNuy2TUl2KBMdIaR6YBbJUdaEiC4w==",
+			"dev": true,
+			"requires": {
+				"@root/request": "^1.3.11"
+			},
+			"dependencies": {
+				"@root/request": {
+					"version": "1.3.11",
+					"resolved": "https://registry.npmjs.org/@root/request/-/request-1.3.11.tgz",
+					"integrity": "sha512-3a4Eeghcjsfe6zh7EJ+ni1l8OK9Fz2wL1OjP4UCa0YdvtH39kdXB9RGWuzyNv7dZi0+Ffkc83KfH0WbPMiuJFw==",
+					"dev": true
+				}
+			}
+		},
+		"sax": {
+			"version": "1.2.4",
+			"resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz",
+			"integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw=="
+		},
+		"xml2js": {
+			"version": "0.4.19",
+			"resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.19.tgz",
+			"integrity": "sha512-esZnJZJOiJR9wWKMyuvSE1y6Dq5LCuJanqhxslH2bxM6duahNZ+HMpCLhBQGZkbX6xRf8x1Y2eJlgt2q3qo49Q==",
+			"requires": {
+				"sax": ">=0.6.0",
+				"xmlbuilder": "~9.0.1"
+			}
+		},
+		"xmlbuilder": {
+			"version": "9.0.7",
+			"resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-9.0.7.tgz",
+			"integrity": "sha1-Ey7mPS7FVlxVfiD0wi35rKaGsQ0="
+		}
+	}
+}

package.json

@@ -3,6 +3,10 @@
 	"version": "3.0.0",
 	"description": "Namecheap DNS for Let's Encrypt / ACME dns-01 challenges with ACME.js and Greenlock.js",
 	"main": "index.js",
+	"files": [
+		"lib",
+		"test.js"
+	],
 	"scripts": {
 		"test": "node ./test.js"
 	},
@@ -30,6 +34,6 @@
 		"xml2js": "^0.4.19"
 	},
 	"devDependencies": {
-    "acme-dns-01-test": "^3.2.1"
+		"acme-challenge-test": "^3.3.2"
 	}
 }

test.js

@@ -3,18 +3,22 @@
 
 // https://git.rootprojects.org/root/acme-dns-01-test.js
 var tester = require('acme-challenge-test');
+require('dotenv').config();
 
 // Usage: node ./test.js example.com xxxxxxxxx
-var zone = process.argv[2];
+var zone = process.argv[2] || process.env.ZONE;
 
 var challenger = require('./index.js').create({
-    apiUser:process.argv[3],
+	apiUser: process.argv[3] || process.env.API_USER,
-	apiKey : process.argv[4],
+	apiKey: process.argv[4] || process.env.API_KEY || process.env.TOKEN,
-    clientIp:process.argv[5],
+	clientIp: process.argv[5] || process.env.CLIENT_IP,
-    username: process.argv[6] || process.argv[3]
+	username:
+		process.argv[6] ||
+		process.env.USERNAME ||
+		process.argv[3] ||
+		process.env.API_USER
 });
 
-
 // The dry-run tests can pass on, literally, 'example.com'
 // but the integration tests require that you have control over the domain
 tester
@@ -27,4 +31,3 @@ tester
 		console.error(e.message);
 		console.error(e.stack);
 	});
-