correios-sro-xml 0.0.4 → 0.1.0

data/lib/correios-sro-xml.rb

@@ -1,10 +1,10 @@
 # encoding: UTF-8
 require 'rubygems'
 require 'correios/sro'
-require 'correios/sro/destino'
-require 'correios/sro/evento'
-require 'correios/sro/objeto'
+require 'correios/sro/destination'
+require 'correios/sro/event'
+require 'correios/sro/object'
 require 'correios/sro/parser'
-require 'correios/sro/rastreador'
+require 'correios/sro/tracker'
 require 'correios/sro/string'
 require 'correios/sro/web_service'

data/lib/correios/sro.rb

@@ -4,5 +4,16 @@ require 'log-me'
 module Correios
   module SRO
     extend LogMe
+
+    module Timeout
+      DEFAULT_REQUEST_TIMEOUT = 5 #seconds
+      attr_writer :request_timeout
+
+      def request_timeout
+        (@request_timeout ||= DEFAULT_REQUEST_TIMEOUT).to_i
+      end
+    end
+
+    extend Timeout
   end
 end

data/lib/correios/sro/destination.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module SRO
+    class Destination
+      include SAXMachine
+
+      element :local,  :as => :place 
+      element :codigo, :as => :code
+      element :cidade, :as => :city
+      element :bairro, :as => :neighborhood
+      element :uf,     :as => :state
+    end
+  end
+end

data/lib/correios/sro/event.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module SRO
+    class Event
+      include SAXMachine
+
+      element :tipo,       :as => :type
+      element :status,     :as => :status
+      element :data,       :as => :date
+      element :hora,       :as => :hour
+      element :descricao,  :as => :description
+      element :recebedor,  :as => :receiver
+      element :documento,  :as => :document
+      element :comentario, :as => :comment
+      element :local,      :as => :place
+      element :codigo,     :as => :code
+      element :cidade,     :as => :city
+      element :uf,         :as => :state
+      element :sto,        :as => :sto
+      element :destino,    :as => :destination, :class => Correios::SRO::Destination
+
+      [:receiver, :document, :comment].each do |method|
+        define_method "#{method}=" do |value|
+          instance_variable_set("@#{method}", value.to_s.strip)
+        end
+      end
+    end
+  end
+end

data/lib/correios/sro/object.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module SRO
+    class Object
+      include SAXMachine
+
+      element  :numero, :as => :number
+      elements :evento, :as => :events, :class => Correios::SRO::Event
+    end
+  end
+end

data/lib/correios/sro/parser.rb

@@ -4,17 +4,17 @@ require 'nokogiri'
 module Correios
   module SRO
     class Parser
-      def objetos(xml)
-        objetos = {}
+      def objects(xml)
+        objects = {}
         xml = xml.backward_encode("UTF-8", "ISO-8859-1")
 
         doc = Nokogiri::XML(xml)
         doc.xpath("//objeto").each do |element|
-          objeto = Correios::SRO::Objeto.parse(element.to_xml)
-          objetos[objeto.numero] = objeto
+          object = Correios::SRO::Object.parse(element.to_xml)
+          objects[object.number] = object
         end
 
-        objetos
+        objects
       end
     end
   end

data/lib/correios/sro/tracker.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+module Correios
+  module SRO
+    class Tracker
+      attr_accessor :user, :password
+      attr_accessor :query_type, :result_mode
+      attr_reader :object_numbers
+
+      DEFAULT_OPTIONS = { :query_type => :list, :result_mode => :last }
+
+      def initialize(options = {})
+        DEFAULT_OPTIONS.merge(options).each do |attr, value|
+          self.send("#{attr}=", value)
+        end
+
+        yield self if block_given?
+        @object_numbers = []
+      end
+
+      def get(*object_numbers)
+        @object_numbers = object_numbers
+        response = web_service.request!
+        objects = parser.objects(response)
+
+        if @object_numbers.size == 1
+          objects.values.first
+        else
+          objects
+        end
+      end
+
+      private
+
+      def web_service
+        @web_service ||= Correios::SRO::WebService.new(self)
+      end
+
+      def parser
+        @parser ||= Correios::SRO::Parser.new
+      end
+    end
+  end
+end

