correios_gem 1.4.0

data/lib/sigep/client.rb

@@ -0,0 +1,29 @@
+require 'savon'
+
+module Correios
+  module Sigep
+    class Client
+      def client
+        Savon.client(
+          wsdl: wsdl,
+          ssl_verify_mode: :none
+        )
+      end
+
+      private
+
+      def wsdl
+        if test_env?
+          'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+        else
+          'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+        end
+      end
+
+      def test_env?
+        (defined?(Rails) && ENV['RAILS_ENV'].in?(%w[test development]) ||
+                            ENV['GEM_ENV'].in?(%w[test development]))
+      end
+    end
+  end
+end

data/lib/sigep/helper.rb

@@ -0,0 +1,234 @@
+require 'date'
+
+module Correios
+  module Sigep
+    class Helper
+      def namespaces
+        {
+          'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+          'xmlns:ns1' => 'http://cliente.bean.master.sigep.bsb.correios.com.br/'
+        }
+      end
+
+      def shippings_xml(data)
+        credentials = Correios.credentials
+        sender = data[:sender]
+        sender_address = sender[:address]
+        shippings = data[:shippings]
+
+        Nokogiri::XML::Builder.new(encoding: 'ISO-8859-1') do |xml|
+          xml.correioslog do
+            xml.tipo_arquivo 'Postagem'
+            xml.versao_arquivo '2.3'
+            xml.plp do
+              xml.id_plp
+              xml.valor_global
+              xml.mcu_unidade_postagem
+              xml.nome_unidade_postagem
+              xml.cartao_postagem credentials.card
+            end
+            xml.remetente do
+              xml.numero_contrato credentials.contract
+              xml.numero_diretoria sender[:board_id]
+              xml.codigo_administrativo credentials.administrative_code
+              xml.nome_remetente sender[:name]
+              xml.logradouro_remetente sender_address[:street]
+              xml.numero_remetente sender_address[:number]
+              xml.complemento_remetente sender_address[:additional]
+              xml.bairro_remetente sender_address[:neighborhood]
+              xml.cep_remetente sender_address[:zip_code]
+              xml.cidade_remetente sender_address[:city]
+              xml.uf_remetente sender_address[:state]
+              xml.telefone_remetente sender[:phone]
+              xml.fax_remetente sender[:fax]
+              xml.email_remetente sender[:email]
+            end
+            xml.forma_pagamento payment_method(data[:payment_method])
+            shippings.each do |shipping|
+              receiver = shipping[:receiver]
+              receiver_address = receiver[:address]
+              object = shipping[:object]
+              invoice = shipping[:invoice] || {}
+              additional_services = shipping[:additional_services] || []
+              notes = shipping[:notes] || []
+
+              xml.objeto_postal do
+                xml.numero_etiqueta shipping[:label_number]
+                xml.codigo_objeto_cliente shipping[:code]
+                xml.codigo_servico_postagem shipping[:service_code]
+                xml.cubagem 0
+                xml.peso object[:weight]
+                xml.rt1 notes[0]
+                xml.rt2 notes[1]
+                xml.destinatario do
+                  xml.nome_destinatario receiver[:name]
+                  xml.telefone_destinatario receiver[:phone]
+                  xml.celular_destinatario receiver[:cellphone]
+                  xml.email_destinatario receiver[:email]
+                  xml.logradouro_destinatario receiver_address[:street]
+                  xml.complemento_destinatario receiver_address[:additional]
+                  xml.numero_end_destinatario receiver_address[:number]
+                end
+                xml.nacional do
+                  xml.bairro_destinatario receiver_address[:neighborhood]
+                  xml.cidade_destinatario receiver_address[:city]
+                  xml.uf_destinatario receiver_address[:state]
+                  xml.cep_destinatario receiver_address[:zip_code]
+                  xml.codigo_usuario_postal
+                  xml.centro_custo_cliente shipping[:cost_center]
+                  xml.numero_nota_fiscal invoice[:number]
+                  xml.serie_nota_fiscal invoice[:serie]
+                  xml.valor_nota_fiscal invoice[:value]
+                  xml.natureza_nota_fiscal invoice[:kind]
+                  xml.descricao_objeto shipping[:description]
+                  xml.valor_a_cobrar shipping[:additional_value]
+                end
+                xml.servico_adicional do
+                  additional_services.each do |additional_service|
+                    xml.codigo_servico_adicional additional_service
+                  end
+                  xml.valor_declarado shipping[:declared_value]
+                end
+                xml.dimensao_objeto do
+                  xml.tipo_objeto object_type(object[:type])
+                  xml.dimensao_altura object[:height] || 0
+                  xml.dimensao_largura object[:width] || 0
+                  xml.dimensao_comprimento object[:length] || 0
+                  xml.dimensao_diametro object[:diameter] || 0
+                end
+                xml.data_postagem_sara
+                xml.status_processamento 0
+                xml.numero_comprovante_postagem
+                xml.valor_cobrado
+              end
+            end
+          end
+        end.to_xml.encode(Encoding::UTF_8)
+      end
+
+      def label_without_digit_checker(label_number)
+        label_number.slice!(10)
+        label_number
+      end
+
+      def convert_string_to_bool(string)
+        string.strip == 'S'
+      end
+
+      def convert_string_to_date(date, time)
+        DateTime.strptime("#{date} #{time}", '%d/%m/%Y %H:%M')
+      end
+
+      def convert_string_to_decimal(string)
+        return nil if string.nil?
+
+        string.tr(',', '.').to_f
+      end
+
+      def tracking_event_status(event)
+        type = event['tipo']
+        status = event['status'].to_i
+
+        case type
+        when 'BDE', 'BDI', 'BDR'
+          case status
+          when 0, 1
+            return :delivered
+          when 2
+            return :not_delivered
+          when 4, 5, 6, 8, 10, 21, 22, 26, 33, 36, 40, 42, 48, 49, 56
+            return :returning
+          when 7, 19, 25, 32, 38, 41, 45, 46, 47, 53, 57, 66, 69
+            return :in_transit
+          when 9, 50, 51, 52
+            return :stolen_lost
+          when 3, 12, 24
+            return :awaiting_pick_up
+          when 20, 34, 35
+            return :not_delivered
+          when 23
+            return :returned
+          when 28, 37
+            return :damaged
+          when 43
+            return :arrested
+          when 54, 55, 58, 59
+            return :taxing
+          end
+        when 'BLQ', 'PMT', 'CD', 'CMT', 'TRI', 'CUN', 'RO', 'DO', 'EST', 'PAR'
+          case status
+          when 0, 1, 2, 3, 4, 5, 6, 9, 15, 16, 17, 18
+            return :in_transit
+          end
+        when 'FC'
+          case status
+          when 1
+            return :returning
+          when 2, 3, 5, 7
+            return :in_transit
+          when 4
+            return :not_delivered
+          end
+        when 'IDC'
+          case status
+          when 1, 2, 3, 4, 5, 6, 7
+            return :stolen_lost
+          end
+        when 'LDI'
+          case status
+          when 0, 1, 2, 3, 14
+            return :awaiting_pick_up
+          end
+        when 'OEC', 'LDE'
+          case status
+          when 0, 1, 9
+            return :delivering
+          end
+        when 'PO', 'CO'
+          case status
+          when 0, 1, 9
+            return :posted
+          end
+        end
+      end
+
+      private
+
+      def convert_decimal_to_string(decimal)
+        return nil if decimal.nil?
+
+        decimal.to_s.tr('.', ',')
+      end
+
+      def object_type(type)
+        case type
+        when :letter_envelope
+          '001'
+        when :box
+          '002'
+        when :prism
+          '002'
+        when :cylinder
+          '003'
+        end
+      end
+
+      def payment_method(method)
+        case method
+        when :postal_vouncher
+          1
+        when :postal_refound
+          2
+        when :exchange_contract
+          3
+        when :credit_card
+          4
+        when :other
+          5
+        when :to_bill
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/sigep/requests/calculate_label_number_check_digit.rb

