correios_gem 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bcdea458108961276833153250ad580148c625d6fb4500a90ad69558d54a98a
+  data.tar.gz: '0967af2c766255082c6a6231d2321d42c25283906b42f72606dbd1559d2517f0'
+SHA512:
+  metadata.gz: d11f27adbbfc2648b8c73442052d707ebe2e3783e14a84ccd8053a7670815ce2ad2939806a4040b3870b402c49cdc1a5e840ede98c25b940a6c08b3e6cdf7749
+  data.tar.gz: 2ce68ea63004a35f7eec0021987b1a6a47d8a88461da43891a44c7ff315b937efdc0f890fce11946646be27c3491b6ce4c7331b46213a8d7a6ec84dbc63d02ee

data/lib/SRO/client.rb

@@ -0,0 +1,25 @@
+require 'savon'
+
+module Correios
+  module SRO
+    class Client
+      def client
+        Savon.client(
+          wsdl: wsdl,
+          ssl_verify_mode: :none
+        )
+      end
+
+      private
+
+      def wsdl
+        'https://webservice.correios.com.br/service/rastro/Rastro.wsdl'
+      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/SRO/helper.rb

@@ -0,0 +1,118 @@
+module Correios
+  module SRO
+    class Helper
+      def namespaces
+        {
+          'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+          'xmlns:ns1' => 'http://resource.webservice.correios.com.br/'
+        }
+      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_pickup
+          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_pickup
+          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
+
+      def query_type(type)
+        case type
+        when :list
+          'L'
+        when :range
+          'F'
+        end
+      end
+
+      def result_type(type)
+        case type
+        when :last_event
+          'U'
+        when :all_events
+          'T'
+        end
+      end
+
+      def language(type)
+        case type
+        when :portuguese
+          '101'
+        when :english
+          '102'
+        end
+      end
+
+      def format_label_numbers(label_numbers)
+        label_numbers_string = ''
+        label_numbers.each do |label_number|
+          label_numbers_string += label_number
+        end
+        label_numbers_string
+      end
+
+      def convert_string_to_date(date, time)
+        Time.strptime("#{date} #{time}", '%d/%m/%Y %H:%M')
+      end
+    end
+  end
+end

data/lib/SRO/requests/track_shippings.rb

@@ -0,0 +1,142 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module SRO
+    class TrackShippings < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @label_numbers = data[:label_numbers]
+        @query_type = data[:query_type]
+        @result_type = data[:result_type]
+        @language = data[:language]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:busca_eventos,
+                                             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'].buscaEventos do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                xml.objetos HELPER.format_label_numbers(@label_numbers)
+                xml.tipo HELPER.query_type(@query_type)
+                xml.resultado HELPER.result_type(@result_type)
+                xml.lingua HELPER.language(@language)
+                xml.usuario @credentials.sro_user
+                xml.senha @credentials.sro_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:busca_eventos_response][:return]
+        
+        objects = response[:objeto]
+        objects = [objects] if objects.is_a?(Hash)
+        
+        generate_exception(objects.first[:erro]) if objects.first[:numero] == 'Erro'
+      
+        formatted_objects = []
+        objects.each do |object|
+          formatted_objects << format_object(object)
+        end
+
+        { tracking: formatted_objects }
+      end
+
+      def format_object(object)
+        if object[:erro].present?
+          return { 
+            label: {
+              number: object[:numero]
+            },
+            error: object[:erro]
+          }
+        end
+
+        events = object[:evento]
+        events = [events] if events.is_a?(Hash)
+
+        formatted_events = []
+        events.each do |event|
+          formatted_events << format_event(event)
+        end
+
+        {
+          label: {
+            number: object[:numero],
+            initials: object[:sigla],
+            name: object[:nome],
+            category: object[:categoria]
+          },
+          events: formatted_events
+        }
+      end
+
+      def format_event(event)
+        {
+          movement: HELPER.tracking_event_status(event),
+          type: event[:tipo],
+          status: event[:status],
+          time: HELPER.convert_string_to_date(event[:data], event[:hora]),
+          description: event[:descricao],
+          detail: event[:detalhe],
+          city: event[:cidade],
+          state: event[:uf],
+          destination: format_destination(event[:destino]),
+          site: {
+            description: event[:local],
+            zip_code: event[:codigo]
+          }
+        }
+      end
+
+      def format_destination(destination)
+        return nil if destination.nil?
+        {
+          city: destination[:cidade],
+          neighborhood: destination[:bairro],
+          state: destination[:uf],
+          site: {
+            description: destination[:local],
+            zip_code: destination[:codigo]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/SRO/requests/track_shippings_list.rb

@@ -0,0 +1,144 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module SRO
+    class TrackShippingsList < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @credentials = Correios.credentials
+
+        @show_request = data[:show_request]
+        @label_numbers = data[:label_numbers]
+        @query_type = data[:query_type]
+        @result_type = data[:result_type]
+        @language = data[:language]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:busca_eventos_lista,
+                                             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'].buscaEventosLista do
+                parent_namespace = xml.parent.namespace
+                xml.parent.namespace = nil
+
+                @label_numbers.each do |label_number|
+                  xml.objetos label_number
+                end
+                xml.tipo HELPER.query_type(@query_type)
+                xml.resultado HELPER.result_type(@result_type)
+                xml.lingua HELPER.language(@language)
+                xml.usuario @credentials.sro_user
+                xml.senha @credentials.sro_password
+
+                xml.parent.namespace = parent_namespace
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:busca_eventos_lista_response][:return]
+        
+        objects = response[:objeto]
+        objects = [objects] if objects.is_a?(Hash)
+        
+        generate_exception(objects.first[:erro]) if objects.first[:numero] == 'Erro'
+      
+        formatted_objects = []
+        objects.each do |object|
+          formatted_objects << format_object(object)
+        end
+
+        { tracking: formatted_objects }
+      end
+
+      def format_object(object)
+        if object[:erro].present?
+          return { 
+            label: {
+              number: object[:numero]
+            },
+            error: object[:erro]
+          }
+        end
+
+        events = object[:evento]
+        events = [events] if events.is_a?(Hash)
+
+        formatted_events = []
+        events.each do |event|
+          formatted_events << format_event(event)
+        end
+
+        {
+          label: {
+            number: object[:numero],
+            initials: object[:sigla],
+            name: object[:nome],
+            category: object[:categoria]
+          },
+          events: formatted_events
+        }
+      end
+
+      def format_event(event)
+        {
+          movement: HELPER.tracking_event_status(event),
+          type: event[:tipo],
+          status: event[:status],
+          time: HELPER.convert_string_to_date(event[:data], event[:hora]),
+          description: event[:descricao],
+          detail: event[:detalhe],
+          city: event[:cidade],
+          state: event[:uf],
+          destination: format_destination(event[:destino]),
+          site: {
+            description: event[:local],
+            zip_code: event[:codigo]
+          }
+        }
+      end
+
+      def format_destination(destination)
+        return nil if destination.nil?
+        {
+          city: destination[:cidade],
+          neighborhood: destination[:bairro],
+          state: destination[:uf],
+          site: {
+            description: destination[:local],
+            zip_code: destination[:codigo]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/correios_exception.rb

@@ -0,0 +1,11 @@
+class CorreiosException < StandardError
+  def generate_exception(message)
+    raise CorreiosException, format_error_message(message)
+  end
+
+  def format_error_message(message)
+    message = message.to_s.gsub('(soap:Server)', '')
+    message = message.strip
+    message.capitalize
+  end
+end