brcep 2.0.10 → 2.0.11

data/lib/brcep/busca_endereco.rb

@@ -1,17 +1,21 @@
 require 'net/http'
 require 'rexml/document'
+require 'active_support'
+require 'brstring'
 
-#Este recurso usa o webservice da http://www.bronzebusiness.com.br/webservices/wscep.asmx para
-#realizar as consultas de cep, então, somente funcionará para serviços com acesso a internet e
-#disponibilidade do serviço da Bronze Business.
+# Este recurso tem como finalidade encontrar um endereço através de um CEP, e
+# para isso ele utiliza o web service da Bronze Business (http://www.bronzebusiness.com.br/webservices/wscep.asmx)
+# e o web service do Buscar CEP (http://www.buscarcep.com.br). O segundo só é utilizado quando
+# o primeiro está indisponível ou quando ele não encontra o endereço associado ao CEP informado.
+# Obviamente, para utilizar este serviço é necessário uma conexão com a Internet.
 # 
 #Como fazer a busca de endereço por cep?
 #
-# BuscaEndereco.por_cep(22640010)     ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
-# BuscaEndereco.por_cep('22640010')   ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
-# BuscaEndereco.por_cep('22640-010')  ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
-# BuscaEndereco.por_cep('22.640-010') ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
-# BuscaEndereco.por_cep('00000000')   ==> RuntimeError 'Cep 00000000 não encontrado.'
+# BuscaEndereco.por_cep(22640100)     ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
+# BuscaEndereco.por_cep('22640100')   ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
+# BuscaEndereco.por_cep('22640-100')  ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
+# BuscaEndereco.por_cep('22.640-100') ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
+# BuscaEndereco.por_cep('00000000')   ==> RuntimeError 'O CEP informado possui um formato inválido.'
 # 
 #Se necessário usar proxy, faça (de preferência em environment.rb):
 # BuscaEndereco.proxy_addr= 'endereco.do.proxy'
@@ -20,28 +24,61 @@ require 'rexml/document'
 class BuscaEndereco
   cattr_accessor :proxy_addr, :proxy_port
 
-  URL_WEB_SERVICE = 'http://www.bronzebusiness.com.br/webservices/wscep.asmx/cep?strcep=' #:nodoc:
+  URL_WEB_SERVICE_BRONZE_BUSINESS = 'http://www.bronzebusiness.com.br/webservices/wscep.asmx/cep?strcep=' #:nodoc:
+  URL_WEB_SERVICE_BUSCAR_CEP = 'http://www.buscarcep.com.br/?cep=' #:nodoc:
+
+  # Elementos do XML retornado pelos web services
+  ELEMENTOS_XML_BRONZE_BUSINESS = %w(logradouro nome bairro UF cidade) #:nodoc:
+  ELEMENTOS_XML_BUSCAR_CEP = %w(tipo_logradouro logradouro bairro uf cidade) #:nodoc:
   
-  # Retorna um array com os dados de endereçamento para o cep informado ou um erro para cep inexistente.
+  # Retorna um array com os dados de endereçamento para o cep informado ou um erro quando o serviço está indisponível,
+  # quando o cep informado possui um formato inválido ou quando o endereço não foi encontrado.
   #
   # Exemplo:
-  #  BuscaEndereco.por_cep(22640010) ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
+  #  BuscaEndereco.por_cep(22640100) ==> ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', 22640100]
   def self.por_cep(numero)
-    cep = numero.to_s.gsub(/\./, '').gsub(/\-/, '').to_i
-    response = Net::HTTP.Proxy(self.proxy_addr,self.proxy_port).get_response(URI.parse("#{URL_WEB_SERVICE}#{cep}"))
-    
-    raise "Não foi possível obter o cep. (#{response.code} - #{response.message})" unless response.kind_of?(Net::HTTPSuccess)
-    
-    doc = REXML::Document.new(response.body)
+    # to_i.to_s adicionado no fim para que o CEP '00000000' não passe pela exceção
+    raise "O CEP informado possui um formato inválido." if numero.to_s.gsub(/\./, '').gsub(/\-/, '').to_i.to_s.length != 8
+
+    @@cep = numero.to_s.gsub(/\./, '').gsub(/\-/, '').to_i
+
+    @@retorno = []
+
+    begin
+      usar_web_service_da_bronze_business
+    rescue
+      usar_web_service_do_buscar_cep
+    end
     
-    retorno = []
-    %w(logradouro nome bairro UF cidade).each do |e|
-      elemento = REXML::XPath.match(doc, "//#{e}").first
-      raise "Cep #{cep} não encontrado." if elemento.nil?
+    @@retorno << @@cep
+  end
 
