# usercycle

> JavaScript USERcycle API for Node.JS

Latest version **0.1.1** (published 2012-10-29) · 0 weekly downloads

## Install

```sh
npm install usercycle
pnpm add usercycle
yarn add usercycle
bun add usercycle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2012-10-29 |
| First published | 2012-10-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mike de Boer |
| Maintainers | mikedeboer |

## Links

- npm: https://www.npmjs.com/package/usercycle
- Repository: http://github.com/c9/node-usercycle
- npm.io page: https://npm.io/package/usercycle

## Recent versions

- 0.1.1 (latest) — 2012-10-29
- 0.1.0 — 2012-10-27

## README

node-usercycle
==============

JavaScript USERcycle API for Node.JS

## Installation

  Install with the Node.JS package manager [npm](http://npmjs.org/):

      $ npm install usercycle

or

  Install via git clone:

      $ git clone git://github.com/c9/node-usercycle.git
      $ cd node-github
      $ npm install

## Documentation

You can find the docs for the API of this client at [http://c9.github.com/node-usercycle/](http://c9.github.com/node-usercycle/)

Additionally, the [official USERcycle documentation](http://docs.usercycle.com/rest_api)
is a very useful resource.

## Example

Print all followers of the user "mikedeboer" to the console.

    var USERcycle = require("usercycle");

    var usercycle = new USERcycle({
        version: "1.0.0"
    });
    github.events.get({}, function(err, res) {
        console.log(JSON.stringify(res));
    });

First the _UsercycleApi_ class is imported from the _node-usercycle_ module. This class provides
access to all of USERcycle's APIs (e.g. events, people or cohorts APIs). The _events.get_
method lists all the events generated so far. Is is part of the events API. It
takes the options as first argument and a callback as last argument. Once the
events list is returned from the server, the callback is called.

Like in Node.JS, callbacks are always the last argument. If the functions fails an
error object is passed as first argument to the callback.

## Authentication

You need the USERcycle API key for authentication. The API key can be found in the
user's _Account Profile_ page.

This example shows how to authenticate:

    user.authenticate({
        type: "token",
        token: token
    });

Note that the _authenticate_ method is synchronous because it only stores the
credentials for the next request.

## Implemented USERcycle APIs

* Events: 100%
* People: 100%
* Cohorts: 100%

## Running the Tests

The unit tests are based on the [mocha](http://visionmedia.github.com/mocha/)
module, which may be installed via npm. To run the tests make sure that the
npm dependencies are installed by running `npm install` from the project directory.

Before running unit tests:

    npm install mocha -g

At the moment, test classes can only be run separately. This will e.g. run the Events Api test:

    mocha api/v1.0.0/eventsTest.js

Note that a connection to the internet is required to run the tests.

## LICENSE

MIT license. See the LICENSE file for details.

---
_Source: https://npm.io/package/usercycle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._