correios_gem 1.4.0

data/lib/pricefier/requests/list_services_star.rb

@@ -0,0 +1,87 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Pricefier
+    class ListServicesSTAR < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:calc_preco,
+                                             soap_action: 'http://tempuri.org/ListaServicosSTAR',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        rescue Savon::HTTPError => error
+          if error.http.code == 401
+            generate_exception("Unauthorized (#{error.http.code}).")
+          end
+          generate_exception("Unknown HTTP error (#{error.http.code}).")
+        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'].ListaServicosSTAR
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:lista_servicos_star_response][:lista_servicos_star_result]
+
+        services = response[:servicos_calculo][:c_servicos_calculo]
+        services = [services] if services.is_a?(Hash)
+
+        formatted_services = []
+        services.each do |service|
+          formatted_services << format_service(service)
+        end
+
+        {
+          services: formatted_services
+        }
+      end
+
+      def format_service(service)
+        if service[:erro].to_i == 0
+          {
+            code: service[:codigo],
+            description: service[:descricao].strip,
+            calculate_price: HELPER.convert_string_to_bool(
+              service[:calcula_preco]
+            ),
+            calculate_deadline: HELPER.convert_string_to_bool(
+              service[:calcula_prazo]
+            )
+          }
+        else
+          {
+            code: service[:codigo],
+            error: {
+              code: service[:erro],
+              description: service[:msg_erro]
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/reverse_logistics/client.rb

@@ -0,0 +1,34 @@
+require 'savon'
+
+module Correios
+  module ReverseLogistics
+    class Client
+      def client
+        credentials = Correios.credentials
+
+        Savon.client(
+          wsdl: wsdl,
+          basic_auth: [
+            credentials.reverse_logistics_user,
+            credentials.reverse_logistics_password
+          ]
+        )
+      end
+
+      private
+
+      def wsdl
+        if test_env?
+          'https://apphom.correios.com.br/logisticaReversaWS/logisticaReversaService/logisticaReversaWS?wsdl'
+        else
+          'https://cws.correios.com.br/logisticaReversaWS/logisticaReversaService/logisticaReversaWS?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/reverse_logistics/helper.rb

@@ -0,0 +1,95 @@
+require 'date'
+
+module Correios
+  module ReverseLogistics
+    class Helper
+      def namespaces
+        {
+          'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+          'xmlns:ns1' => 'http://service.logisticareversa.correios.com.br/'
+        }
+      end
+
+      def bool_to_string(bool)
+        'S' if bool
+        'N'
+      end
+
+      def bool_to_int(bool)
+        1 if bool
+        0
+      end
+
+      def deadline(value, type)
+        if type == :authorization
+          return value if value.is_a?(Numeric)
+
+          Date.today - value
+        else
+          return (Date.today + value).strftime('%d/%m/%Y') if value.is_a?(Numeric)
+
+          value.strftime('%d/%m/%Y')
+        end
+      end
+
+      def shipping_type(type)
+        case type
+        when :authorization
+          'A'
+        when :pickup
+          'C'
+        end
+      end
+
+      def shipping_type_inverse(type)
+        case type
+        when 'A'
+          :authorization
+        when 'C'
+          :pickup
+        end
+      end
+
+      def ticket_type(type)
+        case type
+        when :authorization
+          'AP'
+        when :pickup
+          'LR'
+        end
+      end
+
+      def additional_services(services)
+        nil if services.nil?
+
+        services_string = ''
+        services.each do |service|
+          services_string += "#{service},"
+        end
+        services_string
+      end
+
+      def convert_string_to_date(date)
+        Date.strptime(date, '%d/%m/%Y')
+      end
+
+      def tracking_result_type(result_type)
+        case result_type
+        when :last_event
+          'U'
+        when :all_events
+          'H'
+        end
+      end
+
+      def convert_string_to_date_time(date, time)
+        time = time.strftime('%H:%M:%S')
+        Time.strptime("#{date} #{time}", '%d-%m-%Y %H:%M:%S')
+      end
+
+      def convert_date_to_string(date)
+        date.strftime('%d/%m/%Y')
+      end
+    end
+  end
+end

data/lib/reverse_logistics/requests/calculate_ticket_number_check_digit.rb

@@ -0,0 +1,66 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class CalculateTicketNumberCheckDigit < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        @ticket_number = data[:ticket_number]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:calcular_digito_verificador,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        rescue Savon::HTTPError => error
+          if error.http.code == 401
+            generate_exception("Unauthorized (#{error.http.code}).")
+          end
+          generate_exception("Unknown HTTP error (#{error.http.code}).")
+        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'].calcularDigitoVerificador do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.numero @ticket_number
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:calcular_digito_verificador_response][:calcular_digito_verificador]
+        generate_exception(response[:msg_erro]) if response[:cod_erro] != '0'
+
+        {
+          digit_checker: response[:digito],
+          ticket_number: response[:numero]
+        }
+      end
+    end
+  end
+end

data/lib/reverse_logistics/requests/cancel_shipping.rb

@@ -0,0 +1,70 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class CancelShipping < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @ticket_number = data[:ticket_number]
+        @type = data[:type]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:cancelar_pedido,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        rescue Savon::HTTPError => error
+          if error.http.code == 401
+            generate_exception("Unauthorized (#{error.http.code}).")
+          end
+          generate_exception("Unknown HTTP error (#{error.http.code}).")
+        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'].cancelarPedido do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.codAdministrativo @credentials.administrative_code
+                xml.numeroPedido @ticket_number
+                xml.tipo HELPER.shipping_type(@type)
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:cancelar_pedido_response][:cancelar_pedido]
+        generate_exception(response[:msg_erro]) if response[:cod_erro].to_i != 0
+
+        {
+          ticket_number: response[:objeto_postal][:numero_pedido],
+          status: response[:objeto_postal][:status_pedido]
+        }
+      end
+    end
+  end
+end

