correios-cep 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c30bf76d1f538f6c48b3a60c2deafe507f9da4e
-  data.tar.gz: b438b0368fe598cc6d907a77adb6945c0cf6d020
+  metadata.gz: 4abeb1ebfdf342e8d2db3a0b3f00d38ed97a7735
+  data.tar.gz: 5e76ec6601bb51ee8098f107157e3f734b08d898
 SHA512:
-  metadata.gz: 7b861ffdcadebf2a888704bb63c4cbdfd1f260a011e2033bb869cfb4969c164ad5baa09d6af963cc9463b26fd1701f1fe51c789b307783086910826721466a5b
-  data.tar.gz: d9fd58a084209f4cb46e3bc1952869a3d9988a5bc27cc22dfcac94027c30be7cfe26906485b18640b11d5ea245ae1eb6817ebae657ea6223a0586104588ee834
+  metadata.gz: '091945d26d6d64709d2cd1dd6f31b851f5daee2f35025cba1024c9d873e1cec85f1d1f40ba92bc7d8ec5b32a36a12af1c06d3fc9e71df286bbc5c8056b296dfb'
+  data.tar.gz: 720dc55e5e7bab49f76f49c51a17d408c044c13090deb5188dd8e0cacae9fe4e2a8b224a6ef1b79876bd43a693b0cd72b7b577fda36f523b5532405790e76cc8

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 | Version | Changes                                                                                                                                    |
 | ------- | -------                                                                                                                                    |
