correios-cep 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4205b263bcf608493677f1f0f6ce7a9cbf4fea6
-  data.tar.gz: b39d686fef4ff806416993478d88885a05fe694a
+  metadata.gz: 37ca8dbe26d97bd4264d9c02a66ba229d7014d92
+  data.tar.gz: c92f319267e2fb49a431c110753ce6c6206022bf
 SHA512:
-  metadata.gz: 102b1121be45c66e6963b59ab0490cefd5a7431c8509f98f9285cfc34cee7db68b49dee7efa15c97dfa4a855dc5919da27c9b4be21f00bc6dccc59f382f18f46
-  data.tar.gz: c9ea444975185a81518c5a71b5fcfd787d6c6c53d69c13645482e45c34aa2c4eb036d490d9ae940fef9996ff960b26af4276b5439ff34e6024c98de0cbe65812
+  metadata.gz: c620b2d30da1e0f7485f68300c1e115cf22bccb19fa917c4af9be36a21bee09a5849bdf93ca02926a7093c8539d2841fc81287eb90c59032375d54d6691a3b4f
+  data.tar.gz: 7376ae683db061ed2b5070e056c686f98e191911d6cedb2670e9fa561319a54d5637db32044eb9b47f4a398a45112ddfa4b00c789cfac57cb250e3eda35443fe

data/.travis.yml

