Skip to content
This repository has been archived by the owner on Sep 1, 2020. It is now read-only.
/ openbadges-bakery Public archive

An OpenBadges image baking library that works with PNGs and SVGs

License

Notifications You must be signed in to change notification settings

mozilla/openbadges-bakery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3057b06 · May 3, 2017

History

82 Commits
Nov 6, 2013
Apr 24, 2017
Nov 26, 2013
Sep 18, 2012
Sep 19, 2012
Sep 18, 2012
May 3, 2017
Sep 18, 2012
Nov 5, 2013
Nov 6, 2013
Jun 20, 2014
May 3, 2017

Repository files navigation

openbadges-bakery Build Status

An OpenBadges image baking library that works with PNGs and SVGs

Install

$ npm install openbadges-bakery

CLI Usage

Baking

$ oven [--in ./path/to/image.svg] [--out ./path/to/baked-image.svg] <data>

If --out is not set, the baked image will print to stdout.

The input file can also be piped into stdin.

$ oven <data> <  ./path/to/image.png  > ./path/to/baked-image.png

Extracting

$ oven [--in path/to/image.png] --extract

Same as above, you can also pipe a file to stdin. The data will be printed to stdout.

Libary Usage

bakery.bake(options callback);

Bakes some data into an image.

Options are

  • image: either a buffer or a stream representing the PNG or SVG to bake
  • assertion: assertion to save into the image (optional)
  • signature: JSON Web Signature representing a signed OpenBadges assertion (optional)

You must pass either assertion or signature

callback has the signature function(err, imageData)

bakery.extract(image, callback)

Gets the raw data from the badge. This could be a URL, assertion in JSON format or a signature.

callback has the signature function (err, data)

bakery.debake(image, callback);

bakery.getAssertion(image, callback);

Gets the assertion from the badge. If the assertion is remote, this will require an HTTP request. If the assertion is baked into the badge, either directly or as part of a signature, this will pull the local copy.

image should be a stream or a buffer

callback has the signature function (err, object) where object is expected to be a OpenBadges assertion.

About

An OpenBadges image baking library that works with PNGs and SVGs

Resources

License

Stars

Watchers

Forks

Packages

No packages published