verdnatura-mirror
/
loopback-component-explorer
mirror of https://github.com/strongloop/loopback-component-explorer.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #156 from strongloop/feature/eslint 

Add eslint infrastructure
This commit is contained in:
Amir-61 2016-04-25 11:21:15 -04:00
parent 39ce73eee1 c923710ce2
commit fabc7cf5fb
9 changed files with 107 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
.eslintignore Normal file
View File

10
.eslintrc Normal file
View File

@ -0,0 +1,10 @@
{
"extends": "loopback",
"rules": {
"max-len": ["error", 90, 4, {
"ignoreComments": true,
"ignoreUrls": true,
"ignorePattern": "^\\s*var\\s.+=\\s*(require\\s*\\()|(/)"
}]
}
}

13
.jshintrc
View File

@ -1,13 +0,0 @@
{
"node": true,
"camelcase" : true,
"eqnull" : true,
"indent": 2,
"undef": true,
"quotmark": "single",
"maxlen": 80,
"trailing": true,
"newcap": true,
"nonew": true,
"undef": false
}

4
example/hidden.js
View File

@ -7,13 +7,13 @@ var User = loopback.Model.extend('user', {
username: 'string', username: 'string',
email: 'string', email: 'string',
sensitiveInternalProperty: 'string', sensitiveInternalProperty: 'string',
}, {hidden: ['sensitiveInternalProperty']}); }, { hidden: ['sensitiveInternalProperty'] });
User.attachTo(loopback.memory()); User.attachTo(loopback.memory());
app.model(User); app.model(User);
var apiPath = '/api'; var apiPath = '/api';
app.use('/explorer', explorer(app, {basePath: apiPath})); app.use('/explorer', explorer(app, { basePath: apiPath }));
app.use(apiPath, loopback.rest()); app.use(apiPath, loopback.rest());
console.log('Explorer mounted at localhost:' + port + '/explorer'); console.log('Explorer mounted at localhost:' + port + '/explorer');

6
example/simple.js
View File

@ -4,15 +4,15 @@ var explorer = require('../');
var port = 3000; var port = 3000;
var Product = loopback.PersistedModel.extend('product', { var Product = loopback.PersistedModel.extend('product', {
foo: {type: 'string', required: true}, foo: { type: 'string', required: true },
bar: 'string', bar: 'string',
aNum: {type: 'number', min: 1, max: 10, required: true, default: 5} aNum: { type: 'number', min: 1, max: 10, required: true, default: 5 },
}); });
Product.attachTo(loopback.memory()); Product.attachTo(loopback.memory());
app.model(Product); app.model(Product);
var apiPath = '/api'; var apiPath = '/api';
app.use('/explorer', explorer(app, {basePath: apiPath})); app.use('/explorer', explorer(app, { basePath: apiPath }));
app.use(apiPath, loopback.rest()); app.use(apiPath, loopback.rest());
console.log('Explorer mounted at http://localhost:' + port + '/explorer'); console.log('Explorer mounted at http://localhost:' + port + '/explorer');

138
index.js
View File

