brcep-vandal 3.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd0d83fdf74931b3a6c39373178e577ccdb497bd
+  data.tar.gz: b8aa08fc9322cf2bf22092afe0a525219b4ea5ba
+SHA512:
+  metadata.gz: bfa9ae67f2d2b2e457b9f47e7f8ac4bb671efda5d21aa4d474cd0b69b03531835b3ee9c8909d8b363495a82c865e8139bd1a85a7f1bec9cf8382c0f74f415d88
+  data.tar.gz: 6c207e572f24c6b0b263fdc335bd61773ba93cf2d29413cda32e2a189e78e60fdccf9c92626d4ffbda552b4d73cfd0319fc7df82e17441b92d30737bc6975253

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkdn

@@ -0,0 +1,31 @@
+# BrCep
+
+## O que é?
+
+O BrCep é um gem que tem como objetivo buscar um endereço com base no seu CEP. Para isso ele utiliza dois web services:
+
+* Bronze Business
+* Buscar CEP
+
+Primeiro o endereço é procurado no web service da Bronze Business, e caso não ache o endereço lá, ou caso este web service esteja indisponível, o endereço será então procurado no web service do Buscar CEP. Portanto, o endereço tem duas chances para ser encontrado, sendo mais difícil o serviço de busca de endereço por CEP estar indisponível ou não encontrar o endereço.
+
+## Como usar?
+
+        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]
+
+## O que acontece se o CEP informado tiver um formato inválido?
+
+        BuscaEndereco.por_cep('00000000')   ==> RuntimeError 'O CEP informado possui um formato inválido.'
+
+## E se os dois web services estiverem indisponíveis?
+
+        BuscaEndereco.por_cep('22.640-100') ==> RuntimeError, "A busca de endereço por CEP está indisponível no momento."
+
+## E se por acaso o CEP não for encontrado em nenhum dos dois web services:
+
+        BuscaEndereco.por_cep('12345678') ==> RuntimeError, "CEP 12345678 não encontrado."
+
+P.S.: Nesse caso o endereço não foi encontrado porque não existe um endereço associado ao CEP 12345678. No entanto, pode haver situações em que CEPs que possuem endereços associados não tenham os seus endereços encontrados, no entanto, até o momemnto os dois web services utilizados cobrem todas os CEPs testados na prática.

