node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org ยป

busbuddy

BusBuddyJS

BusBuddy JavaScript API

Usage

BusBuddyJS works both in node and in the brower!

Node

Install with npm

$ npm install busbuddy

Then in your code, do something like

var busbuddy = require('busbuddy');
var bus = busbuddy('YOUR-API-KEY');
bus.stops(function (stops) {
  console.log(stops);
});
bus.departures(100852, function (departures) {
  console.log(departures);
});

In-browser

In-browser usage is identical to the node-way, except for how you include the busbuddy script

<script src="lib/busbuddy.js"></script>
<script>
(function () {
  var bus = busbuddy('YOUR-API-KEY');
  bus.stops(function (stops) {
    console.log(stops);
  });
  bus.departures(100852, function (departures) {
    console.log(departures)
  });
})();
</script>

Tests

The tests are run with node, and you need expresso. It's available on npm

$ npm install expresso

Running the tests

$ make test

Running the integration tests

Edit your api key in the integration-test/integration.test.js and integration-test/browser-test.html

$ make integration-test

Todo

  • [v] Make it work in the browser!

Enjoy! :)

License

(The MIT License)

Copyright (c) 2011 Torgeir Thoresen <@torgeir>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.