correios-frete-alternative 1.10.2

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  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") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "correios-frete #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("CHANGELOG*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'correios-frete'
+
+# pry
+require 'pry'
+Pry.start
+
+# irb
+require 'irb'
+IRB.start

data/correios-frete-alternative.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'correios/frete/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = "correios-frete-alternative"
+  gem.version     = Correios::Frete::VERSION
+  gem.authors     = ["Fernando Hamasaki de Amorim"]
+  gem.email       = ["prodis@gmail.com"]
+  gem.summary     = "Calculo de frete dos Correios."
+  gem.description = "Calculo de frete utilizando o Web Service dos Correios (http://www.correios.com.br/webservices).\nOs servicos de frete suportados sao PAC, SEDEX, SEDEX a Cobrar, SEDEX 10, SEDEX Hoje e e-SEDEX."
+  gem.homepage    = "http://prodis.blog.br/correios-frete-gem-para-calculo-de-frete-dos-correios"
+  gem.licenses    = ["MIT"]
+
+  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"]
+
+  gem.platform              = Gem::Platform::RUBY
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+
+  gem.add_dependency "log-me", "~> 0.0.10"
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "sax-machine", "~> 1.3"
+
+  gem.add_development_dependency "rake", "~> 12.0"
+  gem.add_development_dependency "pry", "~> 0.10"
+  gem.add_development_dependency "rspec", "~> 3.5"
+  gem.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/correios-frete-alternative.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'correios/frete'
+require 'correios/frete/calculador'
+require 'correios/frete/pacote'
+require 'correios/frete/pacote_item'
+require 'correios/frete/parser'
+require 'correios/frete/servico'
+require 'correios/frete/web_service'

data/lib/correios/frete.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'log-me'
+
+module Correios
+  module Frete
+    extend LogMe
+
+    module Timeout
+      DEFAULT_REQUEST_TIMEOUT = 10 #seconds
+      attr_writer :request_timeout
+
+      def request_timeout
+        (@request_timeout ||= DEFAULT_REQUEST_TIMEOUT).to_i
+      end
+    end
+
+    extend Timeout
+  end
+end

