correios_gem 1.4.0

data/lib/reverse_logistics/requests/create_shippings_with_collection.rb

@@ -0,0 +1,152 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class CreateShippingsWithCollection < 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_simultanea,
+                                             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'].solicitarPostagemSimultanea 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.id_cliente shipping[:code]
+                    xml.valor_declarado shipping[:declared_value]
+                    xml.descricao shipping[:description]
+                    xml.cklist shipping[:check_list]
+                    xml.documento shipping[:document]
+                    xml.obj shipping[:label_number]
+                    xml.obs shipping[:note]
+                    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
+                  end
+                end
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:solicitar_postagem_simultanea_response][:solicitar_postagem_simultanea]
+        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

data/lib/reverse_logistics/requests/request_ticket_numbers.rb

@@ -0,0 +1,90 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class RequestTicketNumbers < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @ticket_type = data[:ticket_type]
+        @service = data[:service]
+        @amount = data[:amount]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:solicitar_range,
+                                             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'].solicitarRange do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.codAdministrativo @credentials.administrative_code
+                xml.tipo HELPER.ticket_type(@ticket_type)
+                xml.servico service(@service)
+                xml.quantidade @amount
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:solicitar_range_response][:solicitar_range]
+        generate_exception(response[:msg_erro]) if response[:cod_erro] != '0'
+
+        initial_number = response[:faixa_inicial].to_i
+        final_number = response[:faixa_final].to_i
+
+        ticket_numbers = []
+        while initial_number <= final_number do
+          ticket_numbers << initial_number.to_s
+          initial_number += 1
+        end
+
+        { ticket_numbers: ticket_numbers }
+      end
+
+      def service(service)
+        case service
+        when :pac
+          'LR'
+        when :sedex
+          'LS'
+        when :e_sedex
+          'LV'
+        end
+      end
+    end
+  end
+end

data/lib/reverse_logistics/requests/track_shipping.rb

@@ -0,0 +1,121 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class TrackShipping < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @ticket_number = data[:ticket_number]
+        @type = data[:type]
+        @result_type = data[:result_type]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:acompanhar_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'].acompanharPedido do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.codAdministrativo @credentials.administrative_code
+                xml.numeroPedido @ticket_number
+                xml.tipoSolicitacao HELPER.shipping_type(@type)
+                xml.tipoBusca HELPER.tracking_result_type(@result_type)
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:acompanhar_pedido_response][:acompanhar_pedido]
+        generate_exception(response[:msg_erro]) if response[:cod_erro].to_i != 0
+
+        events = response[:coleta][:historico]
+        events = [events] if events.is_a?(Hash)
+
+        objects = response[:coleta][:objeto]
+        objects = [objects] if objects.is_a?(Hash)
+
+        formatted_events = []
+        events.each do |event|
+          formatted_events << format_event(event)
+        end
+
+        formatted_objects = []
+        objects.each do |object|
+          formatted_objects << format_object(object)
+        end
+
+        {
+          ticket_number: response[:coleta][:numero_pedido],
+          type: HELPER.shipping_type_inverse(
+            response[:tipo_solicitacao]
+          ),
+          code: response[:coleta][:controle_cliente],
+          events: formatted_events,
+          objects: formatted_objects
+        }
+      end
+
+      def format_event(event)
+        {
+          status: event[:status],
+          description: event[:descricao_status],
+          time: HELPER.convert_string_to_date_time(
+            event[:data_atualizacao], event[:hora_atualizacao]
+          ),
+          note: event[:observacao]
+        }
+      end
+
+      def format_object(object)
+        shipping_price = object[:valor_postagem] || 0
+        {
+          label_number: object[:numero_etiqueta],
+          id: object[:controle_objeto_cliente],
+          shipping_price: shipping_price.to_f,
+          last_event: {
+            status: object[:ultimo_status],
+            description: object[:descricao_status],
+            time: HELPER.convert_string_to_date_time(
+              object[:data_ultima_atualizacao], object[:hora_ultima_atualizacao]
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/reverse_logistics/requests/track_shippings_by_date.rb

@@ -0,0 +1,133 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module ReverseLogistics
+    class TrackShippingsByDate < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @type = data[:type]
+        @date = data[:date]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:acompanhar_pedido_por_data,
+                                             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'].acompanharPedidoPorData do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.codAdministrativo @credentials.administrative_code
+                xml.tipoSolicitacao HELPER.shipping_type(@type)
+                xml.data HELPER.convert_date_to_string(@date)
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:acompanhar_pedido_por_data_response][:acompanhar_pedido_por_data]
+        generate_exception(response[:msg_erro]) if response[:cod_erro].present?
+
+        shippings = response[:coleta]
+        shippings = [shippings] if shippings.is_a?(Hash)
+
+        formatted_shippings = []
+        shippings.each do |shipping|
+          formatted_shippings << format_shippping(shipping)
+        end
+
+        {
+          type: HELPER.shipping_type_inverse(
+            response[:tipo_solicitacao]
+          ),
+          shippings: formatted_shippings
+        }
+      end
+
+      def format_shippping(shipping)
+        events = shipping[:historico]
+        events = [events] if events.is_a?(Hash)
+
+        objects = shipping[:objeto]
+        objects = [objects] if objects.is_a?(Hash)
+
+        formatted_events = []
+        events.each do |event|
+          formatted_events << format_event(event)
+        end
+
+        formatted_objects = []
+        objects.each do |object|
+          formatted_objects << format_object(object)
+        end
+
+        {
+          ticket_number: shipping[:numero_pedido],
+          code: shipping[:controle_cliente],
+          events: formatted_events,
+          objects: formatted_objects
+        }
+      end
+
+      def format_event(event)
+        {
+          status: event[:status],
+          description: event[:descricao_status],
+          time: HELPER.convert_string_to_date_time(
+            event[:data_atualizacao], event[:hora_atualizacao]
+          ),
+          note: event[:observacao]
+        }
+      end
+
+      def format_object(object)
+        shipping_price = object[:valor_postagem] || 0
+        {
+          label_number: object[:numero_etiqueta],
+          id: object[:controle_objeto_cliente],
+          shipping_price: shipping_price.to_f,
+          last_event: {
+            status: object[:ultimo_status],
+            description: object[:descricao_status],
+            time: HELPER.convert_string_to_date_time(
+              object[:data_ultima_atualizacao], object[:hora_ultima_atualizacao]
+            )
+          }
+        }
+      end
+    end
+  end
+end