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

Merge pull request #10 from jemartti/master

Browse source 
Making callbacks the last parameter + jsbeautifer
This commit is contained in:
Mr. Goferito 2015-05-23 19:50:31 +02:00
commit 12ebfcb92f
6 changed files with 418 additions and 423 deletions
Download patch file Download diff file Expand all files Collapse all files

16
Gruntfile.js
View file

@ -8,7 +8,18 @@ module.exports = function(grunt) {
ui: 'bdd',
reporter: 'list'
},
all: { src: ['test/**/*.js'] }
all: {
src: ['test/**/*.js']
}
},
jsbeautifier: {
files: ['Gruntfile.js', 'index.js', 'lib/**/*.js', 'test/**/*.js'],
options: {
js: {
jslintHappy: true
}
}
},
jshint: {
@ -27,10 +38,11 @@ module.exports = function(grunt) {
});
grunt.loadNpmTasks('grunt-contrib-jshint');
grunt.loadNpmTasks('grunt-jsbeautifier');
grunt.loadNpmTasks('grunt-simple-mocha');
grunt.loadNpmTasks('grunt-jsdoc');
grunt.registerTask('test', ['simplemocha:all']);
grunt.registerTask('build', ['jshint', 'test']);
grunt.registerTask('build', ['jsbeautifier', 'jshint', 'test']);
grunt.registerTask('default', ['build', 'jsdoc']);
};

48
README.md
View file

