Class: IBGE::Municipio

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Municipio

Returns a new instance of Municipio.



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

def initialize(options = {})
  @id = options['id']
  @nome = options['nome']
  @microrregiao = Microrregiao.new(options['microrregiao'])
end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#microrregiao ⇒ Object

Returns the value of attribute microrregiao.



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

def microrregiao
  @microrregiao
end

#nome ⇒ Object

Returns the value of attribute nome.



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

def nome
  @nome
end

Class Method Details

.municipios_por_id(ids) ⇒ Municipio+

Obtém o conjunto de municípios do Brasil a partir dos respectivos identificadores. Pode ser informado um único ID ou um array de IDs.

Examples:

municipio = IBGE::Municipio.municipios_por_id(2307254)
municipio.nome #=> "Jijoca de Jericoacoara"

municipios = IBGE::Municipio.municipios_por_id([2307254, 2302206])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de municípios.

Returns:



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

def self.municipios_por_id(ids)
  ids      = IBGE.formatar(ids)
  resposta = RestClient.get("#{BASE_URL}/municipios/#{ids}")

  tratar_retorno(resposta)
end

.municipios_por_mesorregiao(mesorregioes) ⇒ Array<Municipio>

Obtém o conjunto de municípios do Brasil a partir dos identificadores das mesorregiões. Pode ser informado um único ID ou um array de IDs.

Examples:

municipios = IBGE::Municipio.municipios_por_mesorregiao(2303)
municipios.first.nome #=> "Aquiraz"

municipios = IBGE::Municipio.municipios_por_mesorregiao([2303, 2304])

Parameters:

  • mesorregioes (String, Integer, Array) —

    Um ou mais identificadores de mesorregiões.

Returns:



145
146
147
148
149
150
 
# File 'lib/ibge/municipio.rb', line 145

def self.municipios_por_mesorregiao(mesorregioes)
  mesorregioes = IBGE.formatar(mesorregioes)
  resposta     = RestClient.get("#{BASE_URL}/mesorregioes/#{mesorregioes}/municipios")

  tratar_retorno(resposta)
end

.municipios_por_microrregiao(microrregioes) ⇒ Array<Municipio>

Obtém o conjunto de municípios do Brasil a partir dos identificadores das microrregiões. Pode ser informado um único ID ou um array de IDs.

Examples:

municipios = IBGE::Municipio.municipios_por_microrregiao(23016)
municipios.last.nome #=> "Pacatuba"

municipios = IBGE::Municipio.municipios_por_microrregiao([23016, 23017])

Parameters:

  • microrregioes (String, Integer, Array) —

    Um ou mais identificadores de microrregiões.

Returns:



127
128
129
130
131
132
 
# File 'lib/ibge/municipio.rb', line 127

def self.municipios_por_microrregiao(microrregioes)
  microrregioes = IBGE.formatar(microrregioes)
  resposta      = RestClient.get("#{BASE_URL}/microrregioes/#{microrregioes}/municipios")

  tratar_retorno(resposta)
end

.municipios_por_regiao(regioes) ⇒ Array<Municipio>

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

Examples:

municipios = IBGE::Municipio.municipios_por_regiao('NE')
municipios.first.nome #=> "Açailândia"

IBGE::Municipio.municipios_por_regiao(['NE', 'N'])
IBGE::Municipio.municipios_por_regiao([1, 2])

Parameters:

  • regioes (String, Integer, Array)

Returns:



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

def self.municipios_por_regiao(regioes)
  regioes  = IBGE.formatar(regioes)
  resposta = RestClient.get("#{BASE_URL}/regioes/#{regioes}/municipios")

  tratar_retorno(resposta)
end

.municipios_por_regiao_imediata(regioes) ⇒ Array<Municipio>

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

Examples:

municipios = IBGE::Municipio.municipios_por_regiao_imediata(230001)
municipios.first.nome #=> "Aquiraz"

municipios = IBGE::Municipio.municipios_por_regiao_imediata([230001, 230002])

Parameters:

  • regioes (String, Integer, Array) —

    Um ou mais identificadores de regiões imediatas.

Returns:



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

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

  tratar_retorno(resposta)
end

.municipios_por_regiao_intermediaria(regioes) ⇒ Array<Municipio>

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

Examples:

municipios = IBGE::Municipio.municipios_por_regiao_intermediaria(2301)
municipios.first.nome #=> "Acarape"

municipios = IBGE::Municipio.municipios_por_regiao_intermediaria([2301, 2302])

Parameters:

  • regioes (String, Integer, Array) —

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

Returns:



109
110
111
112
113
114
 
# File 'lib/ibge/municipio.rb', line 109

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

  tratar_retorno(resposta)
end

.municipios_por_uf(ufs) ⇒ Array<Municipio>

Obtém o conjunto de municípios 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:

municipios = IBGE::Municipio.municipios_por_uf('CE')
municipios.first.nome #=> "Abaiara"

IBGE::Municipio.municipios_por_uf(['BA', 'CE'])
IBGE::Municipio.municipios_por_uf(23)

Parameters:

  • ufs (String, Integer, Array)

Returns:



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

def self.municipios_por_uf(ufs)
  ufs      = IBGE.formatar(ufs)
  resposta = RestClient.get("#{BASE_URL}/estados/#{ufs}/municipios")

  tratar_retorno(resposta)
end

.obter_municipios ⇒ Array<Municipio>

Examples:

municipios = IBGE::Municipio.obter_municipios
municipios.first.nome #=> "Alta Floresta D'Oeste"

Returns:



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

def self.obter_municipios
  resposta = RestClient.get("#{BASE_URL}/municipios")
  
  tratar_retorno(resposta)
end