data/lib/correios/sro/version.rb

@@ -1,12 +1,7 @@
 # encoding: UTF-8
 module Correios
   module SRO
-    module Version
-      MAJOR = 0
-      MINOR = 0
-      PATCH = 4
-      VERSION = [MAJOR, MINOR, PATCH].join(".")
-    end
+    VERSION = "0.1.0"
   end
 end
 

data/lib/correios/sro/web_service.rb

@@ -6,29 +6,82 @@ module Correios
   module SRO
     class WebService
       URL = "http://websro.correios.com.br/sro_bin/sroii_xml.eventos"
-      TYPES = { :lista => "L", :intervalo => "F" }
-      RESULTS = { :todos => "T", :ultimo => "U" }
+      QUERY_TYPES = { :list => "L", :range => "F" }
+      RESULT_MODES = { :all => "T", :last => "U" }
 
-      def initialize
+      def initialize(tracker)
         @uri = URI.parse(URL)
+        @tracker = tracker
       end
 
-      def request(sro)
-        response = Net::HTTP.post_form(@uri, params_for(sro))
+      def request!
+        http = build_http
+
+        request = build_request
+        log_request(request)
+
+        response = http.request(request)
+        log_response(response)
+
         response.body
       end
 
       private
 
-      def params_for(sro)
+      def build_http
+        http = Net::HTTP.new(@uri.host, @uri.port)
+        http.open_timeout = Correios::SRO.request_timeout
+        http
+      end
+
+      def build_request
+        request = Net::HTTP::Post.new(@uri.path)
+        request.set_form_data(request_params)
+        request
+      end
+
+      def request_params
         {
-          :Usuario => sro.usuario,
-          :Senha => sro.senha,
-          :Tipo => TYPES[sro.tipo],
-          :Resultado => RESULTS[sro.resultado],
-          :Objetos => sro.objetos.join
+          :Usuario => @tracker.user,
+          :Senha => @tracker.password,
+          :Tipo => QUERY_TYPES[@tracker.query_type],
+          :Resultado => RESULT_MODES[@tracker.result_mode],
+          :Objetos => @tracker.object_numbers.join
         }
       end
+
+      def log_request(request)
+        message = format_message(request) do
+          message =  with_line_break { "Correios-SRO-XML Request:" }
+          message << with_line_break { "POST #{URL}" }
+        end
+
+        Correios::SRO.log(message)
+      end
+
+      def log_response(response)
+        message = format_message(response) do
+          message =  with_line_break { "Correios-SRO-XML Response:" }
+          message << with_line_break { "HTTP/#{response.http_version} #{response.code} #{response.message}" }
+        end
+
+        Correios::SRO.log(message)
+      end
+
+      def format_message(http)
+        message = yield
+        message << with_line_break { format_headers_for(http) } if Correios::SRO.log_level == :debug
+        message << with_line_break { http.body }
+      end
+
+      def format_headers_for(http)
+        # I'm using an empty block in each_header method for Ruby 1.8.7 compatibility.
+        http.each_header{}.map { |name, values| "#{name}: #{values.first}" }.join("\n")
+      end
+
+      def with_line_break
+        "#{yield}\n"
+      end
     end
   end
 end

data/spec/correios/sro/event_spec.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Correios::SRO::Event do
+  let(:event) { Correios::SRO::Event.new }
+
+  [:receiver, :document, :comment].each do |method|
+    describe "##{method}=" do
+      it "strips string" do
+        event.send("#{method}=", "   Texto.   ")
+        event.send(method).should == "Texto."
+      end
+    end
+  end
+end

data/spec/correios/sro/parser_spec.rb