@@ -3,6 +3,6 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.5
-  - 2.2.2
+  - 2.1.7
+  - 2.2.3
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## Version 0.5.0
+- Fix: Handle errors returned from Correios web service. [Issue #10](https://github.com/prodis/correios-cep/issues/10)
+- Improvent: Zipcode input validation.
+
 ## Version 0.4.0
-- Improvement: Replace Nokogiri by Ox. Issue #3.
+- Improvement: Replace Nokogiri by Ox. [Issue #3](https://github.com/prodis/correios-cep/issues/3).
 
 ## Version 0.3.3
 - Fix: Downgrade LogMe gem version to 0.0.8, because 0.0.9 does not support Ruby 1.9.2.
@@ -27,7 +31,7 @@
 - Improvement: Update LogMe gem to version 0.0.5 with support to log messages label.
 
 ## Version 0.1.1
-- New: A "get" class method in AddressFinder class.
+- New: A `get` class method in `AddressFinder` class.
 
 ## Version 0.1.0
 - First working version.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 Fernando Hamasaki de Amorim
+
+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.md

@@ -2,7 +2,7 @@
 
 Current available solutions to find Brazilian addresses by zipcode use an HTML form from Correios web site to perform it, instead of to use a real API.
 
-This works with an HTTP request to the form, followed by parsing the HTML result page. The huge problem here is when the Correios web site development team decides to modify some HTML element in the result page, even a layout update, it will break the parser logic for result.
+The old solution works with an HTTP request to the form, followed by parsing the HTML result page. The huge problem here is when the Correios web site development team decides to modify some HTML element in the result page, even a layout update, it will break the parser logic for result.
 
 Correios CEP gem solves this problem, getting data directly from Correios database.
 
@@ -132,9 +132,16 @@ To disable the log and configure other log output, use **Correios::CEP** module:
   end
 ```
 
+## Changelog
+
+[See the changes in each version.](CHANGELOG.md)
+
+
 ## Author
 - [Fernando Hamasaki de Amorim (prodis)](http://prodis.blog.br)
 
+![Prodis Logo](http://prodis.net.br/images/prodis_150.gif)
+
 
 ## Contributing to correios-cep
 
@@ -146,34 +153,3 @@ To disable the log and configure other log output, use **Correios::CEP** module:
 - Don't forget to rebase with branch master in main project before submit the pull request.
 - Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 - Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-
-## Copyright
-
-(The MIT License)
-
-[Prodis a.k.a. Fernando Hamasaki de Amorim](http://prodis.blog.br)
-
-![Prodis Logo](http://prodis.net.br/images/prodis_150.gif)
-
-Copyright © 2014-2015 Prodis
-
-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/correios-cep.gemspec

@@ -1,32 +1,32 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'correios/cep/version'
+require "correios/cep/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'correios-cep'
+  spec.name          = "correios-cep"
   spec.version       = Correios::CEP::VERSION
-  spec.authors       = ['Prodis a.k.a. Fernando Hamasaki de Amorim']
-  spec.email         = ['prodis@gmail.com']
+  spec.authors       = ["Prodis a.k.a. Fernando Hamasaki de Amorim"]
+  spec.email         = ["prodis@gmail.com"]
   spec.description   = %q{Correios CEP gem gets updated Brazilian address from a zipcode, directly from Correios database. No HTML parsers.}
   spec.summary       = spec.description
-  spec.homepage      = 'http://prodis.blog.br/correios-cep-gem-para-consulta-de-enderecos-por-cep'
-  spec.license       = 'MIT'
+  spec.homepage      = "http://prodis.blog.br/correios-cep-gem-para-consulta-de-enderecos-por-cep"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
 
-  spec.add_dependency 'log-me',   '= 0.0.8'
-  spec.add_dependency "ox", "~> 2.2"
+  spec.add_dependency "log-me",   "= 0.0.8"
+  spec.add_dependency "ox",       "~> 2.2"
 
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec",   "~> 3.2"
-  spec.add_development_dependency "vcr",     "~> 2.9"
-  spec.add_development_dependency "webmock", "~> 1.15"
+  spec.add_development_dependency "coveralls", "~> 0.8.3"
+  spec.add_development_dependency "pry",       "~> 0.10.3"
+  spec.add_development_dependency "rake",      "~> 10.4", ">= 10.4.2"
+  spec.add_development_dependency "rspec",     "~> 3.2"
+  spec.add_development_dependency "vcr",       "~> 2.9"
+  spec.add_development_dependency "webmock",   "~> 1.15"
 end

data/lib/correios/cep/address_finder.rb

@@ -2,6 +2,7 @@ module Correios
   module CEP
     class AddressFinder
       def get(zipcode)
+        validate(zipcode)
         response = web_service.request(zipcode)
         parser.address(response)
       end
@@ -19,6 +20,14 @@ module Correios
       def parser
         @parser ||= Correios::CEP::Parser.new
       end
+
+      private
+
+      def validate(zipcode)
+        if zipcode.to_s.strip.empty? || !zipcode.to_s.match(/\A\d{5}-?\d{3}\z/)
+          raise ArgumentError.new("invalid cep format")
+        end
+      end
     end
   end
 end

data/lib/correios/cep/parser.rb

@@ -15,8 +15,9 @@ module Correios
 
       def address(xml)
         doc = Ox.parse(xml)
+
         return_node = find_node(doc.nodes, 'return')
-        return if return_node.nil?
+        return {} if return_node.nil?
 
         address = {}
         return_node.nodes.each do |element|
@@ -30,7 +31,8 @@ module Correios
       private
 
       def find_node(nodes, name)
-        node = nodes.first
+        node = nodes.last
+        return nil unless node.is_a?(Ox::Element)
         return node if node.nil? || node.name == name
 
         find_node(node.nodes, name)

data/lib/correios/cep/version.rb

@@ -1,5 +1,5 @@
 module Correios
   module CEP
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/spec/correios/cep/address_finder_spec.rb

@@ -1,24 +1,36 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Correios::CEP::AddressFinder do
-  let(:cep) { '54250610' }
-  let(:web_service_response) { '<end>Rua Fernando Amorim</end>' }
-  let(:address) { { address: 'Rua Fernando Amorim' } }
+  context "with invalid cep" do
+    it "should raise ArgumentError when cep is nil" do
+      expect{ subject.get(nil) }.to raise_error(ArgumentError)
+    end
 
-  before do
-    allow_any_instance_of(Correios::CEP::WebService).to receive(:request).with(cep).and_return(web_service_response)
-    allow_any_instance_of(Correios::CEP::Parser).to receive(:address).with(web_service_response).and_return(address)
+    it "should raise ArgumentError when cep does not have a valid format" do
+      expect{ subject.get("542506-10") }.to raise_error(ArgumentError)
+    end
   end
 
-  describe '#get' do
-    it 'returns address' do
-      expect(subject.get(cep)).to eql address
+  context "with valid cep" do
+    let(:cep) { '54250610' }
+    let(:web_service_response) { "<end>Rua Fernando Amorim</end>" }
+    let(:address) { { address: "Rua Fernando Amorim" } }
+
+    before do
+      allow_any_instance_of(Correios::CEP::WebService).to receive(:request).with(cep){ web_service_response }
+      allow_any_instance_of(Correios::CEP::Parser).to receive(:address).with(web_service_response){ address }
+    end
+
+    describe "#get" do
+      it "returns address" do
+        expect(subject.get(cep)).to eql address
+      end
     end
-  end
 
-  describe '.get' do
-    it 'returns address' do
-      expect(Correios::CEP::AddressFinder.get(cep)).to eql address
+    describe ".get" do
+      it "returns address" do
+        expect(Correios::CEP::AddressFinder.get(cep)).to eql address
+      end
     end
   end
 end

data/spec/correios/cep/parser_spec.rb

@@ -2,20 +2,20 @@
 require 'spec_helper'
 
 describe Correios::CEP::Parser do
-  describe '#address' do
+  describe "#address" do
     let(:expected_address) do
       {
-        address: 'Rua Fernando Amorim',
-        neighborhood: 'Cavaleiro',
-        city: 'Jaboatão dos Guararapes',
-        state: 'PE',
-        zipcode: '54250610',
-        complement: ''
+        address: "Rua Fernando Amorim",
+        neighborhood: "Cavaleiro",
+        city: "Jaboatão dos Guararapes",
+        state: "PE",
+        zipcode: "54250610",
+        complement: ""
       }
     end
 
-    context 'when address is found' do
-      context 'and does not have complement' do
+    context "when address is found" do
+      context "and does not have complement" do
         let(:xml) do
           "<?xml version='1.0' encoding='UTF-8'?>" +
           "<S:Envelope>" +
@@ -36,7 +36,7 @@ describe Correios::CEP::Parser do
           "</S:Envelope>"
         end
 
-        it 'returns address' do
+        it "returns address" do
           expect(subject.address(xml)).to eq expected_address
         end
       end
@@ -62,8 +62,8 @@ describe Correios::CEP::Parser do
           "</S:Envelope>"
         end
 
-        it 'returns address' do
-          expected_address[:complement] = 'de 1500 até o fim'
+        it "returns address" do
+          expected_address[:complement] = "de 1500 até o fim"
 
           expect(subject.address(xml)).to eq expected_address
         end
@@ -90,8 +90,8 @@ describe Correios::CEP::Parser do
           "</S:Envelope>"
         end
 
-        it 'returns address' do
-          expected_address[:complement] = 'de 1500 até o fim (zona mista)'
+        it "returns address" do
+          expected_address[:complement] = "de 1500 até o fim (zona mista)"
 
           expect(subject.address(xml)).to eq expected_address
         end
@@ -108,8 +108,8 @@ describe Correios::CEP::Parser do
         "</S:Envelope>"
       end
 
-      it 'returns nil' do
-        expect(subject.address(xml)).to be_nil
+      it "returns empty hash" do
+        expect(subject.address(xml)).to eq({})
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correios-cep
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log-me
@@ -42,44 +42,50 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -135,6 +141,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - correios-cep.gemspec
@@ -171,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Correios CEP gem gets updated Brazilian address from a zipcode, directly