Module: BroadbandMap::Client::Almanac

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

Instance Method Summary collapse

Instance Method Details

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

Returns all almanac parameters used by the Almanac API for ranking.

Examples:

almanac_parameters()

Parameters:

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



12
13
14
15
 
# File 'lib/broadband_map/client/almanac.rb', line 12

def almanac_parameters(params={}, options={})
  params = {:format => 'json'}.merge(params)
  get("almanac/parameters?format=#{params[:format]}&callback=#{params[:callback]}", options)
end

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

Returns rankings within nation by specific geo id

Examples:

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'})

Parameters:

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

    The parameters for the lookup

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



40
41
42
43
 
# File 'lib/broadband_map/client/almanac.rb', line 40

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

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

Returns the rankings within a state by specific geo id

Examples:

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'})

Parameters:

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

    The parameters for the lookup

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



26
27
28
29
 
# File 'lib/broadband_map/client/almanac.rb', line 26

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

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

Returns rankings within a state by geo type

Examples:

almanac_ranking_geo_type_within_nation({:data_version => 'fall2010', :census_metric_type => 'population', :ranking_metric => 'wirelineproviderequals0', :geography_type => 'county', :sort_order => 'asc'})

Parameters:

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

    The parameters for the lookup

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



68
69
70
71
 
# File 'lib/broadband_map/client/almanac.rb', line 68

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

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

Returns rankings within a state by geo type

Examples:

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'})

Parameters:

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

    The parameters for the lookup

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



54
55
56
57
 
# File 'lib/broadband_map/client/almanac.rb', line 54

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