cep_facil 1.0.4 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe9a453688bb9eb7202f39bf0d11078bc334b6c1
+  data.tar.gz: 672fc5c2844e410a6d466a96628ddd5aba329866
+SHA512:
+  metadata.gz: aaa2bf1a6ffc9b9ec2c439c89cac0ee6fe31a2684bbab1d5c5a75a776d49ad453b5ef1fabcb0c4418f0b64f6c67b2c9995fa78ec529acb7d98ab2bbb9865d00e
+  data.tar.gz: 2fe227adb42b28c4a1cc94afb47a4b2d748d944b68530df25f52a81b4d3ddf2427da1a809740df2719ccc52768c5df2fdf9db90a2163d8481c9f60d69b89d9ee

data/Gemfile

@@ -1,7 +1,2 @@
-if RUBY_VERSION =~ /1.9/
-  Encoding.default_external = Encoding::UTF_8
-  Encoding.default_internal = Encoding::UTF_8
-end
-
 source "http://rubygems.org"
-gemspec
+gemspec

data/README.md

@@ -1,9 +1,10 @@
 # CepFacil
 
-Ruby wrapper para o serviço em [cepfacil.com.br]
+Wrapper Ruby para a API do [CepFácil]
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rodrigoalvesvieira/cep_facil)
 [![Build Status](https://secure.travis-ci.org/rodrigoalvesvieira/cep_facil.png?branch=master)](http://travis-ci.org/rodrigoalvesvieira/cep_facil)
+* [![Dependencies](https://gemnasium.com/rodrigoalvesvieira/cepfacil.png?travis)](https://gemnasium.com/rodrigoalvesvieira/cepfacil)
 
 ## Instalação
 
@@ -13,7 +14,6 @@ No `Gemfile`:
 
 ```ruby
 gem "cep_facil"
-
 ```
 
 Ou via RubyGems, diretamente:
@@ -27,32 +27,23 @@ Ou via RubyGems, diretamente:
 Para usar a API do [CepFácil], você precisa obter um token do serviço. Você obtém esse token gratuitamente em cepfacil.com.br
 
 ```ruby
-
 require "cep_facil"
 
-cep = "53417-540"
+# Autenticando
 
 token = "1234567890"
+conn = CepFacil::API.new token
 
-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")
+# Obtendo endereços
 
+zip_code = "53416540"
+address = conn.get_address(zip_code)
 ```
 
-#### Retorna o endereço referente àquele CEP
+#### Retorna o endereço (objeto `CepFacil::Address`) referente àquele CEP
 
-O retorno é um objeto `CepFacil::API` que contem os seguintes métodos (propriedades) :
 
 ```ruby
-
-
 address.cep # => "53417540"
 
 address.type # => "Rua"
@@ -64,62 +55,25 @@ address.city # => "Paulista"
 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**.
-
 Você pode checar se o endereço retornado é válido utilizando o método `valid?`:
 
 ```ruby
 
-address = CepFacil::API.new "53020-140", token
-
 address.valid? # true
-
 ```
 
-Você também pode checar se o endereço foi encontrado com o CEP passado da seguinte forma:
+Adicionalmente, seu objeto `CepFacil::Address` possui um método `full_format` que o descreve por extenso:
 
 ```ruby
-
-address = CepFacil::API.new "53417-540", token
-
-address.found? # true
-
-address = CepFacil::API.new "00000000", token
-
-address.valid? # false
-
+address.full_format # => "RUA PANELAS, PAULISTA - PE 53416540, Brasil"
 ```
 
-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"
@@ -132,19 +86,17 @@ Você pode passar o CEP como uma string qualquer, letras, caracteres especiais (
 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:
 
 ```ruby
-
 geocoded_by address.full_format
-
 ```
 
 ## Autor
 
-* Rodrigo Alves Vieira - rodrigovieira1994@gmail.com - http://www.rodrigoalvesvieira.com
+* Rodrigo Alves
 
 ## Contribuidores
 
-* Adriano Bacha - abacha@gmail.com
-* Rafael Fidelis - rafa_fidelis@yahoo.com.br | http://defidelis.com
+* Adriano Bacha
+* Rafael Fidelis
 
 ## Agradecimentos
 
@@ -154,11 +106,11 @@ Obrigado também aos [Contribuidores] desse projeto.
 
 ## Licença
 
-CepFacil é liberado sob a [licença do MIT] com atribuições a Rodrigo Alves Vieira.
+CepFacil é liberado sob a [licença do MIT] com atribuições a Rodrigo Alves. Para detalhes veja o arquivo LICENSE.txt
 
 [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
+[licença do MIT]: http://pt.wikipedia.org/wiki/Licen%C3%A7a_MIT#Texto_da_licen.C3.A7a

data/cep_facil.gemspec

@@ -1,20 +1,25 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "cep_facil/version"
 
 Gem::Specification.new do |s|
-  s.name        = "cep_facil"
-  s.version     = CepFacil::VERSION
-  s.authors     = ["Rodrigo Alves Vieira"]
-  s.email       = ["rodrigovieira1994@gmail.com"]
-  s.homepage    = "http://github.com/rodrigoalvesvieira/cep_facil"
-  s.summary     = %q{Wrapper para o serviço cepfacil.com.br}
-  s.description = %q{Wrapper Ruby para o serviço cepfacil.com.br}
+  s.name              = "cep_facil"
+  s.version           = CepFacil::VERSION
+  s.authors           = ["Rodrigo Alves"]
+  s.email             = ["rodrigovieira1994@gmail.com"]
+  s.homepage          = "http://github.com/rodrigoalvesvieira/cep_facil"
+  s.summary           = %q{Wrapper para o serviço cepfacil.com.br}
+  s.description       = %q{Wrapper Ruby para o serviço cepfacil.com.br}
   s.rubyforge_project = "cep_facil"
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.add_dependency("rake", "0.9.2.2")
-  s.add_development_dependency("rspec", "~> 2.10.0")
-end
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables       = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths     = ["lib"]
+
+  s.rdoc_options = ["--title", "Wrapper Ruby para a API do CepFacil", "--main", "README.md"]
+  s.licenses = ["MIT"]
+
+  s.add_dependency("rake", "~> 10.1.0")
+  s.add_dependency("json", "~> 1.8.0")
+
+  s.add_development_dependency("rspec", "~> 2.13.0")
+end

data/lib/cep_facil.rb

@@ -1,4 +1,28 @@
+#--
+# Copyright (c) 2012-2013 Rodrigo Alves
+#
+# 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.
+#++
+
 require "cep_facil/version"
+
 module CepFacil
   autoload :API, "cep_facil/api"
-end
+end

data/lib/cep_facil/api.rb

@@ -1,66 +1,90 @@
-# encoding: utf-8
+#--
+# Copyright (c) 2012-2013 Rodrigo Alves
+#
+# 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.
+#++
+
 require "net/http"
+require "json"
 
 module CepFacil
-  class API
-    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}
-
-    class << self
-      ##
-      # Removes all non-numeric caracters and limit to 8 caracters
-      def parse_zip_code(zip_code)
-        return zip_code.to_s.gsub(/([^0-9]+)/,"")[0...8]
-      end
-    end
-
-    def initialize(*args)
-      args = (args[0].is_a?(Hash) ? args[0] : Hash[[:cep,:token,:format].zip(args)])
-      args[:format] ||= "texto"
-      args[:cep] = CepFacil::API.parse_zip_code(args[:cep])
-
-      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
+  class Address
+    attr_accessor :zip_code, :type, :city, :state, :neighborhood, :street
 
-      # OPTIMIZE: Need a better implementation
-      return self
+    def initialize(zip_code, type, city, state, neighborhood, street)
+      @zip_code = zip_code
+      @type = type
+      @city = city
+      @state = state
+      @neighborhood = neighborhood
+      @street = street
     end
 
-    ##
-    # Returns true if the address in question is a valid one
-    # returns false otherwise
     def valid?
-      @data.is_a?(Hash) and @data.size > 1
+      answ = false
+      answ = true if (self.zip_code && type && city)
+      return true
     end
 
-    #
     # Returns the address in its extense format
     def full_format
-      "#{type} #{street}, #{city} - #{state}, Brasil"
+      "#{self.type} #{self.street}, #{self.city} - #{self.state} #{self.zip_code}, Brasil"
     end
+  end
+
+  class API
+    attr_accessor :token
 
-    #
-    # Returns true if the address was found with the given zip code (CEP)
-    # returns false otherwise
-    def found?
-      self.status == "encontrado"
+    BASE_URL = "http://www.cepfacil.com.br/service/?filiacao=%s&cep=%s&formato=json"
+    PLACEHOLDER_METHODS = {
+      estado: :uf,
+      type: :tipo,
+      state: :uf,
+      city: :cidade,
+      neighborhood: :bairro,
+      street: :descricao,
+      rua: :descricao
+    }
+
+    class << self
+      # Removes all non-numeric caracters from the zip_code argument
+      # and limit it to 8 caracters
+      def parse_zip_code(zip_code)
+        return zip_code.to_s.gsub(/([^0-9]+)/,"")[0...8]
+      end
     end
 
-    def self.get(*args)
-      self.new(*args)
+    def initialize(token)
+      @token = token
     end
 
-    private
-    #
-    # Define placeholder methods for the address attributes
-    # in portuguese
-    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)
+    def get_address(zip_code)
+      uri = URI(BASE_URL % [self.token, CepFacil::API.parse_zip_code(zip_code)])
+      content = Net::HTTP.get(uri)
+
+      result = JSON.parse content
+
+      address = CepFacil::Address.new(
+        result["CEP"], result["LogradouroTipo"],
+        result["Cidade"], result["UF"], result["Bairro"], result["Logradouro"])
     end
 
-    alias :address :full_format
   end
 end

data/lib/cep_facil/version.rb

@@ -1,3 +1,3 @@
 module CepFacil
-  VERSION = "1.0.4" #:nodoc:
-end
+  VERSION = "2.0.0" #:nodoc:
+end

data/spec/cep_facil_spec.rb

@@ -4,65 +4,74 @@ require File.expand_path('spec/spec_helper')
 describe CepFacil do
   before(:each) do
     @token = "0E2ACA03-FC7F-4E87-9046-A8C46637BA9D"
+    @conn = CepFacil::API.new @token
   end
 
   it "has a version" do
     CepFacil::VERSION.should =~ /^\d+\.\d+\.\d+$/
   end
 
+  it "can authenticate" do
+    @conn.should_not be_nil
+  end
+
   it "can fetch an address from a CEP" do
-    cep = "53417-540"
+    cep = "53416-540"
 
-    address = CepFacil::API.new(cep, @token)
+    address = @conn.get_address(cep)
     address.should_not be_nil
 
-    address.type.should eql("Rua")
-    address.city.should eql("Paulista")
+    address.type.should eql("RUA")
+    address.city.should eql("PAULISTA")
   end
 
   it "works with non formatted zip codes (CEPs)" do
-    cep = "53417540"
-    address = CepFacil::API.new(cep, @token)
+    cep = "53416540"
+    address = @conn.get_address(cep)
     address.should_not be_nil
   end
 
   it "works even with zip codes (CEPs) stored as integers" do
     cep = 53417540
-    address = CepFacil::API.new(cep, @token)
+    address = @conn.get_address(cep)
     address.should_not be_nil
   end
 
   it "can get all 6 attributes (cep, type, state, city, neighborhood, street) from a given CEP" do
     cep = "52060-010"
-    address = CepFacil::API.new(cep, @token)
+    address = @conn.get_address(cep)
 
-    address.cep.should eql("52060010")
-    address.type.should eql("Rua")
+    address.zip_code.should eql("52060010")
+    address.type.should eql("RUA")
     address.state.should eql("PE")
-    address.city.should eql("Recife")
-    address.neighborhood.should eql("Parnamirim")
-    address.street.should include("Tude de Melo")
+    address.city.should eql("RECIFE")
+    address.neighborhood.should eql("PARNAMIRIM")
+    address.street.should include("JOÃO TUDE DE MELO")
   end
 
   it "can return a string with the full address" do
     cep = "53417-540"
 
-    address = CepFacil::API.new(cep, @token)
-
+    address = @conn.get_address(cep)
     full_version = address.full_format
 
     full_version.should_not be_nil
-    full_version.should eql("Rua Panelas, Paulista - PE, Brasil")
   end
 
   it "handles correct encoding" do
     cep = "79005-340"
 
-    address = CepFacil::API.new(cep, @token)
+    address = @conn.get_address(cep)
 
-    address.neighborhood.should eql("Amambaí")
-    address.street.should eql("Coronel Camisão")
+    address.neighborhood.should eql("AMAMBAÍ")
+    address.street.should eql("CORONEL CAMISÃO")
   end
 
-end
+  it "can tell if a address is valid" do
+    cep = "79005-340"
+
+    address = @conn.get_address(cep)
+    address.valid?.should be_true
+  end
 
+end

metadata

@@ -1,48 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: cep_facil
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
-- Rodrigo Alves Vieira
+- Rodrigo Alves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.13.0
 description: Wrapper Ruby para o serviço cepfacil.com.br
 email:
 - rodrigovieira1994@gmail.com
@@ -61,28 +70,32 @@ files:
 - spec/cep_facil_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/rodrigoalvesvieira/cep_facil
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --title
+- Wrapper Ruby para a API do CepFacil
+- --main
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: cep_facil
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wrapper para o serviço cepfacil.com.br
 test_files:
 - spec/cep_facil_spec.rb