@@ -0,0 +1,72 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class CalculateLabelNumberCheckDigit < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @label_numbers = data[:label_numbers]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:gera_digito_verificador_etiquetas,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].geraDigitoVerificadorEtiquetas do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                @label_numbers.each do |label_number|
+                  xml.etiquetas label_number
+                end
+                xml.usuario @credentials.sigep_user
+                xml.senha @credentials.sigep_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:gera_digito_verificador_etiquetas_response][:return]
+        response = [response] if response.is_a?(Hash)
+
+        { digit_checkers: format_digit_checkers(response) }
+      end
+
+      def format_digit_checkers(digit_checkers)
+        formatted_digit_checkers = []
+        digit_checkers.each do |digit_check|
+          formatted_digit_checkers << digit_check.to_i
+        end
+        formatted_digit_checkers
+      end
+    end
+  end
+end

data/lib/sigep/requests/cancel_shipping.rb

@@ -0,0 +1,72 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class CancelShipping < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @label_number = data[:label_number]
+        @request_id = data[:request_id]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:bloquear_objeto,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].bloquearObjeto do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.numeroEtiqueta @label_number
+                xml.idPlp @request_id
+                xml.tipoBloqueio 'FRAUDE_BLOQUEIO'
+                xml.acao 'DEVOLVIDO_AO_REMETENTE'
+                xml.usuario @credentials.sigep_user
+                xml.senha @credentials.sigep_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:bloquear_objeto_response][:return]
+
+        { status: convert_status_to_symbol(response) }
+      end
+
+      def convert_status_to_symbol(status)
+        case status
+        when 'Registro gravado'
+          :ok
+        end
+      end
+    end
+  end
+end

data/lib/sigep/requests/check_card_status.rb

@@ -0,0 +1,69 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Sigep
+    class CheckCardStatus < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:get_status_cartao_postagem,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        end
+      end
+
+      private
+
+      def xml
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          xml['soap'].Envelope(HELPER.namespaces) do
+            xml['soap'].Body do
+              xml['ns1'].getStatusCartaoPostagem do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.numeroCartaoPostagem @credentials.card
+                xml.usuario @credentials.sigep_user
+                xml.senha @credentials.sigep_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:get_status_cartao_postagem_response][:return]
+
+        { status: convert_status_to_symbol(response) }
+      end
+
+      def convert_status_to_symbol(status)
+        case status
+        when 'Normal'
+          :ok
+        when 'Cancelado'
+          :canceled
+        end
+      end
+    end
+  end
+end