data/lib/reverse_logistics/requests/create_shippings.rb

@@ -0,0 +1,166 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class CreateShippings < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @receiver = data[:receiver]
+        @service_code = data[:service_code]
+        @shippings = data[:shippings]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:solicitar_postagem_reversa,
+                                             soap_action: '',
+                                             xml: xml).to_hash)
+        rescue Savon::SOAPFault => error
+          generate_exception(error)
+        rescue Savon::HTTPError => error
+          if error.http.code == 401
+            generate_exception("Unauthorized (#{error.http.code}).")
+          end
+          generate_exception("Unknown HTTP error (#{error.http.code}).")
+        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'].solicitarPostagemReversa do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.codAdministrativo @credentials.administrative_code
+                xml.cartao @credentials.card
+                xml.codigo_servico @service_code
+                xml.destinatario do
+                  receiver_address = @receiver[:address]
+                  xml.nome @receiver[:name]
+                  xml.ddd @receiver[:phone][0, 2]
+                  xml.telefone @receiver[:phone][2, @receiver[:phone].length - 1]
+                  xml.email @receiver[:email]
+                  xml.logradouro receiver_address[:street]
+                  xml.numero receiver_address[:number]
+                  xml.complemento receiver_address[:additional]
+                  xml.bairro receiver_address[:neighborhood]
+                  xml.cidade receiver_address[:city]
+                  xml.uf receiver_address[:state]
+                  xml.cep receiver_address[:zip_code]
+                  xml.referencia
+                end
+                @shippings.each do |shipping|
+                  goods = shipping[:goods] || []
+                  objects = shipping[:objects] || [{}]
+                  xml.coletas_solicitadas do
+                    xml.tipo HELPER.shipping_type(shipping[:type])
+                    xml.numero shipping[:ticket_number]
+                    xml.id_cliente shipping[:code]
+                    xml.ag HELPER.deadline(shipping[:deadline], shipping[:type])
+                    xml.cartao @credentials.card
+                    xml.valor_declarado shipping[:_value]
+                    xml.servico_adicional HELPER.additional_services(
+                      shipping[:additional_services]
+                    )
+                    xml.descricao shipping[:description]
+                    xml.ar HELPER.bool_to_int(shipping[:receipt_notification])
+                    xml.cklist shipping[:check_list]
+                    xml.documento shipping[:document]
+                    xml.remetente do
+                      sender = shipping[:sender]
+                      sender_address = shipping[:sender][:address]
+                      xml.nome sender[:name]
+                      xml.ddd sender[:phone][0, 2]
+                      xml.telefone sender[:phone][2, sender[:phone].length - 1]
+                      xml.ddd_celular sender[:cellphone][0, 2]
+                      xml.celular sender[:cellphone][2, sender[:phone].length - 1]
+                      xml.email sender[:email]
+                      xml.sms HELPER.bool_to_string(sender[:send_sms])
+                      xml.identificacao sender[:document]
+                      xml.logradouro sender_address[:street]
+                      xml.numero sender_address[:number]
+                      xml.complemento sender_address[:additional]
+                      xml.bairro sender_address[:neighborhood]
+                      xml.referencia
+                      xml.cidade sender_address[:city]
+                      xml.uf sender_address[:state]
+                      xml.cep sender_address[:zip_code]
+                    end
+                    goods.each do |good|
+                      xml.produto do
+                        xml.codigo good[:code]
+                        xml.tipo good[:type]
+                        xml.qtd good[:amount]
+                      end
+                    end
+                    objects.each do |object|
+                      xml.obj_col do
+                        xml.item 1
+                        xml.id object[:id]
+                        xml.desc object[:description]
+                        xml.entrega object[:number]
+                        xml.num
+                      end
+                    end
+                  end
+                end
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:solicitar_postagem_reversa_response][:solicitar_postagem_reversa]
+        generate_exception(response[:msg_erro]) if response[:cod_erro].to_i != 0
+
+        shippings = response[:resultado_solicitacao]
+        shippings = [shippings] if shippings.is_a?(Hash)
+
+        formatted_shippings = []
+        shippings.each do |shipping|
+          formatted_shippings << format_shipping(shipping)
+        end
+
+        { shippings: formatted_shippings }
+      end
+
+      def format_shipping(shipping)
+        if shipping[:codigo_erro].to_i.zero?
+          {
+            type: HELPER.shipping_type_inverse(shipping[:tipo]),
+            code: shipping[:id_cliente],
+            ticket_number: shipping[:numero_coleta],
+            label_number: shipping[:numero_etiqueta],
+            object_id: shipping[:id_obj],
+            deadline: HELPER.convert_string_to_date(shipping[:prazo])
+          }
+        else
+          {
+            type: HELPER.shipping_type_inverse(shipping[:tipo]),
+            code: shipping[:id_cliente],
+            error: shipping[:descricao_erro]
+          }
+        end
+      end
+    end
+  end
+end