@@ -2,87 +2,87 @@
 require 'spec_helper'
 
 describe Correios::SRO::Parser do
-  describe "#objetos" do
+  describe "#objects" do
     let(:xml) { body_for :success_response_many_objects }
     let(:parser) { Correios::SRO::Parser.new }
 
     it "encodes from ISO-8859-1 to UTF-8" do
       xml.should_receive(:backward_encode).with("UTF-8", "ISO-8859-1").and_return(xml)
-      parser.objetos(xml)
+      parser.objects(xml)
     end
 
     ["SI047624825BR", "SX104110463BR"].each do |number|
       it "returns object number" do
-        objetos = parser.objetos(xml)
-        objetos[number].numero.should == number
+        objects = parser.objects(xml)
+        objects[number].number.should == number
       end
     end
 
     context "returns event" do
-      before(:each) { @objetos = parser.objetos(xml) }
+      before(:each) { @objects = parser.objects(xml) }
 
       { "SI047624825BR" => {
-          :tipo => "BDI",
+          :type => "BDI",
           :status => "01",
-          :data => "26/12/2011",
-          :hora => "15:22",
-          :descricao => "Entregue",
-          :recebedor => "",
-          :documento => "",
-          :comentario => "?",
-          :local => "AC CENTRAL DE SAO PAULO",
-          :codigo => "01009972",
-          :cidade => "SAO PAULO",
-          :uf => "SP",
+          :date => "26/12/2011",
+          :hour => "15:22",
+          :description => "Entregue",
+          :receiver => "",
+          :document => "",
+          :comment => "?",
+          :place => "AC CENTRAL DE SAO PAULO",
+          :code => "01009972",
+          :city => "SAO PAULO",
+          :state => "SP",
           :sto => "00024419"
         },
         "SX104110463BR" => {
-          :tipo => "BDE",
+          :type => "BDE",
           :status => "01",
-          :data => "08/12/2011",
-          :hora => "09:30",
-          :descricao => "Entregue",
-          :recebedor => "",
-          :documento => "",
-          :comentario => "",
-          :local => "CEE JUNDIAI",
-          :codigo => "13211970",
-          :cidade => "JUNDIAI",
-          :uf => "SP",
+          :date => "08/12/2011",
+          :hour => "09:30",
+          :description => "Entregue",
+          :receiver => "",
+          :document => "",
+          :comment => "",
+          :place => "CEE JUNDIAI",
+          :code => "13211970",
+          :city => "JUNDIAI",
+          :state => "SP",
           :sto => "74654209"
         },
       }.each do |number, first_event|
         first_event.each do |attr, value|
           it attr do
-            evento = @objetos[number].eventos.first
-            evento.send(attr).should == value
+            event = @objects[number].events.first
+            event.send(attr).should == value
           end
         end
       end
     end
 
     context "returns destination" do
-      before(:each) { @objetos = parser.objetos(xml) }
+      before(:each) { @objects = parser.objects(xml) }
 
       { "SI047624825BR" => {
-          :local => "CTE VILA MARIA",
-          :codigo => "02170975",
-          :cidade => "SAO PAULO",
-          :bairro => "PQ NOVO MUNDO",
-          :uf => "SP"
+          :place => "CTE VILA MARIA",
+          :code => "02170975",
+          :city => "SAO PAULO",
+          :neighborhood => "PQ NOVO MUNDO",
+          :state => "SP"
         },
         "SX104110463BR" => {
-          :local => "CTE CAMPINAS",
-          :codigo => "13050971",
-          :cidade => "VALINHOS",
-          :bairro => "MACUCO",
-          :uf => "SP"
+          :place => "CTE CAMPINAS",
+          :code => "13050971",
+          :city => "VALINHOS",
+          :neighborhood => "MACUCO",
+          :state => "SP"
         },
-      }.each do |number, destination|
-        destination.each do |attr, value|
+      }.each do |number, destinations|
+        destinations.each do |attr, value|
           it attr do
