bigid_bgcheck 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e56b8286ff8c62b9e3fc0e4b4c147df0737c1bf8af5d32ac6c12fb162ba1cd
-  data.tar.gz: cc0203dfb074f3960d6c96ed832279f8d07e52927fbb3f6880219d502b96403f
+  metadata.gz: d94fea79e3d064b136018dea55150a1839ce25218b82054626a1c32e05495961
+  data.tar.gz: 55164f99a7d2804515214a8b7db4610e04d5a1a0270bf94c2f8da188534206a5
 SHA512:
-  metadata.gz: e7cc45959661c9cb9d62d1237253544af5545454b8de12047d824968cdf7b76c36752b8b12b7ab4d70205c669ba6b749813a3ae40b226b6473fc1afcf60dbce4
-  data.tar.gz: a2f88c24add0312d6e2871432ead1c5eba93d8cca6fe4ebfea966c0ca751a9e320686e4d8b1261a6dc65031de8a0fc17c65e403ead78b9dcac300429f5ec4e40
+  metadata.gz: b2a7bc286c6fabb63e6524c8882923414c7e940016fc9952fd2dd6f6484e6518df3ab910e4df21f205b957def7bbb698fbdfedd58bb7ade69671b251335d3026
+  data.tar.gz: 7f4218efcdff8cffacee26fbce626d3d14339f776fe0017657ef9b254157ce7e4a1c75e2c4db8467bc3baf760ffb48241838317cb730b00d6532917aad6f50c3

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG for bigid_bgcheck
 
+## v0.3.0
+
+* Bump "bigid_auth" version from v0.1.0 to v0.2.0
+
+## v0.2.0
+
+Features
+
+* Add fields to service return: "raw_data", "score_details", "related_score_details" and "raw_response" (the complete json file)
+
+## v0.1.3
+
+* Fix a problem with the locale initialization in Rails projects
+
+## v0.1.2
+
+* Move auth service to an external package
+
 ## v0.1.1
 
 * Fix a problem with the credentials when its get by the env variables

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Danilo Carolino
+Copyright (c) 2021 Quasar Flash
 
 MIT LICENSE
 

data/README.md

