Class: IBGE::Microrregiao

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Microrregiao

Returns a new instance of Microrregiao.



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

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

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#mesorregiao ⇒ Object

Returns the value of attribute mesorregiao.



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

def mesorregiao
  @mesorregiao
end

#nome ⇒ Object

Returns the value of attribute nome.



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

def nome
  @nome
end

Class Method Details

.microrregioes_por_id(ids) ⇒ Microrregiao+

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

Examples:

microrregiao = IBGE::Microrregiao.microrregioes_por_id(23015)
microrregiao.nome #=> "Cascavel"

microrregioes = IBGE::Microrregiao.microrregioes_por_id([23015, 23016])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de microrregiões.

Returns:



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

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

  tratar_retorno(resposta)
end

.microrregioes_por_mesorregiao(mesorregioes) ⇒ Microrregiao+

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

Examples:

microrregioes = IBGE::Microrregiao.microrregioes_por_mesorregiao(2303)
microrregioes.first.nome #=> "Fortaleza"

microrregioes = IBGE::Microrregiao.microrregioes_por_mesorregiao([2303, 2304])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de mesorregiões.

Returns:



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

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

.microrregioes_por_regiao(regioes) ⇒ Array<Microrregiao>

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

Examples:

microrregioes = IBGE::Microrregiao.microrregioes_por_regiao('NE')
microrregioes.first.nome #=> "Litoral Ocidental Maranhense"

IBGE::Microrregiao.microrregioes_por_regiao(['NE', 'N'])
IBGE::Microrregiao.microrregioes_por_regiao([1, 2])

Parameters:

  • regioes (String, Integer, Array)

Returns:



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

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

  tratar_retorno(resposta)
end

.microrregioes_por_uf(ufs) ⇒ Array<Microrregiao>

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

microrregioes = IBGE::Microrregiao.microrregioes_por_uf('CE')
microrregioes.first.nome #=> "Litoral de Camocim e Acaraú"

IBGE::Microrregiao.microrregioes_por_uf(['BA', 'CE'])
IBGE::Microrregiao.microrregioes_por_uf(23)

Parameters:

  • ufs (String, Integer, Array)

Returns:



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

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

  tratar_retorno(resposta)
end

.obter_microrregioes ⇒ Array<Microrregiao>

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

Examples:

microrregioes = IBGE::Microrregiao.obter_microrregioes
microrregioes.first.nome #=> "Porto Velho"

Returns:



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

def self.obter_microrregioes
  resposta = RestClient.get("#{BASE_URL}/microrregioes")

  tratar_retorno(resposta)
end