zaig 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99e8d4eed3c1a4bbc45134a8aff616695b0a0fd7e4c9d9819788a3f13c96ba87
-  data.tar.gz: 6a93abf41c8287aac05c195c7d77300b63bcb17174132fc3fb5b4e6b668cc06a
+  metadata.gz: 4d7e5e123adff444d932edaf15cf93f0d56c036e19a12391957736cdb5b3a0f1
+  data.tar.gz: 6dff02d64d11a052be1a9dc47f77b6a490d3208b1de8b84d487527259099e546
 SHA512:
-  metadata.gz: 95f18c8313813486b95bb353ae378a982420ed45789114c05167608fe15e263022b6ab1ecf4fdb2b837d220a8c133714a69f7c6ca512283a01f67609e60a1c60
-  data.tar.gz: b15e3c9ee02b971ec249f7368ace43d8b67a2ecb0b0af4558e7e14cc3b69d2ea71ecf614cb8a9cbdb7c4073039727368923fced0141ce258707c81d37064b99c
+  metadata.gz: 06ea034e23aef7a39e5dd7fe35260746b31d8095ce9f524bb45f60b02b92d6285fe24bd305e43c1f24b49b3d0cb9e61777d6612430741bc49de0f384c88d6f7f
+  data.tar.gz: f637d5ab308c48793bda590598a41fdff30d8103f395c03cfaf38e87eba2446b4ef77cfe30d3020d174f397e10990802477865559610d80859d4f14f6382bad8

data/lib/locales/en.yml

@@ -2,5 +2,6 @@ en:
   name: Zaig
   zaig:
     errors:
+      validation_error: An validation error was got
       field_not_found: Field not found in the server response '{field_name}'
       unexpected_error: Integration returned an unexpected status code

data/lib/locales/pt-BR.yml

@@ -2,5 +2,6 @@
   name: Zaig
   zaig:
     errors:
+      validation_error: Houve um problema na validação dos campos
       field_not_found: Campo não encontrado na resposta do servidor '{field_name}'
       unexpected_error: Integração retornou um estado inesperado

data/lib/zaig/entities/response.rb

@@ -7,9 +7,18 @@ module Zaig
       attr_reader :analysis_status, :credit_proposal_legal_person_key, :message,
                   :raw_data, :reason, :request, :status_code, :zaig_id
 
+      # Collection with all the approval statuses.
+      APPROVAL_STATUS = %i[automatically_approved manually_approved].freeze
+
+      # Collection with all the pending statuses.
+      PENDING_STATUS = %i[pending in_manual_analysis in_manual_analysis].freeze
+
+      # Colllection with all the reproval statuses.
+      REPROVAL_STATUS = %i[automatically_reproved manually_reproved].freeze
+
       def initialize(analysis_status: nil, credit_proposal_legal_person_key: nil, message: nil,
                      raw_data: nil, reason: nil, request: nil, status_code: nil, zaig_id: nil)
-        @analysis_status = analysis_status
+        @analysis_status = analysis_status.nil? ? nil : analysis_status.to_s.strip.downcase.to_sym
         @credit_proposal_legal_person_key = credit_proposal_legal_person_key
         @message = message
         @raw_data = raw_data
@@ -19,9 +28,27 @@ module Zaig
         @zaig_id = zaig_id
       end
 
+      # Retrieve all the available statuses.
+      def self.statuses
+        %i[automatically_approved automatically_reproved in_manual_analysis manually_approved manually_reproved waiting_for_data pending]
+      end
+
+      # Check if the registration is approved.
       def approved?
-        analysis_status == "automatically_approved"
+        APPROVAL_STATUS.include?(analysis_status)
       end
+
+      # Check if the registration still not done.
+      def pending?
+        PENDING_STATUS.include?(analysis_status)
+      end
+
+      # Check if the registration is reproved.
+      def rejected?
+        REPROVAL_STATUS.include?(analysis_status)
+      end
+
+      alias not_approved? rejected?
     end
   end
 end

data/lib/zaig/field_validation_error.rb

@@ -2,5 +2,6 @@
 
 module Zaig
   class FieldValidationError < BaseError
+    attr_accessor :detail
   end
 end

data/lib/zaig/registration.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "singleton"
-
 module Zaig
   # Class to request a registration to the remote server.
   class Registration
@@ -45,11 +43,18 @@ module Zaig
       def verify_response(res)
         return if res.status.between?(200, 299)
 
-        raise ::Zaig::UnexpectedError, I18n.t("zaig.errors.unexpected_error") if res.status != 500
+        raise ::Zaig::ServerError, I18n.t("zaig.errors.unexpected_error") if res.status.between?(500, 599)
 
         parsed_res = JSON.parse(res.body, symbolize_names: true)
 
-        raise ::Zaig::ServerError, I18n.t("zaig.errors.field_not_found", field_name: "resposta_zaig") unless parsed_res.key?(:resposta_zaig)
+        unless parsed_res.key?(:resposta_zaig)
+          detail = JSON.parse(res.body, symbolize_names: true)[:detail]
+
+          error = ::Zaig::FieldValidationError.new I18n.t("zaig.errors.validation_error", field_name: "resposta_zaig")
+          error.detail = JSON.parse(res.body, symbolize_names: true)[:detail]
+
+          raise error
+        end
 
         zaig_msg = parsed_res[:resposta_zaig][:msg]
         zaig_http_status = parsed_res[:resposta_zaig][:status]
@@ -59,12 +64,12 @@ module Zaig
 
       def raise_error_by_zaig_status(msg, status)
         case status
-        when 209
-          raise ::Zaig::AlreadyExistsError, msg
         when 400
           raise ::Zaig::FieldValidationError, msg
         when 408
           raise ::Zaig::ExternalTimeoutError, msg
+        when 409
+          raise ::Zaig::AlreadyExistsError, msg
         when 422
           raise ::Zaig::UnprocessableEntityError, msg
         else

data/lib/zaig/registration_payload.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "singleton"
-
 module Zaig
   # Service class to build a registration payload request.
   class RegistrationPayload
@@ -9,48 +7,52 @@ module Zaig
 
     def call(obj)
       {
-        address: build_address(obj["address"]),
-        client_category: obj["client_category"],
-        constitution_date: obj["constitution_date"],
-        constitution_type: obj["constitution_type"],
-        credit_request_date: obj["credit_request_date"],
-        credit_type: obj["credit_type"] || "clean",
-        document_number: CNPJ.new(obj["document_number"]).number,
-        email: obj["email"],
-        financial: obj.key?("financial") ? build_financial(obj["financial"]) : nil,
-        guarantors: obj.key?("guarantors") ? build_shareholders(obj["guarantors"]) : nil,
-        id: obj["id"],
-        legal_name: obj["legal_name"],
-        monthly_revenue: obj["monthly_revenue"].to_f,
-        phones: build_phones(obj["phones"]),
-        shareholders: build_shareholders(obj["shareholders"]),
-        source: obj.key?("source") ? build_source(obj["source"]) : nil,
-        scr_parameters: obj.key?("scr_parameters") ? build_scr_parameters(obj["scr_parameters"]) : nil,
-        trading_name: obj["trading_name"],
-        warrants: obj.key?("warrants") ? build_warrants(obj["warrants"]) : nil
+        address: build_address(obj[:address]),
+        client_category: obj[:client_category],
+        constitution_date: obj[:constitution_date],
+        constitution_type: obj[:constitution_type],
+        credit_request_date: obj[:credit_request_date],
+        credit_type: obj[:credit_type] || "clean",
+        document_number: CNPJ.new(obj[:document_number]).formatted,
+        email: obj[:email],
+        financial: obj.key?("financial") ? build_financial(obj[:financial]) : nil,
+        guarantors: obj.key?("guarantors") ? build_shareholders(obj[:guarantors]) : nil,
+        id: obj[:id],
+        legal_name: obj[:legal_name],
+        monthly_revenue: format_money(obj[:monthly_revenue], require_positive: true),
+        phones: build_phones(obj[:phones]),
+        shareholders: build_shareholders(obj[:shareholders]),
+        source: obj.key?("source") ? build_source(obj[:source]) : nil,
+        scr_parameters: obj.key?("scr_parameters") ? build_scr_parameters(obj[:scr_parameters]) : nil,
+        trading_name: obj[:trading_name],
+        warrants: obj.key?("warrants") ? build_warrants(obj[:warrants]) : nil
       }
     end
 
     private
+      def format_money(value, require_positive: false)
+        require_positive && !value.to_f.positive? ? 1.0 : value.to_f
+      end
+
       def build_address(obj_address)
         {
-          city: obj_address["city"],
-          complement: obj_address["complement"] || "",
-          country: obj_address["country"] || "BRA",
-          neighborhood: obj_address["neighborhood"],
-          number: obj_address["number"],
-          postal_code: obj_address["postal_code"],
-          street: obj_address["street"],
-          uf: obj_address["uf"]
+          city: obj_address[:city],
+          complement: obj_address[:complement] || "",
+          country: obj_address[:country] || "BRA",
+          neighborhood: obj_address[:neighborhood],
+          number: obj_address[:number],
+          postal_code: format_cep(obj_address[:postal_code]),
+          street: obj_address[:street],
+          uf: obj_address[:uf]
         }
       end
 
       def build_phone(obj)
         {
-          area_code: obj["area_code"],
-          international_dial_code: obj["international_dial_code"],
-          number: obj["number"],
-          type: obj["type"]
+          area_code: obj[:area_code],
+          international_dial_code: obj[:international_dial_code],
+          number: obj[:number],
+          type: obj[:type]
         }
       end
 
@@ -63,88 +65,104 @@ module Zaig
       end
 
       def build_shareholders(obj_shareholders)