@ -2,17 +2,17 @@
/*! /*!
* Adds dynamically-updated docs as /explorer * Adds dynamically-updated docs as /explorer
*/ */
var url = require('url'); var url = require('url');
var path = require('path'); var path = require('path');
var urlJoin = require('./lib/url-join'); var urlJoin = require('./lib/url-join');
var _defaults = require('lodash').defaults; var _defaults = require('lodash').defaults;
var cors = require('cors'); var cors = require('cors');
var createSwaggerObject = require('loopback-swagger').generateSwaggerSpec; var createSwaggerObject = require('loopback-swagger').generateSwaggerSpec;
var SWAGGER_UI_ROOT = require('strong-swagger-ui/index').dist; var SWAGGER_UI_ROOT = require('strong-swagger-ui/index').dist;
var STATIC_ROOT = path.join(__dirname, 'public'); var STATIC_ROOT = path.join(__dirname, 'public');
module.exports = explorer; module.exports = explorer;
explorer.routes = routes; explorer.routes = routes;
/** /**
* Example usage: * Example usage:
@ -21,70 +21,70 @@ explorer.routes = routes;
* explorer(app, options); * explorer(app, options);
*/ */
function explorer(loopbackApplication, options) { function explorer(loopbackApplication, options) {
options = _defaults({}, options, { mountPath: '/explorer' }); options = _defaults({}, options, { mountPath: '/explorer' });
loopbackApplication.use(options.mountPath, routes(loopbackApplication, options)); loopbackApplication.use(options.mountPath, routes(loopbackApplication, options));
loopbackApplication.set('loopback-component-explorer', options); loopbackApplication.set('loopback-component-explorer', options);
}
function routes(loopbackApplication, options) {
var loopback = loopbackApplication.loopback;
var loopbackMajor = loopback && loopback.version &&
loopback.version.split('.')[0] || 1;
if (loopbackMajor < 2) {
throw new Error('loopback-component-explorer requires loopback 2.0 or newer');
} }
options = _defaults({}, options, { function routes(loopbackApplication, options) {
resourcePath: 'swagger.json', var loopback = loopbackApplication.loopback;
apiInfo: loopbackApplication.get('apiInfo') || {}, var loopbackMajor = loopback && loopback.version &&
swaggerUI: true loopback.version.split('.')[0] || 1;
});
var router = new loopback.Router(); if (loopbackMajor < 2) {
throw new Error('loopback-component-explorer requires loopback 2.0 or newer');
}
mountSwagger(loopbackApplication, router, options); options = _defaults({}, options, {
resourcePath: 'swagger.json',
apiInfo: loopbackApplication.get('apiInfo') || {},
swaggerUI: true,
});
var router = new loopback.Router();
mountSwagger(loopbackApplication, router, options);
// config.json is loaded by swagger-ui. The server should respond // config.json is loaded by swagger-ui. The server should respond
// with the relative URI of the resource doc. // with the relative URI of the resource doc.
router.get('/config.json', function(req, res) { router.get('/config.json', function(req, res) {
// Get the path we're mounted at. It's best to get this from the referer // Get the path we're mounted at. It's best to get this from the referer
// in case we're proxied at a deep path. // in case we're proxied at a deep path.
var source = url.parse(req.headers.referer || '').pathname; var source = url.parse(req.headers.referer || '').pathname;
// If no referer is available, use the incoming url. // If no referer is available, use the incoming url.
if (!source) { if (!source) {
source = req.originalUrl.replace(/\/config.json(\?.*)?$/, ''); source = req.originalUrl.replace(/\/config.json(\?.*)?$/, '');
} }
res.send({ res.send({
url: urlJoin(source, '/' + options.resourcePath) url: urlJoin(source, '/' + options.resourcePath),
});
}); });
});
if (options.swaggerUI) { if (options.swaggerUI) {
// Allow specifying a static file roots for swagger files. Any files in // Allow specifying a static file roots for swagger files. Any files in
// these folders will override those in the swagger-ui distribution. // these folders will override those in the swagger-ui distribution.
// In this way one could e.g. make changes to index.html without having // In this way one could e.g. make changes to index.html without having
// to worry about constantly pulling in JS updates. // to worry about constantly pulling in JS updates.
if (options.uiDirs) { if (options.uiDirs) {
if (typeof options.uiDirs === 'string') { if (typeof options.uiDirs === 'string') {
router.use(loopback.static(options.uiDirs)); router.use(loopback.static(options.uiDirs));
} else if (Array.isArray(options.uiDirs)) { } else if (Array.isArray(options.uiDirs)) {
options.uiDirs.forEach(function(dir) { options.uiDirs.forEach(function(dir) {
router.use(loopback.static(dir)); router.use(loopback.static(dir));
}); });
}
} }
}
// File in node_modules are overridden by a few customizations // File in node_modules are overridden by a few customizations
router.use(loopback.static(STATIC_ROOT)); router.use(loopback.static(STATIC_ROOT));
// Swagger UI distribution // Swagger UI distribution
router.use(loopback.static(SWAGGER_UI_ROOT)); router.use(loopback.static(SWAGGER_UI_ROOT));
} }
return router; return router;
} }
/** /**
* Setup Swagger documentation on the given express app. * Setup Swagger documentation on the given express app.
@ -95,30 +95,30 @@ function routes(loopbackApplication, options) {
* swagger documentation. * swagger documentation.
* @param {Object} opts Options. * @param {Object} opts Options.
*/ */
function mountSwagger(loopbackApplication, swaggerApp, opts) { function mountSwagger(loopbackApplication, swaggerApp, opts) {
var swaggerObject = createSwaggerObject(loopbackApplication, opts); var swaggerObject = createSwaggerObject(loopbackApplication, opts);
// listening to modelRemoted event for updating the swaggerObject // listening to modelRemoted event for updating the swaggerObject
// with the newly created model to appear in the Swagger UI. // with the newly created model to appear in the Swagger UI.
loopbackApplication.on('modelRemoted', function() { loopbackApplication.on('modelRemoted', function() {
swaggerObject = createSwaggerObject(loopbackApplication, opts); swaggerObject = createSwaggerObject(loopbackApplication, opts);
}); });
var resourcePath = opts && opts.resourcePath || 'swagger.json'; var resourcePath = opts && opts.resourcePath || 'swagger.json';
if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath; if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath;
var remotes = loopbackApplication.remotes(); var remotes = loopbackApplication.remotes();
setupCors(swaggerApp, remotes); setupCors(swaggerApp, remotes);
swaggerApp.get(resourcePath, function sendSwaggerObject(req, res) { swaggerApp.get(resourcePath, function sendSwaggerObject(req, res) {
res.status(200).send(swaggerObject); res.status(200).send(swaggerObject);
}); });
} }
function setupCors(swaggerApp, remotes) { function setupCors(swaggerApp, remotes) {
var corsOptions = remotes.options && remotes.options.cors || var corsOptions = remotes.options && remotes.options.cors ||
{ origin: true, credentials: true }; { origin: true, credentials: true };
// TODO(bajtos) Skip CORS when remotes.options.cors === false // TODO(bajtos) Skip CORS when remotes.options.cors === false
swaggerApp.use(cors(corsOptions)); swaggerApp.use(cors(corsOptions));
} }

