Merge pull request #11 from hapijs/es6

es6. Closes #10

Author: hueniverse

.travis.yml

@@ -1,6 +1,8 @@
 language: node_js
+
 node_js:
-  - "0.10"
-  - "4.0"
-  - "4"
+  - 4.0
+  - 4
+  - 5
+
 sudo: false

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# How to contribute
+We welcome contributions from the community and are pleased to have them.  Please follow this guide when logging issues or making code changes.
+
+## Logging Issues
+All issues should be created using the [new issue form](https://github.com/hapijs/isemail/issues/new). Clearly describe the issue including steps
+to reproduce if there are any. Also, make sure to indicate the earliest version that has the issue being reported.
+
+## Patching Code
+
+Code changes are welcome and should follow the guidelines below.
+
+* Fork the repository on GitHub.
+* Fix the issue ensuring that your code follows the [style guide](https://github.com/hapijs/contrib/blob/master/Style.md).
+* Add tests for your new code ensuring that you have 100% code coverage (we can help you reach 100% but will not merge without it).
+    * Run `npm test` to generate a report of test coverage
+* [Pull requests](http://help.github.com/send-pull-requests/) should be made to the [master branch](https://github.com/hapijs/isemail/tree/master).

LICENSE

@@ -1,13 +1,33 @@
-Copyright © 2008-2011, Dominic Sayers
-Copyright © 2013-2014, GlobeSherpa
-Copyright © 2014-2015, Eli Skeggs
+Copyright (c) 2014-2015, Eli Skeggs and other contributors.
+Copyright (c) 2013-2014, GlobeSherpa.
+Copyright (c) 2008-2011, Dominic Sayers.
 
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * The names of any contributors may not be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
 
-- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-- Neither the name of Dominic Sayers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+                                  *   *   *
+
+The complete list of contributors can be found at: https://github.com/hapijs/ammo/graphs/contributors
+Previously published under the 2-Clause-BSD license published here: https://github.com/hapijs/isemail/blob/v1.2.0/LICENSE
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -1,5 +1,4 @@
-isemail
-=======
+# isemail
 
 Node email address validation library
 
@@ -34,12 +33,12 @@ _remember to_ `npm install` to get the development dependencies!
 API
 ===
 
-isEmail(email, [options], [callback])
--------------------------------------
+validate(email, [options], [callback])
+--------------------------------------
 
-Determines whether the `email` is valid or not, for various definitions thereof. Optionally accepts an `options` object and a `callback` function. Options may include `errorLevel` and `checkDNS`. The `callback` function will always be called if specified, and the result of the operation supplied as the only parameter to the callback function. If `isEmail` is not asked to check for the existence of the domain (`checkDNS`), it will also synchronously return the result of the operation.
+Determines whether the `email` is valid or not, for various definitions thereof. Optionally accepts an `options` object and a `callback` function. Options may include `errorLevel` and `checkDNS`. The `callback` function will always be called if specified, and the result of the operation supplied as the only parameter to the callback function. If `validate()` is not asked to check for the existence of the domain (`checkDNS`), it will also synchronously return the result of the operation.
 
-Use `errorLevel` to specify the type of result for `isEmail`. Passing a `false` literal will result in a true or false boolean indicating whether the email address is sufficiently defined for use in sending an email. Passing a `true` literal will result in a more granular numeric status, with zero being a perfectly valid email address. Passing a number will return `0` if the numeric status is below the `errorLevel` and the numeric status otherwise.
+Use `errorLevel` to specify the type of result for `validate()`. Passing a `false` literal will result in a true or false boolean indicating whether the email address is sufficiently defined for use in sending an email. Passing a `true` literal will result in a more granular numeric status, with zero being a perfectly valid email address. Passing a number will return `0` if the numeric status is below the `errorLevel` and the numeric status otherwise.
 
 The `tldWhitelist` option can be either an object lookup table or an array of valid top-level domains. If the email address has a top-level domain that is not in the whitelist, the email will be marked as invalid.
 
@@ -49,43 +48,38 @@ The `minDomainAtoms` option is an optional positive integer that specifies the m
 
 ```js
 $ node
-> var isEmail = require('isemail');
+> var Isemail = require('isemail');
 undefined
 > var log = console.log.bind(console, 'result');
 undefined
-> isEmail('[email protected]');
+> Isemail.validate('[email protected]');
 true
-> isEmail('[email protected]', log);
+> Isemail.validate('[email protected]', log);
 result true
 true
-> isEmail('[email protected]', {checkDNS: true});
+> Isemail.validate('[email protected]', {checkDNS: true});
 undefined
-> isEmail('[email protected]', {checkDNS: true}, log);
+> Isemail.validate('[email protected]', {checkDNS: true}, log);
 undefined
 result true
-> isEmail('[email protected]', {errorLevel: true});
+> Isemail.validate('[email protected]', {errorLevel: true});
 0
-> isEmail('[email protected]', {errorLevel: true}, log);
+> Isemail.validate('[email protected]', {errorLevel: true}, log);
 result 0
 0
-> isEmail('[email protected]');
+> Isemail.validate('[email protected]');
 true
-> isEmail('[email protected]', {checkDNS: true, errorLevel: true}, log);
+> Isemail.validate('[email protected]', {checkDNS: true, errorLevel: true}, log);
 undefined
 result 6
-> isEmail('[email protected]', {checkDNS: true, errorLevel: 7}, log);
+> Isemail.validate('[email protected]', {checkDNS: true, errorLevel: 7}, log);
 undefined
 result 0
-> isEmail('[email protected]', {checkDNS: true, errorLevel: 6}, log);
+> Isemail.validate('[email protected]', {checkDNS: true, errorLevel: 6}, log);
 undefined
 result 6
 ```
 
-License
-=======
-
-[BSD License](http://www.opensource.org/licenses/bsd-license.php)
-
 <sup name="footnote-1">&#91;1&#93;</sup>: if this badge indicates the build is passing, then isemail has 100% code coverage.
 
 [skeggse]: https://github.com/skeggse "Eli Skeggs"