Module: BroadbandMap::Client::Cai

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

Instance Method Summary collapse

Instance Method Details

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

Returns the closest community anchor institutions by latitude and longitude

Examples:

cai_closest({:latitude => 41.486857, :longitude => -71.294392, :max_results=> 2})

Parameters:

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

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

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

    A customizable set of options.

Returns:

  • (Hash)

See Also:



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

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

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

Returns the broadband availability among the Community Anchor Institutions by geography type and ID.

Examples:

cai_geo_id({:data_version => 'fall2010', :geography_type => 'state', :geography_ids => ['01','02']})

Parameters:

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

    :data_version, :geography_type 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/cai.rb', line 26

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

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

Returns the broadband availability among the Community Anchor Institutions by geography name and type.

Examples:

cai_geo_name({:data_version => 'fall2010', :geography_type => 'state', :geography_names => ['alabama', 'arizona']})

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/cai.rb', line 42

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

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

Returns the broadband availability among the Community Anchor Institutions for the entire United States.

Examples:

cai_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/cai.rb', line 58

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