chupacabra

Chupacabra.js

Quality-controlled cryptographic library for ES6 and ES5.

import Chupacabra from "chupacabra";

Chupacabra.getUUID();//returns some uuid according to the RFC
Chupacabra.hash("somestringvalue");//generates a hash using the sha1 algorithm

Quality and Compatibility

Every build and release is automatically tested on the following platforms:

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install chupacabra
cd node_modules/chupacabra
gulp test-local

Installation

Copy and paste the following command into your terminal to install Chupacabra:

npm install chupacabra --save

Import / Require

// ES6
import chupacabra from "chupacabra";

// ES5
var chupacabra = require("chupacabra");

// Require.js
define(["require"] , function (require) {
    var chupacabra = require("chupacabra");
});

Getting Started

Chupacabra provides a set of static methods under the main class useful for crypto-related use cases.

getUUID()

Returns a UUID according to the RFC.

hash()

Receives the string to hash and returns a hash using the sha1 algorithm.

How to Contribute

See something that could use improvement? Have a great feature idea? We listen!

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Chupacabra.js on a platform we aren't automatically testing for.

npm test

SauceLabs Credentials

We've setup our tests to automatically detect whether or not you have our saucelabs credentials installed in your environment (process.env.SAUCE_USERNAME).

If our saucelabs credentials are not installed, the tests are setup to automatically detect all browsers you have installed on your local system, then use them to run the tests.

Obtaining Our SauceLabs Credentials

If you'd like to develop Chupacabra.js using SauceLabs, you need only create a new entry in our issue tracker asking for our SauceLabs credentials.

We'll send over all credentials specific to this project so that you can perform comprehensive cross-platform tests.