-            destino = @objetos[number].eventos[3].destino
-            destino.send(attr).should == value
+            destination = @objects[number].events[3].destination
+            destination.send(attr).should == value
           end
         end
       end

data/spec/correios/sro/tracker_spec.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Correios::SRO::Tracker do
+  describe ".new" do
+    it "creates with default values" do
+      sro = Correios::SRO::Tracker.new
+      sro.query_type.should == :list
+      sro.result_mode.should == :last
+      sro.object_numbers.should == []
+    end
+
+    { :user => "PRODIS",
+      :password => "pim321",
+      :query_type => :range,
+      :result_mode => :all
+    }.each do |attr, value|
+      context "when #{attr} is supplied" do
+        it "sets #{attr}" do
+          sro = Correios::SRO::Tracker.new(attr => value)
+          sro.send(attr).should == value
+        end
+      end
+
+      context "when #{attr} is supplied in a block" do
+        it "sets #{attr}" do
+          sro = Correios::SRO::Tracker.new { |t| t.send("#{attr}=", value) }
+          sro.send(attr).should == value
+        end
+      end
+    end
+  end
+
+  describe "#get" do
+    around do |example|
+      Correios::SRO.configure { |config| config.log_enabled = false }
+      example.run
+      Correios::SRO.configure { |config| config.log_enabled = true }
+    end
+
+    let(:sro) { Correios::SRO::Tracker.new(:user => "PRODIS", :password => "pim321") }
+
+    context "to many objects" do
+      before(:each) { mock_request_for(:success_response_many_objects) }
+
+      it "sets objects numbers" do
+        sro.get("SI047624825BR", "SX104110463BR")
+        sro.object_numbers.size.should == 2
+        sro.object_numbers.first.should == "SI047624825BR"
+        sro.object_numbers.last.should == "SX104110463BR"
+      end
+
+      it "creates a WebService with correct params" do
+        web_service = Correios::SRO::WebService.new(sro)
+        Correios::SRO::WebService.should_receive(:new).with(sro).and_return(web_service)
+        sro.get("SI047624825BR", "SX104110463BR")
+      end
+
+      it "returns all objects" do
+        objects = sro.get("SI047624825BR", "SX104110463BR")
+        objects.size.should == 2
+        objects["SI047624825BR"].number.should == "SI047624825BR"
+        objects["SX104110463BR"].number.should == "SX104110463BR"
+      end
+
+      context "when only one object found" do
+        before(:each) { mock_request_for(:success_response_one_object) }
+
+        it "returns a Hash" do
+          objects = sro.get("SI047624825BR", "SX104110463BR")
+          objects.should be_an_instance_of Hash
+        end
+
+        it "returns the object found" do
+          objects = sro.get("SI047624825BR", "SX104110463BR")
+          objects.size.should == 1
+          objects["SI047624825BR"].number.should == "SI047624825BR"
+        end
+
+        it "returns nil in object not found" do
+          objects = sro.get("SI047624825BR", "SX104110463BR")
+          objects["SX104110463BR"].should be_nil
+        end
+      end
+    end
+
+    context "to one object" do
+      before(:each) { mock_request_for(:success_response_one_object) }
+
+      it "sets object number" do
+        sro.get("SI047624825BR")
+        sro.object_numbers.size.should == 1
+        sro.object_numbers.first.should == "SI047624825BR"
+      end
+
+      it "creates a WebService with correct params" do
+        web_service = Correios::SRO::WebService.new(sro)
+        Correios::SRO::WebService.should_receive(:new).with(sro).and_return(web_service)
+        sro.get("SI047624825BR")
+      end
+
+      it "returns only one object" do
+        object = sro.get("SI047624825BR")
+        object.number.should == "SI047624825BR"
+      end
+
+      context "when object not found" do
+        it "returns nil" do
+          mock_request_for(:failure_response_not_found)
+          object = sro.get("SI047624825BR")
+          object.should be_nil
+        end
+      end
+    end
+  end
+end