sigep_web 0.2.7 → 1.0.0

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]
-
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
+      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]
+
+      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]
-
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      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 => e
+      { success: false, error: e.message }
     end
+
+    private
+
+    attr_reader :id_plp
   end
 end
+

data/lib/sigep_web/search_client.rb

@@ -1,31 +1,31 @@
+# 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]
-
-        {
-          success: true,
-          response: response
-        }
-      rescue Savon::SOAPFault => msg
-        {
-          success: false,
-          error: msg
-        }
-      end
+      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 => 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.7'
+  VERSION = '1.0.0'
 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)

data/lib/sigep_web/web_service_reverse_logistic_api.rb

@@ -1,14 +1,16 @@
+# 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)
-      @client.call(method, soap_action: "", message: message)
+      @client.call(method, soap_action: '', message: message)
     end
 
     private

data/lib/sigep_web/xml/additional_service.rb

@@ -0,0 +1,27 @@
+# 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module SigepWeb
   module XML
     class DimensionObject
@@ -18,3 +20,4 @@ module SigepWeb
     end
   end
 end
+

data/lib/sigep_web/xml/postal_object.rb

@@ -0,0 +1,54 @@
+# 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"
+
+          if postal_object.additional_service_codes
+            postal_object.additional_service_codes.each do |code|
+              @builder.codigo_servico_adicional code
+            end
+          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
@@ -35,3 +37,4 @@ module SigepWeb
     end
   end
 end
+

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/sigep_web.gemspec

@@ -14,20 +14,29 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/marceloperini/sigep_web'
   spec.license       = 'MIT'
 
-  spec.rubyforge_project = 'sigep_web'
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'savon', '~> 2.10', '>= 2.10.0'
-  spec.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  # Ruby 2.4 reaches EoL at the end of March of 2020
+  # https://www.ruby-lang.org/en/news/2019/10/02/ruby-2-4-9-released/
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency 'savon', '~> 2.10'
+  spec.add_dependency 'nokogiri', '>= 1.10.8'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15.1'
-  spec.add_development_dependency 'coveralls', '~> 0.8.21'
-  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency 'rake', '>= 2.0.8'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rspec-json_expectations', '~> 2.2'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.7.0'
+  spec.add_development_dependency 'vcr', '~> 5.1'
+  spec.add_development_dependency 'webmock', '~> 3.8', '>= 3.8.3'
+  spec.add_development_dependency 'rubocop', '~> 0.80.0'
+  spec.add_development_dependency "rubocop-performance", "~> 1.4"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.35"
+  spec.add_development_dependency 'pry'
 end