correios_gem 1.4.0

data/lib/correios_gem.rb

@@ -0,0 +1,186 @@
+# Pricefier
+require_relative 'pricefier/requests/calculate_deadline'
+require_relative 'pricefier/requests/calculate_deadline_with_date'
+require_relative 'pricefier/requests/calculate_deadline_with_restrictions'
+require_relative 'pricefier/requests/calculate_price'
+require_relative 'pricefier/requests/calculate_price_deadline'
+require_relative 'pricefier/requests/calculate_price_deadline_with_date'
+require_relative 'pricefier/requests/calculate_price_deadline_with_restrictions'
+require_relative 'pricefier/requests/calculate_price_fac'
+require_relative 'pricefier/requests/calculate_price_with_date'
+require_relative 'pricefier/requests/list_services'
+require_relative 'pricefier/requests/list_services_star'
+
+# Reverse Logistics
+require_relative 'reverse_logistics/requests/calculate_ticket_number_check_digit'
+require_relative 'reverse_logistics/requests/cancel_shipping'
+require_relative 'reverse_logistics/requests/create_shippings'
+require_relative 'reverse_logistics/requests/create_shippings_with_collection'
+require_relative 'reverse_logistics/requests/request_ticket_numbers'
+require_relative 'reverse_logistics/requests/track_shipping'
+require_relative 'reverse_logistics/requests/track_shippings_by_date'
+
+# Sigep
+require_relative 'sigep/requests/cancel_shipping'
+require_relative 'sigep/requests/calculate_label_number_check_digit'
+require_relative 'sigep/requests/check_card_status'
+require_relative 'sigep/requests/check_service_availability'
+require_relative 'sigep/requests/create_shippings'
+require_relative 'sigep/requests/request_label_numbers'
+require_relative 'sigep/requests/request_shippings_xml'
+require_relative 'sigep/requests/search_available_additional_services'
+require_relative 'sigep/requests/search_customer'
+require_relative 'sigep/requests/search_zip_code'
+require_relative 'sigep/requests/track_shippings'
+
+# SRO
+require_relative 'SRO/requests/track_shippings'
+require_relative 'SRO/requests/track_shippings_list'
+
+require_relative 'credentials'
+
+module Correios
+  def self.test
+    'YAY! Correios_gem is working! Have fun!'
+  end
+
+  def self.authenticate
+    yield(credentials)
+  end
+
+  def self.credentials
+    @credentials ||= Credentials.new
+  end
+
+  module Pricefier
+    def self.calculate_deadline(data = {})
+      CalculateDeadline.new(data).request
+    end
+
+    def self.calculate_deadline_with_date(data = {})
+      CalculateDeadlineWithDate.new(data).request
+    end
+
+    def self.calculate_deadline_with_restrictions(data = {})
+      CalculateDeadlineWithRestrictions.new(data).request
+    end
+
+    def self.calculate_price(data = {})
+      CalculatePrice.new(data).request
+    end
+
+    def self.calculate_price_deadline(data = {})
+      CalculatePriceDeadline.new(data).request
+    end
+
+    def self.calculate_price_deadline_with_date(data = {})
+      CalculatePriceDeadlineWithDate.new(data).request
+    end
+
+    def self.calculate_price_deadline_with_restrictions(data = {})
+      CalculatePriceDeadlineWithRestrictions.new(data).request
+    end
+
+    def self.calculate_price_fac(data = {})
+      CalculatePriceFAC.new(data).request
+    end
+
+    def self.calculate_price_with_date(data = {})
+      CalculatePriceWithDate.new(data).request
+    end
+
+    def self.list_services(data = {})
+      ListServices.new(data).request
+    end
+
+    def self.list_services_star(data = {})
+      ListServicesSTAR.new(data).request
+    end
+  end
+
+  module ReverseLogistics
+    def self.calculate_ticket_number_check_digit(data = {})
+      CalculateTicketNumberCheckDigit.new(data).request
+    end
+
+    def self.cancel_shipping(data = {})
+      CancelShipping.new(data).request
+    end
+
+    def self.create_shippings(data = {})
+      CreateShippings.new(data).request
+    end
+
+    def self.create_shippings_with_collection(data = {})
+      CreateShippingsWithCollection.new(data).request
+    end
+
+    def self.request_ticket_numbers(data = {})
+      RequestTicketNumbers.new(data).request
+    end
+
+    def self.track_shipping(data = {})
+      TrackShipping.new(data).request
+    end
+
+    def self.track_shippings_by_date(data = {})
+      TrackShippingsByDate.new(data).request
+    end
+  end
+
+  module Sigep
+    def self.calculate_label_number_check_digit(data = {})
+      CalculateLabelNumberCheckDigit.new(data).request
+    end
+
+    def self.cancel_shipping(data = {})
+      CancelShipping.new(data).request
+    end
+
+    def self.check_card_status(data = {})
+      CheckCardStatus.new(data).request
+    end
+
+    def self.check_service_availability(data = {})
+      CheckServiceAvailability.new(data).request
+    end
+
+    def self.create_shippings(data = {})
+      CreateShippings.new(data).request
+    end
+
+    def self.request_label_numbers(data = {})
+      RequestLabelNumbers.new(data).request
+    end
+
+    def self.request_shippings_xml(data = {})
+      RequestShippingsXML.new(data).request
+    end
+
+    def self.search_available_additional_services(data = {})
+      SearchAvailableAdditionalServices.new(data).request
+    end
+
+    def self.search_customer(data = {})
+      SearchCustomer.new(data).request
+    end
+
+    def self.search_zip_code(data = {})
+      SearchZipCode.new(data).request
+    end
+
+    def self.track_shippings(data = {})
+      TrackShippings.new(data).request
+    end
+  end
+
+  module SRO
+    def self.track_shippings(data = {})
+      TrackShippings.new(data).request
+    end
+
+    def self.track_shippings_list(data = {})
+      TrackShippingsList.new(data).request
+    end
+  end
+end

