Module: BroadbandMap::Client::Demographics

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

Instance Method Summary collapse

Instance Method Details

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

Returns the demographics data from the coordinates.

Examples:

demographics_coords({:data_version => 'fall2010', :latitude => 42.456, :longitude => -74.987})

Parameters:

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

    :data_version, :latitude, :longitude and optional :format, :callback

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



13
14
15
16
 
# File 'lib/broadband_map/client/demographics.rb', line 13

def demographics_coords(params={}, options={})
  params = {:format => 'json'}.merge(params)
  get("demographic/#{params[:data_version]}/coordinates?latitude=#{params[:latitude]}&longitude=#{params[:longitude]}&format=#{params[:format]}&callback=#{params[:callback]}")
end

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

Returns the demographic information for a particular geography type and geography ID

Examples:

demographics_geo_id({:data_version => 'fall2010', :geography_type => 'county', :geography_ids => ['17081', '17083']})

Parameters:

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

    :data_version, :geography_type, :geography_ids and optional :format, :callback

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



26
27
28
29
30
31
32
 
# File 'lib/broadband_map/client/demographics.rb', line 26

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

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

Returns the demographic information for a particular geography type and geography name.

Examples:

demographics_geo_name({:data_version => 'fall2010', :geography_type => 'county', :geography_names => ['jersey', 'jefferson']})

Parameters:

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

    :data_version, :geography_type, :geography_names and optional :format, :callback

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



42
43
44
45
46
47
48
 
# File 'lib/broadband_map/client/demographics.rb', line 42

def demographics_geo_name(params={}, options={})
  params = {:format => 'json'}.merge(params)
  names = ""
  params[:geography_names].each {|x| names += x +","}
  names.chop!
  get("demographic/#{params[:data_version]}/#{params[:geography_type]}/names/#{names}?format=#{params[:format]}&callback=#{params[:callback]}")
end

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

Returns the demographic information for the whole nation.

Examples:

demographics_nation({:data_version => 'fall2010'})

Parameters:

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

    :data_version, and optional :format, :callback

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



58
59
60
61
 
# File 'lib/broadband_map/client/demographics.rb', line 58

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