cep_facil 1.0.1 → 1.0.2

data/README.md

@@ -1,10 +1,10 @@
 # CepFacil
 
-Ruby wrapper para o serviço em cepfacil.com.br
+Ruby wrapper para o serviço em [cepfacil.com.br]
 
 ## Instalação
 
-NOTA: Esse projeto encontra-se na versão 1.x, cuja API difere completamente das versões 0.x. Se você está procurando a versão mais antiga, veja a branch [0x], que se mantém intacta.
+**NOTA:** Esse projeto encontra-se na versão 1.x, cuja API difere completamente das versões 0.x. Se você está procurando a versão mais antiga, veja a branch [0x], que se mantém intacta.
 
 No `Gemfile`:
 
@@ -33,14 +33,23 @@ token = "1234567890"
 
 address = CepFacil::API.new(cep, token)
 
+### Acesso rápido via método de classe
+
+address = CepFacil::API.get(cep, token) # Hash Notation => CepFacil::API.get(cep: cep, token: token)
+
+# Argumentos como Hashes
+
+address = CepFacil::API.new(cep: cep, token: token, format: "texto")
+
 ```
 
 #### Retorna o endereço referente àquele CEP
 
-O retorno é um objeto `CepFacil::API` que contem 6 métodos (propriedades): cep, type, state, city, neighborhood, street. Assim você os acessa:
+O retorno é um objeto `CepFacil::API` que contem os seguintes métodos (propriedades) :
 
 ```ruby
 
+
 address.cep # => "53417540"
 
 address.type # => "Rua"
@@ -53,28 +62,54 @@ address.neighborhood # => "Artur Lundgren II"
 
 address.street # => "Panelas"
 
+# Também é possivel acessar utilizando metodos em português
+
+address.tipo   # => "Avenida"
+
+address.rua    # => "Francisco Navarro"
+
+address.cidade # => "Varginha"
+
+address.bairro # => "Centro"
+
+address.estado # => "MG"
+
+address.uf     # => "MG"
+
 ```
 
 Embora isso deva parecer óbvio, informo que essas propriedades são todas **READONLY**.
 
-Adicionalmente, seu objeto `CepFacil::API` possui um método `full` que o descreve por extenso:
+Você pode checar se o endereço retornado é válido utilizando o método `valid?`:
 
 ```ruby
 
-address.full_format # => "Rua Panelas, Paulista - PE, Brasil"
+address = CepFacil::API.new "53020-140", token
+
+address.valid? # true
 
 ```
 
-Existem três formatos possíveis para se armazenar CEPs:
+Adicionalmente, seu objeto `CepFacil::API` possui um método `full_format` e seu alias (`full_address`) que o descreve por extenso:
 
 ```ruby
+
+address.full_format # => "Rua Panelas, Paulista - PE, Brasil"
+
+address.full_address  # => Avenida Francisco Navarro, Varginha - MG, Brasil"  # Alias
+
+```
+Você pode passar o CEP como uma string qualquer, letras, caracteres especiais (pontos, hífens) são removidos automaticamente.
+
+```ruby
+
 "12345-678"
+"123.45.678"
+"123-456.78"
 "12345678"
