correios-sro-xml 0.0.4 → 0.1.0

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+TODO
+
+# For MacOS:
+.DS_Store
+
+# For vim:
+*.swp
+*.swo

data/CHANGELOG.rdoc

@@ -1,11 +1,17 @@
-== Versão 0.0.4
-- Correção: Lugar de encode é no Parser e não no WebService.
+== Version 0.1.0
+- Warning: Compatibility break with version 0.0.4.
+- New: Public interface only in English language.
+- New: Log support.
+- New: Request timeout configuration.
 
-== Versão 0.0.3
-- Correção: {Issue #2: Problema de encoding}[https://github.com/prodis/correios-sro-xml/pull/2].
+== Version 0.0.4
+- Fix: The correct place to encode is in Parser, not WebService.
 
-== Versão 0.0.2
-- Melhoria: {Issue #1: Incluindo campo hora}[https://github.com/prodis/correios-sro-xml/pull/1].
+== Version 0.0.3
+- Fix: {Issue #2: Problema de encoding}[https://github.com/prodis/correios-sro-xml/pull/2].
 
-== Versão 0.0.1
-- Primeira versão funcional, mas ainda instável. 
+== Version 0.0.2
+- Improvement: {Issue #1: Incluindo campo hora}[https://github.com/prodis/correios-sro-xml/pull/1].
+
+== Version 0.0.1
+- First version, unstable yet.

data/Gemfile

@@ -1,13 +1,2 @@
 source "http://rubygems.org"
-
-gem "log-me", "~> 0.0.2"
-gem "nokogiri", "~> 1.5"
-gem "sax-machine", "~> 0.1"
-
-group :development do
-  gem "fakeweb", "~> 1.3"
-  gem "jeweler", "~> 1.8"
-  gem "rspec", "~> 2.9"
-  gem "ruby-debug", :platforms => :ruby_18
-  gem "ruby-debug19", :require => "ruby-debug", :platforms => :ruby_19
-end
+gemspec

data/README.rdoc

@@ -1,62 +1,206 @@
 = correios-sro-xml
 
-Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente.
+Tracking Objects System from Correios - SRO (Sistema de Rastreamento de Objetos dos Correios), using SRO XML Web Service, that allows to query up to 50 orders simultaneously.
 
-<b>Atenção:</b> esta gem já está funcional, mas ainda não é uma versão estável.
+http://prodis.net.br/images/ruby/2011/correios_logo.png
 
-== Instalando
+In order to use SRO XML in production environment, it is necessary to request to Correios access data (user and password) for your company, as described in {Correios' Blog}[http://blog.correios.com.br/comercioeletronico/?p=218].
+
+For development environment you can use follow access data:
+  user: ECT
+  password: SRO
+
+== Installing
 
 === Gemfile
   gem 'correios-sro-xml'
 
-=== Instalação direta
+=== Direct installation
   $ gem install correios-sro-xml
 
 
-== Usando
+== Using
 
   require 'correios-sro-xml'
 
-  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.hora      # => "15:22"
-  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.hora      # => "15:22"
-  objetos["SI047624825BR"].eventos.first.local     # => "AC CENTRAL DE SAO PAULO"
-  objetos["SI047624825BR"].eventos.first.descricao # => "Entregue"
-
-  objetos["SX104110463BR"].numero                  # => "SX104110463BR"
-  objetos["SX104110463BR"].eventos.first.data      # => "08/12/2011"
-  objetos["SX104110463BR"].eventos.first.hora      # => "09:30"
-  objetos["SX104110463BR"].eventos.first.local     # => "CEE JUNDIAI"
-  objetos["SX104110463BR"].eventos.first.descricao # => "Entregue"
-
-
-== Autor
+  sro = Correios::SRO::Tracker.new(:user => "ECT", :password => "SRO")
+
+Tracking a single object:
+  object = sro.get("SI047624825BR")
+  object.number                   # => "SI047624825BR"
+  object.events.first.date        # => "26/12/2011"
+  object.events.first.hour        # => "15:22"
+  object.events.first.place       # => "AC CENTRAL DE SAO PAULO"
+  object.events.first.description # => "Entregue"
+
+Tracking many objects:
+  objects = sro.get("SI047624825BR", "SX104110463BR")
+
+  objects["SI047624825BR"].number                   # => "SI047624825BR"
+  objects["SI047624825BR"].events.first.date        # => "26/12/2011"
+  objects["SI047624825BR"].events.first.hour        # => "15:22"
+  objects["SI047624825BR"].events.first.place       # => "AC CENTRAL DE SAO PAULO"
+  objects["SI047624825BR"].events.first.description # => "Entregue"
+
+  objects["SX104110463BR"].number                   # => "SX104110463BR"
+  objects["SX104110463BR"].events.first.date        # => "08/12/2011"
+  objects["SX104110463BR"].events.first.hour        # => "09:30"
+  objects["SX104110463BR"].events.first.place       # => "CEE JUNDIAI"
+  objects["SX104110463BR"].events.first.description # => "Entregue"
+
+=== Tracker result mode
+
+One object can have one or more events.
+For <b>default</b>, the tracker result mode will be return the <b>last object event</b>.
+  sro.result_mode # => :last
+
+  object = sro.get("SI047624825BR")
+  object.events.size # => 1
+
+You can configure to return <b>all</b> events in the object.
+  sro.result_mode = :all
+
+  object = sro.get("SI047624825BR")
+  object.events.size # => 5
+
+=== Tracker query type
+
+There are two ways to query objects in tracker:
+
+==== List of objects
+Where all the object numbers will be requested (the default).
+  sro.query_type # => :list
+
+  objects = sro.get("PB996681660BR", "PB996681700BR")
+  objects.keys # => ["PB996681660BR", "PB996681700BR"]
+
+==== Range of objects
+In which you supplie the first and last objects numbers of an interval.
+  sro.query_type = :range
+
+  objects = sro.get("PB996681660BR", "PB996681700BR")
+  objects.keys # => ["PB996681660BR", "PB996681673BR", "PB996681687BR", "PB996681695BR", "PB996681700BR"]
+
+== Configurations
+
+=== Timeout
+
+For default, the timeout for a request to SRO XML Web Service is <b>5 seconds</b>. If SRO XML Web Service does not respond, a <b>Timeout::Error</b> exception will be raised.
+You can configure this timeout using <b>Correios::SRO</b> module.
+
+  Correios::SRO.configure do |config|
+    config.request_timeout = 3  # It configures timeout to 3 seconds
+  end
+
+=== Log
+
+For default, each request to SRO XML Web service is logged to STDOUT, with <b>:info</b> log level, using the gem {LogMe}[http://github.com/prodis/log-me].
+
+Log example:
+  I, [2012-08-17T00:55:10.531780 #22692]  INFO -- : Correios-SRO-XML Request:
+  POST http://websro.correios.com.br/sro_bin/sroii_xml.eventos
+  Usuario=ECT&Senha=SRO&Tipo=L&Resultado=U&Objetos=PB996681660BR
+
+  I, [2012-08-17T00:55:10.750308 #22692]  INFO -- : Correios-SRO-XML Response:
+  HTTP/1.1 200 OK
+  <?xml version="1.0" encoding="iso-8859-1" ?>
+  <sroxml>
+     <versao>1.0</versao>
+     <qtd>1</qtd>
+     <TipoPesquisa>Lista de Objetos</TipoPesquisa>
+     <TipoResultado>Último evento</TipoResultado>
+       <objeto>
+         <numero>PB996681660BR</numero>
+         <evento>
+            <tipo>BDE</tipo>
+            <status>01</status>
+            <data>05/07/2012</data>
+            <hora>21:11</hora>
+            <descricao>Entregue</descricao>
+            <recebedor>                         </recebedor>
+            <documento>                         </documento>
+            <comentario>                         </comentario>
+            <local>CDD VILA ANDRADE</local>
+            <codigo>05724970</codigo>
+            <cidade>SAO PAULO</cidade>
+            <uf>SP</uf>
+            <sto>72824000</sto>
+        </evento>
+       </objeto>
+  </sroxml>
+
+If you configure log level to <b>:debug</b>, request and response HTTP headers will be logged too.
+  D, [2012-08-17T00:58:56.226742 #22692] DEBUG -- : Correios-SRO-XML Request:
+  POST http://websro.correios.com.br/sro_bin/sroii_xml.eventos
+  accept: */*
+  user-agent: Ruby
+  content-type: application/x-www-form-urlencoded
+  Usuario=ECT&Senha=SRO&Tipo=L&Resultado=U&Objetos=PB996681660BR
+
+  D, [2012-08-17T00:58:56.495131 #22692] DEBUG -- : Correios-SRO-XML Response:
+  HTTP/1.1 200 OK
+  date: Fri, 17 Aug 2012 03:58:56 GMT
+  server: Oracle-Application-Server-10g/10.1.2.0.2 Oracle-HTTP-Server
+  content-length: 855
+  content-type: text/html; charset=ISO-8859-1
+  x-cache: MISS from 127.0.0.1
+  connection: close
+  <?xml version="1.0" encoding="iso-8859-1" ?>
+  <sroxml>
+     <versao>1.0</versao>
+     <qtd>1</qtd>
+     <TipoPesquisa>Lista de Objetos</TipoPesquisa>
+     <TipoResultado>?ltimo evento</TipoResultado>
+       <objeto>
+         <numero>PB996681660BR</numero>
+         <evento>
+            <tipo>BDE</tipo>
+            <status>01</status>
+            <data>05/07/2012</data>
+            <hora>21:11</hora>
+            <descricao>Entregue</descricao>
+            <recebedor>                         </recebedor>
+            <documento>                         </documento>
+            <comentario>                         </comentario>
+            <local>CDD VILA ANDRADE</local>
+            <codigo>05724970</codigo>
+            <cidade>SAO PAULO</cidade>
+            <uf>SP</uf>
+            <sto>72824000</sto>
+        </evento>
+       </objeto>
+  </sroxml>
+
+To disable the log, change log level and configure other log output, use <b>Correios::SRO</b> module:
+
+  Correios::SRO.configure do |config|
+    config.log_enabled = false   # It disables the log
+    config.log_level = :debug    # It changes log level
+    config.logger = Rails.logger # It uses Rails logger
+  end
+
+=== Configuration example
+
+  Correios::SRO.configure do |config|
+    config.log_level = :debug
+    config.logger = Rails.logger
+    config.request_timeout = 3
+  end
+
+== Author
 - {Fernando Hamasaki (prodis)}[http://prodis.blog.br]
 
-== Colaboradores
+== Collaborators
 - {Thiago Ganzarolli (tganzarolli)}[https://github.com/tganzarolli]
 
 == Contributing to correios-sro-xml
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
+* 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.
 
@@ -67,6 +211,8 @@ Rastreamento de vários objetos:
 
 {Prodis a.k.a. Fernando Hamasaki}[http://prodis.blog.br]
 
+http://prodis.net.br/images/prodis_150.gif
+
 Copyright (c) 2012 Prodis
 
 Permission is hereby granted, free of charge, to any person obtaining

data/Rakefile

@@ -1,47 +1,25 @@
-# encoding: UTF-8
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require './lib/correios/sro/version'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  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) 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
-  gem.required_ruby_version = ">= 1.8.7"
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
 
-require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rcov = true
 end
 
 task :default => :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
-  rdoc.rdoc_dir = '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')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("CHANGELOG*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end

data/correios-sro-xml.gemspec

@@ -1,86 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'correios/sro/version'
 
-Gem::Specification.new do |s|
-  s.name = "correios-sro-xml"
-  s.version = "0.0.4"
+Gem::Specification.new do |gem|
+  gem.name        = "correios-sro-xml"
+  gem.version     = Correios::SRO::VERSION
+  gem.authors     = ["Prodis a.k.a. Fernando Hamasaki"]
+  gem.email       = ["prodis@gmail.com"]
+  gem.summary     = "Sistema de Rastreamento de Objetos dos Correios (SRO)."
+  gem.description = "Sistema de Rastreamento de Objetos dos Correios (SRO) utilizando o Web Service SRO XML, que permite a consulta de ate 50 encomendas simultaneamente."
+  gem.homepage    = "http://github.com/prodis/correios-sro-xml"
+  gem.licenses    = ["MIT"]
 
-  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-04-18"
-  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",
-    "Rakefile",
-    "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/string.rb",
-    "lib/correios/sro/version.rb",
-    "lib/correios/sro/web_service.rb",
-    "spec/correios/sro/evento_spec.rb",
-    "spec/correios/sro/parser_spec.rb",
-    "spec/correios/sro/rastreador_spec.rb",
-    "spec/correios/sro/web_service_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/support/fake_request.rb",
-    "spec/support/responses/success-response-many-objects-international.xml",
-    "spec/support/responses/success-response-many-objects.xml",
-    "spec/support/responses/success-response-one-object.xml"
-  ]
-  s.homepage = "http://github.com/prodis/correios-sro-xml"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
-  s.rubygems_version = "1.8.16"
-  s.summary = "Sistema de Rastreamento de Objetos dos Correios (SRO)."
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.platform              = Gem::Platform::RUBY
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<log-me>, ["~> 0.0.2"])
-      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5"])
-      s.add_runtime_dependency(%q<sax-machine>, ["~> 0.1"])
-      s.add_development_dependency(%q<fakeweb>, ["~> 1.3"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.9"])
-      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
-      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
-    else
-      s.add_dependency(%q<log-me>, ["~> 0.0.2"])
-      s.add_dependency(%q<nokogiri>, ["~> 1.5"])
-      s.add_dependency(%q<sax-machine>, ["~> 0.1"])
-      s.add_dependency(%q<fakeweb>, ["~> 1.3"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_dependency(%q<rspec>, ["~> 2.9"])
-      s.add_dependency(%q<ruby-debug>, [">= 0"])
-      s.add_dependency(%q<ruby-debug19>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<log-me>, ["~> 0.0.2"])
-    s.add_dependency(%q<nokogiri>, ["~> 1.5"])
-    s.add_dependency(%q<sax-machine>, ["~> 0.1"])
-    s.add_dependency(%q<fakeweb>, ["~> 1.3"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8"])
-    s.add_dependency(%q<rspec>, ["~> 2.9"])
-    s.add_dependency(%q<ruby-debug>, [">= 0"])
-    s.add_dependency(%q<ruby-debug19>, [">= 0"])
-  end
-end
+  gem.add_dependency "log-me",      "~> 0.0.4"
+  gem.add_dependency "nokogiri",    "~> 1.5"
+  gem.add_dependency "sax-machine", "~> 0.1"
 
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec",   "~> 2.11"
+  gem.add_development_dependency "webmock", "~> 1.8"
+end