ngrid-electric-login/README.md

Login to the NGrid Electric website using curl

# NGE Login
NGrid Electric website login. A module to login to the NGrid Electric website using curl. The curl request will write the authenticated cookie to disk and return the path to the cookie file on disk. The cookie file can then be used in subsequent curl requests using the `--cookie` or `-b` option.

# Installation
```bash
npm install -S ngrid-electric-login
```

# Usage
Call with an object that has username and password fields set. If the login is successful the second parameter of the callback will be the path to the authenticated cookie file on disk that can be used in subsequent requests

```javascript
var ngeLogin = require('ngrid-electric-login')
// currentLogin is a customer login for the https://www1.nationalgridus.com website
var currentLogin = {
  username: 'fooUsername@gmail.com',
  password: 'barPassword'
}
ngeLogin(currentLogin, function (err, cookiePath) {
  if (err) {
    console.dir('error logging into ngrid electric website', err)
  }
  console.dir('logged into ngrid electric website correctly, cookie file stored on disk at path', cookiePath)
})
```

Use the cookie file on disk in another request

```javascript
var ngeLogin = require('ngrid-electric-login')
// currentLogin is a customer login for the https://www1.nationalgridus.com website
var currentLogin = {
  username: 'fooUsername@gmail.com',
  password: 'barPassword'
}
ngeLogin(currentLogin, function (err, cookiePath) {
  var args = [
    '--cookie',
    cookiePath,
    '--insecure',
    url
  ]
  var cmd = 'curl'
  var curl = spawn(cmd, args)
    curl.stdout.setEncoding('utf8')
  var html = ''
  var stdErr = ''
  curl.stdout.on('data', function (data) {
    html += data
  })
  curl.stderr.on('data', function (data) {
    stdErr += data
  })
  curl.on('exit', function(code) {
    // do something useful with the output here

    // code is 0 on success, otherwise a code is a curl error code
    console.dir('curl exit code', code)
  })
})
```

# Tests
Both unit and integration tests are available.

```bash
# install the development dependencies
npm install
# run all tests (unit & integration)
npm test
```

To run just the unit tests execute

```bash
make unit
```

To run just the integration tests execute 

```bash
make integration
```