-12345678   # Eu realmente não usaria esse
+12345678   # Não recomendado, prefira utilizar Strings
 ```
 
-CepFacil funciona com esses três formatos.
-
 ## Integração com a gem Geocoder
 
 A gem [Geocoder] é ótima para uso e manipulação de dados geográficos em projetos Ruby. Para integrá-la com o CepFacil, faça assim:
@@ -92,6 +127,7 @@ geocoded_by address.full_format
 ## Contribuidores
 
 * Adriano Bacha - abacha@gmail.com
+* Rafael Fidelis - rafa_fidelis@yahoo.com.br | http://defidelis.com
 
 ## Agradecimentos
 
@@ -106,5 +142,6 @@ CepFacil é liberado sob a [licença do MIT] com atribuições a Rodrigo Alves V
 [0x]: https://github.com/rodrigoalvesvieira/cep_facil/tree/0x
 [Geocoder]: https://github.com/alexreisner/geocoder
 [CepFácil]: http://cepfacil.com.br
+[cepfacil.com.br]: http://cepfacil.com.br
 [Contribuidores]: #contribuidores
 [licença do MIT]: http://pt.wikipedia.org/wiki/Licen%C3%A7a_MIT#Texto_da_licen.C3.A7a

data/lib/cep_facil.rb

@@ -1,6 +1,4 @@
-require "cep_facil/api"
 require "cep_facil/version"
-
 module CepFacil
   autoload :API, "cep_facil/api"
 end

data/lib/cep_facil/api.rb

@@ -1,53 +1,36 @@
-# coding: utf-8
-
-require "cgi"
+# encoding: utf-8
 require "net/http"
 
 module CepFacil
   class API
-    attr_reader :cep, :type, :state, :city, :neighborhood, :street
-    ## Obtenção de endereço atráves do CEP
-    # retorna um objeto `CepFacil::API` que contem 6 métodos (propriedades):
-    # cep, type, state, city, neighborhood e street.
-
-    def initialize(cep, token)
-      @cep = cep
-      @token = token
-
-      zip_code = @cep.to_s
-
-      if zip_code.match(/^[0-9]{5}[-]?[0-9]{3}/)
-        zip_code.gsub!("-", "")
-        @uri = URI.parse "http://www.cepfacil.com.br/service/?filiacao=#{token}&cep=#{zip_code}&formato=texto"
-      else
-        @uri = URI.parse "http://www.cepfacil.com.br/service/?filiacao=#{token}&cep=#{zip_code}&formato=texto"
-      end
-
-      http = Net::HTTP.new(@uri.host, @uri.port)
-      call = Net::HTTP::Get.new(@uri.request_uri)
-
-      response = http.request(call)
-
-      pattern = /^([a-z]+)\=/
-
-      result = response.body.split("&")
-
-      if result[2]
-        @type = result[2].gsub!(pattern, "")
-        @state = result[3].gsub!(pattern, "")
-        @city = result[4].gsub!(pattern, "")
-        @neighborhood = result[5].gsub!(pattern, "")
-        @street = result[6].gsub!(pattern, "")
-      else
-        return false
-      end
+    attr_reader :read
+    
+    BASE_URL = "http://www.cepfacil.com.br/service/?filiacao=%s&cep=%s&formato=%s"
+    METHODS_PLACEHOLDER = {:estado => :uf , :type => :tipo , :state => :uf , :city => :cidade , :neighborhood => :bairro , :street => :descricao , :rua => :descricao}
+
+    def initialize(*args)
+      args = (args[0].is_a?(Hash) ? args[0] : Hash[[:cep,:token,:format].zip(args)])
+      args[:format] ||= "texto"
+      args[:cep] = args[:cep].to_s.gsub(/([^0-9]+)/,"")[0...8]            # Removing all non-numeric caracters and limit to 8 caracters
+
+      uri = URI(BASE_URL % [args[:token],args[:cep],args[:format]])      
+      @read = Net::HTTP.get(uri)
+      @data = args[:format].to_s == "texto" ? Hash[@read.split("&").map { |i| i.split("=") } ] : @read  # Need a better implementation
+      return self
+    end
+    def valid?
+      @data.is_a?(Hash) and @data.size > 1
     end
-
-    ##
-    # Descreve o endereço obtido, por extenso. i.e: "Rua Panelas, Paulista - PE, Brasil"
-    #
     def full_format
-      "#{self.type} #{self.street}, #{self.city} - #{self.state}, Brasil"
+      "#{type} #{street}, #{city} - #{state}, Brasil"
+    end
+    def self.get(*args)
+      self.new(*args)
+    end
+    private
+    def method_missing(*args)
+      return (@data[METHODS_PLACEHOLDER[args[0].to_sym].to_s] || @data[args[0].to_s]).force_encoding(Encoding::UTF_8) || super(*args) 
     end
+    alias :address :full_format
   end
-end
+end

data/lib/cep_facil/version.rb

@@ -1,3 +1,3 @@
 module CepFacil
-  VERSION = "1.0.1" #:nodoc:
+  VERSION = "1.0.2" #:nodoc:
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cep_facil
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec