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

Add support for API options #4

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

Add support for API options #4

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0e143fd
Default options are modifiable
ntdb Oct 6, 2014
bb9c557
Options may be passed into public methods to be merged with defaults
ntdb Oct 6, 2014
2eace5d
Fixed option merging
ntdb Oct 6, 2014
2792736
Syntax fix
ntdb Oct 6, 2014
39e6405
Syntax fix
ntdb Oct 6, 2014
e4049f1
Syntax fix
ntdb Oct 6, 2014
0b9a878
Add options to transit call
ntdb Oct 6, 2014
f7e6aea
Backwards-compatible options support
ntdb Oct 7, 2014
8284249
Documentation update
ntdb Oct 7, 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
36 changes: 26 additions & 10 deletions maps.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,19 @@ var request = require('request'),
}
}
});
},

/**
* Merge options objects
* @param {Object} options The custom options to be merged with defaults
* @param {Function} defaults Default options
* @private
*/
mergeOptions = function(options, defaults) {
var results = {};
for (var attrname in defaults) { results[attrname] = defaults[attrname]; }
for (var attrname in options) { results[attrname] = options[attrname]; }
return results;
};

/**
Expand All @@ -237,6 +250,7 @@ var request = require('request'),
* @param {String} endLocation The destination address for the directions.
* @param {Function} callback The function to call when a response is received
* from the Bing API or an error occurs.
* @param {Object} options Options for the API call (override defaults)
*
* If the request to the Bing API returns an error, or a non 200 response code
* the the specified callback will be invoked with the an error object as the
Expand All @@ -258,9 +272,9 @@ var request = require('request'),
*
* @since 0.0.1
*/
exports.getTransitRoute = function(startLocation, endLocation, callback) {
var options = getDefaultTransitOptions(),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, options),
exports.getTransitRoute = function(startLocation, endLocation, callback, options) {
var merged_options = mergeOptions(options || {}, getDefaultTransitOptions()),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, merged_options),
requestUrl = createTransitUrl(queryStringArgs);
callBingApi(requestUrl, callback);
}
Expand All @@ -273,6 +287,7 @@ exports.getTransitRoute = function(startLocation, endLocation, callback) {
* @param {String} endLocation The destination address for the directions.
* @param {Function} callback The function to call when a response is received
* from the Bing API or an error occurs.
* @param {Object} options Options for the API call (override defaults)
*
* If the request to the Bing API returns an error, or a non 200 response code
* the the specified callback will be invoked with the an error object as the
Expand All @@ -294,9 +309,9 @@ exports.getTransitRoute = function(startLocation, endLocation, callback) {
*
* @since 0.0.3
*/
exports.getWalkingRoute = function(startLocation, endLocation, callback) {
var options = getDefaultWalkingOptions(),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, options),
exports.getWalkingRoute = function(startLocation, endLocation, callback, options) {
var merged_options = mergeOptions(options || {}, getDefaultWalkingOptions()),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, merged_options),
requestUrl = createWalkingUrl(queryStringArgs);
callBingApi(requestUrl, callback);
}
Expand All @@ -309,6 +324,7 @@ exports.getWalkingRoute = function(startLocation, endLocation, callback) {
* @param {String} endLocation The destination address for the directions.
* @param {Function} callback The function to call when a response is received
* from the Bing API or an error occurs.
* @param {Object} options Options for the API call (override defaults)
*
* If the request to the Bing API returns an error, or a non 200 response code
* the the specified callback will be invoked with the an error object as the
Expand All @@ -330,9 +346,9 @@ exports.getWalkingRoute = function(startLocation, endLocation, callback) {
*
* @since 0.0.6
*/
exports.getDrivingRoute = function(startLocation, endLocation, callback) {
var options = getDefaultDrivingOptions(),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, options),
exports.getDrivingRoute = function(startLocation, endLocation, callback, options) {
var merged_options = mergeOptions(options || {}, getDefaultDrivingOptions()),
queryStringArgs = convertLocationsAndOptionsToQueryStringArgs(startLocation, endLocation, merged_options),
requestUrl = createDrivingUrl(queryStringArgs);
callBingApi(requestUrl, callback);
}
}