10
package.json
View File

@ -4,7 +4,9 @@
"description": "Browse and test your LoopBack app's APIs", "description": "Browse and test your LoopBack app's APIs",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"test": "mocha" "lint": "eslint .",
"test": "mocha",
"posttest": "npm run lint"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -21,10 +23,12 @@
"url": "https://github.com/strongloop/loopback-component-explorer/issues" "url": "https://github.com/strongloop/loopback-component-explorer/issues"
}, },
"devDependencies": { "devDependencies": {
"chai": "^3.2.0",
"eslint": "^2.8.0",
"eslint-config-loopback": "^2.0.0",
"loopback": "^2.19.1", "loopback": "^2.19.1",
"mocha": "^2.2.5", "mocha": "^2.2.5",
"supertest": "^1.0.1", "supertest": "^1.0.1"
"chai": "^3.2.0"
}, },
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {

22
public/lib/loadSwaggerUI.js
View File

@ -4,7 +4,7 @@
/*global SwaggerUi, log, ApiKeyAuthorization, hljs, window, $ */ /*global SwaggerUi, log, ApiKeyAuthorization, hljs, window, $ */
$(function() { $(function() {
// Pre load translate... // Pre load translate...
if(window.SwaggerTranslator) { if (window.SwaggerTranslator) {
window.SwaggerTranslator.translate(); window.SwaggerTranslator.translate();
} }
@ -17,6 +17,7 @@ $(function() {
var accessToken; var accessToken;
function loadSwaggerUi(config) { function loadSwaggerUi(config) {
var methodOrder = ['get', 'head', 'options', 'put', 'post', 'delete']; var methodOrder = ['get', 'head', 'options', 'put', 'post', 'delete'];
/* eslint-disable camelcase */
window.swaggerUi = new SwaggerUi({ window.swaggerUi = new SwaggerUi({
validatorUrl: null, validatorUrl: null,
url: config.url || '/swagger/resources', url: config.url || '/swagger/resources',
@ -28,7 +29,7 @@ $(function() {
log(swaggerApi); log(swaggerApi);
log(swaggerUi); log(swaggerUi);
if(window.SwaggerTranslator) { if (window.SwaggerTranslator) {
window.SwaggerTranslator.translate(); window.SwaggerTranslator.translate();
} }
@ -56,8 +57,9 @@ $(function() {
return pathCompare !== 0 ? return pathCompare !== 0 ?
pathCompare : pathCompare :
methodOrder.indexOf(a.method) - methodOrder.indexOf(b.method); methodOrder.indexOf(a.method) - methodOrder.indexOf(b.method);
} },
}); });
/* eslint-disable camelcase */
$('#explore').click(setAccessToken); $('#explore').click(setAccessToken);
$('#api_selector').submit(setAccessToken); $('#api_selector').submit(setAccessToken);
@ -71,9 +73,10 @@ $(function() {
e.preventDefault(); e.preventDefault();
var key = $('#input_accessToken')[0].value; var key = $('#input_accessToken')[0].value;
log('key: ' + key); log('key: ' + key);
if(key && key.trim() !== '') { if (key && key.trim() !== '') {
log('added accessToken ' + key); log('added accessToken ' + key);
var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization('access_token', key, 'query'); var apiKeyAuth =
new SwaggerClient.ApiKeyAuthorization('access_token', key, 'query');
window.swaggerUi.api.clientAuthorizations.add('key', apiKeyAuth); window.swaggerUi.api.clientAuthorizations.add('key', apiKeyAuth);
accessToken = key; accessToken = key;
$('.accessTokenDisplay').text('Token Set.').addClass('set'); $('.accessTokenDisplay').text('Token Set.').addClass('set');
@ -83,10 +86,9 @@ $(function() {
if (window.localStorage) { if (window.localStorage) {
window.localStorage.setItem(lsKey, key); window.localStorage.setItem(lsKey, key);
} }
} } else {
// If submitted with an empty token, remove the current token. Can be // If submitted with an empty token, remove the current token. Can be
// useful to intentionally remove authorization. // useful to intentionally remove authorization.
else {
log('removed accessToken.'); log('removed accessToken.');
$('.accessTokenDisplay').text('Token Not Set.').removeClass('set'); $('.accessTokenDisplay').text('Token Not Set.').removeClass('set');
$('.accessTokenDisplay').removeAttr('data-tooltip'); $('.accessTokenDisplay').removeAttr('data-tooltip');
@ -116,5 +118,3 @@ $(function() {
} }
} }
}); });

11
test/explorer.test.js
View File

@ -8,7 +8,6 @@ var urlJoin = require('../lib/url-join');
var os = require('os'); var os = require('os');
describe('explorer', function() { describe('explorer', function() {
describe('with default config', function() { describe('with default config', function() {
beforeEach(givenLoopBackAppWithExplorer()); beforeEach(givenLoopBackAppWithExplorer());
@ -117,7 +116,7 @@ describe('explorer', function() {
beforeEach(function setupExplorerWithUiDirs() { beforeEach(function setupExplorerWithUiDirs() {
app = loopback(); app = loopback();
explorer(app, { explorer(app, {
uiDirs: [path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui')] uiDirs: [path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui')],
}); });
}); });
@ -143,7 +142,7 @@ describe('explorer', function() {
beforeEach(function setupExplorerWithoutUI() { beforeEach(function setupExplorerWithoutUI() {
app = loopback(); app = loopback();
explorer(app, { explorer(app, {
swaggerUI: false swaggerUI: false,
}); });
}); });
@ -200,7 +199,7 @@ describe('explorer', function() {
it('should allow `uiDirs` to be defined as an Array', function(done) { it('should allow `uiDirs` to be defined as an Array', function(done) {
explorer(app, { explorer(app, {
uiDirs: [path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui')] uiDirs: [path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui')],
}); });
request(app).get('/explorer/') request(app).get('/explorer/')
@ -212,7 +211,7 @@ describe('explorer', function() {
it('should allow `uiDirs` to be defined as an String', function(done) { it('should allow `uiDirs` to be defined as an String', function(done) {
explorer(app, { explorer(app, {
uiDirs: path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui') uiDirs: path.resolve(__dirname, 'fixtures', 'dummy-swagger-ui'),
}); });
request(app).get('/explorer/') request(app).get('/explorer/')
@ -238,7 +237,7 @@ describe('explorer', function() {
it('can be disabled by configuration', function(done) { it('can be disabled by configuration', function(done) {
var app = loopback(); var app = loopback();
app.set('remoting', { cors: { origin: false } }); app.set('remoting', { cors: { origin: false }});
configureRestApiAndExplorer(app, '/explorer'); configureRestApiAndExplorer(app, '/explorer');
request(app) request(app)