@@ -3,19 +3,19 @@ BigId Background Check's Library for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/bigid_bgcheck.svg)](https://badge.fury.io/rb/bigid_bgcheck)
 [![Build Status](https://travis-ci.com/Quasar-Flash/bigid-bgcheck-ruby.svg?branch=master)](https://travis-ci.com/Quasar-Flash/bigid-bgcheck-ruby)
+[![bigid_bgcheck](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/actions/workflows/ruby.yml)
 
-Simple, efficient background processing for Ruby.
-
-Sidekiq uses threads to handle many jobs at the same time in the
-same process.  It does not require Rails but will integrate tightly with
-Rails to make background processing dead simple.
-
-Dev Requirements
+Requirements
 -----------------
 
 - Ruby: Any version
 - Bundler
 
+Included Modules
+-----------------
+
+- [bigid-auth-ruby](https://github.com/Quasar-Flash/bigid-auth-ruby) - BigID API authentication module
+
 Global Installation
 -----------------
 
@@ -25,35 +25,36 @@ Installation for Rails
 -----------------
 
     # Add to the Gemfile
-    gem 'bigid_bgcheck', '~> 0.1.0'
+    gem "bigid_bgcheck", "~> 0.2"
+    gem "bigid_bgcheck", github: "Quasar-Flash/bigid-bgcheck-ruby"
 
 Setting the BigID credentials
 -----------------
 
     # Set the env variables
-    ENV['BIGID_USERNAME'] = 'your_username'
-    ENV['BIGID_PASSWORD'] = 'your_password'
+    ENV["BIGID_USERNAME"] = "your_username"
+    ENV["BIGID_PASSWORD"] = "your_password"
 
 Setting the BigID credentials - Rails Project
 -----------------
 
-Create the config/initializers/bigid_bgcheck.rb file and define:
+Create the config/initializers/bigid.rb file and define:
 
     # Set the env variables
-    Bigid::Bgcheck.configure do |config|
-        config.username = 'your_username'
-        config.password = 'your_password'
+    Bigid.configure do |config|
+        config.username = "your_username"
+        config.password = "your_password"
     end
 
 Applying a background check
 -----------------
 
-    require 'bigid_bgcheck'
+    require "bigid_bgcheck"
 
     Bigid::Bgcheck::Request.new.call(
-        document: '000.000.000-00',
-        document_type: 'CPF',
-        group: 'Default'
+        document: "000.000.000-00",
+        document_type: "CPF",
+        group: "Default"
     )
 
 Result Example
@@ -77,8 +78,8 @@ Searching the [issues](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/issues
 Contributing
 -----------------
 
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
-- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it;
+- Check out the latest master to make sure the feature hasn"t been implemented or the bug hasn't been fixed yet;
+- Check out the issue tracker to make sure someone already hasn"t requested it and/or contributed it;
 - Fork the project;
 - Start a feature/bugfix branch;
 - Commit and push until you are happy with your contribution;

data/Rakefile

@@ -45,4 +45,4 @@ rescue LoadError
   # no rspec available
 end
 
-task default: %i[rubocop ]
+task default: %i[rubocop spec]

data/lib/bigid/bgcheck/request.rb

@@ -2,7 +2,7 @@
 
 module Bigid
   module Bgcheck
-    class Request < Bigid::Bgcheck::Auth::AuthenticatedResource
+    class Request < Bigid::Auth::AuthenticatedResource
       def call(document:, document_type:, group:)
         res = @connection.post(url: Bigid::Bgcheck::SRV_ENDPOINT,
                                body: payload(document, document_type, group).to_json)
@@ -25,7 +25,7 @@ module Bigid
         end
 
         def payload(document, document_type, group, parameters = {})
-          login = Bigid::Bgcheck.configuration.username
+          login = Bigid.configuration.username
           document_type = document_type.upcase.strip
 
           raise Bigid::Bgcheck::DocumentNotSupportedError unless DocType.valid?(document_type)
@@ -47,11 +47,15 @@ module Bigid
 
           Bigid::Bgcheck::Result.new(
             approved: ResultCode.approved?(body["ResultCode"]),
-            ticket_id: body["TicketId"],
             code: body["ResultCode"],
+            score_details: body["ScoreDetails"],
+            limit_score: body["LimitScore"],
             message: body["ResultMessage"],
+            raw_data: body["RawData"],
+            raw_response: body.to_json,
+            related_score_details: body["RelatedScoreDetails"],
             score: body["Score"],
-            limit_score: body["LimitScore"]
+            ticket_id: body["TicketId"]
           )
         end
     end

data/lib/bigid/bgcheck/result.rb

@@ -3,15 +3,21 @@
 module Bigid
   module Bgcheck
     class Result
-      attr_accessor :approved, :ticket_id, :code, :message, :score, :limit_score
+      attr_accessor :approved, :code, :score_details, :limit_score, :message, :raw_data,
+                    :raw_response, :related_score_details, :score, :ticket_id
 
-      def initialize(approved:, ticket_id:, code:, message:, score:, limit_score:)
-        @approved    = approved
-        @ticket_id   = ticket_id
-        @code        = code
-        @message     = message
-        @score       = score
-        @limit_score = limit_score
+      def initialize(approved:, code:, score_details:, limit_score:, message:, raw_data:, raw_response:,
+                     related_score_details:, score:, ticket_id:)
+        @approved              = approved
+        @code                  = code
+        @score_details         = score_details
+        @limit_score           = limit_score
+        @message               = message
+        @raw_data              = raw_data
+        @raw_response          = raw_response
+        @related_score_details = related_score_details
+        @score                 = score
+        @ticket_id             = ticket_id
       end
     end
   end

data/lib/bigid/bgcheck/version.rb

@@ -9,6 +9,6 @@ module Bigid
     # 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 = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/bigid_bgcheck.rb

@@ -1,70 +1,49 @@
 # frozen_string_literal: true
 
-require "faraday"
 require "i18n"
 require "json"
+require "cpf_cnpj"
 
-require "bigid/bgcheck/version"
-
-require "bigid/bgcheck/integration/multipart_flat"
-require "bigid/bgcheck/integration/response"
-require "bigid/bgcheck/integration/request"
-require "bigid/bgcheck/integration/connection"
+require "bigid_auth"
 
-require "bigid/bgcheck/auth/connection"
-require "bigid/bgcheck/auth/authentication"
-require "bigid/bgcheck/auth/authenticated_resource"
-require "bigid/bgcheck/auth/authenticated_connection"
+require "bigid/bgcheck/version"
 
 require "bigid/bgcheck/base_error"
 require "bigid/bgcheck/bad_request_error"
 require "bigid/bgcheck/document_not_supported_error"
 require "bigid/bgcheck/internal_error"
 require "bigid/bgcheck/invalid_credentials_error"
+require "bigid/bgcheck/invalid_document_value_error"
 require "bigid/bgcheck/no_info_error"
 require "bigid/bgcheck/server_error"
 
 require "bigid/bgcheck/doc_type"
 require "bigid/bgcheck/result"
 require "bigid/bgcheck/result_code"
-
 require "bigid/bgcheck/request"
 
-module Bigid
-  module Bgcheck
-    BASE_URL                         = "https://bigid.bigdatacorp.com.br"
-    AUTH_ENDPOINT                    = "https://accesstoken.bigdatacorp.com.br"
-    SRV_ENDPOINT                     = "backgroundcheck"
-    TOKEN_EXPIRATION                 = 60_000
+I18n.load_path += Dir[File.join(__dir__, "locales", "**/*.yml")]
+I18n.reload! if I18n.backend.initialized?
 
-    class << self
-      attr_writer :configuration
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-    end
-
-    def self.configure
-      self.configuration ||= Configuration.new
+module Bigid
+  class << self
+    attr_writer :configuration
 
-      yield(configuration)
+    def configuration
+      @configuration ||= Configuration.new
     end
+  end
 
-    class Configuration
-      attr_writer :username, :password
+  def self.configure
+    self.configuration ||= Configuration.new
 
-      def username
-        @username ||= ENV["BIGID_USERNAME"]
-      end
+    yield(configuration)
+  end
 
-      def password
-        @password ||= ENV["BIGID_PASSWORD"]
-      end
-    end
+  class Configuration
+  end
 
-    I18n.load_path << Dir["#{File.expand_path('config/locales')}/*.yml"]
-    I18n.config.available_locales = :en, :'pt-BR'
-    I18n.default_locale = :en
+  module Bgcheck
+    SRV_ENDPOINT = "backgroundcheck"
   end
 end

data/lib/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  errors:
+    bigid:
+      auth:
+        authentication_error: An error ocurred during the authentication
+        bad_request_error: The request body or format is invalid
+        invalid_credentials_error: The credentials informed are invalid
+        server_error: An internal server error ocurred
+      bgcheck:
+        bad_request_error: The request body or format is invalid
+        document_not_supported_error: The document type is not supported
+        internal_error: An internal error on the BigId server ocurred
+        invalid_document_value_error: The document value is invalid
+        invalid_credentials_error: The credentials informed are invalid
+        no_info_error: No informations available
+        not_permission_error: Action not allowed
+        server_error: An internal server error ocurred

data/lib/locales/pt-BR.yml

@@ -0,0 +1,17 @@
+'pt-BR':
+  errors:
+    bigid:
+      auth:
+        authentication_error: Ocorreu um erro durante a autenticação
+        bad_request_error: O corpo ou formato da requisição é inválido
+        invalid_credentials_error: As credenciais informadas são inválidas
+        server_error: Ocorreu um erro inesperado no servidor
+      bgcheck:
+        bad_request_error: O corpo ou formato da requisição é inválido
+        document_not_supported_error: O tipo de documento é inválido
+        internal_error: Ocorreu um erro ao verificar a pessoa no BigId
+        invalid_document_value_error: O valor do documento é inválido
+        invalid_credentials_error: As credenciais informadas são inválidas
+        no_info_error: Sem informações disponíveis
+        not_permission_error: Ação não permitida
+        server_error: Ocorreu um erro inesperado no servidor

data/spec/bigid/bgcheck/bad_request_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::BadRequestError do
+  include_examples "error"
+end

data/spec/bigid/bgcheck/base_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::BaseError do
+  include_examples "error"
+end

data/spec/{lib → bigid}/bgcheck/doc_type_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "bigid/bgcheck/doc_type"
 
 RSpec.describe Bigid::Bgcheck::DocType do
   describe ".valid?(document_type)" do

data/spec/bigid/bgcheck/document_not_supported_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::DocumentNotSupportedError do
+  include_examples "error"
+end

data/spec/bigid/bgcheck/internal_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::InternalError do
+  include_examples "http_error"
+end

data/spec/bigid/bgcheck/invalid_credentials_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::InvalidCredentialsError do
+  include_examples "error"
+end

data/spec/bigid/bgcheck/invalid_document_value_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::InvalidDocumentValueError do
+  include_examples "error"
+end

data/spec/bigid/bgcheck/no_info_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::NoInfoError do
+  include_examples "http_error"
+end

data/spec/bigid/bgcheck/request_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Bigid::Bgcheck::Request do
+  describe "#call" do
+    let(:connection) { instance_double(Bigid::Auth::AuthenticatedConnection) }
+    let(:body) {
+      {
+        Login: "username_value",
+        parameters: { CNPJ: document },
+        Group: group
+      }.to_json
+    }
+    let(:success_result) { build(:result, :approved) }
+    let(:success_result_response) {
+      JSON.parse({
+        body: {
+          RawData: success_result.raw_data,
+          ScoreDetails: success_result.score_details,
+          RelatedScoreDetails: success_result.related_score_details,
+          LimitScore: success_result.limit_score,
+          ResultCode: success_result.code,
+          ResultMessage: success_result.message,
+          Score: success_result.score,
+          TicketId: success_result.ticket_id
+        }.to_json,
+        status: request_status
+      }.to_json, object_class: OpenStruct)
+    }
+    let(:document) { CNPJ.generate }
+    let(:document_type) { "CNPJ" }
+    let(:group) { "Default" }
+    let(:request_status) { 200 }
+
+    subject { described_class.new.call(document: document, document_type: document_type, group: group) }
+
+    before do
+      allow(Bigid::Auth::AuthenticatedConnection).to receive(:new).and_return(connection)
+      allow(connection).to receive(:post).and_return(success_result_response)
+    end
+
+    describe ".call" do
+      subject { described_class.call(document: document, document_type: document_type, group: group) }
+
+      it { expect(subject).to be_kind_of(Bigid::Bgcheck::Result) }
+
+      it { subject; expect(connection).to have_received(:post) }
+    end
+
+    context "when all parameters are valid" do
+      it { expect(subject).to be_kind_of(Bigid::Bgcheck::Result) }
+
+      it { subject; expect(connection).to have_received(:post) }
+    end
+
+    context "when document type is invalid" do
+      let(:document_type) { "CNP" }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::DocumentNotSupportedError) }
+    end
+
+    context "when request status is null" do
+      let(:request_status) { nil }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::InternalError) }
+    end
+
+    context "when request status is server error" do
+      let(:request_status) { 500 }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::ServerError) }
+    end
+
+    context "when request status is auth error" do
+      let(:request_status) { 401 }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::InvalidCredentialsError) }
+    end
+
+    context "when request status is bad request" do
+      let(:request_status) { 400 }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::BadRequestError) }
+    end
+
+    context "when the result code is empty" do
+      let(:success_result) { build(:result, :approved, code: nil) }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::InvalidDocumentValueError) }
+    end
+
+    context "when the result code is empty" do
+      let(:success_result) { build(:result, :approved, code: Bigid::Bgcheck::ResultCode::NO_INFO) }
+
+      it { expect { subject }.to raise_error(Bigid::Bgcheck::NoInfoError) }
+    end
+  end
+end