Project

bikeshare

0.01
No commit activity in last 3 years
No release in over 3 years
A Ruby wrapper for Bay Area Bike Share bike and station information.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0

Runtime

>= 0
 Project Readme

BikeShare

A Ruby gem for interacting with Bay Area Bike Share stations and bike info

Installation

This is available as a RubyGem:

gem install bikeshare
require 'bikeshare'

Available methods:

response = BikeShare.new

Returns the full JSON of stations available and their information

response.last_station_id

Will return an integer of the last station in the system

response.station_info(2)

Takes a station_id as an integer, returns an hash with that station's info

response.stations("San Francisco")

Takes a city name string such as "San Francisco" and returns an array of all the stations in that municipality

response.empty_stations

Returns an array of all stations with 0 availableBikes

response.empty?(2)

Takes a station_id as an integer and retuns true or false based on the number of availableBikes

response.full?(2)

Takes a station_id as an integer and retuns true or false based on the number of availableBikes and total docks at that station.

response.available_bikes(2)

Takes a station_id as an integer and returns the nunber of available bikes

response.total_docks(2)

Takes a station_id as an integer and returns the total number of docks at that station

response.percent_available(2)

Takes a station_id as an integer and returns the percentage of bikes available, rounded two decimal places

response.offline_stations

Returns an array of stations currently offline

  • For more information, please go to the Bay Area Bike Share website

  • If you would like to contribute, fork this repo, create a new branch with your changes and submit a pull request!

  • If you have any questions, I'm @ZackShapiro on Twitter.

Bikeshare is open source, and made available under the MIT License. Distribute, use as-is, or modify to your liking in personal and commercial projects.