-      retorno << elemento.text
-    end  
+  private
+  
+  def self.usar_web_service_da_bronze_business
+    @@response = Net::HTTP.Proxy(self.proxy_addr, self.proxy_port).get_response(URI.parse("#{URL_WEB_SERVICE_BRONZE_BUSINESS}#{@@cep}"))
+    raise "A busca de endereço por CEP através do web service da Bronze Business está indisponível." unless @@response.kind_of?(Net::HTTPSuccess)
+
+    @@doc = REXML::Document.new(@@response.body)
+    processar_xml ELEMENTOS_XML_BRONZE_BUSINESS
+  end
+
+  def self.usar_web_service_do_buscar_cep
+    @@response = Net::HTTP.Proxy(self.proxy_addr, self.proxy_port).get_response(URI.parse("#{URL_WEB_SERVICE_BUSCAR_CEP}#{@@cep}&formato=xml"))
+    raise "A busca de endereço por CEP está indisponível no momento." unless @@response.kind_of?(Net::HTTPSuccess)
     
-    retorno << cep
+    @@doc = REXML::Document.new(@@response.body)
+    processar_xml ELEMENTOS_XML_BUSCAR_CEP
+  end
+
+  def self.processar_xml(elementos_do_xml)
+    elementos_do_xml.each do |e|
+      elemento = REXML::XPath.match(@@doc, "//#{e}").first
+
+      raise "CEP #{@@cep} não encontrado." if elemento.nil?
+
+      # Remove os acentos já que o Buscar Cep retorna o endereço com acento e a Bronze Business não
+      @@retorno << elemento.text.remover_acentos
+    end
   end
-end
+end

data/lib/brcep/version.rb

@@ -4,6 +4,6 @@ module BrCep
     
     
 
-    STRING = "2.0.10"
+    STRING = "2.0.11"
   end
 end

data/test/busca_endereco_test.rb

@@ -3,9 +3,10 @@ require 'rubygems'
 require 'net/http'
 require 'mocha'
 
-
 INVALID_ZIPS = [0, '0', '00', '000', '0000', '00000', '000000', '0000000', '00000000']
-VALID_ZIPS = [22640100, '22640100', '22.640-100', '22.640-100']
+VALID_ZIPS = [22640100, '22640100', '22.640100', '22640-100', '22.640-100']
+VALID_CEPS_NOT_FOUND_ON_BRONZE_BUSINESS = [20230024, '20230024', '20.230024', '20230-024', '20.230-024']
+ZIPS_WITH_NO_ADDRESS_ASSOCIATED = [12345678, '12345678', '12.345678', '12345-678', '12.345-678']
 
 class MockSuccess < Net::HTTPSuccess
   def initialize; end
@@ -23,39 +24,117 @@ def limpa_cep(numero)
 end
 
 class BuscaEnderecoTest < Test::Unit::TestCase
-  def test_raise_witout_service
-    http_response = MockServerError.new
-    Net::HTTP.expects(:get_response).returns(http_response)
-    assert_raise RuntimeError, "Não foi possível obter o cep. (505 - HTTPServiceUnaviable)" do
+  def test_raise_without_service_on_both_web_services
+    http_error_response = MockServerError.new
+  
+    Net::HTTP.expects(:get_response).returns(http_error_response)
+    Net::HTTP.expects(:get_response).returns(http_error_response)
+  
+    assert_raise RuntimeError, "A busca de endereço por CEP está indisponível no momento." do
       BuscaEndereco.por_cep(VALID_ZIPS.first)
     end
   end
 
   def test_raise_for_invalid_zip_code
     INVALID_ZIPS.each do |invalid_zip|
-      mock_get_response('invalid')
-      assert_raise RuntimeError, "Cep #{invalid_zip} não encontrado." do
+      assert_raise RuntimeError, "O CEP informado possui um formato inválido." do
         BuscaEndereco.por_cep(invalid_zip)
       end
     end
+  end    
+  
+  def test_valid_code_on_bronze_business
+    VALID_ZIPS.each do |valid_zip|
+      mock_get_response_from_bronze_business(limpa_cep(valid_zip))
+      
+      assert_equal ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro',
+        limpa_cep(valid_zip)], BuscaEndereco.por_cep(valid_zip)
+    end
+  end
+
+  def test_valid_code_on_buscar_cep_when_bronze_business_is_unavailable
+    VALID_ZIPS.each do |valid_zip|
+      mock_get_response_from_buscar_cep_when_bronze_business_is_unavailable(limpa_cep(valid_zip))
+
+      assert_equal ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro',
+        limpa_cep(valid_zip)], BuscaEndereco.por_cep(valid_zip)
+    end
   end
 