+        return nil if obj_shareholders.nil?
+
         shareholders = []
 
         obj_shareholders.each do |s|
           shareholders << {
-            address: build_address(s["address"]),
-            birthdate: Date.parse(s["birthdate"]).to_s,
-            declared_assets: s["declared_assets"],
-            document_number: CPF.new(s["document_number"]).number,
-            email: s["email"],
-            father_name: s["father_name"],
-            gender: s["gender"],
-            monthly_income: s["monthly_income"].to_f,
-            mother_name: s["mother_name"],
-            name: s["name"],
-            nationality: s["nationality"],
-            occupation: s["occupation"],
-            phones: build_phones(s["phones"])
+            address: build_address(s[:address]),
+            birthdate: s[:birthdate],
+            declared_assets: format_money(s[:declared_assets]),
+            document_number: CPF.new(s[:document_number]).formatted,
+            email: s[:email],
+            father_name: s[:father_name],
+            gender: s[:gender],
+            monthly_income: format_money(s[:monthly_income]),
+            mother_name: s[:mother_name],
+            name: s[:name],
+            nationality: s[:nationality],
+            occupation: s[:occupation],
+            phones: build_phones(s[:phones])
           }
         end
         shareholders
       end
 
       def build_financial(fin)
+        return nil if fin.nil?
+
         {
-          amount: fin["amount"],
-          annual_interest_rate: fin["annual_interest_rate"],
-          cdi_percentage: fin["cdi_percentage"],
-          currency: fin["currency"] || "BRL",
-          interest_type: fin["interest_type"],
-          number_of_installments: fin.key?("number_of_installments") ? fin["number_of_installments"].to_i : 0
+          amount: fin[:amount],
+          annual_interest_rate: fin[:annual_interest_rate],
+          cdi_percentage: fin[:cdi_percentage],
+          currency: fin[:currency] || "BRL",
+          interest_type: fin[:interest_type],
+          number_of_installments: fin.key?("number_of_installments") ? fin[:number_of_installments].to_i : 0
         }
       end
 
       def build_warrants(obj_warrants)
+        return nil if obj_warrants.nil?
+
         warrants = []
 
         obj_warrants.each do |w|
           warrants << {
-            warrant_type: w["warrant_type"],
-            address: build_address(w["address"]),
-            property_type: w["property_type"],
-            estimated_value: w["estimated_value"],
-            forced_selling_value: w["forced_selling_value"]
+            warrant_type: w[:warrant_type],
+            address: build_address(w[:address]),
+            property_type: w[:property_type],
+            estimated_value: w[:estimated_value],
+            forced_selling_value: w[:forced_selling_value]
           }
         end
         warrants
       end
 
       def build_source(obj_source)
+        return nil if obj_source.nil?
+
         {
-          channel: obj_source["channel"],
-          ip: obj_source["ip"],
-          session_id: obj_source["session_id"]
+          channel: obj_source[:channel],
+          ip: obj_source[:ip],
+          session_id: obj_source[:session_id]
         }
       end
 
       def build_scr_parameters(obj_src)
+        return nil if obj_src.nil?
+
         {
-          signers: build_signers(obj_src["signers"]),
+          signers: build_signers(obj_src[:signers]),
           signature_evidence: {
-            access_token: obj_src["signature_evidence"]["access_token"],
-            additional_data: obj_src["signature_evidence"]["additional_data"],
-            ip_address: obj_src["signature_evidence"]["ip_address"],
-            session_id: obj_src["signature_evidence"]["session_id"],
+            access_token: obj_src[:signature_evidence][:access_token],
+            additional_data: obj_src[:signature_evidence][:additional_data],
+            ip_address: obj_src[:signature_evidence][:ip_address],
+            session_id: obj_src[:signature_evidence][:session_id],
             signed_term: {
-              raw_text: obj_src["signature_evidence"]["signed_term"]["raw_text"]
+              raw_text: obj_src[:signature_evidence][:signed_term][:raw_text]
             }
           }
         }
       end
 
       def build_signers(obj_signers)
+        return nil if obj_signers.nil?
+
         signers = []
         obj_signers.each do |s|
           signers << {
-            document_number: CNPJ.new(s["document_number"]).number,
-            name: s["name"],
-            email: s["email"],
-            phone: build_phone(s["phone"])
+            document_number: CNPJ.new(s[:document_number]).number,
+            name: s[:name],
+            email: s[:email],
+            phone: build_phone(s[:phone])
           }
         end
         signers
       end
+
+      def format_cep(cep)
+        cep.gsub(/[^0-9]/, "").insert(5, "-")
+      end
   end
 end

data/lib/zaig/version.rb

@@ -8,5 +8,5 @@ module Zaig
   # Major - Incremented for incompatible changes with previous release (or big enough new features)
   # Minor - Incremented for new backwards-compatible features + deprecations
   # Patch - Incremented for backwards-compatible bug fixes
-  VERSION = "1.0.2"
+  VERSION = "1.0.5"
 end

data/lib/zaig.rb

@@ -3,6 +3,7 @@
 require "cpf_cnpj"
 require "flash_integration"
 require "i18n"
+require "singleton"
 
 require "zaig/base_error"
 require "zaig/already_exists_error"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaig
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
 - Danilo Carolino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cpf_cnpj