correios-sro-xml 0.0.0 → 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== Versão 0.0.1
+- Primeira versão funcional, mas ainda instável. 

data/README.rdoc

@@ -1,6 +1,8 @@
 = correios-sro-xml
 
-Sistema de Rastreamento de Objetos dos Correios (SRO).
+Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente.
+
+<b>Atenção:</b> esta gem já está funcional, mas ainda não é uma versão estável.
 
 == Instalando
 
@@ -15,9 +17,28 @@ Sistema de Rastreamento de Objetos dos Correios (SRO).
 
   require 'correios-sro-xml'
 
-  sro = Correios::SRO::Rastreador.new
+  sro = Correios::SRO::Rastreador.new :usuario => "ECT", :senha => "SRO"
+
+Rastreamento de um objeto:
+
+  objeto = sro.consultar("SI047624825BR")
+  objeto.numero                  # => "SI047624825BR"
+  objeto.eventos.first.data      # => "26/12/2011"
+  objeto.eventos.first.local     # => "AC CENTRAL DE SAO PAULO"
+  objeto.eventos.first.descricao # => "Entregue"
+
+Rastreamento de vários objetos:
+  objetos = sro.consultar("SI047624825BR", "SX104110463BR")
+
+  objetos["SI047624825BR"].numero                  # => "SI047624825BR"
+  objetos["SI047624825BR"].eventos.first.data      # => "26/12/2011"
+  objetos["SI047624825BR"].eventos.first.local     # => "AC CENTRAL DE SAO PAULO"
+  objetos["SI047624825BR"].eventos.first.descricao # => "Entregue"
 
-  # Ainda não foi implementado.
+  objetos["SX104110463BR"].numero                  # => "SX104110463BR"
+  objetos["SX104110463BR"].eventos.first.data      # => "08/12/2011"
+  objetos["SX104110463BR"].eventos.first.local     # => "CEE JUNDIAI"
+  objetos["SX104110463BR"].eventos.first.descricao # => "Entregue"
 
 
 == Autor

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "correios-sro-xml"
   gem.homepage = "http://github.com/prodis/correios-sro-xml"
   gem.license = "MIT"
-  gem.summary = %Q{Sistema de Rastreamento de Objetos dos Correios (SRO)}
-  gem.description = %Q{Sistema de Rastreamento de Objetos dos Correios (SRO)}
+  gem.summary = %Q{Sistema de Rastreamento de Objetos dos Correios (SRO).}
+  gem.description = %Q{Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente.}
   gem.email = "prodis@gmail.com"
   gem.authors = ["Prodis a.k.a. Fernando Hamasaki"]
   gem.version = Correios::SRO::Version::VERSION
@@ -42,5 +42,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "correios-sro-xml #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('CHANGELOG*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/correios-sro-xml.gemspec

@@ -5,18 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = "correios-sro-xml"
-  s.version = "0.0.0"
+  s.version = "0.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Prodis a.k.a. Fernando Hamasaki"]
-  s.date = "2012-01-28"
-  s.description = "Sistema de Rastreamento de Objetos dos Correios (SRO)"
+  s.date = "2012-01-30"
+  s.description = "Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente."
   s.email = "prodis@gmail.com"
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
     ".rspec",
+    "CHANGELOG.rdoc",
     "Gemfile",
     "Gemfile.lock",
     "README.rdoc",
@@ -24,9 +25,15 @@ Gem::Specification.new do |s|
     "correios-sro-xml.gemspec",
     "lib/correios-sro-xml.rb",
     "lib/correios/sro.rb",
+    "lib/correios/sro/destino.rb",
+    "lib/correios/sro/evento.rb",
+    "lib/correios/sro/objeto.rb",
+    "lib/correios/sro/parser.rb",
     "lib/correios/sro/rastreador.rb",
     "lib/correios/sro/version.rb",
+    "lib/correios/sro/web_service.rb",
     "spec/correios/sro/rastreador_spec.rb",
+    "spec/correios/sro/web_service_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/prodis/correios-sro-xml"
@@ -34,7 +41,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
   s.rubygems_version = "1.8.11"
-  s.summary = "Sistema de Rastreamento de Objetos dos Correios (SRO)"
+  s.summary = "Sistema de Rastreamento de Objetos dos Correios (SRO)."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/correios-sro-xml.rb

@@ -1,4 +1,9 @@
 # encoding: UTF-8
 require 'rubygems'
 require 'correios/sro'
+require 'correios/sro/destino'
+require 'correios/sro/evento'
+require 'correios/sro/objeto'
+require 'correios/sro/parser'
 require 'correios/sro/rastreador'
+require 'correios/sro/web_service'

data/lib/correios/sro/destino.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module SRO
+    class Destino
+      include SAXMachine
+
+      element :local
+      element :codigo
+      element :cidade
+      element :bairro
+      element :uf
+    end
+  end
+end

data/lib/correios/sro/evento.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module SRO
+    class Evento
+      include SAXMachine
+
+      element :tipo
+      element :status
+      element :data
+      element :descricao
+      element :recebedor
+      element :documento
+      element :comentario
+      element :local
+      element :codigo
+      element :cidade
+      element :uf
+      element :sto
+      element :destino, :class => Correios::SRO::Destino
+    end
+  end
+end

data/lib/correios/sro/objeto.rb

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

