nonstop package resource

This module can be used to provide the nonstop package hypermedia API to any autohost server that's using hyped.

Why?

If you have a client application that you'd like to have installed that auto-updates itself whenever new versions are available - this makes adding the server side support very simple.

Using with Autohost

NPM install this module to your project

npm install nonstop-package-resource hyped -S

Add the module to the modules property in your autohost init:

var hyped = require( 'hyped' );
var host = require( 'autohost' );

host.init( {
		port: 8888,
		noOptions: true,
		urlStrategy: hyped.urlStrategy,
		modules: [ 'nonstop-package-resource' ]
	} )
	.then( hyped.addResources );
hyped.setupMiddleware( host );

Consuming

To consume this API from Node, please look at nonstop-index-client. It uses halon to discover the API this makes available via hyped.

API

The API this adds is relatively straight-forward. It allows for

Download By Filter

If you know the criteria for uniquely identifying a file (project, owner, branch, version or slug), you can provide the criteria via query parameters to get the matching file.

GET /package?project=test&owner=me&branch=master&version=0.1.0-1

GET /package?slug=1da43f9

Download By File Name

If you know the filename, it can be provided in the URL path for the get.

GET /package/test~my~develop~53688240~0.1.0~1~linux~any~any~x64.tar.gz

List Packages

This allows you to find packages that match the criteria provided via query parameters. It sorts the results by the semantic version of the packages from the newest to oldest.

GET /package?project=test&owner=your&branch=feature-branch&version=0.1.0-1

List Projects

Provides a unique set of projects that match the criteria. Useful for finding all a particular owner's projects or seeing the builds for a particular slug.

GET /project?owner=teamMember

List Terms

A way to see all possible values for specific package filters. Warning can be time consuming since some storage mechanisms will have to scan all packages to determine the term list. You can limit the terms by providing a filter to only see values across a subset of packages.

GET /terms?owner=myOrg

Upload

Allows build agents to upload a new package.

POST /package

Promote

Promotes a package to release. Nonstop builds will not produce a release version, there will always be a build number appended so that packages look like pre-releases to the service hosts. Promoting a package removes the build number and creates a non-pre-release semantic version of that package. Use with caution.

Configuration

By default this module uses the file system and memory to manage packages and the related information. The major trade-off being that everything is done in-memory which means some performance degredation over time.

No additional configuration is required to get default behavior.

Alternate Storage Providers

This module supports optional S3 package storage and optional RethinkDB package information storage. They can be used together or separately. If only Rethink is configured, the local file system is still used to store packages.

S3 storage

To have packages stored in S3, you'll need to provide configuration. Configuration for this module is provided via fount:

var fount = require( 'fount' );
var hyped = require( 'hyped' );
var host = require( 'autohost' );

var storage = {
	s3: {
		id: '',
		key: '',
		bucket: ''
	}
};

fount.register( 'storageConfig', storage );

host.init( {
		port: 8888,
		noOptions: true,
		urlStrategy: hyped.urlStrategy,
		modules: [ 'nonstop-package-resource' ]
	} )
	.then( hyped.addResources );
hyped.setupMiddleware( host );

RethinkDB Info

To have packages information stored in RethinkDB, you'll need to provide configuration. Configuration for this module is provided via fount:

var fount = require( 'fount' );
var hyped = require( 'hyped' );
var host = require( 'autohost' );

var storage = {
	rethink: {
		host: 'localhost',
		port: 28015,
		database: 'nonstop'
	}
};

fount.register( 'storageConfig', storage );

host.init( {
		port: 8888,
		noOptions: true,
		urlStrategy: hyped.urlStrategy,
		modules: [ 'nonstop-package-resource' ]
	} )
	.then( hyped.addResources );
hyped.setupMiddleware( host );