forks/node-bing-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adding jsbeautifier grunt task

Browse source
This commit is contained in:
Jacob Marttinen 2015-05-07 20:13:17 -04:00
parent 82cd4e5118
commit 9312aca8a1
5 changed files with 389 additions and 385 deletions
Download patch file Download diff file Expand all files Collapse all files

74
Gruntfile.js
View file

@ -1,36 +1,48 @@
module.exports = function(grunt) { module.exports = function (grunt) {
grunt.initConfig({ grunt.initConfig({
simplemocha: { simplemocha: {
options: { options: {
globals: ['should'], globals: ['should'],
timeout: 3000, timeout: 3000,
ignoreLeaks: false, ignoreLeaks: false,
ui: 'bdd', ui: 'bdd',
reporter: 'list' reporter: 'list'
}, },
all: { src: ['test/**/*.js'] } all: {
}, src: ['test/**/*.js']
}
},
jshint: { jsbeautifier: {
options: { files: ['Gruntfile.js', 'index.js', 'lib/**/*.js', 'test/**/*.js'],
laxbreak: true options: {
}, js: {
all: [ 'Gruntfile.js', 'index.js', 'lib/**/*.js', 'test/**/*.js'] jslintHappy: true
}, }
}
},
jsdoc: { jshint: {
all: { options: {
src: ['index.js', 'lib/**/*.js'], laxbreak: true
dest: 'doc' },
} all: ['Gruntfile.js', 'index.js', 'lib/**/*.js', 'test/**/*.js']
} },
});
grunt.loadNpmTasks('grunt-contrib-jshint'); jsdoc: {
grunt.loadNpmTasks('grunt-simple-mocha'); all: {
grunt.loadNpmTasks('grunt-jsdoc'); src: ['index.js', 'lib/**/*.js'],
dest: 'doc'
}
}
});
grunt.registerTask('test', ['simplemocha:all']); grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.registerTask('build', ['jshint', 'test']); grunt.loadNpmTasks('grunt-jsbeautifier');
grunt.registerTask('default', ['build', 'jsdoc']); grunt.loadNpmTasks('grunt-simple-mocha');
grunt.loadNpmTasks('grunt-jsdoc');
grunt.registerTask('test', ['simplemocha:all']);
grunt.registerTask('build', ['jsbeautifier', 'jshint', 'test']);
grunt.registerTask('default', ['build', 'jsdoc']);
}; };

196
lib/bing.js
View file

