sigep_web 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12df3b443d893a1363a805d9d34c1fe16996dc9cf6cb9f6f46535d9191b9db22
-  data.tar.gz: e56fc299f3c1d6107cc3d751fc01be3101d6b123e0deb36ddf7e7befcbd27651
+  metadata.gz: b15f2b5e8823b2fa0e3ddcd82f81f69bc851aedf5e185fbfd1acc23d8889ed20
+  data.tar.gz: d5a55f1d63603da8d81f454f1b6bd740aff804e0206687b58b14fab68c19907a
 SHA512:
-  metadata.gz: 39397b656be869fd3e79209ac688ba567543c26075db8f9bbfd03c202e8ae07e48b7c6ba487ae874685c4a7ec29e3cc553a6778e87b625c4a7c20e654b8d9b0b
-  data.tar.gz: 6ca1802855b3cb22b562f7586258416580b1aaa63e914382e088205e3d768c04025dfe42be33098b3b0c01ed706e575fb4c1cae12c121de70347d524bb059b33
+  metadata.gz: ccd0a77f6254a8d9adc8987f88fe2c65fe4c35d77fa5ac882d409f2aadb7a9a29d47a73594497cb26d75a0b0ede4150c1442f492d35ee2c4e4fd6f8108872649
+  data.tar.gz: 1ba66ee5c968725d9e90e320de07f98db2e34fb9d6a8dfb4e3ab0d38508d1fdbde9b23767ffc9853f268d48272df57cb93b0fc24e58e50471cf92c43e50a9a1d

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: gha-workflow-test
+on: [push, pull_request]
+
+jobs:
+  gha-job-lint:
+    name: Lint
+    runs-on: ubuntu-18.04
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - name: Bundle
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Lint
+        run: bundle exec standardrb
+
+  # The test job is a matrix of ruby/rails versions.
+  gha-job-test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-18.04
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        run: bundle exec rspec
+
+      - name: Coverage
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -7,7 +7,7 @@
 
 ## About
 