data/lib/correios/sro/parser.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+require 'nokogiri'
+
+module Correios
+  module SRO
+    class Parser
+      def objetos(xml)
+        objetos = {}
+
+        doc = Nokogiri::XML(xml)
+        doc.xpath("//objeto").each do |element|
+          objeto = Correios::SRO::Objeto.parse(element.to_xml)
+          objetos[objeto.numero] = objeto
+        end
+
+        objetos
+      end
+    end
+  end
+end

data/lib/correios/sro/rastreador.rb

@@ -2,6 +2,42 @@
 module Correios
   module SRO
     class Rastreador
+      attr_accessor :usuario, :senha
+      attr_accessor :tipo, :resultado
+      attr_reader :objetos
+
+      DEFAULT_OPTIONS = { :tipo => :lista, :resultado => :ultimo }
+
+      def initialize(options = {})
+        DEFAULT_OPTIONS.merge(options).each do |attr, value|
+          self.send("#{attr}=", value)
+        end
+
+        yield self if block_given?
+        @objetos = []
+      end
+
+      def consultar(*object_numbers)
+        @objetos = object_numbers
+        response = web_service.request(self)
+        objects = parser.objetos(response)
+
+        if objects.size == 1
+          objects.values.first
+        else
+          objects
+        end
+      end
+
+      private
+
+      def web_service
+        @web_service ||= Correios::SRO::WebService.new
+      end
+
+      def parser
+        @parser ||= Correios::SRO::Parser.new
+      end
     end
   end
 end

data/lib/correios/sro/version.rb

@@ -4,7 +4,7 @@ module Correios
     module Version
       MAJOR = 0
       MINOR = 0
-      PATCH = 0
+      PATCH = 1
       VERSION = [MAJOR, MINOR, PATCH].join(".")
     end
   end

data/lib/correios/sro/web_service.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require 'net/http'
+require 'uri'
+
+module Correios
+  module SRO
+    class WebService
+      URL = "http://websro.correios.com.br/sro_bin/sroii_xml.eventos"
+      TYPES = { :lista => "L", :intervalor => "F" }
+      RESULTS = { :todos => "T", :ultimo => "U" }
+
+      def initialize
+        @uri = URI.parse(URL)
+      end
+
+      def request(sro)
+        response = Net::HTTP.post_form(@uri, params_for(sro))
+        response.body
+      end
+
+      private
+
+      def params_for(sro)
+        {
+          :Usuario => sro.usuario,
+          :Senha => sro.senha,
+          :Tipo => TYPES[sro.tipo],
+          :Resultado => RESULTS[sro.resultado],
+          :Objetos => sro.objetos.join
+        }
+      end
+    end
+  end
+end

data/spec/correios/sro/rastreador_spec.rb

@@ -3,9 +3,48 @@ require 'spec_helper'
 
 describe Correios::SRO::Rastreador do
   describe ".new" do
-    it "creates new tracker" do
-      sro = Correios::SRO::Rastreador.new
-      sro.should_not be_nil
+    context "creates with default value of" do
+      before(:each) { @sro = Correios::SRO::Rastreador.new }
+
+      { :tipo => :lista,
+        :resultado => :ultimo,
+        :objetos => []
+      }.each do |attr, value|
+        it attr do
+          @sro.send(attr).should == value
+        end
+      end
+    end
+
+    { :usuario => "USUARIO",
+      :senha => "SENHA",
+      :tipo => :intervalo,
+      :resultado => :todos
+    }.each do |attr, value|
+      context "when #{attr} is supplied" do
+        it "sets #{attr}" do
+          sro = Correios::SRO::Rastreador.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::Rastreador.new { |f| f.send("#{attr}=", value) }
+          sro.send(attr).should == value
+        end
+      end
+    end
+  end
+
+  describe "#consultar" do
+    before(:each) { @sro = Correios::SRO::Rastreador.new :usuario => "USUARIO", :senha => "SENHA" }
+
+    it "sets objetos" do
+      @sro.consultar("SQ458226057B", "RA132678652BR")
+      @sro.objetos.size.should == 2
+      @sro.objetos.first.should == "SQ458226057B"
+      @sro.objetos.last.should == "RA132678652BR"
     end
   end
 end

data/spec/correios/sro/web_service_spec.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Correios::SRO::WebService do
+end

metadata

@@ -2,7 +2,7 @@
 name: correios-sro-xml
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Prodis a.k.a. Fernando Hamasaki
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-28 00:00:00 Z
+date: 2012-01-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: log-me
@@ -111,7 +111,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id009
-description: Sistema de Rastreamento de Objetos dos Correios (SRO)
+description: Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente.
 email: prodis@gmail.com
 executables: []
 
@@ -121,6 +121,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .rspec
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -128,9 +129,15 @@ files:
 - correios-sro-xml.gemspec
 - lib/correios-sro-xml.rb
 - lib/correios/sro.rb
+- lib/correios/sro/destino.rb
+- lib/correios/sro/evento.rb
+- lib/correios/sro/objeto.rb
+- lib/correios/sro/parser.rb
 - lib/correios/sro/rastreador.rb
 - lib/correios/sro/version.rb
+- lib/correios/sro/web_service.rb
 - spec/correios/sro/rastreador_spec.rb
+- spec/correios/sro/web_service_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/prodis/correios-sro-xml
 licenses: 
@@ -158,6 +165,6 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Sistema de Rastreamento de Objetos dos Correios (SRO)
+summary: Sistema de Rastreamento de Objetos dos Correios (SRO).
 test_files: []