@ -16,34 +16,29 @@ var Bing = require('node-bing-api')({ accKey: "your-account-key" });
#### Web Search:
```js
Bing.web("Pizza", function(error, res, body){
console.log(body);
},
{
Bing.web("Pizza", {
top: 10, // Number of results (max 50)
skip: 3, // Skip first 3 results
}, function(error, res, body){
console.log(body);
});
```
#### Composite Search:
```js
Bing.composite("xbox", function(error, res, body){
console.log(body);
},
{
Bing.composite("xbox", {
top: 10, // Number of results (max 50)
skip: 3, // Skip first 3 results
sources: "web+news", //Choises are web+image+video+news+spell
newssortby: "Date" //Choices are Date, Relevance
}, function(error, res, body){
console.log(body);
});
```
#### News Search:
```js
Bing.news("xbox", function(error, res, body){
console.log(body);
},
{
Bing.news("xbox", {
top: 10, // Number of results (max 50)
skip: 3, // Skip first 3 results
newssortby: "Date" //Choices are: Date, Relevance
@ -56,40 +51,40 @@ Bing.news("xbox", function(error, res, body){
// rt_US
// rt_World
// rt_ScienceAndTechnology
}, function(error, res, body){
console.log(body);
});
```
#### Video Search:
```js
Bing.video("monkey vs frog", function(error, res, body){
console.log(body);
},
{
Bing.video("monkey vs frog", {
top: 10, // Number of results (max 50)
skip: 3, // Skip first 3 result
videofilters: {
duration: 'short',
resolution: 'high'
}
}, function(error, res, body){
console.log(body);
});
```
#### Images Search:
```js
Bing.images("Ninja Turtles", function(error, res, body){
Bing.images("Ninja Turtles", {skip: 50}, function(error, res, body){
console.log(body);
}, {skip: 50});
});
```
Adding filter(s) for the Image Search
```js
Bing.images("Ninja Turtles", function(error, res, body){
console.log(body);
},
{
Bing.images("Ninja Turtles", {
imagefilters: {
size: 'small',
color: 'monochrome'
}
}, function(error, res, body){
console.log(body);
});
```
Accepted filter values:
@ -105,18 +100,18 @@ Accepted filter values:
#### Specify Market
Getting spanish results:
```js
Bing.images("Ninja Turtles", function(error, res, body){
Bing.images("Ninja Turtles", {top: 5, market: 'es-ES'}, function(error, res, body){
console.log(body);
}, {top: 5, market: 'es-ES'});
});
```
[List of Bing Markets](https://msdn.microsoft.com/en-us/library/dd251064.aspx)
#### Adult Filter
```js
Bing.images('Kim Kardashian', function(error, res, body){
Bing.images('Kim Kardashian', {market: 'en-US', adult: 'Strict'}, function(error, res, body){
console.log(body.d.results);
}, { market: 'en-US', adult: 'Strict'});
});
```
Accepted values: "Off", "Moderate", "Strict".
@ -126,4 +121,3 @@ or videos, but may include sexually explicit text.*
## License
MIT

98
lib/bing.js
View file

@ -1,4 +1,3 @@
/*********************************************************
* Simple Node.js module for using the Bing Search API *
*********************************************************/
@ -44,8 +43,10 @@ var Bing = function( options ) {
//merge options passed in with defaults
this.options = _.extend(defaults, options);
this.searchVertical = function(query, vertical, callback, options) {
this.searchVertical = function (query, vertical, options, callback) {
if (typeof options === 'function') {
callback = options;
}
if (typeof callback != 'function') {
throw "Error: Callback function required!";
}
@ -53,26 +54,17 @@ var Bing = function( options ) {
// Create a copy of the options, to avoid permanent overwrites
var opts = JSON.parse(JSON.stringify(this.options));
if (typeof options === 'object') {
_.extend(opts, options);
}
var reqUri = opts.rootUri
+ vertical
+ "?$format=json&"
+ qs.stringify({ "Query": "'" + query + "'" })
+ "&$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({ "ImageFilters": "'" + opts.imagefilters + "'" })
: '')
+ (opts.videofilters
? '&' + qs.stringify({ "VideoFilters": "'" + opts.videofilters + "'" })
: '');
var reqUri = opts.rootUri + vertical + "?$format=json&" + qs.stringify({
"Query": "'" + query + "'"
}) + "&$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({
"ImageFilters": "'" + opts.imagefilters + "'"
}) : '') + (opts.videofilters ? '&' + qs.stringify({
"VideoFilters": "'" + opts.videofilters + "'"
}) : '');
request({
uri: reqUri,
@ -93,9 +85,7 @@ var Bing = function( options ) {
} else {
// Parse body, if body
body = typeof body === 'string'
? JSON.parse(body)
: body;
body = typeof body === 'string' ? JSON.parse(body) : body;
}
callback(err, res, body);
@ -118,16 +108,17 @@ var Bing = function( options ) {
*
* @param {String} query Query term to search for.
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @param {Object} options Options to command, allows overriding
* of rootUri, accKey (Bing API key),
* userAgent, reqTimeout, top, skip
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @function
*/
Bing.prototype.web = function(query, callback, options) {
this.searchVertical(query, "Web", callback, options);
Bing.prototype.web = function (query, options, callback) {
this.searchVertical(query, "Web", options, callback);
};
// Alias Bing.search to Bing.web
@ -140,16 +131,16 @@ Bing.prototype.search = Bing.prototype.web;
*
* @param {String} query Query term to search for.
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @param {Object} options Options to command, allows overriding
* of rootUri, accKey (Bing API key),
* userAgent, reqTimeout, top, skip,
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
* @function
*/
Bing.prototype.composite = function(query, callback, options) {
this.searchVertical(query, "Composite", callback, options);
Bing.prototype.composite = function (query, options, callback) {
this.searchVertical(query, "Composite", options, callback);
};
/**
@ -157,16 +148,16 @@ Bing.prototype.composite = function(query, callback, options) {
*
* @param {String} query Query term to search for.
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @param {Object} options Options to command, allows overriding
* of rootUri, accKey (Bing API key),
* userAgent, reqTimeout, top, skip,
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
* @function
*/
Bing.prototype.news = function(query, callback, options) {
this.searchVertical(query, "News", callback, options);
Bing.prototype.news = function (query, options, callback) {
this.searchVertical(query, "News", options, callback);
};
/**
@ -174,18 +165,16 @@ Bing.prototype.news = function(query, callback, options) {
*
* @param {String} query Query term to search for.
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @param {Object} options Options to command, allows overriding
* of rootUri, accKey (Bing API key),
* userAgent, reqTimeout, top, skip,
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
* @function
*/
Bing.prototype.video = function(query, callback, options) {
if (options
&& options.videofilters
&& typeof options.videofilters === 'object') {
Bing.prototype.video = function (query, options, callback) {
if (options && typeof options === 'object' && options.videofilters && typeof options.videofilters === 'object') {
var filterQuery = '';
var filters = Object.keys(options.videofilters);
filters.map(function (key, i) {
@ -196,7 +185,7 @@ Bing.prototype.video = function(query, callback, options) {
});
options.videofilters = filterQuery;
}
this.searchVertical(query, "Video", callback, options);
this.searchVertical(query, "Video", options, callback);
};
@ -206,19 +195,17 @@ Bing.prototype.video = function(query, callback, options) {
*
* @param {String} query Query term to search for.
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
*
* @param {Object} options Options to command, allows overriding of
* rootUri, accKey (Bing API key),
* userAgent, reqTimeout, top, skip,
* imagefilters
*
* @param {requestCallback} callback Callback called with (potentially
* json-parsed) response.
* @function
*/
Bing.prototype.images = function(query, callback, options) {
if (options
&& options.imagefilters
&& typeof options.imagefilters === 'object') {
Bing.prototype.images = function (query, options, callback) {
if (options && typeof options === 'object' && options.imagefilters && typeof options.imagefilters === 'object') {
var filterQuery = '';
var filters = Object.keys(options.imagefilters);
filters.map(function (key, i) {
@ -229,7 +216,7 @@ Bing.prototype.images = function(query, callback, options) {
});
options.imagefilters = filterQuery;
}
this.searchVertical(query, "Image", callback, options);
this.searchVertical(query, "Image", options, callback);
};
function capitalizeFirstLetter(s) {
@ -237,4 +224,3 @@ function capitalizeFirstLetter(s) {
}
module.exports = Bing;

1
package.json
View file

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

26
test/basic.js
View file

@ -1,7 +1,6 @@
var validWebResponse = {
"d": {
"results": [
{
"results": [{
"__metadata": {
"uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=0&$top=1",
"type": "WebResult"
@ -11,8 +10,7 @@ var validWebResponse = {
"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",
"Url": "http://www.xbox.com/"
},
{
}, {
"__metadata": {
"uri": "https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query='xbox'&$skip=1&$top=1",
"type": "WebResult"
@ -22,8 +20,7 @@ var validWebResponse = {
"Description": "Online shopping for Video Games from a great selection of Games, Hardware, Computer And Console Video Game Products & more at everyday low prices.",
"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"
}
};
@ -49,7 +46,8 @@ describe('Bing', function() {
} else {
done();
}
}]);
}
]);
});
after(function (done) {
@ -63,7 +61,10 @@ describe('Bing', function() {
app.get('/hello/Web', function (req, res) {
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) {
response.statusCode.should.eql(200);
body.should.eql(validWebResponse);
@ -73,11 +74,16 @@ describe('Bing', function() {
it('should cope with errors', function (done) {
// 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) {
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) {
response.statusCode.should.eql(500);
body.should.eql(JSON.stringify(failure));

60
test/integration.js
View file

@ -1,20 +1,22 @@
// 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
// should still run the basic tests; thus throwing an exception must
// be avoided.
try {
var accKey = require('./secrets').accKey;
} catch (e) {
console.log(e);
}
catch(e){ console.log(e) }
if (!accKey) {
return console.error("Need to include an access key in your secrets.js");
}
var Bing = require('../')({ accKey: accKey})
, should = require('should')
var Bing = require('../')({
accKey: accKey
});
var should = require('should');
describe("Bing Search", function () {
@ -23,7 +25,7 @@ describe("Bing Search", function(){
it('works without options', function (done) {
Bing.search('nigger vs chink', function(err, res, body){
Bing.search('monkey vs frog', function (err, res, body) {
should.not.exist(err);
should.exist(res);
@ -37,8 +39,11 @@ describe("Bing Search", function(){
});
it('finds only 5 results', function (done) {
Bing.search('nigger vs chink', function(err, res, body){
Bing.search('monkey vs frog', {
top: 5,
market: 'en-US',
adult: 'Strict'
}, function (err, res, body) {
should.not.exist(err);
should.exist(res);
should.exist(body);
@ -46,11 +51,6 @@ describe("Bing Search", function(){
body.d.results.should.have.length(5);
done();
},
{
top: 5,
market: 'en-US',
adult: 'Strict'
});
});
@ -62,9 +62,14 @@ describe("Bing Images", function(){
this.timeout(1000 * 10);
it('finds images with specific options', function (done) {
Bing.images('pizza',
function(err, res, body){
Bing.images('pizza', {
top: 3,
adult: 'Off',
imagefilters: {
size: 'small',
color: 'monochrome'
}
}, function (err, res, body) {
should.not.exist(err);
should.exist(res);
should.exist(body);
@ -72,11 +77,6 @@ describe("Bing Images", function(){
body.d.results.should.have.length(3);
done();
},
{
top: 3,
adult: 'Off',
imagefilters: { size: 'small', color: 'monochrome' }
});
});
@ -89,7 +89,11 @@ describe("Bing News", function(){
it('finds news with specific options', function (done) {
Bing.news('ps4', function(err, res, body){
Bing.news('ps4', {
top: 10,
skip: 1,
newsortby: 'Date'
}, function (err, res, body) {
//TODO try unaccepted options like imagefilters
should.not.exist(err);
@ -99,11 +103,6 @@ describe("Bing News", function(){
body.d.results.should.have.length(10);
done();
},
{
top: 10,
skip: 1,
newsortby: 'Date'
});
});
@ -116,8 +115,9 @@ describe("Bing Video", function(){
it('finds videos with specific options', function (done) {
Bing.video('monkey vs frog', function(err, res, body){
Bing.video('monkey vs frog', {
top: 10
}, function (err, res, body) {
should.not.exist(err);
should.exist(res);
should.exist(body);
@ -127,11 +127,7 @@ describe("Bing Video", function(){
//TODO try here unaccepted options like imagefilters
done();
},
{
top: 10
});
});
});