data/lib/credentials.rb

@@ -0,0 +1,27 @@
+module Correios
+  class Credentials
+    attr_accessor :sigep_user,
+                  :sigep_password,
+                  :administrative_code,
+                  :contract,
+                  :card,
+                  :cnpj,
+                  :reverse_logistics_user,
+                  :reverse_logistics_password,
+                  :sro_user,
+                  :sro_password
+
+    def initialize
+      self.sigep_user =                 sigep_user
+      self.sigep_password =             sigep_password
+      self.administrative_code =        administrative_code
+      self.contract =                   contract
+      self.card =                       card
+      self.cnpj =                       cnpj
+      self.reverse_logistics_user =     reverse_logistics_user
+      self.reverse_logistics_password = reverse_logistics_password
+      self.sro_user =                   sro_user
+      self.sro_password =               sro_password
+    end
+  end
+end

data/lib/pricefier/client.rb

@@ -0,0 +1,20 @@
+require 'savon'
+
+module Correios
+  module Pricefier
+    class Client
+      def client
+        Savon.client(
+          wsdl: wsdl,
+          ssl_verify_mode: :none
+        )
+      end
+
+      private
+
+      def wsdl
+        'http://ws.correios.com.br/calculador/CalcPrecoPrazo.asmx?wsdl'
+      end
+    end
+  end
+end

data/lib/pricefier/helper.rb

