broadband_map 0.0.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in broadband_map.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Code for America
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,66 @@
+Broadband Map
+=======
+A Ruby wrapper for the [Broadband Map APIs](http://broadbandmap.gov/developer).
+
+
+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](http://www.fsf.org/licensing/essays/free-sw.html), **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 resolving [issues](https://github.com/codeforamerica/broadband_map_ruby/issues)
+* by reviewing patches
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](https://github.com/codeforamerica/broadband_map_ruby/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](https://gist.github.com/) 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
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Copyright
+---------
+Copyright (c) 2010 Code for America Laboratories
+See [LICENSE](https://github.com/codeforamerica/broadband_map_ruby/blob/master/LICENSE.md) for details.
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/broadband_map_ruby.png)](http://stats.codeforamerica.org/projects/broadband_map_ruby)

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/broadband_map.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/broadband_map/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'broadband_map'
+  gem.version     = BroadbandMap::VERSION
+  gem.author      = "blakeshall"
+  gem.email       = 'blake@codeforamerica.org'
+  gem.homepage    = ''
+  gem.summary     = %q{Ruby wrapper for Broadbandmap.gov api}
+  gem.description = %q{Ruby wrapper for Broadbandmap.gov api}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'webmock', '~> 1.6'
+
+  gem.add_runtime_dependency 'faraday', '~> 0.6.1'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.6.3'
+  gem.add_runtime_dependency 'hashie', '~> 1.0.0'
+  gem.add_runtime_dependency 'multi_json', '~> 1.0.2'
+  gem.add_runtime_dependency 'rash', '~> 0.3.0'
+
+end

data/lib/broadband_map.rb

@@ -0,0 +1,19 @@
+require 'broadband_map/client'
+
+module BroadbandMap
+  
+  def self.client(options={})
+      BroadbandMap::Client.new(options)
+    end
+
+    # Delegate to BroadbandMap::Client.new
+    def self.method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
+
+    def self.respond_to?(method, include_private=false)
+      client.respond_to?(method, include_private) || super(method, include_private)
+    end
+    
+end

data/lib/broadband_map/client.rb

@@ -0,0 +1,32 @@
+require 'broadband_map/client'
+require 'broadband_map/client/connection'
+require 'broadband_map/client/request'
+require 'broadband_map/client/almanac'
+require 'broadband_map/client/bip'
+require 'broadband_map/client/btop'
+require 'broadband_map/client/provider'
+require 'broadband_map/client/summary'
+require 'broadband_map/client/census'
+require 'broadband_map/client/cai'
+require 'broadband_map/client/demographics'
+require 'broadband_map/client/geography'
+require 'broadband_map/client/speed_test'
+require 'broadband_map/client/wire'
+
+module BroadbandMap
+  class Client
+    include BroadbandMap::Client::Connection
+    include BroadbandMap::Client::Request
+    include BroadbandMap::Client::Bip
+    include BroadbandMap::Client::Btop
+    include BroadbandMap::Client::Almanac
+    include BroadbandMap::Client::Provider
+    include BroadbandMap::Client::Summary
+    include BroadbandMap::Client::Census
+    include BroadbandMap::Client::Cai
+    include BroadbandMap::Client::Demographics
+    include BroadbandMap::Client::Geography
+    include BroadbandMap::Client::SpeedTest
+    include BroadbandMap::Client::Wire
+  end
+end

data/lib/broadband_map/client/almanac.rb

@@ -0,0 +1,74 @@
+module BroadbandMap
+  class Client
+    module Almanac
+
+      # Returns all almanac parameters used by the Almanac API for ranking.
+      #
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/almanac-api-parameters
+      # @example
+      #   almanac_parameters()
+      def almanac_parameters(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("almanac/parameters?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+
+      # Returns the rankings within a state by specific geo id
+      #
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/almanac-api-ranking-by-geography-id-within-a-state
+      # @example
+      #   almanac_ranking_geo_id_within_state({:data_version => 'fall2010', :state_id => '01', :census_metric_type => 'population', :ranking_metric => 'wirelineproviderequals0', :geography_type => 'county', :geography_id => '01101', :sort_order => 'asc'})
+
+      def almanac_ranking_geo_id_within_state(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("almanac/#{params[:data_version]}/rankby/state/#{params[:state_id]}/#{params[:census_metric_type]}/#{params[:ranking_metric]}/#{params[:geography_type]}/id/#{params[:geography_id]}?format=#{params[:format]}&order=#{params[:sort_order]}&properties=#{params[:properties]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns rankings within nation by specific geo id
+      #
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/almanac-api-ranking-by-geography-id-within-the-nation
+      # @example
+      #   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'})
+
+      def almanac_ranking_geo_id_within_nation(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("almanac/#{params[:data_version]}/rankby/nation/#{params[:census_metric_type]}/#{params[:ranking_metric]}/#{params[:geography_type]}/id/#{params[:geography_id]}?format=#{params[:format]}&order=#{params[:sort_order]}&properties=#{params[:properties]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns rankings within a state by geo type
+      #
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/almanac-api-ranking-by-geography-type-within-a-state
+      # @example
+      #   almanac_ranking_geo_type_within_state({:data_version => 'fall2010', :state_id => '01', :census_metric_type => 'population', :ranking_metric => 'wirelineproviderequals0', :geography_type => 'county', :sort_order => 'asc'})
+
+      def almanac_ranking_geo_type_within_state(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("almanac/#{params[:data_version]}/rankby/state/#{params[:state_id]}/#{params[:census_metric_type]}/#{params[:ranking_metric]}/#{params[:geography_type]}?format=#{params[:format]}&order=#{params[:sort_order]}&properties=#{params[:properties]}&callback=#{params[:callback]}")
+      end
+      
+      # Returns rankings within a state by geo type
+      #
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/almanac-api-ranking-by-geography-type-within-a-state
+      # @example
+      #   almanac_ranking_geo_type_within_nation({:data_version => 'fall2010', :census_metric_type => 'population', :ranking_metric => 'wirelineproviderequals0', :geography_type => 'county', :sort_order => 'asc'})
+      
+      def almanac_ranking_geo_type_within_nation(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("almanac/#{params[:data_version]}/rankby/nation/#{params[:census_metric_type]}/#{params[:ranking_metric]}/#{params[:geography_type]}?format=#{params[:format]}&order=#{params[:sort_order]}&properties=#{params[:properties]}&callback=#{params[:callback]}", options)
+      end
+    end 
+  end
+end

data/lib/broadband_map/client/bip.rb

@@ -0,0 +1,50 @@
+module BroadbandMap
+  class Client
+    module Bip
+      
+      # Returns the BIP funding allocated to states by specifying the state fips code
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/bip-funding-api-by-state-id
+      # @example
+      #   bip_state_id({:state_ids => ["01", "02"]})
+      def bip_state_id(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        ids = ""
+        params[:state_ids].each {|x| ids += x +","}
+        ids.chop!
+        get("bip/stateids/#{ids}?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns the BIP funding allocated to states by specifying the state name
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/bip-funding-api-by-state-name
+      # @example
+      #   bip_state_id({:state_names => ['alaska', 'alabama']})
+      
+      def bip_state_name(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        names = ""
+        params[:state_names].each {|x| names += x +","}
+        names.chop!
+        get("bip/states/#{names}?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns the BIP funding allocation for the whole nation
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/bip-funding-api-nation
+      # @example
+      #   bip_nation()
+      
+      def bip_nation(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("bip/nation?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+    end
+  end
+end

data/lib/broadband_map/client/btop.rb

@@ -0,0 +1,50 @@
+module BroadbandMap
+  class Client
+    module Btop
+      
+      # Returns the BIP funding allocated to states by specifying the state fips code
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/btop-funding-api-by-state-id
+      # @example
+      #   btop_state_id({:state_ids => ["01", "02"]})
+      def btop_state_id(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        ids = ""
+        params[:state_ids].each {|x| ids += x +","}
+        ids.chop!
+        get("btop/stateids/#{ids}?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns the BIP funding allocated to states by specifying the state name
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/btop-funding-api-by-state-name
+      # @example
+      #   btop_state_id({:state_names => ['alaska', 'alabama']})
+      
+      def btop_state_name(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        names = ""
+        params[:state_names].each {|x| names += x +","}
+        names.chop!
+        get("btop/states/#{names}?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+      
+      # Returns the BIP funding allocation for the whole nation
+      # @param params [Hash] The parameters for the lookup
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/btop-funding-api-nation
+      # @example
+      #   btop_nation()
+      
+      def btop_nation(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("btop/nation?format=#{params[:format]}&callback=#{params[:callback]}", options)
+      end
+    end
+  end
+end

data/lib/broadband_map/client/cai.rb

@@ -0,0 +1,65 @@
+module BroadbandMap
+  class Client
+    module Cai
+      
+      # Returns the closest community anchor institutions by latitude and longitude
+      # @param params [Hash] :latitude and :longitude and optional :max_results, :format, :callback
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/community-anchor-institutions-closest-by-latitude-and-longitude
+      # @example
+      #   cai_closest({:latitude => 41.486857, :longitude => -71.294392, :max_results=> 2})
+      
+      def cai_closest(params={}, options={})
+        params = {:format => 'json', :max_results => 25}.merge(params)
+        get("cai/closest?latitude=#{params[:latitude]}&longitude=#{params[:longitude]}&maxresults=#{params[:max_results]}&format=#{params[:format]}&callback=#{params[:callback]}")
+      end
+      
+      # Returns the broadband availability among the Community Anchor Institutions by geography type and ID.
+      # @param params [Hash] :data_version, :geography_type and optional :format, :callback
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/community-anchor-institutions-api-by-geography-type-and-geography-id
+      # @example
+      #   cai_geo_id({:data_version => 'fall2010', :geography_type => 'state', :geography_ids => ['01','02']})
+      
+      def cai_geo_id(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        ids = ""
+        params[:geography_ids].each {|x| ids += x +","}
+        ids.chop!
+        get("cai/#{params[:data_version]}/#{params[:geography_type]}/ids/#{ids}?format=#{params[:format]}&callback=#{params[:callback]}")
+      end
+      
+      # Returns the broadband availability among the Community Anchor Institutions by geography name and type.
+      # @param params [Hash] :data_version, :geography_type, :geography_names and optional :format, :callback
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/community-anchor-institutions-api-by-geography-type-and-geography-name
+      # @example
+      #   cai_geo_name({:data_version => 'fall2010', :geography_type => 'state', :geography_names => ['alabama', 'arizona']})
+      
+      def cai_geo_name(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        names = ""
+        params[:geography_names].each {|x| names += x +","}
+        names.chop!
+        get("cai/#{params[:data_version]}/#{params[:geography_type]}/names/#{names}?format=#{params[:format]}&callback=#{params[:callback]}")
+      end
+      
+      # Returns the broadband availability among the Community Anchor Institutions for the entire United States.
+      # @param params [Hash] :data_version and optional :format, :callback
+      # @param options [Hash] A customizable set of options. 
+      # @return {Hash}
+      # @see http://www.broadbandmap.gov/developer/api/community-anchor-institutions-api-nation
+      # @example
+      #   cai_nation({:data_version => 'fall2010'})
+      
+      def cai_nation(params={}, options={})
+        params = {:format => 'json'}.merge(params)
+        get("cai/#{params[:data_version]}/nation?format=#{params[:format]}&callback=#{params[:callback]}")
+      end
+      
+    end
+  end
+end