-This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this [API documentation](http://www.corporativo.correios.com.br/encomendas/sigepweb/doc/Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf)
+This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this [API documentation](https://www2.correios.com.br/sistemas/encomendas/sigepweb/doc/Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf)
 
 ## Getting started
 

data/Rakefile

@@ -1,8 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-#RSpec::Core::RakeTask.new(:spec)
+# RSpec::Core::RakeTask.new(:spec)
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/lib/sigep_web/calculate_digit_checker.rb

@@ -11,20 +11,21 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:calcular_digito_verificador,
+      response = process(
+        :calcular_digito_verificador,
         usuario: authenticate.user,
         senha: authenticate.password,
         codAdministrativo: authenticate.administrative_code,
         numero: number
       ).to_hash[:calcular_digito_verificador_response][:return]
 
-      if response[:cod_erro] == '0'
-        { success: true, response: response }
+      if response[:cod_erro] == "0"
+        {success: true, response: response}
       else
-        { success: false, error: response }
+        {success: false, error: response}
       end
     rescue Savon::SOAPFault => exception
-      { success: false, error: exception.message }
+      {success: false, error: exception.message}
     end
 
     private

data/lib/sigep_web/configuration.rb

@@ -5,9 +5,11 @@ module SigepWeb
 
     def authenticate
       @authenticate ||=
-        Authenticate.new(user: user, password: password,
-                         administrative_code: administrative_code,
-                         contract: contract, card: card)
+        Authenticate.new(
+          user: user, password: password,
+          administrative_code: administrative_code,
+          contract: contract, card: card
+        )
     end
   end
 end

data/lib/sigep_web/generate_labels_digit_verifier.rb

@@ -11,15 +11,16 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:gera_digito_verificador_etiquetas,
+      response = process(
+        :gera_digito_verificador_etiquetas,
         etiquetas: labels,
         usuario: authenticate.user,
         senha: authenticate.password
       ).to_hash[:gera_digito_verificador_etiquetas_response][:return]
 
-      { success: true, response: response }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -27,4 +28,3 @@ module SigepWeb
     attr_reader :labels
   end
 end
-

data/lib/sigep_web/models/additional_service.rb

@@ -6,7 +6,7 @@ module SigepWeb
       attr_accessor :codes, :declareted_value
 
       def initialize(codes:, declareted_value:)
-        @codes            = codes
+        @codes = codes
         @declareted_value = declareted_value
       end
     end

data/lib/sigep_web/models/dimension_object.rb

@@ -7,12 +7,11 @@ module SigepWeb
 
       def initialize(object_type:, height:, width:, length:, diameter:)
         @object_type = object_type
-        @height      = height
-        @width       = width
-        @length      = length
-        @diameter    = diameter
+        @height = height
+        @width = width
+        @length = length
+        @diameter = diameter
       end
     end
   end
 end
-

data/lib/sigep_web/models/postal_object.rb

@@ -8,20 +8,19 @@ module SigepWeb
         :additional_service_codes, :additional_services_declared_value
 
       def initialize(label_number:, postage_code_service:, cubage:, weight:,
-                     receiver:, dimension_object:, processing_status:,
-                     additional_service_codes: nil,
-                     additional_services_declared_value: nil)
-        @label_number                       = label_number
-        @postage_code_service               = postage_code_service
-        @cubage                             = cubage
-        @weight                             = weight
-        @receiver                           = receiver
-        @dimension_object                   = dimension_object
-        @processing_status                  = processing_status
-        @additional_service_codes           = additional_service_codes
+        receiver:, dimension_object:, processing_status:,
+        additional_service_codes: nil, additional_services_declared_value: nil)
+
+        @label_number = label_number
+        @postage_code_service = postage_code_service
+        @cubage = cubage
+        @weight = weight
+        @receiver = receiver
+        @dimension_object = dimension_object
+        @processing_status = processing_status
+        @additional_service_codes = additional_service_codes
         @additional_services_declared_value = additional_services_declared_value
       end
     end
   end
 end
-

data/lib/sigep_web/models/receiver.rb

@@ -10,27 +10,26 @@ module SigepWeb
         :description_object, :amount
 
       def initialize(options = {})
-        @name               = options[:name]
-        @phone              = options[:phone]
-        @cellphone          = options[:cellphone]
-        @email              = options[:email]
-        @address            = options[:address]
-        @complement         = options[:complement]
-        @number             = options[:number]
-        @neighborhood       = options[:neighborhood]
-        @city               = options[:city]
-        @uf                 = options[:uf]
-        @cep                = options[:cep]
-        @user_postal_code   = options[:user_postal_code]
+        @name = options[:name]
+        @phone = options[:phone]
+        @cellphone = options[:cellphone]
+        @email = options[:email]
+        @address = options[:address]
+        @complement = options[:complement]
+        @number = options[:number]
+        @neighborhood = options[:neighborhood]
+        @city = options[:city]
+        @uf = options[:uf]
+        @cep = options[:cep]
+        @user_postal_code = options[:user_postal_code]
         @cost_center_client = options[:cost_center_client]
-        @invoice_number     = options[:invoice_number]
-        @invoice_serie      = options[:invoice_serie]
-        @invoice_value      = options[:invoice_value]
-        @invoice_nature     = options[:invoice_nature]
+        @invoice_number = options[:invoice_number]
+        @invoice_serie = options[:invoice_serie]
+        @invoice_value = options[:invoice_value]
+        @invoice_nature = options[:invoice_nature]
         @description_object = options[:description_object]
-        @amount             = options[:amount]
+        @amount = options[:amount]
       end
     end
   end
 end
-

data/lib/sigep_web/models/sender.rb

@@ -26,10 +26,10 @@ module SigepWeb
       end
 
       def to_xml
-        builder = Nokogiri::XML::Builder.new(encoding: 'ISO-8859-1') do |xml|
+        builder = Nokogiri::XML::Builder.new(encoding: "ISO-8859-1") do |xml|
           xml.correioslog do
-            xml.tipo_arquivo 'Postagem'
-            xml.versao_arquivo '2.3'
+            xml.tipo_arquivo "Postagem"
+            xml.versao_arquivo "2.3"
             plp_xml(xml)
             receiver_xml(xml)
             xml.forma_pagamento @payment_form
@@ -74,4 +74,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/postage_card_status.rb

@@ -11,16 +11,16 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:get_status_cartao_postagem,
+      response = process(
+        :get_status_cartao_postagem,
         numeroCartaoPostagem: @postage_number_card,
         usuario: authenticate.user,
         senha: authenticate.password
       ).to_hash[:get_status_cartao_postagem_response][:return]
 
-      { success: true, response: response }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
   end
 end
-

data/lib/sigep_web/request_labels.rb

@@ -4,9 +4,9 @@ module SigepWeb
   class RequestLabels < WebServiceInterfaceApi
     def initialize(receiver_type:, identifier:, id_service:, qt_labels:)
       @receiver_type = receiver_type
-      @identifier    = identifier
-      @id_service    = id_service
-      @qt_labels     = qt_labels
+      @identifier = identifier
+      @id_service = id_service
+      @qt_labels = qt_labels
 
       super()
     end
@@ -14,7 +14,8 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:solicita_etiquetas,
+      response = process(
+        :solicita_etiquetas,
         tipoDestinatario: receiver_type,
         identificador: identifier,
         idServico: id_service,
@@ -23,9 +24,9 @@ module SigepWeb
         senha: authenticate.password
       ).to_hash[:solicita_etiquetas_response][:return]
 
-      { success: true, response: build_label_array(response) }
+      {success: true, response: build_label_array(response)}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -34,20 +35,20 @@ module SigepWeb
 
     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
+      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
+      while number <= end_number
         use_number = number.to_s
 
         if use_number.size < 8
-          use_number = ('0' * (8 - use_number.size)) + use_number
+          use_number = ("0" * (8 - use_number.size)) + use_number
         end
 
-        label_array.push prefix + use_number + ' ' + suffix
+        label_array.push prefix + use_number + " " + suffix
         number += 1
       end
 
@@ -55,4 +56,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/request_plp_services.rb

@@ -13,7 +13,8 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:fecha_plp_varios_servicos,
+      response = process(
+        :fecha_plp_varios_servicos,
         xml: plp.to_xml,
         idPlpCliente: id_plp_client,
         cartaoPostagem: authenticate.card,
@@ -22,9 +23,9 @@ module SigepWeb
         senha: authenticate.password
       ).to_hash[:fecha_plp_varios_servicos_response][:return].to_s
 
-      { success: true, response: response }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -32,4 +33,3 @@ module SigepWeb
     attr_reader :plp, :id_plp_client, :labels
   end
 end
-

data/lib/sigep_web/request_range.rb

@@ -13,7 +13,8 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:solicitar_range,
+      response = process(
+        :solicitar_range,
         usuario: authenticate.user,
         senha: authenticate.password,
         codAdministrativo: authenticate.administrative_code,
@@ -23,13 +24,13 @@ module SigepWeb
         quantidade: quantity
       ).to_hash[:solicitar_range_response][:return]
 
-      if response[:cod_erro] == '0'
-        { success: true, response: response }
+      if response[:cod_erro] == "0"
+        {success: true, response: response}
       else
-        { success: false, error: response[:msg_erro] }
+        {success: false, error: response[:msg_erro]}
       end
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -37,4 +38,3 @@ module SigepWeb
     attr_reader :type, :service, :quantity
   end
 end
-

data/lib/sigep_web/request_xml_plp.rb

@@ -11,15 +11,16 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:solicita_xml_plp,
+      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 }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -27,4 +28,3 @@ module SigepWeb
     attr_reader :id_plp
   end
 end
