Class: IBGE::Subdistrito

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Subdistrito

Returns a new instance of Subdistrito.



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

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

Instance Attribute Details

#distrito ⇒ Object

Returns the value of attribute distrito.



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

def distrito
  @distrito
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#nome ⇒ Object

Returns the value of attribute nome.



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

def nome
  @nome
end

Class Method Details

.obter_subdistritos ⇒ Array<Subdistrito>

Obtém o conjunto de subdistritos do Brasil.

Examples:

subdistritos = IBGE::Subdistrito.obter_subdistritos
subdistritos.first.nome #=> "Zona Central"

Returns:



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

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

.subdistritos_por_distrito(distritos) ⇒ Array<Subdistrito>

Obtém o conjunto de subdistritos do Brasil a partir dos identificadores dos distritos. Pode ser informado um único ID ou um array de IDs.

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_distrito('230440005')
subdistritos.last.nome #=> "Mucuripe"

subdistritos = IBGE::Subdistrito.subdistritos_por_distrito(['230440005', '230370905'])

Parameters:

  • distritos (String, Integer, Array) —

    um ou mais identificadores de distritos.

Returns:



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

def self.subdistritos_por_distrito(distritos)
  distritos = IBGE.formatar(distritos)
  resposta  = RestClient.get("#{BASE_URL}/distritos/#{distritos}/subdistritos")

  tratar_retorno(resposta)
end

.subdistritos_por_id(ids) ⇒ Array<Subdistrito>

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

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_id('23044000512')
subdistritos.first.nome #=> "Mucuripe"

subdistritos = IBGE::Subdistrito.subdistritos_por_id(['23044000512', '23044006511'])

Parameters:

  • ids (String, Integer, Array) —

    Um ou mais identificadores de subdistritos.

Returns:



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

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

  tratar_retorno(resposta)
end

.subdistritos_por_mesorregiao(mesorregioes) ⇒ Array<Subdistrito>

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

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_mesorregiao(2303)
subdistritos.first.nome #=> "Antônio Bezerra"

subdistritos = IBGE::Subdistrito.subdistritos_por_mesorregiao([2303, 2304])

Parameters:

  • mesorregioes (String, Integer, Array) —

    Um ou mais identificadores de mesorregiões.

Returns:



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

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

  tratar_retorno(resposta)
end

.subdistritos_por_microrregiao(microrregioes) ⇒ Array<Subdistrito>

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

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_microrregiao(23016)
subdistritos.last.nome #=> "Parangaba"

subdistritos = IBGE::Subdistrito.subdistritos_por_microrregiao([23016, 23017])

Parameters:

  • microrregioes (String, Integer, Array) —

    Um ou mais identificadores de microrregiões.

Returns:



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

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

  tratar_retorno(resposta)
end

.subdistritos_por_municipio(municipios) ⇒ Array<Subdistrito>

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

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_municipio('2304400')
subdistritos.last.nome #=> "Parangaba"

subdistritos = IBGE::Subdistrito.subdistritos_por_municipio(['2304400', '2927408'])

Parameters:

  • municipios (String, Integer, Array) —

    um ou mais identificadores de municípios.

Returns:



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

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

  tratar_retorno(resposta)
end

.subdistritos_por_regiao(regioes) ⇒ Array<Subdistrito>

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

Examples:

subdistritos = IBGE::Subdistrito.subdistritos_por_regiao('NE')
subdistritos.first.nome #=> "RPA I"

IBGE::Subdistrito.subdistritos_por_regiao(['NE', 'N'])
IBGE::Subdistrito.subdistritos_por_regiao([1, 2])

Parameters:

  • regioes (String, Integer, Array)

Returns:



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

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

  tratar_retorno(resposta)
end

.subdistritos_por_uf(ufs) ⇒ Array<Subdistrito>

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

distritos = IBGE::Subdistrito.subdistritos_por_uf('CE')
distritos.first.nome #=> "Antônio Bezerra"

IBGE::Subdistrito.subdistritos_por_uf(['BA', 'CE'])
IBGE::Subdistrito.subdistritos_por_uf(23)

Parameters:

  • ufs (String, Integer, Array)

Returns:



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

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

  tratar_retorno(resposta)
end