https://github.com/thedumbterminal/gemnasium-client

A wrapper for the gemnasium API
https://github.com/thedumbterminal/gemnasium-client

Last synced: 16 days ago
JSON representation

A wrapper for the gemnasium API

• Host: GitHub
• URL: https://github.com/thedumbterminal/gemnasium-client
• Owner: thedumbterminal
• License: mit
• Created: 2015-06-02T17:52:19.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-12-09T13:47:40.000Z (almost 9 years ago)
• Last Synced: 2025-10-10T12:34:31.259Z (about 1 month ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gemnasium-client

[![Dependency Status](https://gemnasium.com/thedumbterminal/gemnasium-client.svg)](https://gemnasium.com/thedumbterminal/gemnasium-client)

[![Build Status](https://travis-ci.org/thedumbterminal/gemnasium-client.svg)](https://travis-ci.org/thedumbterminal/gemnasium-client)

A wrapper for the gemnasium API

## Usage

First set the correct environment variables, which can be found in the gemnasium account and project settings pages.

    export GEMNASIUM_TOKEN=yourtoken

    export GEMNASIUM_PROJECT_SLUG=yourprojectslug

    var GemnasiumClient = require('gemnasium-client');

    var client = new GemnasiumClient();

### details()

Retrieve details for the project.

    client.details(function(error, result){

      console.log(error, result);

    });

### alerts()

Retrieve all security alerts for the project.

    client.alerts(function(error, result){

      console.log(error, result);

    });

### dependencies()

Retrieve all dependencies for the project.

    client.dependencies(function(error, result){

      console.log(error, result);

    });

### dependencyFiles()

Retrieve all the dependency files for the project.

    client.dependencyFiles(function(error, result){

      console.log(error, result);

    });

## Example

Run the following command to see a demo of the above methods:

    node example/client.js

## Developing

To run tests:

    npm test