correios-sro-xml 0.3.1 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2JmMGZiNTEwNDNkZDgwODhmMjhlY2QzNGE5YmFkNjVjOTg2YjU1NQ==
-  data.tar.gz: !binary |-
-    OTczMTMwMmNmNTlkOTc5OTc4NmJkNDM0Y2NjYTQ5MTEyMzFlZDI2YQ==
+SHA1:
+  metadata.gz: 8b4c3bd92172a23de831757bd0baa3c424c739b5
+  data.tar.gz: 3465ad05393df1da106d1298c5e574ee65bcb24d
 SHA512:
-  metadata.gz: !binary |-
-    ZTQ3NTQ5NjE4OTdjYjIzYWE0M2IwNWQxZDZiMjQwYmJhYTI4NjQ0YzcwYTBh
-    ZjkwMjE1ZTg1ZWIyY2MwMWUzZGVkZWU2NWJlNjg3NmQyNjc1Y2FiMGE5MjY0
-    ZTBmOWQxOGE1NGU3N2RhMWMxMWE0ZWM4ZjJhZTVmZDU3NDgxOGQ=
-  data.tar.gz: !binary |-
-    NmNiNzhjMTYzOTVkYTE0ZjRiZDE5MWEzNjk5ZGUzZDIwM2U5NThjNzFmMDgy
-    ZDdhMzcxNzNkMjM5NDA0ZmUwNDkzODg5ZjgyOTM2ZWU1NjBkN2RhODEwNmI2
-    N2E3ODcwYzYzMzI1MGU5YjdiMWZiYjEyMGEwNjljMzNkOWJhZTA=
+  metadata.gz: d54c42ad7a14b7234206400cf71afa834b4d5b95ef40771d3f35d5b2345bdcae84ad1560bb1376dd027b906024746a4370a3147e8049acc65a64d7530365d356
+  data.tar.gz: ba68368e66770f980916f5e07c0e4663b96c9059843a7be983d2fd84df79d5d09f45360be8c1abdc1d5ade86f2aee86fbc6c3f1cfbcb6122519710e1da3d073b

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
+
+before_install:
+  - gem install bundler
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.5
   - 2.2.3