+| 0.6.3   | Improve performance regarding strings.                                                                                                     |
 | 0.6.2   | Update Ox gem to version `2.4`. [PR #14](https://github.com/prodis/correios-cep/pull/14)                                                   |
 | 0.6.1   | Update LogMe gem to version `0.0.10`.                                                                                                      |
 | 0.6.0   | Minimal required Ruby version from now is 2.0.0.                                                                                           |

data/README.md

@@ -1,10 +1,10 @@
 # Correios CEP
 
-Current available solutions to find Brazilian addresses by zipcode use an HTML form from [Correios web site](http://correios.com.br) to perform it, instead of to use a real API.
+Current available solutions to find Brazilian addresses by zipcode use an HTML form from [Correios web site](http://correios.com.br) website to perform it, instead of to use a real API.
 
-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.
+The old solution works with an HTTP request to the form, followed by parsing 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.
+Correios CEP gem solves this problem, retrieving data directly from Correios database.
 
 ![Correios Logo](http://prodis.net.br/images/ruby/2015/correios_logo.png)
 
@@ -148,7 +148,7 @@ end
 ### Contributors
 - [Gabriel Givigier Guimarães (givigier)](https://github.com/givigier)
 - [Maury M. Marques (maurymmarques)](https://github.com/maurymmarques)
-- [Rafael Garcia](https://github.com/rafbgarcia)
+- [Rafael Garcia (rafbgarcia)](https://github.com/rafbgarcia)
 
 
 ## Contributing to correios-cep

data/correios-cep.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'correios/cep/version'
@@ -7,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Correios::CEP::VERSION
   spec.author        = 'Prodis a.k.a. Fernando Hamasaki de Amorim'
   spec.email         = 'prodis@gmail.com'
-  spec.summary       = 'Correios CEP gem gets updated Brazilian address from a zipcode, directly from Correios database. No HTML parsers.'
+  spec.summary       = 'Correios CEP gem finds updated Brazilian addresses by zipcode, directly from Correios database. No HTML parsers.'
   spec.description   = spec.summary
-  spec.homepage      = 'http://prodis.blog.br/correios-cep-gem-para-consulta-de-enderecos-por-cep'
+  spec.homepage      = 'https://github.com/prodis/correios-cep'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)

data/lib/correios/cep/address_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Correios
   module CEP
     class AddressFinder

data/lib/correios/cep/config.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
 module Correios
   module CEP
     module Config
-      DEFAULT_REQUEST_TIMEOUT = 5 #seconds
-      attr_writer :proxy_url, :request_timeout
+      WEB_SERVICE_URL = 'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente'
+      DEFAULT_REQUEST_TIMEOUT = 5 # seconds
+
+      attr_writer :web_service_url, :proxy_url, :request_timeout
+
+      def web_service_url
+        @web_service_url ||= WEB_SERVICE_URL
+      end
 
       def proxy_url
         @proxy_url ||= ''

data/lib/correios/cep/parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ox'
 
 module Correios

data/lib/correios/cep/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Correios
   module CEP
-    VERSION = '0.6.2'
+    VERSION = '0.6.3'
   end
 end

data/lib/correios/cep/web_service.rb

@@ -1,13 +1,24 @@
+# frozen_string_literal: true
 require 'net/https'
 require 'uri'
 
 module Correios
   module CEP
     class WebService
-      URL = 'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente'
+      CONTENT_TYPE_HEADER = 'text/xml; charset=utf-8'
+      BODY_TEMPLATE = '<?xml version="1.0" encoding="UTF-8"?>' \
+                      '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"' \
+                      ' xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">' \
+                         '<soapenv:Header />' \
+                         '<soapenv:Body>' \
+                            '<cli:consultaCEP>' \
+                              '<cep>%{zipcode}</cep>' \
+                            '</cli:consultaCEP>' \
+                         '</soapenv:Body>' \
+                      '</soapenv:Envelope>'
 
       def initialize
-        @uri = URI.parse(URL)
+        @uri = URI.parse(Correios::CEP.web_service_url)
         @proxy_uri = URI.parse(Correios::CEP.proxy_url)
       end
 
@@ -46,22 +57,10 @@ module Correios
 
       def build_request(zipcode)
         request = Net::HTTP::Post.new(uri.path)
-        request['Content-Type'] = 'text/xml; charset=utf-8'
-        request.body = request_body(zipcode)
+        request['Content-Type'] = CONTENT_TYPE_HEADER
+        request.body = BODY_TEMPLATE % { zipcode: zipcode }
         request
       end
-
-      def request_body(zipcode)
-        '<?xml version="1.0" encoding="UTF-8"?>' +
-        '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">' +
-           '<soapenv:Header />' +
-           '<soapenv:Body>' +
-              '<cli:consultaCEP>' +
-                "<cep>#{zipcode}</cep>" +
-              '</cli:consultaCEP>' +
-           '</soapenv:Body>' +
-        '</soapenv:Envelope>'
-      end
     end
   end
 end

data/lib/correios/cep.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'log-me'
 
 module Correios

data/lib/correios-cep.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'correios/cep/config'
 require 'correios/cep/address_finder'
 require 'correios/cep/parser'

data/spec/correios/cep/address_finder_spec.rb

@@ -1,5 +1,4 @@
-require 'spec_helper'
-
+# frozen_string_literal: true
 describe Correios::CEP::AddressFinder do
   context 'when zipcode is valid' do
     let(:cep) { '54250610' }

data/spec/correios/cep/parser_spec.rb

@@ -1,6 +1,5 @@
+# frozen_string_literal: true
 # encoding: UTF-8
-require 'spec_helper'
-
 describe Correios::CEP::Parser do
   describe '#address' do
     let(:expected_address) do
@@ -17,21 +16,21 @@ describe Correios::CEP::Parser do
     context 'when address is found' do
       context 'and does not have complement' do
         let(:xml) do
-          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' +
-            '<soap:Body>' +
-              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' +
-                '<return>' +
-                  '<bairro>Cavaleiro</bairro>' +
-                  '<cep>54250610</cep>' +
-                  '<cidade>Jaboatão dos Guararapes</cidade>' +
-                  '<complemento></complemento>' +
-                  '<complemento2></complemento2>' +
-                  '<end>Rua Fernando Amorim</end>' +
-                  '<id>0</id>' +
-                  '<uf>PE</uf>' +
-                '</return>' +
-              '</ns2:consultaCEPResponse>' +
-            '</soap:Body>' +
+          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' \
+            '<soap:Body>' \
+              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' \
+                '<return>' \
+                  '<bairro>Cavaleiro</bairro>' \
+                  '<cep>54250610</cep>' \
+                  '<cidade>Jaboatão dos Guararapes</cidade>' \
+                  '<complemento></complemento>' \
+                  '<complemento2></complemento2>' \
+                  '<end>Rua Fernando Amorim</end>' \
+                  '<id>0</id>' \
+                  '<uf>PE</uf>' \
+                '</return>' \
+              '</ns2:consultaCEPResponse>' \
+            '</soap:Body>' \
           '</soap:Envelope>'
         end
 
@@ -42,21 +41,21 @@ describe Correios::CEP::Parser do
 
       context 'and has one complement' do
         let(:xml) do
-          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' +
-            '<soap:Body>' +
-              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' +
-                '<return>' +
-                  '<bairro>Cavaleiro</bairro>' +
-                  '<cep>54250610</cep>' +
-                  '<cidade>Jaboatão dos Guararapes</cidade>' +
-                  '<complemento>de 1500 até o fim</complemento>' +
-                  '<complemento2></complemento2>' +
-                  '<end>Rua Fernando Amorim</end>' +
-                  '<id>0</id>' +
-                  '<uf>PE</uf>' +
-                '</return>' +
-              '</ns2:consultaCEPResponse>' +
-            '</soap:Body>' +
+          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' \
+            '<soap:Body>' \
+              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' \
+                '<return>' \
+                  '<bairro>Cavaleiro</bairro>' \
+                  '<cep>54250610</cep>' \
+                  '<cidade>Jaboatão dos Guararapes</cidade>' \
+                  '<complemento>de 1500 até o fim</complemento>' \
+                  '<complemento2></complemento2>' \
+                  '<end>Rua Fernando Amorim</end>' \
+                  '<id>0</id>' \
+                  '<uf>PE</uf>' \
+                '</return>' \
+              '</ns2:consultaCEPResponse>' \
+            '</soap:Body>' \
           '</soap:Envelope>'
         end
 
@@ -69,21 +68,21 @@ describe Correios::CEP::Parser do
 
       context 'and has two complements' do
         let(:xml) do
-          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' +
-            '<soap:Body>' +
-              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' +
-                '<return>' +
-                  '<bairro>Cavaleiro</bairro>' +
-                  '<cep>54250610</cep>' +
-                  '<cidade>Jaboatão dos Guararapes</cidade>' +
-                  '<complemento>de 1500 até o fim</complemento>' +
-                  '<complemento2>(zona mista)</complemento2>' +
-                  '<end>Rua Fernando Amorim</end>' +
-                  '<id>0</id>' +
-                  '<uf>PE</uf>' +
-                '</return>' +
-              '</ns2:consultaCEPResponse>' +
-            '</soap:Body>' +
+          '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' \
+            '<soap:Body>' \
+              '<ns2:consultaCEPResponse xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">' \
+                '<return>' \
+                  '<bairro>Cavaleiro</bairro>' \
+                  '<cep>54250610</cep>' \
+                  '<cidade>Jaboatão dos Guararapes</cidade>' \
+                  '<complemento>de 1500 até o fim</complemento>' \
+                  '<complemento2>(zona mista)</complemento2>' \
+                  '<end>Rua Fernando Amorim</end>' \
+                  '<id>0</id>' \
+                  '<uf>PE</uf>' \
+                '</return>' \
+              '</ns2:consultaCEPResponse>' \
+            '</soap:Body>' \
           '</soap:Envelope>'
         end
 
@@ -97,16 +96,16 @@ describe Correios::CEP::Parser do
 
     context 'when address is not found' do
       let(:xml) do
-        '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' +
-          '<soap:Body>' +
-            '<soap:Fault>' +
-              '<faultcode>soap:Server</faultcode>' +
-              '<faultstring>CEP NAO ENCONTRADO</faultstring>' +
-              '<detail>' +
-                '<ns2:SigepClienteException xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">CEP NAO ENCONTRADO</ns2:SigepClienteException>' +
-              '</detail>' +
-            '</soap:Fault>' +
-          '</soap:Body>' +
+        '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">' \
+          '<soap:Body>' \
+            '<soap:Fault>' \
+              '<faultcode>soap:Server</faultcode>' \
+              '<faultstring>CEP NAO ENCONTRADO</faultstring>' \
+              '<detail>' \
+                '<ns2:SigepClienteException xmlns:ns2="http://cliente.bean.master.sigep.bsb.correios.com.br/">CEP NAO ENCONTRADO</ns2:SigepClienteException>' \
+              '</detail>' \
+            '</soap:Fault>' \
+          '</soap:Body>' \
         '</soap:Envelope>'
       end
 

data/spec/correios/cep/web_service_spec.rb

@@ -1,5 +1,4 @@
-require 'spec_helper'
-
+# frozen_string_literal: true
 describe Correios::CEP::WebService do
   let(:cep) { '54250610' }
 

data/spec/correios/cep_spec.rb

@@ -1,33 +1,59 @@
-require 'spec_helper'
-
+# frozen_string_literal: true
 describe Correios::CEP do
+  describe '#web_service_url' do
+    it 'default is Correios::CEP::Config::WEB_SERVICE_URL' do
+      expect(Correios::CEP.web_service_url).to eq Correios::CEP::Config::WEB_SERVICE_URL
+    end
+
+    context 'when set web service URL' do
+      let(:url) { 'http://ws.correios.com.br/cep' }
+
+      around do |example|
+        Correios::CEP.web_service_url = url
+        example.run
+        Correios::CEP.web_service_url = Correios::CEP::Config::WEB_SERVICE_URL
+      end
+
+      it 'returns the given web service URL' do
+        expect(Correios::CEP.web_service_url).to eq url
+      end
+    end
+  end
+
   describe '#proxy_url' do
     it 'default is empty' do
-      expect(Correios::CEP.proxy_url).to eql ''
+      expect(Correios::CEP.proxy_url).to eq ''
     end
 
     context 'when set proxy URL' do
-      it 'returns proxy URL' do
-        Correios::CEP.configure { |config| config.proxy_url = 'http://10.20.30.40:8888' }
-        expect(Correios::CEP.proxy_url).to eql 'http://10.20.30.40:8888'
+      let(:url) { 'http://10.20.30.40:8888' }
+
+      around do |example|
+        Correios::CEP.proxy_url = url
+        example.run
+        Correios::CEP.proxy_url = ''
+      end
+
+      it 'returns the given proxy URL' do
+        expect(Correios::CEP.proxy_url).to eq url
       end
     end
   end
 
   describe "#request_timeout" do
     it "default is 5" do
-      expect(Correios::CEP.request_timeout).to eql 5
+      expect(Correios::CEP.request_timeout).to eq 5
     end
 
     context "when set timeout" do
       it "returns timeout" do
-        Correios::CEP.configure { |config| config.request_timeout = 3 }
-        expect(Correios::CEP.request_timeout).to eql 3
+        Correios::CEP.request_timeout = 3
+        expect(Correios::CEP.request_timeout).to eq 3
       end
 
       it "returns timeout in seconds (integer)" do
-        Correios::CEP.configure { |config| config.request_timeout = 2.123 }
-        expect(Correios::CEP.request_timeout).to eql 2
+        Correios::CEP.request_timeout = 2.123
+        expect(Correios::CEP.request_timeout).to eq 2
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'correios-cep'
 require 'coveralls'
 require 'vcr'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correios-cep
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-18 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log-me
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Correios CEP gem gets updated Brazilian address from a zipcode, directly
+description: Correios CEP gem finds updated Brazilian addresses by zipcode, directly
   from Correios database. No HTML parsers.
 email: prodis@gmail.com
 executables:
@@ -153,7 +153,7 @@ files:
 - spec/correios/cep_spec.rb
 - spec/fixtures/cassettes/correios_consulta_cep_ok.yml
 - spec/spec_helper.rb
-homepage: http://prodis.blog.br/correios-cep-gem-para-consulta-de-enderecos-por-cep
+homepage: https://github.com/prodis/correios-cep
 licenses:
 - MIT
 metadata: {}
@@ -176,8 +176,8 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Correios CEP gem gets updated Brazilian address from a zipcode, directly
-  from Correios database. No HTML parsers.
+summary: Correios CEP gem finds updated Brazilian addresses by zipcode, directly from
+  Correios database. No HTML parsers.
 test_files:
 - spec/correios/cep/address_finder_spec.rb
 - spec/correios/cep/parser_spec.rb