Module: BroadbandMap::Client::Summary

Included in:
BroadbandMap::Client
Defined in:
lib/broadband_map/client/summary.rb

Instance Method Summary collapse

Instance Method Details

#summary_geo(params = {}, options = {}) ⇒ Hash

Returns broadband summary data by geography IDs for a specific geography type

Examples:

summary_geo({:data_version => 'fall2010', :census_metric_type => 'population', :geography_type => 'state', :geography_ids => ['10']})

Parameters:

  • params (Hash) (defaults to: {}) —

    :data_version, :census_metric_type, :geography_type (optional :format, :callback)

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Returns:

  • (Hash)

See Also:



14
15
16
17
18
19
20
 
# File 'lib/broadband_map/client/summary.rb', line 14

def summary_geo(params={}, options={})
  params = {:format => 'json'}.merge(params)
  ids = ""
  params[:geography_ids].each {|x| ids += x +","}
  ids.chop!
  get("analyze/#{params[:data_version]}/summary/#{params[:census_metric_type]}/#{params[:geography_type]}/ids/#{ids}?format=#{params[:format]}&callback=#{params[:callback]}")
end

#summary_nation(params = {}, options = {}) ⇒ Hash

Returns broadband summary data for the nation

Examples:

summary_nation(:data_version => 'fall2010', :census_metric_type => 'population')

Parameters:

  • params (Hash) (defaults to: {}) —

    :data_version, :census_metric_type (optional :format, :callback)

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Returns:

  • (Hash)

See Also:



31
32
33
34
 
# File 'lib/broadband_map/client/summary.rb', line 31

def summary_nation(params={}, options={})
  params = {:format => 'json'}.merge(params)
  get("analyze/#{params[:data_version]}/summary/#{params[:census_metric_type]}/nation?format=#{params[:format]}&callback=#{params[:callback]}")
end