@ -1,4 +1,3 @@
/********************************************************* /*********************************************************
* Simple Node.js module for using the Bing Search API * * Simple Node.js module for using the Bing Search API *
*********************************************************/ *********************************************************/
@ -15,96 +14,83 @@ var request = require('request'),
* @returns {Bing} * @returns {Bing}
* @constructor * @constructor
*/ */
var Bing = function( options ) { var Bing = function (options) {
if( !(this instanceof Bing) ) return new Bing( options ); if (!(this instanceof Bing)) return new Bing(options);
var defaults = { var defaults = {
//Bing Search API URI //Bing Search API URI
rootUri: "https://api.datamarket.azure.com/Bing/Search/v1/", rootUri: "https://api.datamarket.azure.com/Bing/Search/v1/",
//Account Key //Account Key
accKey: null, accKey: null,
//Bing UserAgent //Bing UserAgent
userAgent: 'Bing Search Client for Node.js', userAgent: 'Bing Search Client for Node.js',
//Request Timeout //Request Timeout
reqTimeout: 5000, reqTimeout: 5000,
// Number of results (limited to 50 by API) // Number of results (limited to 50 by API)
top: 50, top: 50,
// Number of skipped results (pagination) // Number of skipped results (pagination)
skip: 0 skip: 0
}; };
//merge options passed in with defaults //merge options passed in with defaults
this.options = _.extend(defaults, options); this.options = _.extend(defaults, options);
this.searchVertical = function(query, vertical, options, callback) { this.searchVertical = function (query, vertical, options, callback) {
if (typeof options === 'function') { if (typeof options === 'function') {
callback = options; callback = options;
} }
if(typeof callback != 'function') { if (typeof callback != 'function') {
throw "Error: Callback function required!"; throw "Error: Callback function required!";
} }
// Create a copy of the options, to avoid permanent overwrites // Create a copy of the options, to avoid permanent overwrites
var opts = JSON.parse(JSON.stringify(this.options)); var opts = JSON.parse(JSON.stringify(this.options));
if (typeof options === 'object') { if (typeof options === 'object') {
_.extend(opts, options); _.extend(opts, options);
} }
var reqUri = opts.rootUri var reqUri = opts.rootUri + vertical + "?$format=json&" + qs.stringify({
+ vertical "Query": "'" + query + "'"
+ "?$format=json&" }) + "&$top=" + opts.top + "&$skip=" + opts.skip + (opts.sources ? "&Sources=%27" + opts.sources + "%27" : '') + (opts.newssortby ? "&NewsSortBy=%27" + opts.newssortby + "%27" : '') + (opts.newscategory ? "&NewsCategory=%27" + opts.newscategory + "%27" : '') + (opts.newslocationoverride ? "&NewsLocationOverride=%27" + opts.newslocationoverride + "%27" : '') + (opts.market ? "&Market=%27" + opts.market + "%27" : '') + (opts.adult ? "&Adult=%27" + opts.adult + "%27" : '') + (opts.imagefilters ? '&' + qs.stringify({
+ qs.stringify({ "Query": "'" + query + "'" }) "ImageFilters": "'" + opts.imagefilters + "'"
+ "&$top=" + opts.top }) : '') + (opts.videofilters ? '&' + qs.stringify({
+ "&$skip=" + opts.skip "VideoFilters": "'" + opts.videofilters + "'"
+ (opts.sources ? "&Sources=%27" + opts.sources + "%27" : '') }) : '');
+ (opts.newssortby ? "&NewsSortBy=%27" + opts.newssortby + "%27" : '')
+ (opts.newscategory ? "&NewsCategory=%27" + opts.newscategory + "%27" : '')
+ (opts.newslocationoverride ? "&NewsLocationOverride=%27" + opts.newslocationoverride + "%27" : '')
+ (opts.market ? "&Market=%27" + opts.market + "%27" : '')
+ (opts.adult ? "&Adult=%27" + opts.adult + "%27" : '')
+ (opts.imagefilters
? '&' + qs.stringify({ "ImageFilters": "'" + opts.imagefilters + "'" })
: '')
+ (opts.videofilters
? '&' + qs.stringify({ "VideoFilters": "'" + opts.videofilters + "'" })
: '');
request({ request({
uri: reqUri, uri: reqUri,
method: opts.method || "GET", method: opts.method || "GET",
headers: { headers: {
"User-Agent": opts.userAgent "User-Agent": opts.userAgent
}, },
auth: { auth: {
user: opts.accKey, user: opts.accKey,
pass: opts.accKey pass: opts.accKey
}, },
timeout: opts.reqTimeout timeout: opts.reqTimeout
}, function(err, res, body){ }, function (err, res, body) {
if(res && res.statusCode !== 200){ if (res && res.statusCode !== 200) {
err = new Error(body); err = new Error(body);
}else{ } else {
// Parse body, if body // Parse body, if body
body = typeof body === 'string' body = typeof body === 'string' ? JSON.parse(body) : body;
? JSON.parse(body) }
: body;
}
callback(err, res, body); callback(err, res, body);
}); });
}; };
}; };
@ -131,7 +117,7 @@ var Bing = function( options ) {
* *
* @function * @function
*/ */
Bing.prototype.web = function(query, options, callback) { Bing.prototype.web = function (query, options, callback) {
this.searchVertical(query, "Web", options, callback); this.searchVertical(query, "Web", options, callback);
}; };
@ -153,8 +139,8 @@ Bing.prototype.search = Bing.prototype.web;
* json-parsed) response. * json-parsed) response.
* @function * @function
*/ */
Bing.prototype.composite = function(query, options, callback) { Bing.prototype.composite = function (query, options, callback) {
this.searchVertical(query, "Composite", options, callback); this.searchVertical(query, "Composite", options, callback);
}; };
/** /**
@ -170,8 +156,8 @@ Bing.prototype.composite = function(query, options, callback) {
* json-parsed) response. * json-parsed) response.
* @function * @function
*/ */
Bing.prototype.news = function(query, options, callback) { Bing.prototype.news = function (query, options, callback) {
this.searchVertical(query, "News", options, callback); this.searchVertical(query, "News", options, callback);
}; };
/** /**
@ -187,22 +173,19 @@ Bing.prototype.news = function(query, options, callback) {
* json-parsed) response. * json-parsed) response.
* @function * @function
*/ */
Bing.prototype.video = function(query, options, callback) { Bing.prototype.video = function (query, options, callback) {
if (options if (options && typeof options === 'object' && options.videofilters && typeof options.videofilters === 'object') {
&& typeof options === 'object' var filterQuery = '';
&& options.videofilters var filters = Object.keys(options.videofilters);
&& typeof options.videofilters === 'object') { filters.map(function (key, i) {
var filterQuery = ''; filterQuery += capitalizeFirstLetter(key) + ':';
var filters = Object.keys(options.videofilters); filterQuery += capitalizeFirstLetter(options.videofilters[key]);
filters.map(function(key, i) { if (i < filters.length - 1)
filterQuery += capitalizeFirstLetter(key) + ':'; filterQuery += '+';
filterQuery += capitalizeFirstLetter(options.videofilters[key]); });
if (i < filters.length - 1) options.videofilters = filterQuery;
filterQuery += '+'; }
}); this.searchVertical(query, "Video", options, callback);
options.videofilters = filterQuery;
}
this.searchVertical(query, "Video", options, callback);
}; };
@ -221,26 +204,23 @@ Bing.prototype.video = function(query, options, callback) {
* json-parsed) response. * json-parsed) response.
* @function * @function
*/ */
Bing.prototype.images = function(query, options, callback) { Bing.prototype.images = function (query, options, callback) {
if (options if (options && typeof options === 'object' && options.imagefilters && typeof options.imagefilters === 'object') {
&& typeof options === 'object' var filterQuery = '';
&& options.imagefilters var filters = Object.keys(options.imagefilters);
&& typeof options.imagefilters === 'object') { filters.map(function (key, i) {
var filterQuery = ''; filterQuery += capitalizeFirstLetter(key) + ':';
var filters = Object.keys(options.imagefilters); filterQuery += capitalizeFirstLetter(options.imagefilters[key]);
filters.map(function(key, i) { if (i < filters.length - 1)
filterQuery += capitalizeFirstLetter(key) + ':'; filterQuery += '+';
filterQuery += capitalizeFirstLetter(options.imagefilters[key]); });
if (i < filters.length - 1) options.imagefilters = filterQuery;
filterQuery += '+';
});
options.imagefilters = filterQuery;
} }
this.searchVertical(query, "Image", options, callback); this.searchVertical(query, "Image", options, callback);
}; };
function capitalizeFirstLetter(s) { function capitalizeFirstLetter(s) {
return s.charAt(0).toUpperCase() + s.slice(1); return s.charAt(0).toUpperCase() + s.slice(1);
} }
module.exports = Bing; module.exports = Bing;