+
 script: bundle exec rspec

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== Version 0.4.0
+- Fix: {Using new Correios endpoint #5}[https://github.com/prodis/correios-sro-xml/pull/5]
+
 == Version 0.3.1
 - Improvement: Update LogMe gem to version 0.0.10.
 

data/README.rdoc

@@ -163,6 +163,7 @@ You can disable the log and configure other log output.
 - {Fernando Hamasaki de Amorim (prodis)}[http://prodis.blog.br]
 
 == Collaborators
+- {Lennon Manchester (lemanchester)}[https://github.com/lemanchester]
 - {Thiago Ganzarolli (tganzarolli)}[https://github.com/tganzarolli]
 
 == Contributing to correios-sro-xml

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'correios-sro-xml'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/correios-sro-xml.rb

@@ -7,3 +7,4 @@ require 'correios/sro/object'
 require 'correios/sro/parser'
 require 'correios/sro/tracker'
 require 'correios/sro/web_service'
+require 'correios/sro/request_builder'

data/lib/correios/sro/object.rb

@@ -6,7 +6,13 @@ module Correios
       include SAXMachine
 
       element  :numero, :as => :number
+      element  :erro,   :as => :error
       elements :evento, :as => :events, :class => Correios::SRO::Event
+
+      def has_error?
+        error != nil
+      end
+
     end
   end
 end

data/lib/correios/sro/parser.rb

@@ -5,11 +5,10 @@ module Correios
     class Parser
       def objects(xml)
         objects = {}
-        xml.encode!("UTF-8", "ISO-8859-1")
 
-        doc = Nokogiri::XML(xml)
-        doc.xpath("//objeto").each do |element|
+        Nokogiri::XML(xml).xpath("//objeto").each do |element|
           object = Correios::SRO::Object.parse(element.to_xml)
+          return objects if object.has_error?
           objects[object.number] = object
         end
 

data/lib/correios/sro/request_builder.rb

@@ -0,0 +1,55 @@
+module Correios
+  module SRO
+    class RequestBuilder
+
+      QUERY_TYPES =  { list: "L", range: "F" }.freeze
+
+      RESULT_MODES = { all:  "T", last:  "U" }.freeze
+
+      LANGUAGE = { pt:  "101", en:  "102" }.freeze
+
+      NAMESPACES = {
+        "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+        "xmlns:res" => "http://resource.webservice.correios.com.br/"
+      }.freeze
+
+      def initialize(tracker)
+        @tracker = tracker
+      end
+
+      def build_xml
+        Nokogiri::XML::Builder.new do |builder|
+          builder[:soapenv].Envelope(NAMESPACES) {
+            builder[:soapenv].Header  { }
+            builder[:soapenv].Body  {
+              builder[:res].buscaEventosLista() {
+                builder.usuario(@tracker.user) {
+                  builder.parent.namespace = nil
+                }
+                builder.senha(@tracker.password) {
+                  builder.parent.namespace = nil
+                }
+                builder.tipo(QUERY_TYPES[@tracker.query_type]) {
+                  builder.parent.namespace = nil
+                }
+                builder.resultado(RESULT_MODES[@tracker.result_mode]) {
+                  builder.parent.namespace = nil
+                }
+                builder.lingua(LANGUAGE[@tracker.language]) {
+                  builder.parent.namespace = nil
+                }
+                @tracker.object_numbers.each do |object_number|
+                  builder.objetos(object_number) {
+                    builder.parent.namespace = nil
+                  }
+                end
+              }
+            }
+          }
+        end.to_xml
+      end
+
+
+    end
+  end
+end

data/lib/correios/sro/tracker.rb

@@ -1,11 +1,11 @@
 module Correios
   module SRO
     class Tracker
-      attr_accessor :user, :password
-      attr_accessor :query_type, :result_mode
+
+      attr_accessor :user, :password, :query_type, :result_mode, :language
       attr_reader :object_numbers
 
-      DEFAULT_OPTIONS = { query_type: :list, result_mode: :last }.freeze
+      DEFAULT_OPTIONS = { query_type: :list, result_mode: :last, language: :pt }.freeze
 
       def initialize(options = {})
         DEFAULT_OPTIONS.merge(options).each do |attr, value|

data/lib/correios/sro/version.rb

@@ -1,5 +1,5 @@
 module Correios
   module SRO
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/correios/sro/web_service.rb

@@ -4,9 +4,7 @@ require 'uri'
 module Correios
   module SRO
     class WebService
-      URL = "http://websro.correios.com.br/sro_bin/sroii_xml.eventos"
-      QUERY_TYPES =  { list: "L", range: "F" }
-      RESULT_MODES = { all:  "T", last:  "U" }
+      URL = "http://webservice.correios.com.br:80/service/rastro"
 
       def initialize(tracker)
         @uri = URI.parse(URL)
@@ -20,9 +18,10 @@ module Correios
         Correios::SRO.log_request request, @uri.to_s
 
         response = http.request(request)
+
         Correios::SRO.log_response response
 
-        response.body
+        response.body.force_encoding('utf-8')
       end
 
       private
@@ -35,18 +34,14 @@ module Correios
 
       def build_request
         request = Net::HTTP::Post.new(@uri.path)
-        request.set_form_data(request_params)
+        request.content_type = 'text/xml;charset=UTF-8'
+        request.add_field("Accept-Encoding", "UTF-8")
+        request.body = request_body
         request
       end
 
-      def request_params
-        {
-          Usuario: @tracker.user,
-          Senha: @tracker.password,
-          Tipo: QUERY_TYPES[@tracker.query_type],
-          Resultado: RESULT_MODES[@tracker.result_mode],
-          Objetos: @tracker.object_numbers.join
-        }
+      def request_body
+        RequestBuilder.new(@tracker).build_xml
       end
     end
   end

data/spec/correios/sro/parser_spec.rb

@@ -4,11 +4,6 @@ describe Correios::SRO::Parser do
   describe "#objects" do
     let(:xml) { Fixture.load :sro_many_objects }
 
-    it "encodes from ISO-8859-1 to UTF-8" do
-      expect(xml).to receive(:encode!).with("UTF-8", "ISO-8859-1")
-      subject.objects(xml)
-    end
-
     ["SI047624825BR", "SX104110463BR"].each do |number|
       it "returns object number" do
         objects = subject.objects(xml)
@@ -22,11 +17,11 @@ describe Correios::SRO::Parser do
       { "SI047624825BR" => {
           type: "BDI",
           status: "01",
-          date: "26/12/2011",
+          date: "26/12/2016",
           hour: "15:22",
-          description: "Entregue",
-          receiver: "",
-          document: "",
+          description: "Objeto entregue ao destinatário",
+          receiver: "?",
+          document: "?",
           comment: "?",
           place: "AC CENTRAL DE SAO PAULO",
           code: "01009972",
@@ -37,15 +32,15 @@ describe Correios::SRO::Parser do
         "SX104110463BR" => {
           type: "BDE",
           status: "01",
-          date: "08/12/2011",
-          hour: "09:30",
-          description: "Entregue",
-          receiver: "",
-          document: "",
-          comment: "",
-          place: "CEE JUNDIAI",
-          code: "13211970",
-          city: "JUNDIAI",
+          date: "26/12/2016",
+          hour: "15:22",
+          description: "Objeto entregue ao destinatário",
+          receiver: nil,
+          document: nil,
+          comment: nil,
+          place: "AC CENTRAL DE SAO PAULO",
+          code: "01009972",
+          city: "SAO PAULO",
           state: "SP",
           sto: "74654209"
         },
@@ -65,7 +60,7 @@ describe Correios::SRO::Parser do
       { "SI047624825BR" => {
           place: "CTE VILA MARIA",
           code: "02170975",
-          city: "SAO PAULO",
+          city: "Sao Paulo",
           neighborhood: "PQ NOVO MUNDO",
           state: "SP"
         },

data/spec/correios/sro/tracker_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Correios::SRO::Tracker do
+
   describe ".new" do
     it "creates with default values" do
       expect(subject.query_type).to eql :list
@@ -58,7 +59,7 @@ describe Correios::SRO::Tracker do
     end
 
     let(:subject)  { Correios::SRO::Tracker.new(user: "PRODIS", password: "pim321") }
-    let(:response) { "" }
+
     before { Correios::SRO::WebService.any_instance.stub(:request!).and_return(response) }
 
     context "to many objects" do
@@ -84,10 +85,10 @@ describe Correios::SRO::Tracker do
         expect(objects.size).to eql 2
 
         expect(objects["SI047624825BR"].number).to eql "SI047624825BR"
-        expect(objects["SI047624825BR"].events.first.description).to eql "Entregue"
+        expect(objects["SI047624825BR"].events.first.description).to eql "Objeto entregue ao destinatário"
 
         expect(objects["SX104110463BR"].number).to eql "SX104110463BR"
-        expect(objects["SX104110463BR"].events.first.description).to eql "Entregue"
+        expect(objects["SX104110463BR"].events.first.description).to eql "Objeto entregue ao destinatário"
       end
 
       context "when only one object found" do
@@ -103,7 +104,7 @@ describe Correios::SRO::Tracker do
 
           expect(objects.size).to eql 1
           expect(objects["SI047624825BR"].number).to eql "SI047624825BR"
-          expect(objects["SI047624825BR"].events.first.description).to eql "Entregue"
+          expect(objects["SI047624825BR"].events.first.description).to eql "Objeto entregue ao destinatário"
         end
 
         it "returns nil in object not found" do
@@ -115,6 +116,7 @@ describe Correios::SRO::Tracker do
 
     context "to one object" do
       let(:response) { Fixture.load :sro_one_object }
+      let(:object_number) { "SI047624825BR" }
 
       it "sets object number" do
         subject.get("SI047624825BR")
@@ -125,7 +127,7 @@ describe Correios::SRO::Tracker do
       it "returns only one object" do
         object = subject.get("SI047624825BR")
         expect(object.number).to eql "SI047624825BR"
-        expect(object.events.first.description).to eql "Entregue"
+        expect(object.events.first.description).to eql "Objeto entregue ao destinatário"
       end
 
       context "when object not found" do

data/spec/correios/sro/web_service_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Correios::SRO::WebService do
   describe "#request" do
+    let(:object_number) { "SS123456789BR" }
+
     around do |example|
       Correios::SRO.configure { |config| config.log_enabled = false }
       example.run
@@ -10,13 +12,13 @@ describe Correios::SRO::WebService do
 
     let(:tracker) do
       sro = Correios::SRO::Tracker.new(user: "ECT", password: "SRO")
-      sro.instance_variable_set :@object_numbers, ["SS123456789BR"]
+      sro.instance_variable_set :@object_numbers, [object_number]
       sro
     end
     let(:subject) { Correios::SRO::WebService.new(tracker) }
 
     it "returns XML response", vcr: { cassette_name: "sro_found_last" } do
-      expect(subject.request!).to include("<numero>SS123456789BR</numero>")
+      expect(subject.request!).to include("<numero>#{object_number}</numero>")
     end
   end
 end

data/spec/correios/sro/xml_builder_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Correios::SRO::RequestBuilder do
+
+  describe ".build_xml" do
+
+    let(:subject) { described_class.new(tracker).build_xml }
+
+    context "given one tracking object" do
+      let(:tracker) do
+        sro = Correios::SRO::Tracker.new(user: "EXT", password: "APQ",
+          query_type:   :list,
+          result_mode:  :all
+        )
+        sro.instance_variable_set :@object_numbers, ["SS123456789BR"]
+        sro
+      end
+
+      it { expect(subject).to include("<usuario>EXT</usuario>") }
+      it { expect(subject).to include("<senha>APQ</senha>") }
+      it { expect(subject).to include("<tipo>L</tipo>") }
+      it { expect(subject).to include("<resultado>T</resultado>") }
+      it { expect(subject).to include("<lingua>101</lingua>") }
+      it { expect(subject).to include("<objetos>SS123456789BR</objetos>") }
+
+    end
+
+    context "given more than one tracking object" do
+      let(:tracker) do
+        sro = Correios::SRO::Tracker.new(user: "ECT", password: "SRO",
+          language:     :en,
+          query_type:   :range,
+          result_mode:  :last
+        )
+        sro.instance_variable_set :@object_numbers, ["SS123456730BR", "SS12345650BR"]
+        sro
+      end
+
+      it { expect(subject).to include("<usuario>ECT</usuario>") }
+      it { expect(subject).to include("<senha>SRO</senha>") }
+      it { expect(subject).to include("<tipo>F</tipo>") }
+      it { expect(subject).to include("<resultado>U</resultado>") }
+      it { expect(subject).to include("<lingua>102</lingua>") }
+      it { expect(subject).to include("<objetos>SS123456730BR</objetos>") }
+      it { expect(subject).to include("<objetos>SS12345650BR</objetos>") }
+
+    end
+
+  end
+
+end

data/spec/fixtures/cassettes/sro_found_last.yml

@@ -2,10 +2,24 @@
 http_interactions:
 - request:
     method: post
-    uri: http://websro.correios.com.br/sro_bin/sroii_xml.eventos
+    uri: http://webservice.correios.com.br/service/rastro
     body:
-      encoding: US-ASCII
-      string: Usuario=ECT&Senha=SRO&Tipo=L&Resultado=U&Objetos=SS123456789BR
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0"?>
+        <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:res="http://resource.webservice.correios.com.br/">
+          <soapenv:Header/>
+          <soapenv:Body>
+            <res:buscaEventosLista>
+              <usuario>ECT</usuario>
+              <senha>SRO</senha>
+              <tipo>L</tipo>
+              <resultado>U</resultado>
+              <lingua>101</lingua>
+              <objetos>SS123456789BR</objetos>
+            </res:buscaEventosLista>
+          </soapenv:Body>
+        </soapenv:Envelope>
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
@@ -14,44 +28,38 @@ http_interactions:
       User-Agent:
       - Ruby
       Content-Type:
-      - application/x-www-form-urlencoded
+      - text/xml
   response:
     status:
       code: 200
       message: OK
     headers:
       Date:
-      - Mon, 24 Feb 2014 01:12:34 GMT
-      Server:
-      - Oracle-Application-Server-10g/10.1.2.0.2 Oracle-HTTP-Server
+      - Mon, 27 Jun 2016 13:10:36 GMT
+      X-Powered-By:
+      - Servlet/3.0
+      X-Opnet-Transaction-Trace:
+      - a2_05669c39-8570-4f65-b8b8-3c2c86883d68
       Content-Length:
-      - '850'
+      - '1093'
+      Set-Cookie:
+      - _op_aixPageId=a2_05669c39-8570-4f65-b8b8-3c2c86883d68; Path=/
+      Expires:
+      - Thu, 01 Dec 1994 16:00:00 GMT
+      Cache-Control:
+      - no-cache="set-cookie, set-cookie2"
       Content-Type:
-      - text/html; charset=ISO-8859-1
-      X-Cache:
-      - MISS from 127.0.0.1
+      - text/xml; charset=UTF-8
+      Content-Language:
+      - pt-BR
     body:
-      encoding: ASCII-8BIT
-      string: !binary |-
-        PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iaXNvLTg4NTktMSIgPz4K
-        PHNyb3htbD4KICAgPHZlcnNhbz4xLjA8L3ZlcnNhbz4KICAgPHF0ZD4xPC9x
-        dGQ+CiAgIDxUaXBvUGVzcXVpc2E+TGlzdGEgZGUgT2JqZXRvczwvVGlwb1Bl
-        c3F1aXNhPgogICA8VGlwb1Jlc3VsdGFkbz7abHRpbW8gZXZlbnRvPC9UaXBv
-        UmVzdWx0YWRvPgogICAgIDxvYmpldG8+CiAgICAgICA8bnVtZXJvPlNTMTIz
-        NDU2Nzg5QlI8L251bWVybz4KICAgICAgIDxldmVudG8+CiAgICAgICAgICA8
-        dGlwbz5STzwvdGlwbz4KICAgICAgICAgIDxzdGF0dXM+MDE8L3N0YXR1cz4K
-        ICAgICAgICAgIDxkYXRhPjE3LzA5LzIwMTM8L2RhdGE+CiAgICAgICAgICA8
-        aG9yYT4xMzo0ODwvaG9yYT4KICAgICAgICAgIDxkZXNjcmljYW8+RW5jYW1p
-        bmhhZG88L2Rlc2NyaWNhbz4KICAgICAgICAgIDxsb2NhbD5MQUJPUkFUT1JJ
-        TzAxLVNST0lJL0NFPC9sb2NhbD4KICAgICAgICAgIDxjb2RpZ28+NjAwMDA5
-        MDE8L2NvZGlnbz4KICAgICAgICAgIDxjaWRhZGU+Rk9SVEFMRVpBPC9jaWRh
-        ZGU+CiAgICAgICAgICA8dWY+Q0U8L3VmPgogICAgICAgICAgPHN0bz45OTk5
-        OTk5OTwvc3RvPgogICAgICAgPGRlc3Rpbm8+CiAgICAgICAgICA8bG9jYWw+
-        TEFCT1JBVE9SSU8wMi1TUk9JSS9DRTwvbG9jYWw+CiAgICAgICAgICA8Y29k
-        aWdvPjYwMDAwOTAyPC9jb2RpZ28+CiAgICAgICAgICA8Y2lkYWRlPkZPUlRB
-        TEVaQTwvY2lkYWRlPgogICAgICAgICAgPGJhaXJybz5BTERFT1RBPC9iYWly
-        cm8+CiAgICAgICAgICA8dWY+Q0U8L3VmPgogICAgICAgPC9kZXN0aW5vPgog
-        ICAgICA8L2V2ZW50bz4KICAgICA8L29iamV0bz4KPC9zcm94bWw+Cg==
-    http_version: 
-  recorded_at: Mon, 24 Feb 2014 01:12:40 GMT
-recorded_with: VCR 2.8.0
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Header><X-OPNET-Transaction-Trace:X-OPNET-Transaction-Trace
+        xmlns:X-OPNET-Transaction-Trace="http://opnet.com">pid=135270,requestid=0ba77bf1a686bb8ac2d2956daab521c191713276963afdd8</X-OPNET-Transaction-Trace:X-OPNET-Transaction-Trace></soapenv:Header><soapenv:Body><ns2:buscaEventosListaResponse
+        xmlns:ns2="http://resource.webservice.correios.com.br/"><return><versao>2.0</versao><qtd>1</qtd><objeto><numero>SS123456789BR</numero><sigla>DG</sigla><nome>ENCOMENDA
+        SEDEX (ETIQ LOGICA)</nome><categoria>SEDEX</categoria><evento><tipo>RO</tipo><status>01</status><data>25/06/2016</data><hora>08:54</hora><descricao>Objeto
+        encaminhado </descricao><local>CDD JOAO MONLEVADE</local><codigo>35930971</codigo><cidade>Joao
+        Monlevade</cidade><uf>MG</uf><destino><local>AC ALVINOPOLIS</local><codigo>35950970</codigo><cidade>Alvinopolis</cidade><bairro>Centro</bairro><uf>MG</uf></destino></evento></objeto></return></ns2:buscaEventosListaResponse></soapenv:Body></soapenv:Envelope>
+    http_version:
+  recorded_at: Mon, 27 Jun 2016 13:10:38 GMT
+recorded_with: VCR 2.9.3