-  def test_valid_code
+  def test_valid_code_on_buscar_cep_when_address_not_found_on_bronze_business
+    VALID_CEPS_NOT_FOUND_ON_BRONZE_BUSINESS.each do |cep_not_found_on_bronze_business|
+      mock_get_response_from_buscar_cep_when_address_not_found_on_bronze_business(limpa_cep(cep_not_found_on_bronze_business))
+
+      assert_equal ['Rua', 'Washington Luis', 'Centro', 'RJ', 'Rio de Janeiro', limpa_cep(cep_not_found_on_bronze_business)],
+        BuscaEndereco.por_cep(cep_not_found_on_bronze_business)
+    end
+  end
+
+  def test_should_return_the_same_address_on_both_web_services
     VALID_ZIPS.each do |valid_zip|
-      mock_get_response(limpa_cep(valid_zip))
-      assert_equal ['Avenida', 'das Americas', 'Barra da Tijuca', 'RJ', 'Rio de Janeiro', limpa_cep(valid_zip)], BuscaEndereco.por_cep(valid_zip)
+      mock_get_response_from_bronze_business(limpa_cep(valid_zip))
+      mock_get_response_from_buscar_cep_when_bronze_business_is_unavailable(limpa_cep(valid_zip))
+      assert_equal BuscaEndereco.por_cep(valid_zip), BuscaEndereco.por_cep(valid_zip)
+    end
+  end
+
+  def test_should_raise_exception_when_search_for_zip_with_no_associated_address
+    ZIPS_WITH_NO_ADDRESS_ASSOCIATED.each do |zip_with_no_address_associated|
+      assert_raise RuntimeError, "CEP #{limpa_cep(zip_with_no_address_associated)} não encontrado." do
+        mock_get_response_when_theres_no_address_associated_with_zip
+
+        BuscaEndereco.por_cep(zip_with_no_address_associated)
+      end
     end
   end
 
   private
 
-  def mock_get_response(zip_number)
-    xml_data = xml_data_from zip_name(zip_number)
+  def mock_get_response_from_bronze_business(zip_number)
+    xml_data = xml_data_from zip_name(zip_number, "bronze_business")
+
+    http_success_response = MockSuccess.new
+    http_success_response.expects(:body).returns(xml_data)
+
+    Net::HTTP.expects(:get_response).returns(http_success_response)
+  end
+
+  def mock_get_response_from_buscar_cep_when_bronze_business_is_unavailable(zip_number)
+    xml_data = xml_data_from zip_name(zip_number, "buscar_cep")
+
+    http_success_response = MockSuccess.new
+    http_success_response.expects(:body).returns(xml_data)
+
+    Net::HTTP.expects(:get_response).returns(http_success_response)
+
+    http_error_response = MockServerError.new
+    Net::HTTP.expects(:get_response).returns(http_error_response)
+  end
+
+  def mock_get_response_from_buscar_cep_when_address_not_found_on_bronze_business(zip_number)
+    xml_data_from_bronze_business = xml_data_from zip_name("not_found", "bronze_business")
+    xml_data_from_buscar_cep = xml_data_from zip_name(zip_number, "buscar_cep")
+
+    http_success_response_from_buscar_cep = MockSuccess.new
+    http_success_response_from_buscar_cep.expects(:body).returns(xml_data_from_buscar_cep)
+    Net::HTTP.expects(:get_response).returns(http_success_response_from_buscar_cep)
+
+    http_success_response_from_bronze_business = MockSuccess.new
+    http_success_response_from_bronze_business.expects(:body).returns(xml_data_from_bronze_business)
+    Net::HTTP.expects(:get_response).returns(http_success_response_from_bronze_business)
+  end
+
+  def mock_get_response_when_theres_no_address_associated_with_zip
+    xml_data_from_bronze_business = xml_data_from zip_name("not_found", "bronze_business")
+    xml_data_from_buscar_cep = xml_data_from zip_name("not_found", "buscar_cep")
 
-    http_response = MockSuccess.new
-    http_response.expects(:body).returns(xml_data)
+    http_success_response_from_buscar_cep = MockSuccess.new
+    http_success_response_from_buscar_cep.expects(:body).returns(xml_data_from_buscar_cep)
+    Net::HTTP.expects(:get_response).returns(http_success_response_from_buscar_cep)
 
-    Net::HTTP.expects(:get_response).returns(http_response)
+    http_success_response_from_bronze_business = MockSuccess.new
+    http_success_response_from_bronze_business.expects(:body).returns(xml_data_from_bronze_business)
+    Net::HTTP.expects(:get_response).returns(http_success_response_from_bronze_business)
   end
 
   def xml_data_from xml_mock
@@ -70,8 +149,7 @@ class BuscaEnderecoTest < Test::Unit::TestCase
     xml_data
   end
 
