correios_gem 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca814241bdecf0a89001a6f7a98adee9a729a3e3c574d681eea57ee35b776d6f
-  data.tar.gz: 74cbd84e21eed85efe7f0997a2975ac07f4f717b55e15872d2475e3a37ee7a93
+  metadata.gz: 3effd48cfda5b95dc4651f7da866b603670821b1810715e4c9f4e45499648816
+  data.tar.gz: e76beb29d7c3b198fe08cf0601c89fa6f63f427b62827d2875ccde646f502925
 SHA512:
-  metadata.gz: bdf55c59f0e0b32e121182c878e25f38809fe4999b47c5bff6244e011060c79529ac2a86367f2fa8be063a77db46acf20b52db69b0ea908931670636a79b417f
-  data.tar.gz: eecdad994f4fed052b924d87c19b528244f249dca96e747562eede66def80cffb41b5e4d143aeac5422b7aa994ffd51073ddb4b20ae029cfc55fed0630253be4
+  metadata.gz: a461c743a47eac0aee55fd8ed23010b1e07b67ce333d98f0158c11861b30de07fe3607e1b9815c1600620e6e3d8a293a34e79b9a9b5c0c833cee651a079d0a9b
+  data.tar.gz: a2222afeb2b1900201dfedce91f06903ea311124ae7338d9cdbb5cc08cfca0a25b9a5583fbdfb28f68371e5ca99ad38fb22bb0969f388e417551285fcad865c7

data/correios_gem.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.author        = 'Arthur Soares'
+  s.email         = 'arthurvsp97@gmail.com'
+
+  s.name          = 'correios_gem'
+  s.version       = '1.4.3'
+  s.date          = '2019-03-09'
+  s.homepage      = 'https://github.com/arthursoas/correios_gem'
+  s.summary       = 'A correios-gem integra sua aplicacao com as APIs dos
+                     Correios'
+  s.description   = 'Integracao com as APIs Sigep, Logistica Reversa,
+                     Precificador (frete) e SRO, utilizando objetos Ruby para
+                     requisicoes e respostas. Integrar com os Correios nunca foi
+                     tao simples.'
+  s.license       = 'MIT'
+  s.files         = Dir['lib/**/*'] + %w[correios_gem.gemspec]
+
+  s.add_dependency 'activesupport', '~> 5.2',  '>= 5.2.2'
+  s.add_dependency 'nokogiri',      '~> 1.9',  '>= 1.9.1'
+  s.add_dependency 'savon',         '~> 2.12', '>= 2.12.0'
+
+  s.add_development_dependency 'rspec', '~> 3.0'
+
+  # s.add_development_dependency 'bundler', '~> 1.11'
+  # s.add_development_dependency 'rake', '~> 10.0'
+  # s.add_development_dependency 'simplecov', '~> 0.14.1'
+  # s.add_development_dependency 'coveralls', '~> 0.8.21'
+  # s.add_development_dependency 'rubocop', '~> 0.52.1'
+end

data/lib/SRO/requests/track_shippings.rb

@@ -1,20 +1,10 @@
-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
-
+    class TrackShippings < Helper
       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]
@@ -22,19 +12,21 @@ module Correios
         super()
       end
 
-      def request
+      def request(method)
+        @method = method
+        @method_snake = method.underscore
+
         puts xml if @show_request == true
         begin
-          format_response(CLIENT.client.call(:busca_eventos,
-                                             soap_action: '',
-                                             xml: xml).to_hash)
+          format_response(SRO.client.call(
+            @method_snake.to_sym,
+            soap_action: '',
+            xml: xml
+          ).to_hash)
         rescue Savon::SOAPFault => error
-          generate_exception(error)
+          generate_soap_fault_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}).")
+          generate_http_exception(error.http.code)
         end
       end
 
@@ -42,16 +34,22 @@ module Correios
 
       def xml
         Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-          xml['soap'].Envelope(HELPER.namespaces) do
+          xml['soap'].Envelope(SRO.namespaces) do
             xml['soap'].Body do