@@ -0,0 +1,72 @@
+require 'date'
+
+module Correios
+  module Pricefier
+    class Helper
+      def namespaces
+        {
+          'xmlns:soap' => 'http://www.w3.org/2003/05/soap-envelope',
+          'xmlns:ns1' => 'http://tempuri.org/'
+        }
+      end
+
+      def calculate_deadline_date(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
+
+      def convert_string_to_date(date)
+        Date.strptime(date, '%d/%m/%Y')
+      end
+
+      def convert_date_to_string(date)
+        date.strftime('%d/%m/%Y')
+      end
+
+      def convert_string_to_bool(string)
+        string == 'S'
+      end
+
+      def convert_bool_to_string(bool)
+        return 'S' if bool
+        'N'
+      end
+
+      def convert_string_to_float(string)
+        string = string.tr(',', '.')
+        string.to_f
+      end
+
+      def object_type(type)
+        case type
+        when :letter_envelope
+          3
+        when :box
+          1
+        when :prism
+          1
+        when :cylinder
+          2
+        end
+      end
+
+      def format_service_codes(services)
+        services_string = ''
+        services.each do |service|
+          services_string += "#{service},"
+        end
+        services_string
+      end
+    end
+  end
+end

data/lib/pricefier/requests/calculate_deadline.rb

@@ -0,0 +1,100 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Pricefier
+    class CalculateDeadline < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        @service_codes = data[:service_codes]
+        @source_zip_code = data[:source_zip_code]
+        @target_zip_code = data[:target_zip_code]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:calc_prazo,
+                                             soap_action: 'http://tempuri.org/CalcPrazo',
+                                             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'].CalcPrazo do
+                xml.nCdServico HELPER.format_service_codes(@service_codes)
+                xml.sCepOrigem @source_zip_code
+                xml.sCepDestino @target_zip_code
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:calc_prazo_response][:calc_prazo_result]
+
+        services = response[:servicos][:c_servico]
+        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 [0, 10, 11].include?(service[:erro].to_i)
+          {
+            code: service[:codigo],
+            delivery_at_home: HELPER.convert_string_to_bool(
+              service[:entrega_domiciliar]
+            ),
+            delivery_on_saturdays: HELPER.convert_string_to_bool(
+              service[:entrega_sabado]
+            ),
+            note: service[:obs_fim],
+            deadline: {
+              days: service[:prazo_entrega].to_i,
+              date: HELPER.convert_string_to_date(
+                service[:data_max_entrega]
+              ),
+            }
+          }
+        else
+          {
+            code: service[:codigo],
+            error: {
+              code: service[:erro],
+              description: service[:msg_erro]
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/pricefier/requests/calculate_deadline_with_date.rb

@@ -0,0 +1,102 @@
+require 'savon'
+require 'nokogiri'
+
+require_relative '../client'
+require_relative '../helper'
+require_relative '../../correios_exception.rb'
+
+module Correios
+  module Pricefier
+    class CalculateDeadlineWithDate < CorreiosException
+      HELPER = Helper.new
+      CLIENT = Client.new
+
+      def initialize(data = {})
+        @show_request = data[:show_request]
+        @service_codes = data[:service_codes]
+        @source_zip_code = data[:source_zip_code]
+        @target_zip_code = data[:target_zip_code]
+        @reference_date = data[:reference_date]
+        super()
+      end
+
+      def request
+        puts xml if @show_request == true
+        begin
+          format_response(CLIENT.client.call(:calc_prazo_data,
+                                             soap_action: 'http://tempuri.org/CalcPrazoData',
+                                             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'].CalcPrazoData do
+                xml.nCdServico HELPER.format_service_codes(@service_codes)
+                xml.sCepOrigem @source_zip_code
+                xml.sCepDestino @target_zip_code
+                xml.sDtCalculo HELPER.convert_date_to_string(@reference_date)
+              end
+            end
+          end
+        end.doc.root.to_xml
+      end
+
+      def format_response(response)
+        response = response[:calc_prazo_data_response][:calc_prazo_data_result]
+
+        services = response[:servicos][:c_servico]
+        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 [0, 10, 11].include?(service[:erro].to_i)
+          {
+            code: service[:codigo],
+            delivery_at_home: HELPER.convert_string_to_bool(
+              service[:entrega_domiciliar]
+            ),
+            delivery_on_saturdays: HELPER.convert_string_to_bool(
+              service[:entrega_sabado]
+            ),
+            note: service[:obs_fim],
+            deadline: {
+              days: service[:prazo_entrega].to_i,
+              date: HELPER.convert_string_to_date(
+                service[:data_max_entrega]
+              )
+            }
+          }
+        else
+          {
+            code: service[:codigo],
+            error: {
+              code: service[:erro],
+              description: service[:msg_erro]
+            }
+          }
+        end
+      end
+    end
+  end
+end