Class: IBGE::RegiaoImediata

Inherits:
Object
  • Object
show all
Defined in:
lib/ibge/regiao_imediata.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ RegiaoImediata

Returns a new instance of RegiaoImediata.



5
6
7
8
9
 
# File 'lib/ibge/regiao_imediata.rb', line 5

def initialize(options = {})
  @id                   = options['id']
  @nome                 = options['nome']
  @regiao_intermediaria = RegiaoIntermediaria.new(options['regiao-intermediaria'])
end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



3
4
5
 
# File 'lib/ibge/regiao_imediata.rb', line 3

def id
  @id
end

#nome ⇒ Object

Returns the value of attribute nome.



3
4
5
 
# File 'lib/ibge/regiao_imediata.rb', line 3

def nome
  @nome
end

#regiao_intermediaria ⇒ Object

Returns the value of attribute regiao_intermediaria.



3
4
5
 
# File 'lib/ibge/regiao_imediata.rb', line 3

def regiao_intermediaria
  @regiao_intermediaria
end

Class Method Details

.obter_regioes_imediatas ⇒ Array<RegiaoImediata>

Obtém o conjunto de regiões imediatas do Brasil.

Examples:

regioes = IBGE::RegiaoImediata.obter_regioes_imediatas
regioes.first.nome #=> "Porto Velho"

Returns:



18
19
20
21
22
 
# File 'lib/ibge/regiao_imediata.rb', line 18

def self.obter_regioes_imediatas
  resposta = RestClient.get("#{BASE_URL}/regioes-imediatas")
  
  tratar_retorno(resposta)
end

.regioes_imediatas_por_id(ids) ⇒ RegiaoImediata+

Obtém o conjunto de regiões imediatas do Brasil a partir dos respectivos identificadores. Pode ser informado um único ID ou um array de IDs.

Examples:

regiao = IBGE::RegiaoImediata.regioes_imediatas_por_id(230001)
regiao.nome #=> "Fortaleza"

regioes = IBGE::RegiaoImediata.regioes_imediatas_por_id([230001, 230002])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de regiões imediatas.

Returns:



35
36
37
38
39
40
 
# File 'lib/ibge/regiao_imediata.rb', line 35

def self.regioes_imediatas_por_id(ids)
  ids      = IBGE.formatar(ids)
  resposta = RestClient.get("#{BASE_URL}/regioes-imediatas/#{ids}")

  tratar_retorno(resposta)
end

.regioes_imediatas_por_intermediaria(regioes) ⇒ Array<RegiaoImediata>

Obtém o conjunto de regiões imediatas do Brasil a partir dos identificadores das regiões intermediárias. Pode ser informado um único ID ou um array de IDs.

Examples:

regiao = IBGE::RegiaoImediata.regioes_imediatas_por_intermediaria(2301)
regiao.nome #=> "Fortaleza"

regioes = IBGE::RegiaoImediata.regioes_imediatas_por_intermediaria([2301, 2302])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de regiões intermediárias.

Returns:



91
92
93
94
95
96
 
# File 'lib/ibge/regiao_imediata.rb', line 91

def self.regioes_imediatas_por_intermediaria(regioes)
  regioes  = IBGE.formatar(regioes)
  resposta = RestClient.get("#{BASE_URL}/regioes-intermediarias/#{regioes}/regioes-imediatas")

  tratar_retorno(resposta)
end

.regioes_imediatas_por_regiao(regioes) ⇒ Array<RegiaoImediata>

Obtém o conjunto de regiões imediatas do Brasil a partir dos identificadores das regiões. Pode ser informada a sigla, identificador (ID) ou um array de siglas/identificadores.

Examples:

regioes = IBGE::RegiaoImediata.regioes_imediatas_por_regiao('NE')
regioes.first.nome #=> "São Luís"

IBGE::RegiaoImediata.regioes_imediatas_por_regiao(['NE', 'N'])
IBGE::RegiaoImediata.regioes_imediatas_por_regiao([1, 2])

Parameters:

  • regioes (String, Integer, Array) —

    Um ou mais identificadores de regiões.

Returns:



73
74
75
76
77
78
 
# File 'lib/ibge/regiao_imediata.rb', line 73

def self.regioes_imediatas_por_regiao(regioes)
  regioes  = IBGE.formatar(regioes)
  resposta = RestClient.get("#{BASE_URL}/regioes/#{regioes}/regioes-imediatas")

  tratar_retorno(resposta)
end

.regioes_imediatas_por_uf(ufs) ⇒ Array<RegiaoImediata>

Obtém o conjunto de regiões imediatas do Brasil a partir dos identificadores das Unidades da Federação. Pode ser informada a sigla, identificador (ID) ou um array de siglas/identificadores.

Examples:

regioes = IBGE::RegiaoImediata.regioes_imediatas_por_uf('CE')
regioes.first.nome #=> "Fortaleza"

IBGE::RegiaoImediata.regioes_imediatas_por_uf(['BA', 'CE'])
IBGE::RegiaoImediata.regioes_imediatas_por_uf(23)

Parameters:

  • ufs (String, Integer, Array)

Returns:



54
55
56
57
58
59
 
# File 'lib/ibge/regiao_imediata.rb', line 54

def self.regioes_imediatas_por_uf(ufs)
  ufs      = IBGE.formatar(ufs)
  resposta = RestClient.get("#{BASE_URL}/estados/#{ufs}/regioes-imediatas")

  tratar_retorno(resposta)
end