Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle non-JSON responses from the API #59

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Handle non-JSON responses from the API #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c6d57b
Added a fourth 'options' parameter for request. The first option I cr…
louisameline Apr 30, 2014
3eb8cca
Edited example
louisameline Apr 30, 2014
e839127
indent
louisameline Apr 30, 2014
145b58d
Updated the doc and the default content-type to a more proper 'applic…
louisameline Apr 30, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,26 @@ FB.api('4', { fields: ['id', 'name'] }, function (res) {
});
```

__Expecting a non-JSON response__

```js
var FB = require('fb');

/* By default, the library expects a JSON response and will try to parse
* it before it is returned to you. An error is returned if this cannot be performed.
* A contentType option (which defaults to 'application/json') can be provided
* through the fourth parameter to prevent this. For example, set contentType
* to 'image/jpeg', ['image/jpeg', 'image/gif'] or just 'any'.
*/
FB.api('4/picture', { redirect: 1 }, { contentType: 'any' }, function (res) {
if(!res || res.error) {
console.log(!res ? 'error occurred' : res.error);
return;
}
console.log('Picture fetched. "Res" can be written in a file on disk.');
});
```

### Post

```js
Expand Down
79 changes: 60 additions & 19 deletions fb.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@
* @access public
* @param path {String} the url path
* @param method {String} the http method (default: `"GET"`)
* @param params {Object} the parameters for the query
* @param params {Object} the query parameters sent to Facebook
* @param reqOptions {Object} options for the handling of the request
* @param cb {Function} the callback function to handle the response
*/
api = function() {
Expand Down Expand Up @@ -140,12 +141,14 @@
*
* Make a api call to Graph server.
*
* Except the path, all arguments to this function are optiona. So any of
* these are valid:
* Except the path, all arguments to this function are optional.
* Only if reqOptions is defined, then params must be provided (an object or null)
* So any of these are valid:
*
* FB.api('/me') // throw away the response
* FB.api('/me', function(r) { console.log(r) })
* FB.api('/me', { fields: 'email' }); // throw away response
* FB.api('/123456789/picture', null, { content-type: 'image/jpg' });
* FB.api('/me', { fields: 'email' }, function(r) { console.log(r) });
* FB.api('/123456789', 'delete', function(r) { console.log(r) } );
* FB.api(
Expand All @@ -162,6 +165,7 @@
, next = args.shift()
, method
, params
, reqOptions
, cb;

while(next) {
Expand All @@ -170,8 +174,10 @@
method = next.toLowerCase();
} else if(type === 'function' && !cb) {
cb = next;
} else if(type === 'object' && !params) {
} else if(type === 'object' && typeof params == 'undefined') {
params = next;
} else if(type === 'object' && !reqOptions) {
reqOptions = next;
} else {
log('Invalid argument passed to FB.api(): ' + next);
return;
Expand All @@ -181,6 +187,16 @@

method = method || 'get';
params = params || {};

var defaultOptions = {
contentType: 'application/json'
};
reqOptions = reqOptions || {};
for(key in defaultOptions){
if(typeof reqOptions[key] == 'undefined'){
reqOptions[key] = defaultOptions[key];
}
}

// remove prefix slash if one is given, as it's already in the base url
if(path[0] === '/') {
Expand All @@ -192,7 +208,7 @@
return;
}

oauthRequest('graph', path, method, params, cb);
oauthRequest('graph', path, method, params, reqOptions, cb);
};

/**
Expand All @@ -219,9 +235,10 @@
* @param path {String} the request path
* @param method {String} the http method
* @param params {Object} the parameters for the query
* @param reqOptions {Object} the options for the query
* @param cb {Function} the callback function to handle the response
*/
oauthRequest = function(domain, path, method, params, cb) {
oauthRequest = function(domain, path, method, params, reqOptions, cb) {
var uri
, body
, key
Expand Down Expand Up @@ -279,6 +296,7 @@

requestOptions = {
method: method
, encoding: 'binary'
, uri: uri
, body: body
};
Expand All @@ -301,19 +319,42 @@
response.headers && /.*text\/plain.*/.test(response.headers['content-type'])) {
cb(parseOAuthApiResponse(body));
} else {
var json;
try {
json = JSON.parse(body);
} catch (ex) {
// sometimes FB is has API errors that return HTML and a message
// of "Sorry, something went wrong". These are infrequent and unpredictable but
// let's not let them blow up our application.
json = { error: {
code: 'JSONPARSE',
Error: ex
}};
var ret;
// special treatment for (expected) json responses : decode them
if(reqOptions.contentType == 'application/json'){
try {
ret = JSON.parse(body);
} catch (ex) {
// sometimes FB is has API errors that return HTML and a message
// of "Sorry, something went wrong". These are infrequent and unpredictable but
// let's not let them blow up our application.
ret = { error: {
code: 'JSONPARSE',
Error: ex
}};
}
}
else {
// check that the content is of expected type(s)
if( reqOptions.contentType == 'any'
|| ( response.headers
&& (
(typeof reqOptions.contentType == 'string' && reqOptions.contentType == response.headers['content-type'])
|| (Array.isArray(reqOptions.contentType) && reqOptions.contentType.indexOf(response.headers['content-type']) !== -1)
)
)
){
ret = body;
}
else {
ret = { error: {
code: 'UNEXPECTED_CONTENT-TYPE',
expected: reqOptions.contentType,
received: response.headers['content-type']
}};
}
}
cb(json);
cb(ret);
}
});
};
Expand Down Expand Up @@ -605,7 +646,7 @@
if(options('proxy')) {
requestOptions['proxy'] = options('proxy');
}
request(
requestOptions
, function(error, response, body) {
Expand Down