Sha256: 8efb33d63232ec1ef0b08b9558864bec7901c47d4d32a43c196829d212495505

Contents?: true

Size: 1.47 KB

Versions: 1

Compression:

Stored size: 1.47 KB

Contents

# CitybikesApi - Ruby

A ruby interface to the [CityBikes API](http://api.citybik.es/v2/) (v2). Includes endpoints for bike-share network and station data.

## Installation

Add `gem 'citybikes_api', '~> 2.0'` to Gemfile and run `bundle install`. Or install with:

```` sh
gem install citybikes_api
````

## Usage

Get a list of all bike-share networks.

```` rb
response = CitybikesApi.networks
puts response["networks"]
````

Find a given bike-share network and all of its stations.

```` rb
response = CitybikesApi.network(network_id)
puts response["network"]
puts response["network"]["stations"]
````

## Contributing

Browse existing [issues](https://github.com/data-creative/citybikes-api-ruby/issues) or create a new issue to communicate bugs, desired features, etc.

After forking the repo and pushing your changes, create a pull request referencing the applicable issue(s).

### Developing

After checking out the repo, run `bin/setup` to install dependencies.

### Testing

Run `rake rspec` or `bundle exec rspec spec/` to run the tests.

You can also run `bin/console` for an interactive prompt that will allow you to experiment.

### Releasing

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## [License](LICENSE.txt)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
citybikes_api-0.1.0 README.md