1
package.json
View file

@ -20,6 +20,7 @@
"express": "^4.9.5", "express": "^4.9.5",
"grunt": "^0.4.5", "grunt": "^0.4.5",
"grunt-contrib-jshint": "^0.10.0", "grunt-contrib-jshint": "^0.10.0",
"grunt-jsbeautifier": "~0.2.10",
"grunt-jsdoc": "^0.5.7", "grunt-jsdoc": "^0.5.7",
"grunt-simple-mocha": "^0.4.0", "grunt-simple-mocha": "^0.4.0",
"mocha": "^1.21.4", "mocha": "^1.21.4",

78
test/basic.js
View file

@ -1,31 +1,28 @@
var validWebResponse = { var validWebResponse = {
"d": { "d": {
"results": [ "results": [{
{ "__metadata": {
"__metadata": { "uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=0&$top=1",
"uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=0&$top=1", "type": "WebResult"
"type": "WebResult" },
}, "ID": "26888c2a-d245-47dc-87de-dc3551249de7",
"ID": "26888c2a-d245-47dc-87de-dc3551249de7", "Title": "Xbox | Games and Entertainment on All Your Devices",
"Title": "Xbox | Games and Entertainment on All Your Devices", "Description": "Experience the new generation of games and entertainment with Xbox. Play Xbox games and stream video on all your devices.",
"Description": "Experience the new generation of games and entertainment with Xbox. Play Xbox games and stream video on all your devices.", "DisplayUrl": "www.xbox.com",
"DisplayUrl": "www.xbox.com", "Url": "http://www.xbox.com/"
"Url": "http://www.xbox.com/" }, {
}, "__metadata": {
{ "uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=1&$top=1",
"__metadata": { "type": "WebResult"
"uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=1&$top=1", },
"type": "WebResult" "ID": "ff23e110-31c2-44f9-be21-f213bcd4c654",
}, "Title": "Amazon.com: Xbox - More Systems: Video Games: Games ...",
"ID": "ff23e110-31c2-44f9-be21-f213bcd4c654", "Description": "Online shopping for Video Games from a great selection of Games, Hardware, Computer And Console Video Game Products & more at everyday low prices.",
"Title": "Amazon.com: Xbox - More Systems: Video Games: Games ...", "DisplayUrl": "www.amazon.com/Xbox-Games/b?ie=UTF8&node=537504",
"Description": "Online shopping for Video Games from a great selection of Games, Hardware, Computer And Console Video Game Products & more at everyday low prices.", "Url": "http://www.amazon.com/Xbox-Games/b?ie=UTF8&node=537504"
"DisplayUrl": "www.amazon.com/Xbox-Games/b?ie=UTF8&node=537504", }],
"Url": "http://www.amazon.com/Xbox-Games/b?ie=UTF8&node=537504" "__next": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=2"
} }
],
"__next": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=2"
}
}; };
var should = require('should'), var should = require('should'),
@ -34,7 +31,7 @@ var should = require('should'),
request = require('request'), request = require('request'),
bing = require('../lib/bing'); bing = require('../lib/bing');
describe('Bing', function() { describe('Bing', function () {
var server; var server;
var app; var app;
var port = 4321; var port = 4321;
@ -43,13 +40,14 @@ describe('Bing', function() {
app = express(); app = express();
server = http.createServer(app); server = http.createServer(app);
server.listen.apply(server, [port, server.listen.apply(server, [port,
function(err, result) { function (err, result) {
if (err) { if (err) {
done(err); done(err);
} else { } else {
done(); done();
} }
}]); }
]);
}); });
after(function (done) { after(function (done) {
@ -59,11 +57,14 @@ describe('Bing', function() {
done(); done();
}); });
it('should cope with valid responses', function(done) { it('should cope with valid responses', function (done) {
app.get('/hello/Web', function (req, res) { app.get('/hello/Web', function (req, res) {
res.status(200).send(JSON.stringify(validWebResponse)); res.status(200).send(JSON.stringify(validWebResponse));
}); });
var bingClient = bing({ rootUri: 'http://localhost:'+port+'/hello/', accKey: '123' }); var bingClient = bing({
rootUri: 'http://localhost:' + port + '/hello/',
accKey: '123'
});
bingClient.search('xbox', function (error, response, body) { bingClient.search('xbox', function (error, response, body) {
response.statusCode.should.eql(200); response.statusCode.should.eql(200);
body.should.eql(validWebResponse); body.should.eql(validWebResponse);
@ -71,13 +72,18 @@ describe('Bing', function() {
}); });
}); });
it('should cope with errors', function(done) { it('should cope with errors', function (done) {
// No actual data on what the failure looks like. // No actual data on what the failure looks like.
var failure = { message: 'Failed request' }; var failure = {
message: 'Failed request'
};
app.get('/hello/Image', function (req, res) { app.get('/hello/Image', function (req, res) {
res.status(500).send(failure); res.status(500).send(failure);
});
var bingClient = bing({
rootUri: 'http://localhost:' + port + '/hello/',
accKey: '123'
}); });
var bingClient = bing({ rootUri: 'http://localhost:'+port+'/hello/', accKey: '123' });
bingClient.images('xbox', function (error, response, body) { bingClient.images('xbox', function (error, response, body) {
response.statusCode.should.eql(500); response.statusCode.should.eql(500);
body.should.eql(JSON.stringify(failure)); body.should.eql(JSON.stringify(failure));

149
test/integration.js
View file

@ -1,128 +1,133 @@
// Try to get an access key to run all this test. // Try to get an access key to run all this test.
// If the file doesn't exist or it doesn't contain an access key, it // If the file doesn't exist or it doesn't contain an access key, it
// should still run the basic tests; thus throwing an exception must // should still run the basic tests; thus throwing an exception must
// be avoided. // be avoided.
try{ try {
var accKey = require('./secrets').accKey; var accKey = require('./secrets').accKey;
} catch (e) {
console.log(e);
} }
catch(e){ console.log(e); }
if(!accKey){ if (!accKey) {
return console.error("Need to include an access key in your secrets.js"); return console.error("Need to include an access key in your secrets.js");
} }
var Bing = require('../')({ accKey: accKey}); var Bing = require('../')({
accKey: accKey
});
var should = require('should'); var should = require('should');
describe("Bing Search", function(){ describe("Bing Search", function () {
this.timeout(1000 * 10); this.timeout(1000 * 10);
it('works without options', function(done){ it('works without options', function (done) {
Bing.search('monkey vs frog', function(err, res, body){ Bing.search('monkey vs frog', function (err, res, body) {
should.not.exist(err); should.not.exist(err);
should.exist(res); should.exist(res);
should.exist(body); should.exist(body);
body.d.results.should.have.length(50); body.d.results.should.have.length(50);
//TODO check it contains the right fields //TODO check it contains the right fields
done(); done();
});
}); });
});
it('finds only 5 results', function(done){ it('finds only 5 results', function (done) {
Bing.search('monkey vs frog', { Bing.search('monkey vs frog', {
top: 5, top: 5,
market: 'en-US', market: 'en-US',
adult: 'Strict' adult: 'Strict'
}, function(err, res, body){ }, function (err, res, body) {
should.not.exist(err); should.not.exist(err);
should.exist(res); should.exist(res);
should.exist(body); should.exist(body);
body.d.results.should.have.length(5); body.d.results.should.have.length(5);
done(); done();
});
}); });
});
}); });
describe("Bing Images", function(){ describe("Bing Images", function () {
this.timeout(1000 * 10); this.timeout(1000 * 10);
it('finds images with specific options', function(done){ it('finds images with specific options', function (done) {
Bing.images('pizza', { Bing.images('pizza', {
top: 3, top: 3,
adult: 'Off', adult: 'Off',
imagefilters: { size: 'small', color: 'monochrome' } imagefilters: {
}, function(err, res, body){ size: 'small',
should.not.exist(err); color: 'monochrome'
should.exist(res); }
should.exist(body); }, function (err, res, body) {
should.not.exist(err);
should.exist(res);
should.exist(body);
body.d.results.should.have.length(3); body.d.results.should.have.length(3);
done(); done();
});
}); });
});
}); });
describe("Bing News", function(){ describe("Bing News", function () {
this.timeout(1000 * 10); this.timeout(1000 * 10);
it('finds news with specific options', function(done){ it('finds news with specific options', function (done) {
Bing.news('ps4', { Bing.news('ps4', {
top: 10, top: 10,
skip: 1, skip: 1,
newsortby: 'Date' newsortby: 'Date'
}, function(err, res, body){ }, function (err, res, body) {
//TODO try unaccepted options like imagefilters //TODO try unaccepted options like imagefilters
should.not.exist(err); should.not.exist(err);
should.exist(res); should.exist(res);
should.exist(body); should.exist(body);
body.d.results.should.have.length(10); body.d.results.should.have.length(10);
done(); done();
});
}); });
});
}); });
describe("Bing Video", function(){ describe("Bing Video", function () {
this.timeout(1000 * 10); this.timeout(1000 * 10);
it('finds videos with specific options', function(done){ it('finds videos with specific options', function (done) {
Bing.video('monkey vs frog', { Bing.video('monkey vs frog', {
top: 10 top: 10
}, function(err, res, body){ }, function (err, res, body) {
should.not.exist(err); should.not.exist(err);
should.exist(res); should.exist(res);
should.exist(body); should.exist(body);
body.d.results.should.have.length(10); body.d.results.should.have.length(10);
//TODO try here unaccepted options like imagefilters //TODO try here unaccepted options like imagefilters
done(); done();
});
}); });
});
}); });