Added gulp tasks for release process.

- Includes commands to build and release browser builds
- Commands to run node and browser tests with karma
This commit is contained in:
Braydon Fuller 2015-09-18 09:49:41 -04:00
parent 452dc5386c
commit 66a3dbb61d
14 changed files with 284 additions and 50 deletions

4
.gitignore vendored
View File

@ -1,2 +1,6 @@
node_modules
bitauth.js
bitauth.min.js
tests.js

View File

@ -30,7 +30,7 @@
"maxlen": 120,
"multistr": true,
"predef": [ // Extra globals.
"predef": [
"after",
"afterEach",
"before",

View File

@ -1,4 +1,12 @@
language: node_js
sudo: false
node_js:
- '0.10'
- '0.12'
before_install:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
install:
- npm install

View File

@ -21,10 +21,9 @@ npm install bitauth
To generate a browser bundle, you can then run:
```bash
npm run make-dist
gulp browser
```
## Advantages over other authentication mechanisms
* By signing each request, man in the middle attacks are impossible.
@ -206,21 +205,19 @@ app.use( bitauth.middleware );
To build a browser compatible version of BitAuth, run the following command from the project's root directory:
```bash
npm run make-dist
gulp browser
```
This will output `bitauth.browser.min.js` to the `dist` directory. The script introduces a global variable at `window.bitauth`.
This will output `bitauth.min.js` to project directory. The script can be loaded using `require('bitauth')`.
To then run tests for a web browser open `test/index.html` in a browser, such as:
To then run tests for a web browser:
```bash
firefox test/index.html
chromium-browser test/index.html
gulp test:browser
```
To run tests for Node.js:
```bash
npm run test
gulp test:node
```

29
bower.json Normal file
View File

@ -0,0 +1,29 @@
{
"name": "bitauth",
"main": "./bitauth.min.js",
"version": "0.2.1",
"homepage": "https://github.com/bitpay/bitauth",
"authors": [
"BitPay, Inc."
],
"description": "Passwordless authentication using Bitcoin cryptography",
"moduleType": [
"globals"
],
"keywords": [
"bitcoin",
"bitcore",
"btc",
"satoshi"
],
"license": "MIT",
"ignore": [
"**/.*",
"CONTRIBUTING.md",
"gulpfile.js",
"lib",
"index.js",
"karma.conf.js",
"test"
]
}

3
dist/.gitignore vendored
View File

@ -1,3 +0,0 @@
# Ignore everything in this directory
*
!.gitignore

176
gulpfile.js Normal file
View File

@ -0,0 +1,176 @@
'use strict';
// Run these commands to make a release:
//
// gulp release:checkout-releases
// gulp release:install
// gulp test
// gulp release:bump:<major|minor|patch>
// gulp browser
// gulp release:build-commit
// gulp release:push-tag
// npm publish
// gulp release:checkout-master
// gulp release:bump:<major|minor|patch>
// gulp release:version-commit
// gulp release:push
var path = require('path');
var gulp = require('gulp');
var shell = require('gulp-shell');
var mocha = require('gulp-mocha');
var runsequence = require('run-sequence');
runsequence.use(gulp);
var bump = require('gulp-bump');
var git = require('gulp-git');
var binPath = path.resolve(__dirname, './node_modules/.bin/');
var browserifyPath = path.resolve(binPath, './browserify');
var uglifyPath = path.resolve(binPath, './uglifyjs');
var indexPath = path.resolve(__dirname, './lib/bitauth-browserify');
var namePath = path.resolve(__dirname, './bitauth');
var bundlePath = namePath + '.js';
var minPath = namePath + '.min.js';
var browserifyCommand = browserifyPath + ' --require ' + indexPath + ':bitauth -o ' + bundlePath;
var uglifyCommand = uglifyPath + ' ' + bundlePath + ' --compress --mangle -o ' + minPath;
gulp.task('browser:uncompressed', shell.task([
browserifyCommand
]));
gulp.task('browser:compressed', ['browser:uncompressed'], shell.task([
uglifyCommand
]));
gulp.task('browser:maketests', shell.task([
'find test/ -type f -name "*.js" | xargs ' + browserifyPath + ' -o tests.js'
]));
gulp.task('browser', function(callback) {
runsequence(['browser:compressed'], callback);
});
gulp.task('release:install', function() {
return shell.task([
'npm install',
]);
});
var releaseFiles = ['./package.json', './bower.json'];
var bumpVersion = function(importance) {
return gulp.src(releaseFiles)
.pipe(bump({
type: importance
}))
.pipe(gulp.dest('./'));
};
['patch', 'minor', 'major'].forEach(function(importance) {
gulp.task('release:bump:' + importance, function() {
bumpVersion(importance);
});
});
gulp.task('release:checkout-releases', function(cb) {
var tempBranch = 'releases/' + new Date().getTime() + '-build';
git.branch(tempBranch, {
args: ''
}, function() {
git.checkout(tempBranch, {
args: ''
}, cb);
});
});
gulp.task('release:checkout-master', function(cb) {
git.checkout('master', {
args: ''
}, cb);
});
gulp.task('release:sign-built-files', shell.task([
'gpg --yes --out ' + namePath + '.js.sig --detach-sig ' + namePath + '.js',
'gpg --yes --out ' + namePath + '.min.js.sig --detach-sig ' + namePath + '.min.js'
]));
var buildFiles = ['./package.json'];
var signatureFiles = [];
buildFiles.push(namePath + '.js');
buildFiles.push(namePath + '.js.sig');
buildFiles.push(namePath + '.min.js');
buildFiles.push(namePath + '.min.js.sig');
buildFiles.push('./bower.json');
signatureFiles.push(namePath + '.js.sig');
signatureFiles.push(namePath + '.min.js.sig');
var addFiles = function() {
return gulp.src(buildFiles)
.pipe(git.add({
args: '-f'
}));
};
var buildCommit = function() {
var pjson = require('./package.json');
return gulp.src(buildFiles)
.pipe(git.commit('Build: ' + pjson.version, {
args: ''
}));
};
gulp.task('release:add-signed-files', ['release:sign-built-files'], addFiles);
gulp.task('release:add-built-files', addFiles);
gulp.task('release:build-commit', [
'release:add-signed-files'
], buildCommit);
gulp.task('release:version-commit', function() {
var pjson = require('./package.json');
return gulp.src(releaseFiles)
.pipe(git.commit('Bump package version to ' + pjson.version, {
args: ''
}));
});
gulp.task('release:push', function(cb) {
git.push('upstream', 'master', {
args: ''
}, cb);
});
gulp.task('release:push-tag', function(cb) {
var pjson = require('./package.json');
var name = 'v' + pjson.version;
git.tag(name, 'Release ' + name, function() {
git.push('upstream', name, cb);
});
});
gulp.task('release:publish', shell.task([
'npm publish'
]));
var tests = ['test/**/*.js'];
var testmocha = function() {
return gulp.src(tests).pipe(new mocha({
recursive: true
}));
};
var testkarma = shell.task([
path.resolve(__dirname, './node_modules/karma/bin/karma') +
' start ' + path.resolve(__dirname, './karma.conf.js')
]);
gulp.task('test:node', testmocha);
gulp.task('test:browser', ['browser:uncompressed', 'browser:maketests'], testkarma);
gulp.task('test', function(callback) {
runsequence(['test:node'], ['test:browser'], callback);
});
gulp.task('benchmark', shell.task([
'node benchmarks/index.js'
]));

View File

@ -1,9 +1,15 @@
// get base functionality
var bitauth = require('./lib/bitauth-node');
'use strict';
var bitauth;
if (process.browser) {
bitauth = require('./lib/bitauth-browserify');
} else {
bitauth = require('./lib/bitauth-node');
// add node-specific encrypt/decrypt
bitauth.encrypt = require('./lib/encrypt');
bitauth.decrypt = require('./lib/decrypt');
bitauth.middleware = require('./lib/middleware/bitauth');
}
module.exports = bitauth;

18
karma.conf.js Normal file
View File

@ -0,0 +1,18 @@
'use strict';
module.exports = function(config) {
config.set({
browsers: ['Firefox'],
frameworks: ['mocha'],
singleRun: true,
files: [
'./tests.js'
],
plugins: [
'karma-mocha',
'karma-firefox-launcher'
]
});
};

View File

@ -13,7 +13,7 @@ BitAuth.PREFIX = new Buffer('0f02', 'hex');
*/
BitAuth.generateSin = function() {
var pair = BitAuth._generateRandomPair();
var sin = this.getSinFromPublicKey(pair[1]);
var sin = BitAuth.getSinFromPublicKey(pair[1]);
var sinObj = {
created: Math.round(Date.now() / 1000),
priv: pair[0],

View File

@ -25,7 +25,7 @@
],
"scripts": {
"make-dist": "sh scripts/make-dist.sh",
"test": "mocha test/*.js --reporter spec"
"test": "gulp test"
},
"main": "index.js",
"version": "0.2.1",
@ -38,7 +38,17 @@
"benchmark": "^1.0.0",
"browserify": "=6.1.0",
"chai": "=1.9.1",
"gulp": "^3.8.10",
"gulp-bump": "^0.1.11",
"gulp-mocha": "^2.0.0",
"gulp-git": "^0.5.5",
"gulp-shell": "^0.2.10",
"karma": "^0.13.9",
"karma-firefox-launcher": "^0.1.4",
"karma-mocha": "^0.1.9",
"run-sequence": "^1.0.2",
"uglify-js": "~2.4.14",
"mocha": "~1.20.1"
}
},
"license": "MIT"
}

View File

@ -1,5 +0,0 @@
echo "Building browser bundle for bitauth..."
node_modules/.bin/browserify lib/bitauth-browserify.js -s bitauth -o dist/bitauth.bundle.js
echo "Minifying bitauth..."
node_modules/.bin/uglifyjs dist/bitauth.bundle.js --compress --mangle -o dist/bitauth.browser.min.js
echo "Done!"

View File

@ -9,11 +9,10 @@
<script src="../node_modules/mocha/mocha.js"></script>
<script src="../node_modules/chai/chai.js"></script>
<link rel="stylesheet" href="../node_modules/mocha/mocha.css" />
<script type="text/javascript" src="../dist/bitauth.browser.min.js"></script>
<script>
mocha.setup('bdd');
</script>
<script type="text/javascript" src="test.bitauth.js"></script>
<script type="text/javascript" src="../tests.js"></script>
<script>
mocha.run();
</script>

View File

@ -1,12 +1,7 @@
'use strict';
if (typeof(window) === 'undefined') {
var bitauth = require('../index');
} else {
var bitauth = window.bitauth;
}
var chai = chai || require('chai');
var bitauth = require('../');
var chai = require('chai');
describe('bitauth', function() {