data/lib/correios/frete/calculador.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+module Correios
+  module Frete
+    class Calculador
+      attr_accessor :cep_origem, :cep_destino
+      attr_accessor :diametro, :mao_propria, :aviso_recebimento, :valor_declarado
+      attr_accessor :codigo_empresa, :senha, :encomenda
+      attr_writer :peso, :comprimento, :largura, :altura, :formato
+
+      DEFAULT_OPTIONS = {
+        :peso => 0.0,
+        :comprimento => 0.0,
+        :largura => 0.0,
+        :altura => 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
+
+      [:peso, :comprimento, :largura, :altura, :formato].each do |method|
+        define_method method do
+          @encomenda ? @encomenda.send(method) : instance_variable_get("@#{method}")
+        end
+      end
+
+      def calcular(*service_types)
+        response = web_service(service_types).request!
+        services = parser.servicos(response)
+
+        if service_types.size == 1
+          services.values.first
+        else
+          services
+        end
+      end
+      alias calculate calcular
+
+      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
+
+      def respond_to?(method_name)
+        return true if method_name.to_s =~ /^(calcular|calculate)_(.*)/ && Correios::Frete::Servico.code_from_type($2.to_sym)
+        super
+      end
+
+      private
+
+      def web_service(service_types)
+        Correios::Frete::WebService.new(self, service_types)
+      end
+
+      def parser
+        @parser ||= Correios::Frete::Parser.new
+      end
+    end
+  end
+end

data/lib/correios/frete/pacote.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+module Correios
+  module Frete
+    class Pacote
+      attr_reader :peso, :comprimento, :altura, :largura, :volume
+
+      MIN_DIMENSIONS = {
+        :comprimento => 16.0,
+        :largura => 11.0,
+        :altura => 2.0
+      }
+
+      def initialize(itens = nil)
+        @peso = @comprimento = @largura = @altura = @volume = 0.0
+        @itens = []
+
+        itens.each { |item| adicionar_item(item) } if itens
+      end
+
+      def formato
+        :caixa_pacote
+      end
+
+      def itens
+        @itens
+      end
+      alias items itens
+
+      def adicionar_item(item)
+        return unless item
+
+        item = Correios::Frete::PacoteItem.new(item) if item.is_a?(Hash)
+        @itens << item
+
+        calcular_medidas(item)
+        item
+      end
+      alias add_item adicionar_item
+
+      private
+
+      def calcular_medidas(item)
+        @peso += item.peso
+        @volume += item.volume
+
+        if @itens.size == 1
+          @comprimento = item.comprimento
+          @largura = item.largura
+          @altura = item.altura
+        else
+          dimensao = @volume.to_f**(1.0/3)
+          @comprimento = @largura = @altura = dimensao
+        end
+
+        min_dimension_values
+      end
+
+      def min_dimension_values()
+        @comprimento = min(@comprimento, MIN_DIMENSIONS[:comprimento])
+        @largura = min(@largura, MIN_DIMENSIONS[:largura])
+        @altura = min(@altura, MIN_DIMENSIONS[:altura])
+      end
+
+      def min(value, minimum)
+        (value < minimum) ? minimum : value
+      end
+    end
+  end
+end

data/lib/correios/frete/pacote_item.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+module Correios
+  module Frete
+    class PacoteItem
+      attr_accessor :peso, :comprimento, :largura, :altura
+
+      DEFAULT_OPTIONS = {
+        :peso => 0.0,
+        :comprimento => 0.0,
+        :largura => 0.0,
+        :altura => 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 volume
+        @comprimento * @largura * @altura
+      end
+    end
+  end
+end

data/lib/correios/frete/parser.rb

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

data/lib/correios/frete/servico.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+require 'sax-machine'
+
+module Correios
+  module Frete
+    class Servico
+      include SAXMachine
+
+      AVAILABLE_SERVICES = {
+        "04510" => { :type => :pac,                         :name => "PAC",            :description => "PAC sem contrato"                  },
+        "41068" => { :type => :pac_com_contrato,            :name => "PAC",            :description => "PAC com contrato"                  },
+        "41300" => { :type => :pac_gf,                      :name => "PAC GF",         :description => "PAC para grandes formatos"         },
+        "04014" => { :type => :sedex,                       :name => "SEDEX",          :description => "SEDEX sem contrato"                },
+        "40045" => { :type => :sedex_a_cobrar,              :name => "SEDEX a Cobrar", :description => "SEDEX a Cobrar, sem contrato"      },
+        "40126" => { :type => :sedex_a_cobrar_com_contrato, :name => "SEDEX a Cobrar", :description => "SEDEX a Cobrar, com contrato"      },
+        "40215" => { :type => :sedex_10,                    :name => "SEDEX 10",       :description => "SEDEX 10, sem contrato"            },
+        "40290" => { :type => :sedex_hoje,                  :name => "SEDEX Hoje",     :description => "SEDEX Hoje, sem contrato"          },
+        "40096" => { :type => :sedex_com_contrato_1,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+        "40436" => { :type => :sedex_com_contrato_2,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+        "40444" => { :type => :sedex_com_contrato_3,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+        "40568" => { :type => :sedex_com_contrato_4,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+        "40606" => { :type => :sedex_com_contrato_5,        :name => "SEDEX",          :description => "SEDEX com contrato"                },
+        "81019" => { :type => :e_sedex,                     :name => "e-SEDEX",        :description => "e-SEDEX, com contrato"             },
+        "81027" => { :type => :e_sedex_prioritario,         :name => "e-SEDEX",        :description => "e-SEDEX Prioritário, com contrato" },
+        "81035" => { :type => :e_sedex_express,             :name => "e-SEDEX",        :description => "e-SEDEX Express, com contrato"     },
+        "81868" => { :type => :e_sedex_grupo_1,             :name => "e-SEDEX",        :description => "(Grupo 1) e-SEDEX, com contrato"   },
+        "81833" => { :type => :e_sedex_grupo_2,             :name => "e-SEDEX",        :description => "(Grupo 2) e-SEDEX, com contrato"   },
+        "81850" => { :type => :e_sedex_grupo_3,             :name => "e-SEDEX",        :description => "(Grupo 3) e-SEDEX, com contrato"   }
+      }.freeze
+
+      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, :descricao
+
+      alias_method :original_parse, :parse
+
+      def parse(xml_text)
+        original_parse xml_text
+
+        if AVAILABLE_SERVICES[codigo]
+          @tipo = AVAILABLE_SERVICES[codigo][:type]
+          @nome = AVAILABLE_SERVICES[codigo][:name]
+          @descricao = AVAILABLE_SERVICES[codigo][:description]
+        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?
+        valor > 0.0
+      end
+      alias sucesso? success?
+
+      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
+
+      private
+
+      def cast_to_float!(*attributes)
+        attributes.each do |attr|
+          value = send(attr).to_s.gsub(".", "").gsub("," ,".")
+          instance_variable_set("@#{attr}", value.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_boolean!(*attributes)
+        attributes.each do |attr|
+          instance_variable_set("@#{attr}", send(attr) == "S")
+        end
+      end
+    end
+  end
+end

data/lib/correios/frete/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+module Correios
+  module Frete
+    VERSION = "1.10.2"
+  end
+end

data/lib/correios/frete/web_service.rb

@@ -0,0 +1,87 @@
+# encoding: UTF-8
+require 'net/http'
+require 'uri'
+
+module Correios
+  module Frete
+    class WebService
+      URL = "http://ws.correios.com.br/calculador/CalcPrecoPrazo.aspx"
+      FORMATS = { :caixa_pacote => 1, :rolo_prisma => 2, :envelope => 3 }
+      CONDITIONS = { true => "S", false => "N" }
+
+      def initialize(frete, service_types)
+        @url = "#{URL}?#{params_for(frete, service_types)}"
+      end
+
+      def request!
+        response = with_log { http_request(@url) }
+        response.body
+      end
+
+      private
+
+      def http_request(url)
+        uri = URI.parse(url)
+        request = Net::HTTP::Get.new(uri.request_uri)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.open_timeout = Correios::Frete.request_timeout
+        http.request(request)
+      end
+
+      def params_for(frete, service_types)
+        "sCepOrigem=#{frete.cep_origem}&" +
+        "sCepDestino=#{frete.cep_destino}&" +
+        "nVlPeso=#{frete.peso}&" +
+        "nVlComprimento=#{format_decimal(frete.comprimento)}&" +
+        "nVlLargura=#{format_decimal(frete.largura)}&" +
+        "nVlAltura=#{format_decimal(frete.altura)}&" +
+        "nVlDiametro=#{format_decimal(frete.diametro)}&" +
+        "nCdFormato=#{FORMATS[frete.formato]}&" +
+        "sCdMaoPropria=#{CONDITIONS[frete.mao_propria]}&" +
+        "sCdAvisoRecebimento=#{CONDITIONS[frete.aviso_recebimento]}&" +
+        "nVlValorDeclarado=#{format_decimal(format("%.2f" % frete.valor_declarado))}&" +
+        "nCdServico=#{service_codes_for(service_types)}&" +
+        "nCdEmpresa=#{frete.codigo_empresa}&" +
+        "sDsSenha=#{frete.senha}&" +
+        "StrRetorno=xml"
+      end
+
+      def format_decimal(value)
+        value.to_s.gsub(".", ",")
+      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 format_request_message
+        response = yield
+        Correios::Frete.log format_response_message(response)
+        response
+      end
+
+      def format_request_message
+        message =  with_line_break { "Correios-Frete Request:" }
+        message << with_line_break { "GET #{@url}" }
+      end
+
+      def format_response_message(response)
+        message =  with_line_break { "Correios-Frete Response:" }
+        message << with_line_break { "HTTP/#{response.http_version} #{response.code} #{response.message}" }
+        message << with_line_break { format_headers_for(response) } if Correios::Frete.log_level == :debug
+        message << with_line_break { response.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