broadband_map_ruby's Introduction

Broadband Map

A Ruby wrapper for the Broadband Map APIs.

Installation

gem install broadband_map

Usage Examples

require 'broadband_map'

# Provide all the wireless providers within a US census block given a passed latitude and longitude.
BroadbandMap.wireless(:data_version => 'fall2010', :latitude => '38.0', :longitude => '-77.5')

	# Provide all the wireline providers within a US census block given a passed latitude and longitude.
BroadbandMap.wireline(:data_version => 'fall2010', :latitude => '38.0', :longitude => '-77.5')

	# Returns rankings within nation by specific geo id
	BroadbandMap.almanac_ranking_geo_id_within_nation({:data_version => 'fall2010', :census_metric_type => 'population', :ranking_metric => 'wirelineproviderequals0', :geography_type => 'county', :geography_id => '01101', :sort_order => 'asc'})

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using alpha, beta, and prerelease versions
by reporting bugs
by suggesting new features
by writing or editing documentation
by writing specifications
by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
by refactoring code
by fixing issues
by reviewing patches

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

Fork the repository.
Create a topic branch.
Add specs for your unimplemented feature or bug fix.
Run bundle exec rake spec. If your specs pass, return to step 3.
Implement your feature or bug fix.
Run bundle exec rake spec. If your specs fail, return to step 5.
Run open coverage/index.html. If your changes are not completely covered by your tests, return to step 3.
Add, commit, and push your changes.
Submit a pull request.