sigep_web 0.2.6.3 → 1.0.1

data/lib/sigep_web/request_labels.rb

@@ -1,58 +1,58 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class RequestLabels < WebServiceInterfaceApi
-    def initialize(options = {})
-      @receiver_type = options[:receiver_type]
-      @identifier    = options[:identifier]
-      @id_service    = options[:id_service]
-      @qt_labels     = options[:qt_labels]
+    def initialize(receiver_type:, identifier:, id_service:, qt_labels:)
+      @receiver_type = receiver_type
+      @identifier = identifier
+      @id_service = id_service
+      @qt_labels = qt_labels
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
-      begin
-        response = process(:solicita_etiquetas, {
-          tipoDestinatario: @receiver_type,
-          identificador: @identifier,
-          idServico: @id_service,
-          qtdEtiquetas: @qt_labels,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:solicita_etiquetas_response][:return]
-
-        {
-          success: true,
-          response: build_label_array(response)
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+
+      response = process(
+        :solicita_etiquetas,
+        tipoDestinatario: receiver_type,
+        identificador: identifier,
+        idServico: id_service,
+        qtdEtiquetas: qt_labels,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:solicita_etiquetas_response][:return]
+
+      {success: true, response: build_label_array(response)}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
 
     private
-      def build_label_array(label_range)
-        label_array = []
-        start_label, end_label = label_range.split(',')
-        prefix = start_label[0,2]
-        suffix = start_label[11,12]
-        number = start_label[2,8].to_i
-        end_number = end_label[2,8].to_i
-
-        while number <= end_number do
-          use_number = number.to_s
-
-          if use_number.size < 8
-            use_number = ('0' * (8 - use_number.size)) + use_number
-          end
-
-          label_array.push prefix + use_number + ' ' + suffix
-          number += 1
+
+    attr_reader :receiver_type, :identifier, :id_service, :qt_labels
+
+    def build_label_array(label_range)
+      label_array = []
+      start_label, end_label = label_range.split(",")
+      prefix = start_label[0, 2]
+      suffix = start_label[11, 12]
+      number = start_label[2, 8].to_i
+      end_number = end_label[2, 8].to_i
+
+      while number <= end_number
+        use_number = number.to_s
+
+        if use_number.size < 8
+          use_number = ("0" * (8 - use_number.size)) + use_number
         end
 
-        label_array
+        label_array.push prefix + use_number + " " + suffix
+        number += 1
       end
+
+      label_array
+    end
   end
 end

data/lib/sigep_web/request_plp_services.rb

@@ -1,35 +1,35 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class RequestPlpServices < WebServiceInterfaceApi
-    def initialize(options = {})
-      @plp = options[:plp]
-      @id_plp_client = options[:id_plp_client]
-      #@post_card = options[:post_card]
-      @labels = options[:labels]
+    def initialize(plp:, id_plp_client:, labels:)
+      @plp = plp
+      @id_plp_client = id_plp_client
+      @labels = labels
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
-      begin
-        response = process(:fecha_plp_varios_servicos, {
-          xml: @plp.to_xml,
-          idPlpCliente: @id_plp_client,
-          cartaoPostagem: authenticate.card,
-          listaEtiquetas: @labels,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:fecha_plp_varios_servicos_response][:return].to_s
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      response = process(
+        :fecha_plp_varios_servicos,
+        xml: plp.to_xml,
+        idPlpCliente: id_plp_client,
+        cartaoPostagem: authenticate.card,
+        listaEtiquetas: labels,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:fecha_plp_varios_servicos_response][:return].to_s
+
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :plp, :id_plp_client, :labels
   end
 end

data/lib/sigep_web/request_range.rb

@@ -1,36 +1,40 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class RequestRange < WebServiceReverseLogisticApi
-    def initialize(options = {})
-      @type = options[:type]
-      @service = options[:service]
-      @quantity = options[:quantity]
+    def initialize(type:, service:, quantity:)
+      @type = type
+      @service = service
+      @quantity = quantity
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      begin
-        response = process(:solicitar_range, {
-          usuario: authenticate.user,
-          senha: authenticate.password,
-          codAdministrativo: authenticate.administrative_code,
-          contrato: authenticate.contract,
-          tipo: @type,
-          servico: @service,
-          quantidade: @quantity
-        }).to_hash[:solicitar_range_response][:return]
+      response = process(
+        :solicitar_range,
+        usuario: authenticate.user,
+        senha: authenticate.password,
+        codAdministrativo: authenticate.administrative_code,
+        contrato: authenticate.contract,
+        tipo: type,
+        servico: service,
+        quantidade: quantity
+      ).to_hash[:solicitar_range_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
+      if response[:cod_erro] == "0"
+        {success: true, response: response}
+      else
+        {success: false, error: response[:msg_erro]}
       end
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :type, :service, :quantity
   end
 end

data/lib/sigep_web/request_xml_plp.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class RequestXmlPlp < WebServiceInterfaceApi
-    def initialize(options = {})
-      @id_plp   = options[:id_plp]
+    def initialize(id_plp:)
+      @id_plp = id_plp
 
       super()
     end
@@ -9,23 +11,20 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      begin
-        response = process(:solicita_xml_plp, {
-          idPlpMaster: @id_plp,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:solicita_xml_plp_response][:return]
+      response = process(
+        :solicita_xml_plp,
+        idPlpMaster: id_plp,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:solicita_xml_plp_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :id_plp
   end
 end

data/lib/sigep_web/search_client.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class SearchClient < WebServiceInterfaceApi
-    def initialize(options = {})
-      @id_contract = options[:id_contract]
-      @id_post_card = options[:id_post_card]
+    def initialize(id_contract:, id_post_card:)
+      @id_contract = id_contract
+      @id_post_card = id_post_card
+
       super()
     end
 
     def request
       authenticate = SigepWeb.configuration.authenticate
-      begin
-        response = process(:busca_cliente, {
-          idContrato: @id_contract,
-          idCartaoPostagem: @id_post_card,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:busca_cliente_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      response = process(
+        :busca_cliente,
+        idContrato: id_contract,
+        idCartaoPostagem: id_post_card,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:busca_cliente_response][:return]
+
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :id_contract, :id_post_card
   end
 end

data/lib/sigep_web/service_availability.rb

@@ -1,34 +1,35 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class ServiceAvailability < WebServiceInterfaceApi
-    def initialize(options = {})
-      @service_number = options[:service_number]
-      @source_zip     = options[:source_zip]
-      @target_zip     = options[:target_zip]
+    def initialize(service_number:, source_zip:, target_zip:)
+      @service_number = service_number
+      @source_zip = source_zip
+      @target_zip = target_zip
+
       super()
     end
 
     def request
-      begin
-        authenticate = SigepWeb.configuration.authenticate
-        response = process(:verifica_disponibilidade_servico, {
-          codAdministrativo: authenticate.administrative_code,
-          numeroServico: @service_number,
-          cepOrigem: @source_zip,
-          cepDestino: @target_zip,
-          usuario: authenticate.user,
-          senha: authenticate.password
-        }).to_hash[:verifica_disponibilidade_servico_response][:return]
+      authenticate = SigepWeb.configuration.authenticate
+
+      response = process(
+        :verifica_disponibilidade_servico,
+        codAdministrativo: authenticate.administrative_code,
+        numeroServico: service_number,
+        cepOrigem: source_zip,
+        cepDestino: target_zip,
+        usuario: authenticate.user,
+        senha: authenticate.password
+      ).to_hash[:verifica_disponibilidade_servico_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :service_number, :source_zip, :target_zip
   end
 end

data/lib/sigep_web/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SigepWeb
-  VERSION = '0.2.6.3'
+  VERSION = "1.0.1"
 end

data/lib/sigep_web/web_service_interface_api.rb

@@ -1,10 +1,9 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class WebServiceInterfaceApi
-    def initialize
-      @client = Savon.client({
-        wsdl: url,
-        ssl_verify_mode: :none
-      })
+    def initialize(default_transfer = Savon)
+      @client = default_transfer.client(wsdl: url, ssl_verify_mode: :none)
     end
 
     def process(method, message)
@@ -12,12 +11,17 @@ module SigepWeb
     end
 
     private
-      def url
-        if ENV['GEM_ENV'] == 'test'
-          'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
-        else
-          'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
-        end
+
+    def url
+      if test_env?
+        "https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl"
+      else
+        "https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl"
       end
+    end
+
+    def test_env?
+      (defined?(Rails) && ENV["RAILS_ENV"] == "test") || ENV["GEM_ENV"] == "test"
+    end
   end
 end

data/lib/sigep_web/web_service_reverse_logistic_api.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class WebServiceReverseLogisticApi
     def initialize
-      @client = Savon.client({
+      @client = Savon.client(
         wsdl: url,
         ssl_verify_mode: :none
-      })
+      )
     end
 
     def process(method, message)
@@ -12,12 +14,13 @@ module SigepWeb
     end
 
     private
-      def url
-        if ENV['GEM_ENV'] == 'test'
-          'http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl'
-        else
-          'http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl'
-        end
+
+    def url
+      if ENV["GEM_ENV"] == "test"
+        "http://webservicescolhomologacao.correios.com.br/ScolWeb/WebServiceScol?wsdl"
+      else
+        "http://webservicescol.correios.com.br/ScolWeb/WebServiceScol?wsdl"
       end
+    end
   end
 end

data/lib/sigep_web/xml/additional_service.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module XML
+    class AdditionalService
+      def initialize(builder, additional_service)
+        @builder = builder
+        @additional_service = additional_service
+      end
+
+      def build_xml
+        @builder.servico_adicional do
+          if @additional_service
+            @additional_service.codes.each do |code|
+              @builder.codigo_servico_adicional code
+            end
+
+            @builder.codigo_servico_adicional "025"
+
+            @builder.valor_declarado @additional_service.declareted_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sigep_web/{XML → xml}/dimension_object.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module SigepWeb
   module XML
     class DimensionObject
       def initialize(builder, dimension_object)
-        @builder          = builder
+        @builder = builder
         @dimension_object = dimension_object
       end
 

data/lib/sigep_web/xml/postal_object.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SigepWeb
+  module XML
+    class PostalObject
+      def initialize(builder, postal_objects = [])
+        @builder = builder
+        @postal_objects = postal_objects
+      end
+
+      def build_xml
+        @postal_objects.each do |postal_object|
+          @builder.objeto_postal do
+            build_object(postal_object)
+          end
+        end
+      end
+
+      private
+
+      def build_object(postal_object)
+        @builder.numero_etiqueta postal_object.label_number
+        @builder.codigo_objeto_cliente
+        @builder.codigo_servico_postagem postal_object.postage_code_service
+        @builder.cubagem postal_object.cubage
+        @builder.peso postal_object.weight
+        @builder.rt1
+        @builder.rt2
+
+        XML::Receiver.new(@builder, postal_object.receiver).build_xml
+
+        @builder.servico_adicional do
+          @builder.codigo_servico_adicional "025"
+
+          postal_object.additional_service_codes&.each do |code|
+            @builder.codigo_servico_adicional code
+          end
+
+          @builder.valor_declarado postal_object.additional_services_declared_value
+        end
+
+        XML::DimensionObject.new(@builder, postal_object.dimension_object).build_xml
+
+        @builder.data_postagem_sara
+        @builder.status_processamento postal_object.processing_status
+        @builder.numero_comprovante_postagem
+        @builder.valor_cobrado
+      end
+    end
+  end
+end

data/lib/sigep_web/{XML → xml}/receiver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SigepWeb
   module XML
     class Receiver

data/lib/sigep_web/zip_query.rb

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 module SigepWeb
   class ZipQuery < WebServiceInterfaceApi
-    def initialize(options = {})
-      @zip = options[:zip]
+    def initialize(zip:)
+      @zip = zip
+
       super()
     end
 
     def request
-      begin
-        response = process(:consulta_cep, {
-          cep: @zip
-        }).to_hash[:consulta_cep_response][:return]
+      response = process(
+        :consulta_cep, cep: zip
+      ).to_hash[:consulta_cep_response][:return]
 
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      {success: true, response: response}
+    rescue Savon::SOAPFault => e
+      {success: false, error: e.message}
     end
+
+    private
+
+    attr_reader :zip
   end
 end

data/lib/sigep_web.rb

@@ -1,29 +1,29 @@
-require 'sigep_web/version'
-require 'sigep_web/configuration'
-require 'sigep_web/web_service_interface_api'
-require 'sigep_web/web_service_reverse_logistic_api'
-require 'sigep_web/authenticate'
-require 'sigep_web/XML/postal_object'
-require 'sigep_web/XML/receiver'
-require 'sigep_web/XML/additional_service'
-require 'sigep_web/XML/dimension_object'
-require 'sigep_web/Models/sender'
-require 'sigep_web/Models/postal_object'
-require 'sigep_web/Models/receiver'
-require 'sigep_web/Models/additional_service'
-require 'sigep_web/Models/dimension_object'
-require 'sigep_web/service_availability'
-require 'sigep_web/search_client'
-require 'sigep_web/zip_query'
-require 'sigep_web/request_labels'
-require 'sigep_web/generate_labels_digit_verifier'
-require 'sigep_web/request_plp_services'
-require 'sigep_web/postage_card_status'
-require 'sigep_web/request_xml_plp'
-require 'sigep_web/request_range'
-require 'sigep_web/calculate_digit_checker'
-require 'savon'
-require 'nokogiri'
+require "sigep_web/version"
+require "sigep_web/configuration"
+require "sigep_web/web_service_interface_api"
+require "sigep_web/web_service_reverse_logistic_api"
+require "sigep_web/authenticate"
+require "sigep_web/xml/postal_object"
+require "sigep_web/xml/receiver"
+require "sigep_web/xml/additional_service"
+require "sigep_web/xml/dimension_object"
+require "sigep_web/models/sender"
+require "sigep_web/models/postal_object"
+require "sigep_web/models/receiver"
+require "sigep_web/models/additional_service"
+require "sigep_web/models/dimension_object"
+require "sigep_web/service_availability"
+require "sigep_web/search_client"
+require "sigep_web/zip_query"
+require "sigep_web/request_labels"
+require "sigep_web/generate_labels_digit_verifier"
+require "sigep_web/request_plp_services"
+require "sigep_web/postage_card_status"
+require "sigep_web/request_xml_plp"
+require "sigep_web/request_range"
+require "sigep_web/calculate_digit_checker"
+require "savon"
+require "nokogiri"
 
 module SigepWeb
   def self.configure