Class: IBGE::Mesorregiao

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Mesorregiao

Returns a new instance of Mesorregiao.



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

def initialize(options = {})
  @id   = options['id']
  @nome = options['nome']
  @uf   = IBGE::UF.new(options['UF'])
end

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#nome ⇒ Object

Returns the value of attribute nome.



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

def nome
  @nome
end

#uf ⇒ Object

Returns the value of attribute uf.



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

def uf
  @uf
end

Class Method Details

.mesorregioes_por_id(ids) ⇒ Mesorregiao+

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

Examples:

mesorregiao = IBGE::Mesorregiao.mesorregioes_por_id(2303)
mesorregiao.nome #=> "Metropolitana de Fortaleza"

mesorregioes = IBGE::Mesorregiao.mesorregioes_por_id([2303, 2304])

Parameters:

  • ids (String, Integer, Array)

Returns:



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

def self.mesorregioes_por_id(ids)
  ids      = IBGE.formatar(ids)
  resposta = RestClient.get("#{BASE_URL}/mesorregioes/#{ids}")
  
  tratar_retorno(resposta)
end

.mesorregioes_por_regiao(regioes) ⇒ Array<Mesorregiao>

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

Examples:

mesorregioes = IBGE::Mesorregiao.mesorregioes_por_regiao('NE')
mesorregioes.first.nome #=> "Norte Maranhense"

IBGE::Mesorregiao.mesorregioes_por_regiao(['NE', 'N'])
IBGE::Mesorregiao.mesorregioes_por_regiao([1, 2])

Parameters:

  • regioes (String, Integer, Array)

Returns:



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

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

  tratar_retorno(resposta)
end

.mesorregioes_por_uf(ufs) ⇒ Array<Mesorregiao>

Obtém o conjunto de mesorregiões 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:

mesorregioes = IBGE::Mesorregiao.mesorregioes_por_uf('CE')
mesorregioes.first.nome #=> "Noroeste Cearense"

IBGE::Mesorregiao.mesorregioes_por_uf(['BA', 'CE'])
IBGE::Mesorregiao.mesorregioes_por_uf(23)

Parameters:

  • ufs (String, Integer, Array)

Returns:



36
37
38
39
40
41
 
# File 'lib/ibge/mesorregiao.rb', line 36

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

  tratar_retorno(resposta)
end

.obter_mesorregioes ⇒ Array<Mesorregiao>

Obtém o conjunto de mesorregiões do Brasil.

Examples:

mesorregioes = IBGE::Mesorregiao.obter_mesorregioes
mesorregioes.first.nome #=> "Madeira-Guaporé"

Returns:



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

def self.obter_mesorregioes
  resposta = RestClient.get("#{BASE_URL}/mesorregioes")

  tratar_retorno(resposta)
end