-

data/lib/sigep_web/search_client.rb

@@ -3,7 +3,7 @@
 module SigepWeb
   class SearchClient < WebServiceInterfaceApi
     def initialize(id_contract:, id_post_card:)
-      @id_contract  = id_contract
+      @id_contract = id_contract
       @id_post_card = id_post_card
 
       super()
@@ -12,16 +12,17 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:busca_cliente,
+      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 }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private

data/lib/sigep_web/service_availability.rb

@@ -4,8 +4,8 @@ module SigepWeb
   class ServiceAvailability < WebServiceInterfaceApi
     def initialize(service_number:, source_zip:, target_zip:)
       @service_number = service_number
-      @source_zip     = source_zip
-      @target_zip     = target_zip
+      @source_zip = source_zip
+      @target_zip = target_zip
 
       super()
     end
@@ -13,7 +13,8 @@ module SigepWeb
     def request
       authenticate = SigepWeb.configuration.authenticate
 
-      response = process(:verifica_disponibilidade_servico,
+      response = process(
+        :verifica_disponibilidade_servico,
         codAdministrativo: authenticate.administrative_code,
         numeroServico: service_number,
         cepOrigem: source_zip,
@@ -22,9 +23,9 @@ module SigepWeb
         senha: authenticate.password
       ).to_hash[:verifica_disponibilidade_servico_response][:return]
 
-      { success: true, response: response }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private
@@ -32,4 +33,3 @@ module SigepWeb
     attr_reader :service_number, :source_zip, :target_zip
   end
 end
-

data/lib/sigep_web/version.rb

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

data/lib/sigep_web/web_service_interface_api.rb

@@ -7,21 +7,21 @@ module SigepWeb
     end
 
     def process(method, message)
-      @client.call(method, soap_action: '', message: message)
+      @client.call(method, soap_action: "", message: message)
     end
 
     private
 
     def url
       if test_env?
-        'https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+        "https://apphom.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl"
       else
-        'https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl'
+        "https://apps.correios.com.br/SigepMasterJPA/AtendeClienteService/AtendeCliente?wsdl"
       end
     end
 
     def test_env?
-      (defined?(Rails) && ENV['RAILS_ENV'] == 'test') || ENV['GEM_ENV'] == 'test'
+      (defined?(Rails) && ENV["RAILS_ENV"] == "test") || ENV["GEM_ENV"] == "test"
     end
   end
 end

data/lib/sigep_web/web_service_reverse_logistic_api.rb

@@ -10,16 +10,17 @@ module SigepWeb
     end
 
     def process(method, message)
-      @client.call(method, soap_action: '', message: message)
+      @client.call(method, soap_action: "", message: message)
     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

@@ -4,7 +4,7 @@ module SigepWeb
   module XML
     class AdditionalService
       def initialize(builder, additional_service)
-        @builder            = builder
+        @builder = builder
         @additional_service = additional_service
       end
 
@@ -24,4 +24,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/xml/dimension_object.rb

@@ -4,7 +4,7 @@ module SigepWeb
   module XML
     class DimensionObject
       def initialize(builder, dimension_object)
-        @builder          = builder
+        @builder = builder
         @dimension_object = dimension_object
       end
 
@@ -20,4 +20,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/xml/postal_object.rb

@@ -32,10 +32,8 @@ module SigepWeb
         @builder.servico_adicional do
           @builder.codigo_servico_adicional "025"
 
-          if postal_object.additional_service_codes
-            postal_object.additional_service_codes.each do |code|
-              @builder.codigo_servico_adicional code
-            end
+          postal_object.additional_service_codes&.each do |code|
+            @builder.codigo_servico_adicional code
           end
 
           @builder.valor_declarado postal_object.additional_services_declared_value
@@ -51,4 +49,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/xml/receiver.rb

@@ -37,4 +37,3 @@ module SigepWeb
     end
   end
 end
-

data/lib/sigep_web/zip_query.rb

@@ -13,9 +13,9 @@ module SigepWeb
         :consulta_cep, cep: zip
       ).to_hash[:consulta_cep_response][:return]
 
-      { success: true, response: response }
+      {success: true, response: response}
     rescue Savon::SOAPFault => e
-      { success: false, error: e.message }
+      {success: false, error: e.message}
     end
 
     private