data/Rakefile

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+require "rubygems"
+require "rake"
+require "rake/testtask"
+require "rdoc/task"
+require "rake/packagetask"
+require "rubygems/package_task"
+
+require File.join(File.dirname(__FILE__), "lib", "brcep", "version")
+
+PKG_BUILD     = ENV["PKG_BUILD"] ? "." + ENV["PKG_BUILD"] : ""
+PKG_NAME      = "brcep-vandal"
+PKG_VERSION   = BrCep::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+desc "Default Task"
+task :default => [ :test ]
+
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+  t.verbose = true
+  t.warning = false
+}
+
+
+#Generate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = "doc"
+  rdoc.title    = "Brazilian Rails -- CEP"
+  rdoc.options << "--line-numbers" << "--inline-source" << "-A cattr_accessor=object"
+  rdoc.options << "--charset" << "utf-8"
+  rdoc.template = "#{ENV["template"]}.rb" if ENV["template"]
+  rdoc.rdoc_files.include("README.mkdn", "CHANGELOG")
+  rdoc.rdoc_files.include("lib/**/*")
+}
+
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "brcep é uma das gems que compoem o Brazilian Rails"
+  s.description = %q{brcep é uma das gems que compoem o Brazilian Rails}
+  s.version = PKG_VERSION
+
+  s.authors = ["Marcos Tapajós", "Celestino Gomes", "Andre Kupkosvki", "Vinícius Teles", "Felipe Barreto", "Rafael Walter", "Cassio Marques"]
+  s.email = %w"tapajos@gmail.com tinorj@gmail.com kupkovski@gmail.com vinicius.m.teles@gmail.com felipebarreto@gmail.com rafawalter@gmail.com cassiommc@gmail.com"
+  s.rubyforge_project = "brcep-vandal"
+  s.homepage = "http://www.improveit.com.br/software_livre/brazilian_rails"
+
+  s.has_rdoc = true
+  s.requirements << "none"
+  s.require_path = "lib"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "mocha"
+
+  s.files = [ "Rakefile", "README.mkdn", "CHANGELOG", "MIT-LICENSE" ]
+  s.files = s.files + Dir.glob( "lib/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+  s.files = s.files + Dir.glob( "test/**/*" ).delete_if { |item| item.include?( "\.svn" ) }
+end
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  `gem push pkg/#{PKG_FILE_NAME}.gem`
+end

data/lib/brcep/busca_endereco.rb

@@ -0,0 +1,96 @@
+# encoding: UTF-8
+require 'net/http'
+require 'cgi'
+
+# Este recurso tem como finalidade encontrar um endereço através de um CEP, e
+# para isso ele utiliza o web service da Republica Virtual (http://cep.republicavirtual.com.br/web_cep.php)
+# Obviamente, para utilizar este serviço é necessário uma conexão com a Internet.
+#
+# Como fazer a busca de endereço por cep?
+#
+# BuscaEndereco.cep(22640100)     ==> {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :uf => 'RJ', :cidade => 'Rio de Janeiro', :cep => '22640100'}
+# BuscaEndereco.cep('22640100')   ==> {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :uf => 'RJ', :cidade => 'Rio de Janeiro', :cep => '22640100'}
+# BuscaEndereco.cep('22640-100')  ==> {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :uf => 'RJ', :cidade => 'Rio de Janeiro', :cep => '22640100'}
+# BuscaEndereco.cep('22.640-100') ==> {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :uf => 'RJ', :cidade => 'Rio de Janeiro', :cep => '22640100'}
+#
+# É feita uma validação para ver se o cep possui 8 caracteres após a remoção de '.' e '-'.
+# BuscaEndereco.cep('0000000')   ==> 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'
+# BuscaEndereco.proxy_port= 999 # porta a ser utilizada
+#
+class BuscaEndereco
+  @@proxy_addr = nil
+  @@proxy_port = nil
+
+  class << self
+    def proxy_addr
+      @@proxy_addr
+    end
+
+    def proxy_addr=(addr)
+      @@proxy_addr = addr
+    end
+
+    def proxy_port
+      @@proxy_port
+    end
+
+    def proxy_port=(port)
+      @@proxy_port = port
+    end
+  end
+
+  WEB_SERVICE_REPUBLICA_VIRTUAL_URL = "http://cep.republicavirtual.com.br/web_cep.php?formato=query_string&cep="
+
+  # Deprecated: Será removido
+  def self.por_cep(numero)
+    warn("DEPRECATION WARNING: O método `BuscaEnderedo.por_cep` será removido. Use o BuscaEndereco.cep e faça os ajustes necessarios")
+    _cep = cep(numero)
+    [
+      _cep[:tipo_logradouro],
+      _cep[:logradouro],
+      _cep[:bairro],
+      _cep[:cidade],
+      _cep[:uf],
+      _cep[:cep]
+    ]
+  end
+
+  # Retorna um hash 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.cep(22640100) ==> {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :uf => 'RJ', :cidade => 'Rio de Janeiro', :cep => '22640100'}
+  def self.cep(numero, acronym=true)
+    cep = numero.to_s.gsub(/[\.-]/, '')
+    raise "O CEP informado possui um formato inválido." unless cep.to_s.match(/^\d{8}$/)
+
+    response = Net::HTTP.Proxy(self.proxy_addr, self.proxy_port).get_response(URI.parse("#{WEB_SERVICE_REPUBLICA_VIRTUAL_URL}#{cep}"))
+    raise "A busca de endereço por CEP através do web service da República Virtual está indisponível." unless response.kind_of?(Net::HTTPSuccess)
+
+    doc = Hash[* CGI::parse(response.body).map {|k,v| [k,v[0]]}.flatten]
+
+    retorno = {}
+
+    raise "CEP #{cep} não encontrado." unless [1,2].include?(doc['resultado'].to_i)
+
+    %w(tipo_logradouro logradouro bairro cidade uf).each do |field|
+      retorno[field.to_sym] = if RUBY_VERSION < '1.9'
+        require 'iconv'
+        Iconv.conv("utf-8", "ISO-8859-1", doc[field])
+      else
+        doc[field].force_encoding("ISO-8859-1").encode("UTF-8")
+      end
+    end
+
+    retorno[:cep] = cep
+    if acronym == false
+      retorno[:uf] = ConvertAcronym.convert(retorno[:uf].to_sym)
+    end
+
+    retorno
+  end
+end

data/lib/brcep/convert_acronym.rb

@@ -0,0 +1,34 @@
+class ConvertAcronym
+  def self.convert(acronym)
+    ufs = {
+      'AC': 'Acre',
+      'AL': 'Alagoas',
+      'AP': 'Amapá',
+      'AM': 'Amazonas',
+      'BA': 'Bahia',
+      'CE': 'Ceará',
+      'DF': 'Distrito Federal',
+      'ES': 'Espírito Santo',
+      'GO': 'Goiás',
+      'MA': 'Maranhão',
+      'MT': 'Mato Grosso',
+      'MS': 'Mato Grosso do Sul',
+      'MG': 'Minas Gerais',
+      'PA': 'Pará',
+      'PB': 'Paraíba',
+      'PR': 'Paraná',
+      'PE': 'Pernambuco',
+      'PI': 'Piauí',
+      'RJ': 'Rio de Janeiro',
+      'RN': 'Rio Grande do Norte',
+      'RS': 'Rio Grande do Sul',
+      'RO': 'Rond&ohat;nia',
+      'RR': 'Roraima',
+      'SC': 'Santa Catarina',
+      'SP': 'São Paulo',
+      'SE': 'Sergipe',
+      'TO': 'Tocantins'
+    }
+    ufs[acronym]
+  end
+end

data/lib/brcep/version.rb

@@ -0,0 +1,10 @@
+module BrCep
+  module VERSION #:nodoc:
+    MAJOR = 3
+    MINOR = 3
+    TINY = 0
+
+    STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
+  end
+end
+

data/lib/brcep.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+%w(busca_endereco version convert_acronym).each {|req| require File.dirname(__FILE__) + "/brcep/#{req}"}
+
+
+module BrCep
+end

data/test/busca_endereco_test.rb

@@ -0,0 +1,87 @@
+# encoding: UTF-8
+require File.dirname(__FILE__) + '/test_helper'
+require 'rubygems'
+require 'net/http'
+require 'mocha'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+INVALID_ZIPS = [0, '0', '00', '000', '0000', '00000', '000000', '0000000', '4006000']
+VALID_ZIPS = [22640100, '22640100', '22.640100', '22640-100', '22.640-100']
+VALID_ZIPS_WITH_ZERO_AT_BEGINNING = ['05145100', '05145-100', '05.145-100']
+ZIPS_WITH_NO_ADDRESS_ASSOCIATED = [12345678, '12345678', '12.345678', '12345-678', '12.345-678']
+
+URL = BuscaEndereco::WEB_SERVICE_REPUBLICA_VIRTUAL_URL
+
+class BuscaEnderecoTest < Test::Unit::TestCase
+  def test_accept_option_to_convert_acronym
+    cep = VALID_ZIPS.first.to_s
+    expected = {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :cidade => 'Rio de Janeiro', :uf => 'Rio de Janeiro', :cep => cep}
+    body = "&resultado=1&resultado_txt=sucesso+-+cep+completo&uf=RJ&cidade=Rio+de+Janeiro&bairro=Barra+da+Tijuca&tipo_logradouro=Avenida&logradouro=das+Am%E9ricas"
+
+    FakeWeb.register_uri(:get, "#{URL}#{cep}", :body => body)
+
+    assert_equal expected, BuscaEndereco.cep(cep, acronym=false)
+  end
+
+  def test_if_warn_for_por_cep_usage
+    cep = VALID_ZIPS.sample
+    expected = {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :cidade => 'Rio de Janeiro', :uf => 'RJ', :cep => cep}
+    BuscaEndereco.expects(:warn).with("DEPRECATION WARNING: O método `BuscaEnderedo.por_cep` será removido. Use o BuscaEndereco.cep e faça os ajustes necessarios")
+    BuscaEndereco.expects(:cep).with(cep).returns(expected)
+
+    assert_equal expected.values, BuscaEndereco.por_cep(cep)
+  end
+
+  def test_raise_without_service_on_both_web_services
+    FakeWeb.register_uri(:get, "#{URL}#{22640100}", :status => 504, :body => "Service Unavailable")
+
+    assert_raise RuntimeError, "A busca de endereço por CEP está indisponível no momento." do
+      BuscaEndereco.cep(22640100)
+    end
+  end
+
+  INVALID_ZIPS.each do |invalid_zip|
+    define_method "test_raise_for_invalid_zip_code_#{invalid_zip}" do
+      assert_raise RuntimeError, "O CEP informado possui um formato inválido." do
+        BuscaEndereco.cep(invalid_zip)
+      end
+    end
+  end
+
+  VALID_ZIPS.each do |valid_zip|
+    define_method "test_valid_code_#{valid_zip}" do
+      cep = VALID_ZIPS.first.to_s
+      expected = {:tipo_logradouro => 'Avenida', :logradouro => 'das Américas', :bairro => 'Barra da Tijuca', :cidade => 'Rio de Janeiro', :uf => 'RJ', :cep => cep}
+      body = "&resultado=1&resultado_txt=sucesso+-+cep+completo&uf=RJ&cidade=Rio+de+Janeiro&bairro=Barra+da+Tijuca&tipo_logradouro=Avenida&logradouro=das+Am%E9ricas"
+
+      FakeWeb.register_uri(:get, "#{URL}#{cep}", :body => body)
+
+      assert_equal expected,BuscaEndereco.cep(valid_zip)
+    end
+  end
+
+  VALID_ZIPS_WITH_ZERO_AT_BEGINNING.each do |valid_zip|
+    define_method "test_valid_code_#{valid_zip}" do
+      cep = VALID_ZIPS_WITH_ZERO_AT_BEGINNING.first
+      expected = {:tipo_logradouro => "Avenida", :logradouro => "Raimundo Pereira de Magalhães", :bairro => "Jardim Iris", :cidade => "São Paulo", :uf => "SP", :cep => cep}
+      body = "&resultado=1&resultado_txt=sucesso+-+cep+completo&uf=SP&cidade=S%E3o+Paulo&bairro=Jardim+Iris&tipo_logradouro=Avenida&logradouro=Raimundo+Pereira+de+Magalh%E3es"
+
+      FakeWeb.register_uri(:get, "#{URL}#{cep}", :body => body)
+
+      assert_equal expected, BuscaEndereco.cep(cep)
+    end
+  end
+
+  def test_should_raise_exception_when_invalid_code
+    cep = "12345678"
+    body = "&resultado=0&resultado_txt=servi%E7o+indispon%EDvel%2Fcep+inv%E1lido&uf=&cidade=&bairro=&tipo_logradouro=&logradouro="
+
+    assert_raise RuntimeError, "CEP #{cep} não encontrado." do
+      FakeWeb.register_uri(:get, "#{URL}#{cep}", :body => body)
+
+      BuscaEndereco.cep("12345678")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/brcep'
+
+def tornar_metodos_publicos(clazz)
+  clazz.class_eval do
+    private_instance_methods.each { |instance_method| public instance_method }
+    private_methods.each { |method| public_class_method method }
+  end
+end
+
+def p80 text
+  p '*'*80
+  p text
+  yield if block_given?
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: brcep-vandal
+version: !ruby/object:Gem::Version
+  version: 3.3.0
+platform: ruby
+authors:
+- Marcos Tapajós
+- Celestino Gomes
+- Andre Kupkosvki
+- Vinícius Teles
+- Felipe Barreto
+- Rafael Walter
+- Cassio Marques
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: brcep é uma das gems que compoem o Brazilian Rails
+email:
+- tapajos@gmail.com
+- tinorj@gmail.com
+- kupkovski@gmail.com
+- vinicius.m.teles@gmail.com
+- felipebarreto@gmail.com
+- rafawalter@gmail.com
+- cassiommc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.mkdn
+- Rakefile
+- lib/brcep.rb
+- lib/brcep/busca_endereco.rb
+- lib/brcep/convert_acronym.rb
+- lib/brcep/version.rb
+- test/busca_endereco_test.rb
+- test/test_helper.rb
+homepage: http://www.improveit.com.br/software_livre/brazilian_rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: brcep-vandal
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: brcep é uma das gems que compoem o Brazilian Rails
+test_files: []