correios-frete 0.3.0 → 1.0.0

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
+== Versão 1.0.0
+- Aviso: Quebra de compatibilidade com a versão 0.3.0.
+- Novo: Adicionado log de requisição e resposta do Web Service dos Correios.
+
 == Versão 0.3.0
 - Novo: Métodos diretos para cálculo de um serviço de frete por vez. Exemplo: Correios::Frete#calcular_sedex.
+
 == Versão 0.2.1
 - Melhoria: Alias Correios::Frete::Servico#sucesso? para Correios::Frete::Servico#success?
 - Melhoria: Alias Correios::Frete::Servico#erro? para Correios::Frete::Servico#error?

data/README.rdoc

@@ -1,8 +1,13 @@
 = correios-frete
 
+---
+Esta documentação é da <b>versão 1.0.0</b>.
+Para a versão 0.3.0, por favor veja {README_v0.3.0.rdoc}[https://github.com/prodis/correios-frete/blob/master/README_v0.3.0.rdoc]
+---
+
 Cálculo de frete utilizando o Web Service dos Correios (http://www.correios.com.br/webservices).
 
-Serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (necessário informar código de empresa e senha).
+Os serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (necessário informar código de empresa e senha).
 
 == Instalando
 
@@ -17,12 +22,12 @@ Serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (n
 
   require 'correios-frete'
 
-  frete = Correios::Frete.new :cep_origem => "04094-050",
-                              :cep_destino => "90619-900",
-                              :peso => 0.3,
-                              :comprimento => 30,
-                              :largura => 15,
-                              :altura => 2
+  frete = Correios::Frete::Calculador.new :cep_origem => "04094-050",
+                                          :cep_destino => "90619-900",
+                                          :peso => 0.3,
+                                          :comprimento => 30,
+                                          :largura => 15,
+                                          :altura => 2
 
 Cálculo de vários serviços ao mesmo tempo:
 
@@ -72,6 +77,17 @@ Usando a interface pública em inglês:
   servico.success? # => true
   servico.error?   # => false
 
+== Log
+
+Por padrão, cada chamada ao Web Service dos Correios é logada usando STDOUT.
+
+Para desabilitar o log ou configurar um outro mecanismo de log, você pode configurar o módulo Correios::Frete.
+
+  Correios::Frete.configure do |config|
+    config.log_enabled = false   # Desabilita o log
+    config.logger = Rails.logger # Usa o logger do Rails
+  end
+
 == Informações adicionais
 
 === Serviços suportados
@@ -82,18 +98,18 @@ Usando a interface pública em inglês:
   :e_sedex
 
 
-=== Maneiras de configurar atributos no construtor de Correios::Frete
+=== Maneiras de configurar atributos no construtor de Correios::Frete::Calculador
 
 ==== Com um hash
-  frete = Correios::Frete.new :cep_origem => "04094-050",
-                              :cep_destino => "90619-900",
-                              :peso => 0.3,
-                              :comprimento => 30,
-                              :largura => 15,
-                              :altura => 2
+  frete = Correios::Frete::Calculador.new :cep_origem => "04094-050",
+                                          :cep_destino => "90619-900",
+                                          :peso => 0.3,
+                                          :comprimento => 30,
+                                          :largura => 15,
+                                          :altura => 2
 
 ==== Com um bloco
-  frete = Correios::Frete.new do |f|
+  frete = Correios::Frete::Calculador.new do |f|
     f.cep_origem = "04094-050"
     f.cep_destino = "90619-900"
     f.peso = 0.3
@@ -103,7 +119,7 @@ Usando a interface pública em inglês:
   end
 
 
-=== Atributos de Correios::Frete
+=== Atributos de Correios::Frete::Calculador
 
 ==== String
   cep_origem, cep_destino, codigo_empresa, senha
@@ -134,7 +150,7 @@ Usando a interface pública em inglês:
 
 (The MIT License)
 
-{Prodis a.k.a. Fernando Hamasaki de Amorim}[http://prodis.blog.br]
+{Prodis a.k.a. Fernando Hamasaki}[http://prodis.blog.br]
 
 Copyright (c) 2011 Prodis
 

data/README_v0.3.0.rdoc

@@ -0,0 +1,164 @@
+= correios-frete
+
+---
+Esta documentação é da <b>versão 0.3.0</b>.
+Para a versão 1.0.0 ou acima, por favor veja {README.rdoc}[https://github.com/prodis/correios-frete/blob/master/README.rdoc]
+---
+
+Cálculo de frete utilizando o Web Service dos Correios (http://www.correios.com.br/webservices).
+
+Os serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (necessário informar código de empresa e senha).
+
+== Instalando
+
+=== Gemfile
+  gem 'correios-frete'
+
+=== Instalação direta
+  $ gem install correios-frete
+
+
+== Usando
+
+  require 'correios-frete'
+
+  frete = Correios::Frete.new :cep_origem => "04094-050",
+                              :cep_destino => "90619-900",
+                              :peso => 0.3,
+                              :comprimento => 30,
+                              :largura => 15,
+                              :altura => 2
+
+Cálculo de vários serviços ao mesmo tempo:
+
+  servicos = frete.calcular :sedex, :pac
+
+  servicos[:sedex].nome          # => "SEDEX"
+  servicos[:sedex].valor         # => 26.2
+  servicos[:sedex].prazo_entrega # => 1
+
+  servicos[:pac].nome          # => "PAC"
+  servicos[:pac].valor         # => 10.0
+  servicos[:pac].prazo_entrega # => 5
+
+Cálculo de um serviço de frete passando o serviço para parâmetro:
+
+  servico = frete.calcular :sedex
+  service.nome          # => "SEDEX"
+  servico.valor         # => 26.2
+  servico.prazo_entrega # => 1
+
+  servico = frete.calcular :pac
+  service.nome          # => "PAC"
+  servico.valor         # => 10.0
+  servico.prazo_entrega # => 5
+
+Cálculo de um serviço de frete chamando o método direto do serviço:
+
+  servico = frete.calcular_sedex
+  service.nome          # => "SEDEX"
+  servico.valor         # => 26.2
+  servico.prazo_entrega # => 1
+
+  servico = frete.calcular_pac
+  service.nome          # => "PAC"
+  servico.valor         # => 10.0
+  servico.prazo_entrega # => 5
+
+Verificação de sucesso e erro:
+
+  servico = frete.calcular_sedex
+  servico.sucesso? # => true
+  servico.erro?    # => false
+
+Usando a interface pública em inglês:
+
+  servico = frete.calculate_sedex
+  servico.success? # => true
+  servico.error?   # => false
+
+== Informações adicionais
+
+=== Serviços suportados
+  :pac
+  :sedex
+  :sedex_10
+  :sedex_hoje
+  :e_sedex
+
+
+=== Maneiras de configurar atributos no construtor de Correios::Frete
+
+==== Com um hash
+  frete = Correios::Frete.new :cep_origem => "04094-050",
+                              :cep_destino => "90619-900",
+                              :peso => 0.3,
+                              :comprimento => 30,
+                              :largura => 15,
+                              :altura => 2
+
+==== Com um bloco
+  frete = Correios::Frete.new do |f|
+    f.cep_origem = "04094-050"
+    f.cep_destino = "90619-900"
+    f.peso = 0.3
+    f.comprimento = 30
+    f.largura = 15
+    f.altura = 2
+  end
+
+
+=== Atributos de Correios::Frete
+
+==== String
+  cep_origem, cep_destino, codigo_empresa, senha
+==== Float
+  peso, valor_declarado
+==== Fixnum
+  comprimento, largura, altura, diametro
+==== Boolean
+  mao_propria, aviso_recebimento
+==== Symbol
+  formato (:caixa_pacote, :rolo_prisma)
+
+
+=== Atributos de Correios::Frete::Servico
+
+==== String
+  codigo, erro, msg_erro, nome
+==== Float
+  valor, valor_mao_propria, valor_aviso_recebimento, valor_valor_declarado
+==== Fixnum
+  prazo_entrega
+==== Boolean
+  entrega_domiciliar, entrega_sabado
+==== Symbol
+  tipo (:pac, :sedex, :sedex_10, :sedex_hoje, :e_sedex)
+
+== Copyright
+
+(The MIT License)
+
+{Prodis a.k.a. Fernando Hamasaki}[http://prodis.blog.br]
+
+Copyright (c) 2011 Prodis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -20,8 +20,8 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{Cálculo de frete dos Correios.}
   gem.description = %Q{Cálculo de frete utilizando o Web Service dos Correios (http://www.correios.com.br/webservices). Serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (necessário informar código de empresa e senha).}
   gem.email = "prodis@gmail.com"
-  gem.authors = ["Prodis a.k.a. Fernando Hamasaki de Amorim"]
-  gem.version = Correios::Frete::Version::STRING
+  gem.authors = ["Prodis a.k.a. Fernando Hamasaki"]
+  gem.version = Correios::Frete::Version::VERSION
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/correios-frete.gemspec

@@ -5,15 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{correios-frete}
-  s.version = "0.3.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Prodis a.k.a. Fernando Hamasaki de Amorim"]
-  s.date = %q{2011-08-02}
+  s.authors = ["Prodis a.k.a. Fernando Hamasaki"]
+  s.date = %q{2011-08-10}
   s.description = %q{Cálculo de frete utilizando o Web Service dos Correios (http://www.correios.com.br/webservices). Serviços de frete suportados são PAC, SEDEX, SEDEX 10, SEDEX Hoje e e-SEDEX (necessário informar código de empresa e senha).}
   s.email = %q{prodis@gmail.com}
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.rdoc",
+    "README_v0.3.0.rdoc"
   ]
   s.files = [
     ".document",
@@ -22,14 +23,18 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "README.rdoc",
+    "README_v0.3.0.rdoc",
     "Rakefile",
     "correios-frete.gemspec",
     "lib/correios-frete.rb",
     "lib/correios/frete.rb",
+    "lib/correios/frete/calculador.rb",
+    "lib/correios/frete/logger.rb",
     "lib/correios/frete/parser.rb",
     "lib/correios/frete/servico.rb",
     "lib/correios/frete/version.rb",
     "lib/correios/frete/web_service.rb",
+    "spec/correios/frete/calculador_spec.rb",
     "spec/correios/frete/parser_spec.rb",
     "spec/correios/frete/servico_spec.rb",
     "spec/correios/frete/web_service_spec.rb",

data/lib/correios-frete.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require 'rubygems'
 require 'correios/frete'
+require 'correios/frete/calculador'
 require 'correios/frete/parser'
 require 'correios/frete/servico'
 require 'correios/frete/web_service'

data/lib/correios/frete.rb

@@ -1,58 +1,12 @@
 # encoding: UTF-8
-module Correios
-  class Frete
-    attr_accessor :cep_origem, :cep_destino
-    attr_accessor :peso, :comprimento, :altura, :largura, :diametro
-    attr_accessor :formato, :mao_propria, :aviso_recebimento, :valor_declarado
-    attr_accessor :codigo_empresa, :senha
-    attr_writer :web_service, :parser
-
-    DEFAULT_OPTIONS = {
-      :peso => 0.0,
-      :comprimento => 0.0,
-      :altura => 0.0,
-      :largura => 0.0,
-      :diametro => 0.0,
-      :formato => :caixa_pacote, 
-      :mao_propria => false, 
-      :aviso_recebimento => false, 
-      :valor_declarado => 0.0
-    }
+require 'correios/frete/logger'
 
-    def initialize(options = {})
-      DEFAULT_OPTIONS.merge(options).each do |attr, value|
-        self.send("#{attr}=", value)
-      end
+module Correios
+  module Frete
+    extend Logger
 
+    def self.configure
       yield self if block_given?
     end
-
-    def web_service
-      @web_service ||= Correios::Frete::WebService.new
-    end
-
-    def parser
-      @parser ||= Correios::Frete::Parser.new
-    end
-
-    def calcular(*service_types)
-      response = web_service.request(self, service_types)
-      services = parser.servicos(response)
-
-      if service_types.size == 1
-        services.values.first
-      else
-        services
-      end
-    end
-
-    alias calculate calcular
-
-    private
-
-    def method_missing(method_name, *args)
-      return calcular($2.to_sym) if method_name.to_s =~ /^(calcular|calculate)_(.*)/ && Correios::Frete::Servico.code_from_type($2.to_sym)
-      super
-    end
   end
 end

data/lib/correios/frete/calculador.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+module Correios
+  module Frete
+    class Calculador
+      attr_accessor :cep_origem, :cep_destino
+      attr_accessor :peso, :comprimento, :altura, :largura, :diametro
+      attr_accessor :formato, :mao_propria, :aviso_recebimento, :valor_declarado
+      attr_accessor :codigo_empresa, :senha
+      attr_writer :web_service, :parser
+
+      DEFAULT_OPTIONS = {
+        :peso => 0.0,
+        :comprimento => 0.0,
+        :altura => 0.0,
+        :largura => 0.0,
+        :diametro => 0.0,
+        :formato => :caixa_pacote, 
+        :mao_propria => false, 
+        :aviso_recebimento => false, 
+        :valor_declarado => 0.0
+      }
+
+      def initialize(options = {})
+        DEFAULT_OPTIONS.merge(options).each do |attr, value|
+          self.send("#{attr}=", value)
+        end
+
+        yield self if block_given?
+      end
+
+      def web_service
+        @web_service ||= Correios::Frete::WebService.new
+      end
+
+      def parser
+        @parser ||= Correios::Frete::Parser.new
+      end
+
+      def calcular(*service_types)
+        response = web_service.request(self, service_types)
+        services = parser.servicos(response)
+
+        if service_types.size == 1
+          services.values.first
+        else
+          services
+        end
+      end
+
+      alias calculate calcular
+
+      private
+
+      def method_missing(method_name, *args)
+        return calcular($2.to_sym) if method_name.to_s =~ /^(calcular|calculate)_(.*)/ && Correios::Frete::Servico.code_from_type($2.to_sym)
+        super
+      end
+    end
+  end
+end

data/lib/correios/frete/logger.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+require 'logger'
+
+module Correios
+  module Frete
+    module Logger
+      attr_writer :log_enabled
+      attr_writer :logger
+
+      def log_enabled?
+        @log_enabled != false
+      end
+
+      def logger
+        @logger ||= ::Logger.new STDOUT
+      end
+
+      def log(message)
+        logger.info(message) if log_enabled?
+      end
+    end
+  end
+end

data/lib/correios/frete/parser.rb

@@ -1,15 +1,19 @@
 # encoding: UTF-8
 require 'nokogiri'
 
-class Correios::Frete::Parser
-  def servicos(xml)
-    servicos = {}
+module Correios
+  module Frete
+    class Parser
+      def servicos(xml)
+        servicos = {}
 
-    Nokogiri::XML(xml).root.elements.each do |element|
-      servico = Correios::Frete::Servico.new.parse(element.to_xml)
-      servicos[servico.tipo] = servico
-    end
+        Nokogiri::XML(xml).root.elements.each do |element|
+          servico = Correios::Frete::Servico.new.parse(element.to_xml)
+          servicos[servico.tipo] = servico
+        end
 
-    servicos
+        servicos
+      end
+    end
   end
 end

data/lib/correios/frete/servico.rb

@@ -1,77 +1,81 @@
 # encoding: UTF-8
 require 'sax-machine'
 
-class Correios::Frete::Servico
-  include SAXMachine
+module Correios
+  module Frete
+    class Servico
+      include SAXMachine
 
-  AVAILABLE_SERVICES = {
-    "41106" => { :type => :pac       , :name => "PAC"        },
-    "40010" => { :type => :sedex     , :name => "SEDEX"      },
-    "40215" => { :type => :sedex_10  , :name => "SEDEX 10"   },
-    "40290" => { :type => :sedex_hoje, :name => "SEDEX Hoje" },
-    "81019" => { :type => :e_sedex   , :name => "e-SEDEX"    }
-  }
+      AVAILABLE_SERVICES = {
+        "41106" => { :type => :pac       , :name => "PAC"        },
+        "40010" => { :type => :sedex     , :name => "SEDEX"      },
+        "40215" => { :type => :sedex_10  , :name => "SEDEX 10"   },
+        "40290" => { :type => :sedex_hoje, :name => "SEDEX Hoje" },
+        "81019" => { :type => :e_sedex   , :name => "e-SEDEX"    }
+      }
 
-  element :Codigo, :as => :codigo
-  element :Valor, :as => :valor
-  element :PrazoEntrega, :as => :prazo_entrega
-  element :ValorMaoPropria, :as => :valor_mao_propria
-  element :ValorAvisoRecebimento, :as => :valor_aviso_recebimento
-  element :ValorValorDeclarado, :as => :valor_valor_declarado
-  element :EntregaDomiciliar, :as => :entrega_domiciliar
-  element :EntregaSabado, :as => :entrega_sabado
-  element :Erro, :as => :erro
-  element :MsgErro, :as => :msg_erro
-  attr_reader :tipo, :nome
+      element :Codigo, :as => :codigo
+      element :Valor, :as => :valor
+        element :PrazoEntrega, :as => :prazo_entrega
+      element :ValorMaoPropria, :as => :valor_mao_propria
+      element :ValorAvisoRecebimento, :as => :valor_aviso_recebimento
+      element :ValorValorDeclarado, :as => :valor_valor_declarado
+      element :EntregaDomiciliar, :as => :entrega_domiciliar
+      element :EntregaSabado, :as => :entrega_sabado
+      element :Erro, :as => :erro
+      element :MsgErro, :as => :msg_erro
+      attr_reader :tipo, :nome
 
-  alias_method :original_parse, :parse
+      alias_method :original_parse, :parse
 
-  def parse(xml_text)
-    original_parse xml_text
+      def parse(xml_text)
+        original_parse xml_text
 
-    if AVAILABLE_SERVICES[codigo]
-      @tipo = AVAILABLE_SERVICES[codigo][:type]
-      @nome = AVAILABLE_SERVICES[codigo][:name]
-    end
+        if AVAILABLE_SERVICES[codigo]
+          @tipo = AVAILABLE_SERVICES[codigo][:type]
+          @nome = AVAILABLE_SERVICES[codigo][:name]
+        end
 
-    cast_to_float! :valor, :valor_mao_propria, :valor_aviso_recebimento, :valor_valor_declarado
-    cast_to_int! :prazo_entrega
-    cast_to_boolean! :entrega_domiciliar, :entrega_sabado
-    self
-  end
+        cast_to_float! :valor, :valor_mao_propria, :valor_aviso_recebimento, :valor_valor_declarado
+        cast_to_int! :prazo_entrega
+        cast_to_boolean! :entrega_domiciliar, :entrega_sabado
+        self
+      end
 
-  def success?
-    erro == "0"
-  end
-  alias sucesso? success?
+      def success?
+        erro == "0"
+      end
+      alias sucesso? success?
 
-  def error?
-    !success?
-  end
-  alias erro? error?
+      def error?
+        !success?
+      end
+      alias erro? error?
 
-  def self.code_from_type(type)
-    # I don't use select method for Ruby 1.8.7 compatibility.
-    AVAILABLE_SERVICES.map { |key, value| key if value[:type] == type }.compact.first
-  end
+      def self.code_from_type(type)
+        # I don't use select method for Ruby 1.8.7 compatibility.
+        AVAILABLE_SERVICES.map { |key, value| key if value[:type] == type }.compact.first
+      end
 
-  private
+      private
 
-  def cast_to_float!(*attributes)
-    attributes.each do |attr|
-      instance_variable_set("@#{attr}", send(attr).to_s.gsub("," ,".").to_f)
-    end
-  end
+      def cast_to_float!(*attributes)
+        attributes.each do |attr|
+          instance_variable_set("@#{attr}", send(attr).to_s.gsub("," ,".").to_f)
+        end
+      end
 
-  def cast_to_int!(*attributes)
-    attributes.each do |attr|
-      instance_variable_set("@#{attr}", send(attr).to_i)
-    end
-  end
+      def cast_to_int!(*attributes)
+        attributes.each do |attr|
+          instance_variable_set("@#{attr}", send(attr).to_i)
+        end
+      end
 
-  def cast_to_boolean!(*attributes)
-    attributes.each do |attr|
-      instance_variable_set("@#{attr}", send(attr) == "S")
+      def cast_to_boolean!(*attributes)
+        attributes.each do |attr|
+          instance_variable_set("@#{attr}", send(attr) == "S")
+        end
+      end
     end
   end
 end

data/lib/correios/frete/version.rb

@@ -2,10 +2,10 @@
 module Correios
   module Frete
     module Version
-      MAJOR = 0
-      MINOR = 3
+      MAJOR = 1
+      MINOR = 0
       PATCH = 0
-      STRING = [MAJOR, MINOR, PATCH].join(".")
+      VERSION = [MAJOR, MINOR, PATCH].join(".")
     end
   end
 end

data/lib/correios/frete/web_service.rb

@@ -2,36 +2,55 @@
 require 'net/http'
 require 'uri'
 
-class Correios::Frete::WebService
-  URL = "http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx"
-  FORMATS = { :caixa_pacote => 1, :rolo_prisma => 2 }
-  CONDITIONS = { true => "S", false => "N" }
+module Correios
+  module Frete
+    class WebService
+      URL = "http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx"
+      FORMATS = { :caixa_pacote => 1, :rolo_prisma => 2 }
+      CONDITIONS = { true => "S", false => "N" }
 
-  def request(frete, service_types)
-    Net::HTTP.get(URI.parse("#{URL}?#{params_for(frete, service_types)}"))
-  end
+      def request(frete, service_types)
+        @url = "#{URL}?#{params_for(frete, service_types)}"
+          with_log { Net::HTTP.get_response URI.parse(@url) }
+      end
 
-  private
+      private
 
-  def params_for(frete, service_types)
-    "sCepOrigem=#{frete.cep_origem}&" +
-    "sCepDestino=#{frete.cep_destino}&" +
-    "nVlPeso=#{frete.peso}&" +
-    "nVlComprimento=#{frete.comprimento}&" +
-    "nVlAltura=#{frete.altura}&" +
-    "nVlLargura=#{frete.largura}&" +
-    "nVlDiametro=#{frete.diametro}&" +
-    "nCdFormato=#{FORMATS[frete.formato]}&" +
-    "sCdMaoPropria=#{CONDITIONS[frete.mao_propria]}&" +
-    "sCdAvisoRecebimento=#{CONDITIONS[frete.aviso_recebimento]}&" +
-    "nVlValorDeclarado=#{frete.valor_declarado}&" +
-    "nCdServico=#{service_codes_for(service_types)}&" +
-    "nCdEmpresa=#{frete.codigo_empresa}&" +
-    "sDsSenha=#{frete.senha}&" +
-    "StrRetorno=xml"
-  end
+      def params_for(frete, service_types)
+        "sCepOrigem=#{frete.cep_origem}&" +
+        "sCepDestino=#{frete.cep_destino}&" +
+        "nVlPeso=#{frete.peso}&" +
+        "nVlComprimento=#{frete.comprimento}&" +
+        "nVlAltura=#{frete.altura}&" +
+        "nVlLargura=#{frete.largura}&" +
+        "nVlDiametro=#{frete.diametro}&" +
+        "nCdFormato=#{FORMATS[frete.formato]}&" +
+        "sCdMaoPropria=#{CONDITIONS[frete.mao_propria]}&" +
+        "sCdAvisoRecebimento=#{CONDITIONS[frete.aviso_recebimento]}&" +
+        "nVlValorDeclarado=#{frete.valor_declarado}&" +
+        "nCdServico=#{service_codes_for(service_types)}&" +
+        "nCdEmpresa=#{frete.codigo_empresa}&" +
+        "sDsSenha=#{frete.senha}&" +
+        "StrRetorno=xml"
+      end
+
+      def service_codes_for(service_types)
+        service_types.map { |type| Correios::Frete::Servico.code_from_type(type) }.join(",")
+      end
+
+      def with_log
+        Correios::Frete.log "Correios-Frete Request:\n#{@url}"
+        response = yield
+        Correios::Frete.log format_response_message(response)
+        response.body
+      end
 
-  def service_codes_for(service_types)
-    service_types.map { |type| Correios::Frete::Servico.code_from_type(type) }.join(",")
+      def format_response_message(response)
+        message = "Correios-Frete Response:\n"
+        message << "HTTP/#{response.http_version} #{response.code} #{response.message}\n"
+        response.each_header { |header| message << "#{header}: #{response[header]}\n" }
+        message << response.body
+      end
+    end
   end
 end

data/spec/correios/frete/calculador_spec.rb

@@ -0,0 +1,120 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Correios::Frete::Calculador do
+  describe ".new" do
+    context "create with default value of" do
+      before(:each) { @frete = Correios::Frete::Calculador.new }
+
+      { :peso => 0.0,
+        :comprimento => 0.0,
+        :altura => 0.0,
+        :largura => 0.0,
+        :diametro => 0.0,
+        :formato => :caixa_pacote,
+        :mao_propria => false,
+        :aviso_recebimento => false,
+        :valor_declarado => 0.0
+      }.each do |attr, value|
+        it attr do
+          @frete.send(attr).should == value
+        end
+      end
+    end
+
+    { :cep_origem => "01000-000",
+      :cep_destino => "021222-222",
+      :peso => 0.321,
+      :comprimento => 12.5,
+      :altura => 1.4,
+      :largura => 4.6,
+      :diametro => 5.0,
+      :formato => :rolo_prisma,
+      :mao_propria => true,
+      :aviso_recebimento => true,
+      :valor_declarado => 1.99,
+      :codigo_empresa => "1234567890",
+      :senha => "senha",
+      :web_service => Correios::Frete::WebService.new,
+      :parser => Correios::Frete::Parser.new
+    }.each do |attr, value|
+      context "when #{attr} is supplied" do
+        it "sets #{attr}" do
+          @frete = Correios::Frete::Calculador.new(attr => value)
+          @frete.send(attr).should == value
+        end
+      end
+
+      context "when #{attr} is supplied in a block" do
+        it "sets #{attr}" do
+          @frete = Correios::Frete::Calculador.new { |f| f.send("#{attr}=", value) }
+          @frete.send(attr).should == value
+        end
+      end
+    end
+  end
+
+  describe "#calcular" do
+    before :each do
+      @web_service = Correios::Frete::WebService.new
+      @parser = Correios::Frete::Parser.new
+      @frete = Correios::Frete::Calculador.new(:web_service => @web_service, :parser => @parser)
+    end
+
+    context "to many services" do
+      before :each do
+        @xml = '<?xml version="1.0" encoding="ISO-8859-1" ?><Servicos><cServico><Codigo>41106</Codigo><Valor>15,70</Valor><PrazoEntrega>3</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>N</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico><cServico><Codigo>40010</Codigo><Valor>17,80</Valor><PrazoEntrega>1</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>S</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico></Servicos>'
+        @servicos = { :pac => Correios::Frete::Servico.new, :sedex => Correios::Frete::Servico.new }
+
+        @parser.stub(:servicos).and_return(@servicos)
+        @web_service.stub(:request).with(@frete, [:pac, :sedex]).and_return(@xml)
+      end
+
+      it "returns all services" do
+        @frete.calcular(:pac, :sedex).should == @servicos
+      end
+    end
+
+    context "to one service" do
+      before :each do
+        @xml = '<?xml version="1.0" encoding="ISO-8859-1" ?><cServico><Codigo>40010</Codigo><Valor>17,80</Valor><PrazoEntrega>1</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>S</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico></Servicos>'
+        @servico = Correios::Frete::Servico.new
+
+        @parser.stub(:servicos).and_return(:sedex => @servico)
+        @web_service.stub(:request).with(@frete, [:sedex]).and_return(@xml)
+      end
+
+      it "returns only one service" do
+        @frete.calcular(:sedex).should == @servico
+      end
+    end
+  end
+
+  ["calcular", "calculate"].each do |method_name|
+    Correios::Frete::Servico::AVAILABLE_SERVICES.each do |key, service|
+      describe "##{method_name}_#{service[:type]}" do
+        before :each do
+          web_service = Correios::Frete::WebService.new
+          parser = Correios::Frete::Parser.new
+          @frete = Correios::Frete::Calculador.new(:web_service => web_service, :parser => parser)
+          @servico = Correios::Frete::Servico.new
+
+          parser.stub(:servicos).and_return(service[:type] => @servico)
+          web_service.stub(:request).with(@frete, [service[:type]]).and_return("XML")
+        end
+
+        it "calculates #{service[:name]}" do
+          @frete.send("#{method_name}_#{service[:type]}").should == @servico
+        end
+      end
+    end
+
+    describe "##{method_name}_servico_que_nao_existe" do
+      before(:each) { @frete = Correios::Frete::Calculador.new }
+
+      it "raises NoMethodError" do
+        expect { @frete.send("#{method_name}_servico_que_nao_existe") }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/correios/frete/web_service_spec.rb

@@ -4,19 +4,20 @@ require 'spec_helper'
 describe Correios::Frete::WebService do
   describe "#request" do
     before :each do
-      @frete = Correios::Frete.new :cep_origem => "01000-000",
-                                   :cep_destino => "021222-222",
-                                   :peso => 0.321,
-                                   :comprimento => 12.5,
-                                   :altura => 1.4,
-                                   :largura => 4.6,
-                                   :diametro => 5.0,
-                                   :formato => :rolo_prisma,
-                                   :mao_propria => true,
-                                   :aviso_recebimento => false,
-                                   :valor_declarado => 1.99,
-                                   :codigo_empresa => "1234567890",
-                                   :senha => "senha"
+      @frete = Correios::Frete::Calculador.new :cep_origem => "01000-000",
+                                               :cep_destino => "021222-222",
+                                               :peso => 0.321,
+                                               :comprimento => 12.5,
+                                               :altura => 1.4,
+                                               :largura => 4.6,
+                                               :diametro => 5.0,
+                                               :formato => :rolo_prisma,
+                                               :mao_propria => true,
+                                               :aviso_recebimento => false,
+                                               :valor_declarado => 1.99,
+                                               :codigo_empresa => "1234567890",
+                                               :senha => "senha"
+
       url = "http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx?" +
             "sCepOrigem=01000-000&" +
             "sCepDestino=021222-222&" +
@@ -33,10 +34,20 @@ describe Correios::Frete::WebService do
             "nCdEmpresa=1234567890&" +
             "sDsSenha=senha&" +
             "StrRetorno=xml"
-      Net::HTTP.stub(:get).with(URI.parse(url)).and_return("<xml><fake></fake>")
+
+      response = Net::HTTPOK.new nil, 200, "OK"
+      response.stub(:body).and_return("<xml><fake></fake>")
+      Net::HTTP.stub(:get_response).with(URI.parse(url)).and_return(response)
+
       @web_service = Correios::Frete::WebService.new
     end
 
+    around do |example|
+      Correios::Frete.configure { |config| config.log_enabled = false }
+      example.run
+      Correios::Frete.configure { |config| config.log_enabled = true }
+    end
+
     it "returns XML response" do
       @web_service.request(@frete, [:pac, :sedex]).should == "<xml><fake></fake>"
     end

data/spec/correios/frete_spec.rb

@@ -2,118 +2,61 @@
 require 'spec_helper'
 
 describe Correios::Frete do
-  describe ".new" do
-    context "create with default value of" do
-      before(:each) { @frete = Correios::Frete.new }
-
-      { :peso => 0.0,
-        :comprimento => 0.0,
-        :altura => 0.0,
-        :largura => 0.0,
-        :diametro => 0.0,
-        :formato => :caixa_pacote,
-        :mao_propria => false,
-        :aviso_recebimento => false,
-        :valor_declarado => 0.0
-      }.each do |attr, value|
-        it attr do
-          @frete.send(attr).should == value
-        end
-      end
+  describe "#log_enabled?" do
+    it "default is true" do
+      Correios::Frete.log_enabled?.should be_true
     end
 
-    { :cep_origem => "01000-000",
-      :cep_destino => "021222-222",
-      :peso => 0.321,
-      :comprimento => 12.5,
-      :altura => 1.4,
-      :largura => 4.6,
-      :diametro => 5.0,
-      :formato => :rolo_prisma,
-      :mao_propria => true,
-      :aviso_recebimento => true,
-      :valor_declarado => 1.99,
-      :codigo_empresa => "1234567890",
-      :senha => "senha",
-      :web_service => Correios::Frete::WebService.new,
-      :parser => Correios::Frete::Parser.new
-    }.each do |attr, value|
-      context "when #{attr} is supplied" do
-        it "sets #{attr}" do
-          @frete = Correios::Frete.new(attr => value)
-          @frete.send(attr).should == value
-        end
+    context "when disable log" do
+      around do |example|
+        Correios::Frete.configure { |config| config.log_enabled = false }
+        example.run
+        Correios::Frete.configure { |config| config.log_enabled = true }
       end
 
-      context "when #{attr} is supplied in a block" do
-        it "sets #{attr}" do
-          @frete = Correios::Frete.new { |f| f.send("#{attr}=", value) }
-          @frete.send(attr).should == value
-        end
+      it "returns false" do
+        Correios::Frete.log_enabled?.should be_false
       end
     end
   end
 
-  describe "#calcular" do
-    before :each do
-      @web_service = Correios::Frete::WebService.new
-      @parser = Correios::Frete::Parser.new
-      @frete = Correios::Frete.new(:web_service => @web_service, :parser => @parser)
-    end
-
-    context "to many services" do
-      before :each do
-        @xml = '<?xml version="1.0" encoding="ISO-8859-1" ?><Servicos><cServico><Codigo>41106</Codigo><Valor>15,70</Valor><PrazoEntrega>3</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>N</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico><cServico><Codigo>40010</Codigo><Valor>17,80</Valor><PrazoEntrega>1</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>S</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico></Servicos>'
-        @servicos = { :pac => Correios::Frete::Servico.new, :sedex => Correios::Frete::Servico.new }
-
-        @parser.stub(:servicos).and_return(@servicos)
-        @web_service.stub(:request).with(@frete, [:pac, :sedex]).and_return(@xml)
-      end
-
-      it "returns all services" do
-        @frete.calcular(:pac, :sedex).should == @servicos
-      end
+  describe "#logger" do
+    it "default is Logger" do
+      Correios::Frete.logger.should be_a(Logger)
     end
 
-    context "to one service" do
-      before :each do
-        @xml = '<?xml version="1.0" encoding="ISO-8859-1" ?><cServico><Codigo>40010</Codigo><Valor>17,80</Valor><PrazoEntrega>1</PrazoEntrega><ValorMaoPropria>3,70</ValorMaoPropria><ValorAvisoRecebimento>0,00</ValorAvisoRecebimento><ValorValorDeclarado>1,50</ValorValorDeclarado><EntregaDomiciliar>S</EntregaDomiciliar><EntregaSabado>S</EntregaSabado><Erro>0</Erro><MsgErro></MsgErro></cServico></Servicos>'
-        @servico = Correios::Frete::Servico.new
-
-        @parser.stub(:servicos).and_return(:sedex => @servico)
-        @web_service.stub(:request).with(@frete, [:sedex]).and_return(@xml)
-      end
-
-      it "returns only one service" do
-        @frete.calcular(:sedex).should == @servico
+    context "when set logger" do
+      it "returns set logger" do
+        fake_logger = Class.new
+        Correios::Frete.configure { |config| config.logger = fake_logger }
+        Correios::Frete.logger.should == fake_logger
       end
     end
   end
 
-  ["calcular", "calculate"].each do |method_name|
-    Correios::Frete::Servico::AVAILABLE_SERVICES.each do |key, service|
-      describe "##{method_name}_#{service[:type]}" do
-        before :each do
-          web_service = Correios::Frete::WebService.new
-          parser = Correios::Frete::Parser.new
-          @frete = Correios::Frete.new(:web_service => web_service, :parser => parser)
-          @servico = Correios::Frete::Servico.new
-
-          parser.stub(:servicos).and_return(service[:type] => @servico)
-          web_service.stub(:request).with(@frete, [service[:type]]).and_return("XML")
-        end
+  describe "#log" do
+    before :each do
+      @log_stream = StringIO.new
+      Correios::Frete.configure { |config| config.logger = Logger.new(@log_stream) }
+    end
 
-        it "calculates #{service[:name]}" do
-          @frete.send("#{method_name}_#{service[:type]}").should == @servico
-        end
+    context "when log is enabled" do
+      it "logs the message" do
+        Correios::Frete.log("Some message to log.")
+        @log_stream.string.should include("Some message to log.")
       end
     end
 
-    describe "##{method_name}_servico_que_nao_existe" do
-      before(:each) { @frete = Correios::Frete.new }
+    context "when log is disabled" do
+      around do |example|
+        Correios::Frete.configure { |config| config.log_enabled = false }
+        example.run
+        Correios::Frete.configure { |config| config.log_enabled = true }
+      end
 
-      it "raises NoMethodError" do
-        expect { @frete.send("#{method_name}_servico_que_nao_existe") }.to raise_error(NoMethodError)
+      it "does not log the message" do
+        Correios::Frete.log("Some message to log.")
+        @log_stream.string.should be_empty
       end
     end
   end

metadata

@@ -2,15 +2,15 @@
 name: correios-frete
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors: 
-- Prodis a.k.a. Fernando Hamasaki de Amorim
+- Prodis a.k.a. Fernando Hamasaki
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-08-02 00:00:00 -03:00
+date: 2011-08-10 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,6 +76,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- README_v0.3.0.rdoc
 files: 
 - .document
 - .rspec
@@ -83,14 +84,18 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.rdoc
+- README_v0.3.0.rdoc
 - Rakefile
 - correios-frete.gemspec
 - lib/correios-frete.rb
 - lib/correios/frete.rb
+- lib/correios/frete/calculador.rb
+- lib/correios/frete/logger.rb
 - lib/correios/frete/parser.rb
 - lib/correios/frete/servico.rb
 - lib/correios/frete/version.rb
 - lib/correios/frete/web_service.rb
+- spec/correios/frete/calculador_spec.rb
 - spec/correios/frete/parser_spec.rb
 - spec/correios/frete/servico_spec.rb
 - spec/correios/frete/web_service_spec.rb
@@ -110,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -510697009
+      hash: 829032559
       segments: 
       - 0
       version: "0"