-              xml['ns1'].buscaEventos do
+              xml['ns1'].send(@method) 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)
+                if @method == 'buscaEventosLista'
+                  @label_numbers.each do |label_number|
+                    xml.objetos label_number
+                  end
+                elsif @method == 'buscaEventos'
+                  xml.objetos array_to_string(@label_numbers)
+                end
+                xml.tipo tracking_query_type(@query_type)
+                xml.resultado tracking_result_type(@result_type)
+                xml.lingua tracking_language(@language)
                 xml.usuario @credentials.sro_user
                 xml.senha @credentials.sro_password
 
@@ -63,19 +61,12 @@ module Correios
       end
 
       def format_response(response)
-        response = response[:busca_eventos_response][:return]
-        
+        response = response["#{@method_snake}_response".to_sym][: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
+        generate_sro_exception(objects)
 
-        { tracking: formatted_objects }
+        { tracking: objects.map {|o| format_object(o)} }
       end
 
       def format_object(object)
@@ -91,11 +82,6 @@ module Correios
         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],
@@ -103,16 +89,16 @@ module Correios
             name: object[:nome],
             category: object[:categoria]
           },
-          events: formatted_events
+          events: events.map {|e| format_event(e)}
         }
       end
 
       def format_event(event)
         {
-          movement: HELPER.tracking_event_status(event),
+          movement: inverse_tracking_event_status(event),
           type: event[:tipo],
           status: event[:status],
-          time: HELPER.convert_string_to_date(event[:data], event[:hora]),
+          time: string_to_time_no_second(event[:data], event[:hora]),
           description: event[:descricao],
           detail: event[:detalhe],
           city: event[:cidade],

data/lib/auxiliars/environments.rb

@@ -0,0 +1,94 @@
+module Correios
+  module Pricefier
+    def self.client
+      base_client(wsdl: wsdl)
+    end
+
+    def self.namespaces
+      {
+        'xmlns:soap' => 'http://www.w3.org/2003/05/soap-envelope',
+        'xmlns:ns1' => 'http://tempuri.org/'
+      }
+    end
+
+    def self.wsdl
+      'http://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?wsdl'
+    end
+  end
+
+  module ReverseLogistics
+    def self.client
+      base_client(wsdl: wsdl,
+                  basic_auth: [
+                    Correios.credentials.reverse_logistics_user || 'user',
+                    Correios.credentials.reverse_logistics_password || 'pass'
+                  ])
+    end
+
+    def self.namespaces
+      {
+        'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:ns1' => 'http://service.logisticareversa.correios.com.br/'
+      }
+    end
+
+    def self.wsdl
+      if production_env?
+        'https://cws.correios.com.br/logisticaReversaWS/logisticaReversaService/logisticaReversaWS?wsdl'
+      else
+        'https://apphom.correios.com.br/logisticaReversaWS/logisticaReversaService/logisticaReversaWS?wsdl'
+      end
+    end
+  end
+
+  module Sigep
+    def self.client
+      base_client(wsdl: wsdl)
+    end
+
+    def self.namespaces
+      {
+        'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:ns1' => 'http://cliente.bean.master.sigep.bsb.correios.com.br/'
+      }
+    end
+
+    def self.wsdl
+      if production_env?
+        'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+      else
+        'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+      end
+    end
+  end
+
+  module SRO
+    def self.client
+      base_client(wsdl: wsdl)
+    end
+
+    def self.namespaces
+      {
+        'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:ns1' => 'http://resource.webservice.correios.com.br/'
+      }
+    end
+
+    def self.wsdl
+      'https://webservice.correios.com.br/service/rastro/Rastro.wsdl'
+    end
+  end
+end
+
+def base_client(wsdl:, ssl_verify_mode: :none, basic_auth: [])
+  Savon.client(wsdl: wsdl,
+               basic_auth: basic_auth,
+               ssl_verify_mode: ssl_verify_mode)
+end
+
+def production_env?
+  return false unless defined?(Rails)
+  return true if Rails.env.production?
+
+  false
+end

data/lib/auxiliars/exception.rb

@@ -0,0 +1,5 @@
+class CorreiosException < StandardError
+  def generate_exception(message)
+    raise CorreiosException, message
+  end
+end

data/lib/auxiliars/helper.rb

@@ -0,0 +1,404 @@
+require_relative './exception'
+
+require 'date'
+require 'time'
+
+class Helper < CorreiosException
+  def generate_soap_fault_exception(message)
+    message = message.to_s.gsub('(soap:Server)', '')
+    message = message.strip
+    generate_exception(message.capitalize)
+  end
+
+  def generate_http_exception(status)
+    case status
+    when 400
+      generate_exception("Bad request. Status code #{status}")
+    when 401
+      generate_exception("Access unauthorized. Status code #{status}")
+    when 404
+      generate_exception("Data or method not found. Status code #{status}")
+    when 500
+      generate_exception("Internal server error. Status code #{status}")
+    when 503
+      generate_exception("Service unavailable. Status code #{status}")
+    when 504
+      generate_exception("Gateway timeout. Status code #{status}")
+    else
+      generate_exception("Unknown HTTP error. Status code #{status}")
+    end
+  end
+
+  def generate_revese_logistics_exception(response)
+    unless response[:cod_erro].to_i.zero?
+      generate_exception(response[:msg_erro].capitalize)
+    end
+  end
+
+  def generate_sro_exception(objects)
+    generate_exception(objects.first[:erro]) if objects.first[:numero] == 'Erro'
+  end
+
+  def remove_label_digit_checker(label_number)
+    label_number.slice!(10)
+    label_number
+  end
+
+  def calculate_reverse_shipping_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 calculate_shipping_deadline(days, saturday, date = Date.today)
+    if saturday
+      days.to_i.times do
+        date += 1.days
+        date += 1.days if date.sunday?
+      end
+    else
+      days.to_i.times do
+        date += 1.days
+        date += 1.days if deadline.sunday? || deadline.saturday?
+      end
+    end
+    date
+  end
+
+  # Converters
+
+  def string_to_bool(string)
+    string.strip == 'S'
+  end
+
+  def bool_to_string(bool)
+    bool ? 'S' : 'N'
+  end
+
+  def bool_to_int(bool)
+    bool ? 1 : 0
+  end
+
+  def string_to_time(date, time)
+    time = time.strftime('%H:%M:%S')
+    Time.strptime("#{date} #{time}", '%d-%m-%Y %H:%M:%S')
+  end
+
+  def string_to_time_no_second(date, time)
+    Time.strptime("#{date} #{time}", '%d/%m/%Y %H:%M')
+  end
+
+  def string_to_date(date)
+    Date.strptime(date, '%d/%m/%Y')
+  end
+
+  def date_to_string(date)
+    date.strftime('%d/%m/%Y')
+  end
+
+  def string_to_decimal(string)
+    return nil if string.nil?
+
+    string.tr(',', '.').to_f
+  end
+
+  def decimal_to_string(decimal)
+    return nil if decimal.nil?
+
+    decimal.to_s.tr('.', ',')
+  end
+
+  def array_to_string_comma(array)
+    return nil if array.nil?
+
+    array.join(',')
+  end
+
+  def array_to_string(array)
+    return nil if array.nil?
+
+    array.join('')
+  end
+
+  # Enumerizers
+
+  def object_type(type)
+    case type
+    when :letter_envelope
+      '001'
+    when :box
+      '002'
+    when :prism
+      '002'
+    when :cylinder
+      '003'
+    else
+      generate_exception('Object type not in list.')
+    end
+  end
+
+  def pricefier_object_type(type)
+    case type
+    when :letter_envelope
+      3
+    when :box
+      1
+    when :prism
+      1
+    when :cylinder
+      2
+    else
+      generate_exception('Object type not in list.')
+    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
+    else
+      generate_exception('Payment method not in list.')
+    end
+  end
+
+  def reverse_shipping_type(type)
+    case type
+    when :authorization
+      'A'
+    when :pickup
+      'C'
+    when :authorization_pickup
+      'CA'
+    else
+      generate_exception('Shipping type not in list.')
+    end
+  end
+
+  def ticket_type(type)
+    case type
+    when :authorization
+      'AP'
+    when :pickup
+      'LR'
+    else
+      generate_exception('Tickect type not in list.')
+    end
+  end
+
+  def reverse_shipping_service(service)
+    case service
+    when :pac
+      'LR'
+    when :sedex
+      'LS'
+    when :e_sedex
+      'LV'
+    else
+      service
+    end
+  end
+
+  def reverse_tracking_result_type(result_type)
+    case result_type
+    when :last_event
+      'U'
+    when :all_events
+      'H'
+    else
+      generate_exception('Tracking result type not in list.')
+    end
+  end
+
+  def tracking_query_type(query_type)
+    case query_type
+    when :list
+      'L'
+    when :range
+      'F'
+    else
+      generate_exception('Query type not in list.')
+    end
+  end
+
+  def tracking_result_type(result_type)
+    case result_type
+    when :last_event
+      'U'
+    when :all_events
+      'T'
+    else
+      generate_exception('Query type not in list.')
+    end
+  end
+
+  def tracking_language(language)
+    case language
+    when :portuguese
+      '101'
+    when :english
+      '102'
+    else
+      generate_exception('Language not in list.')
+    end
+  end
+
+  # Inverted enumerizers
+
+  def inverse_card_status(status)
+    case status
+    when 'Normal'
+      :ok
+    when 'Cancelado'
+      :canceled
+    end
+  end
+
+  def inverse_shipping_cancellation(status)
+    case status
+    when 'Registro gravado'
+      :ok
+    end
+  end
+
+  def inverse_payment_method(method)
+    case method
+    when '1'
+      :postal_vouncher
+    when '2'
+      :postal_refound
+    when '3'
+      :exchange_contract
+    when '4'
+      :credit_card
+    when '5'
+      :other
+    when nil
+      :to_bill
+    end
+  end
+
+  def inverse_object_type(type)
+    case type
+    when '1'
+      :letter_envelope
+    when '2'
+      :box_prism
+    when '3'
+      :cylinder
+    end
+  end
+
+  def inverse_service_availability(availability)
+    case availability.to_i
+    when 0, 11
+      :available
+    when -2, -3
+      :invalid_zip_code
+    when -33
+      :system_down
+    when -34, -35, 1
+      :incorrect_data
+    when -36, -37, -38
+      :unauthorized
+    when -888, 6, 7, 8, 9, 12
+      :unavailable
+    when 10
+      :partially_available
+    when 99
+      :error
+    end
+  end
+
+  def inverse_reverse_shipping_type(type)
+    case type
+    when 'A'
+      :authorization
+    when 'C'
+      :pickup
+    end
+  end
+
+  def inverse_tracking_event_status(event)
+    type = event['tipo'] || event[:tipo]
+    status = event['status'] || event[:status]
+    status = status.to_i
+
+    case type
+    when 'BDE', 'BDI', 'BDR'
+      case status
+      when 0, 1
+        :delivered
+      when 2
+        :not_delivered
+      when 4, 5, 6, 8, 10, 21, 22, 26, 33, 36, 40, 42, 48, 49, 56
+        :returning
+      when 7, 19, 25, 32, 38, 41, 45, 46, 47, 53, 57, 66, 69
+        :in_transit
+      when 9, 50, 51, 52
+        :stolen_lost
+      when 3, 12, 24
+        :awaiting_pick_up
+      when 20, 34, 35
+        :not_delivered
+      when 23
+        :returned
+      when 28, 37
+        :damaged
+      when 43
+        :arrested
+      when 54, 55, 58, 59
+        :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
+        :in_transit
+      end
+    when 'FC'
+      case status
+      when 1
+        :returning
+      when 2, 3, 5, 7
+        :in_transit
+      when 4
+        :not_delivered
+      end
+    when 'IDC'
+      case status
+      when 1, 2, 3, 4, 5, 6, 7
+        :stolen_lost
+      end
+    when 'LDI'
+      case status
+      when 0, 1, 2, 3, 14
+        :awaiting_pick_up
+      end
+    when 'OEC', 'LDE'
+      case status
+      when 0, 1, 9
+        :delivering
+      end
+    when 'PO', 'CO'
+      case status
+      when 0, 1, 9
+        :posted
+      end
+    end
+  end
+end