<commit_before># Akamai API for Node.js

[![Build Status](https://travis-ci.org/mrlannigan/node-akamai.svg)](https://travis-ci.org/mrlannigan/node-akamai) [![Coverage Status](https://img.shields.io/coveralls/mrlannigan/node-akamai.svg)](https://coveralls.io/r/mrlannigan/node-akamai)

node-akamai allows for easy communication with Akamai's REST CCU API to purge/invalidate cached objects.

## Installation

    npm install akamai

## Example Usage

```javascript
var akamai = require('akamai');

akamai.purge('<EMAIL>', '...', [
  'http://example.com/somewhere',
  'http://example.com/cool',
  'http://example.com/but',
  'http://example.com/nowhere',
  'http://example.com/real'
], {domain: 'staging', action: 'invalidate'}).then(function (response) {
  console.log(response);
}).catch(function (err) {
  console.log(err.body);
  console.trace();
});

// ===

akamai.invalidate.staging.url('<EMAIL>', '...', [
  'http://example.com/somewhere',
  'http://example.com/cool',
  'http://example.com/but',
  'http://example.com/nowhere',
  'http://example.com/real'
]).then(function (response) {
  console.log(response);
}).catch(function (err) {
  console.log(err.body);
  console.trace();
});
```

See more examples:
* [basic purge](examples/basic_purge.js)
* [chainable configuration](examples/chainable_purge.js)

## .purge(username, password, objects[, options])

Create a purge request. Returns a promise.

### username

Username of account with access to API.

### password

Password for that account.

### objects

Array of strings representing the full urls/cpcodes of the content you wish to be purged.  Depending on the options.type value, this array can represent cpcode names to be purged/invalidated.

### options

* `type` Of urls. They can be urls or cpcodes.
  * `arl` [Default]
  * `cpcode`
* `domain` The network to target your request.
  * `production` [Default]
  * `staging`
* `action`
  * `remove` [Default]
  * `invalidate`

### Option Modifiers

This library offers a more readable way to set the options for a API request.  See [constants.js](lib/constants.js#L13).  At the root level of this library only the following modifiers are available:

* `remove`
* `invalidate`
* `purge`

All modifier functions only take username, password, and objects as arguments.

## .queue(username, password)

Make a request to check the length of the queue. Returns a promise.

## Bugs or Feature Requests?

Please use GitHub's issue tracker.

## License

Node-Akamai is available under the MIT license

```
Copyright (c) 2014 <NAME>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```<commit_msg>Removed coveralls and added npm badge<commit_after># Akamai API for Node.js

[![Build Status](https://travis-ci.org/mrlannigan/node-akamai.svg)](https://travis-ci.org/mrlannigan/node-akamai)

[![NPM](https://nodei.co/npm/akamai.png?downloads=true&stars=true)](https://nodei.co/npm/akamai/) [![NPM](https://nodei.co/npm-dl/akamai.png?months=6)](https://nodei.co/npm/akamai/)

node-akamai allows for easy communication with Akamai's REST CCU API to purge/invalidate cached objects.

## Installation

    npm install akamai

## Example Usage

```javascript
var akamai = require('akamai');

akamai.purge('<EMAIL>', '...', [
  'http://example.com/somewhere',
  'http://example.com/cool',
  'http://example.com/but',
  'http://example.com/nowhere',
  'http://example.com/real'
], {domain: 'staging', action: 'invalidate'}).then(function (response) {
  console.log(response);
}).catch(function (err) {
  console.log(err.body);
  console.trace();
});

// ===

akamai.invalidate.staging.url('<EMAIL>', '...', [
  'http://example.com/somewhere',
  'http://example.com/cool',
  'http://example.com/but',
  'http://example.com/nowhere',
  'http://example.com/real'
]).then(function (response) {
  console.log(response);
}).catch(function (err) {
  console.log(err.body);
  console.trace();
});
```

See more examples:
* [basic purge](examples/basic_purge.js)
* [chainable configuration](examples/chainable_purge.js)

## .purge(username, password, objects[, options])

Create a purge request. Returns a promise.

### username

Username of account with access to API.

### password

Password for that account.

### objects

Array of strings representing the full urls/cpcodes of the content you wish to be purged.  Depending on the options.type value, this array can represent cpcode names to be purged/invalidated.

### options

* `type` Of urls. They can be urls or cpcodes.
  * `arl` [Default]
  * `cpcode`
* `domain` The network to target your request.
  * `production` [Default]
  * `staging`
* `action`
  * `remove` [Default]
  * `invalidate`

### Option Modifiers

This library offers a more readable way to set the options for a API request.  See [constants.js](lib/constants.js#L13).  At the root level of this library only the following modifiers are available:

* `remove`
* `invalidate`
* `purge`

All modifier functions only take username, password, and objects as arguments.

## .queue(username, password)

Make a request to check the length of the queue. Returns a promise.

## Bugs or Feature Requests?

Please use GitHub's issue tracker.

## License

Node-Akamai is available under the MIT license

```
Copyright (c) 2014 <NAME>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
{'fraction_non_alphanumeric': 0.12209944751381216, 'fraction_numerical': 0.0017955801104972376, 'mean_word_length': 4.493930197268589, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1231933', 'n_tokens_mistral': 2261, 'n_tokens_neox': 2173, 'n_words': 793}