-  def zip_name(nome)
-    File.join(File.dirname(__FILE__), 'mocks', "zip_#{nome}.xml")
+  def zip_name(nome, web_service)
+    File.join(File.dirname(__FILE__), 'mocks', "zip_#{nome}_#{web_service}.xml")
   end
-end
-
+end

data/test/mocks/zip_20230024_buscar_cep.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<webservicecep><cep>20230024</cep><uf>RJ</uf><cidade>Rio de Janeiro</cidade><bairro>Centro</bairro><tipo_logradouro>Rua</tipo_logradouro><logradouro>Washington Lu�s</logradouro><resultado>1</resultado><resultado_txt>sucesso. cep encontrado</resultado_txt></webservicecep>

data/test/mocks/zip_22640100_bronze_business.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8"?>
+<DataSet xmlns="http://tempuri.org/">
+  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">
+      <xs:complexType>
+        <xs:choice minOccurs="0" maxOccurs="unbounded">
+          <xs:element name="tbCEP">
+            <xs:complexType>
+              <xs:sequence>
+                <xs:element name="logradouro" type="xs:string" minOccurs="0" />
+                <xs:element name="nome" type="xs:string" minOccurs="0" />
+                <xs:element name="bairro" type="xs:string" minOccurs="0" />
+                <xs:element name="UF" type="xs:string" minOccurs="0" />
+                <xs:element name="cidade" type="xs:string" minOccurs="0" />
+              </xs:sequence>
+            </xs:complexType>
+          </xs:element>
+        </xs:choice>
+      </xs:complexType>
+    </xs:element>
+  </xs:schema>
+  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
+    <NewDataSet xmlns="">
+      <tbCEP diffgr:id="tbCEP1" msdata:rowOrder="0">
+        <logradouro>Avenida</logradouro>
+        <nome>das Americas</nome>
+        <bairro>Barra da Tijuca</bairro>
+        <UF>RJ</UF>
+        <cidade>Rio de Janeiro</cidade>
+      </tbCEP>
+    </NewDataSet>
+  </diffgr:diffgram>
+</DataSet>

data/test/mocks/zip_22640100_buscar_cep.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<webservicecep>
+  <cep>22640100</cep>
+  <uf>RJ</uf>
+  <cidade>Rio de Janeiro</cidade>
+  <bairro>Barra da Tijuca</bairro>
+  <tipo_logradouro>Avenida</tipo_logradouro>
+  <logradouro>das Am�ricas</logradouro>
+  <resultado>1</resultado>
+  <resultado_txt>sucesso. cep encontrado</resultado_txt>
+</webservicecep>

data/test/mocks/zip_not_found_bronze_business.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<DataSet xmlns="http://tempuri.org/">
+  <xs:schema id="NewDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xs:element name="NewDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true">
+      <xs:complexType>
+        <xs:choice minOccurs="0" maxOccurs="unbounded">
+          <xs:element name="tbCEP">
+            <xs:complexType>
+              <xs:sequence>
+                <xs:element name="logradouro" type="xs:string" minOccurs="0"/>
+                <xs:element name="nome" type="xs:string" minOccurs="0"/>
+                <xs:element name="bairro" type="xs:string" minOccurs="0"/>
+                <xs:element name="UF" type="xs:string" minOccurs="0"/>
+                <xs:element name="cidade" type="xs:string" minOccurs="0"/>
+              </xs:sequence>
+            </xs:complexType>
+          </xs:element>
+        </xs:choice>
+      </xs:complexType>
+    </xs:element>
+  </xs:schema>
+  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1"/>
+</DataSet>

data/test/mocks/zip_not_found_buscar_cep.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<webservicecep><resultado>-1</resultado><resultado_txt>cep nao encontrado</resultado_txt><cep>12345678</cep></webservicecep>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brcep
 version: !ruby/object:Gem::Version 
-  version: 2.0.10
+  version: 2.0.11
 platform: ruby
 authors: 
 - "Marcos Tapaj\xC3\xB3s"
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-24 00:00:00 -03:00
+date: 2008-11-27 00:00:00 -02:00
 default_executable: 
 dependencies: []
 
@@ -35,8 +35,13 @@ files:
 - lib/brcep.rb
 - test/busca_endereco_test.rb
 - test/mocks
+- test/mocks/zip_20230024_buscar_cep.xml
 - test/mocks/zip_22640100.xml
+- test/mocks/zip_22640100_bronze_business.xml
+- test/mocks/zip_22640100_buscar_cep.xml
 - test/mocks/zip_invalid.xml
+- test/mocks/zip_not_found_bronze_business.xml
+- test/mocks/zip_not_found_buscar_cep.xml
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://www.improveit.com.br/software_livre/brazilian_rails