bigid_bgcheck 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1ebc273c327323e346cd5f95acdf0f416fe43b9df2b63af7a26f74125397ce
-  data.tar.gz: 0a89cf40a825ad278c2ca22ca441e1cd7f2cb8e77c0884a17507cc207d3680dd
+  metadata.gz: be95a78ca1f565303461532c086f52e0fdc83dcfac235fed73c995f9f81493e1
+  data.tar.gz: 5fdeb2b9f0a5aeb97282cd55289030cd85584ab6da1879cc480c46590128e0a2
 SHA512:
-  metadata.gz: 67a17203419ba2e66edbfdced0ddcb9d6affa3a12742bf55432ec0c30d60bd22abacda6b0ff656d755e340ab05a63bbd5f1b8984e0ef3c1ea1713b19d6305573
-  data.tar.gz: 62b1d4edec6dde17d86342dcb06a4b01748b2bcb298a1776a81209bb2118ff8f514e859b9209703df49efff7519e94ea198d61ed7a1e3a21c5fda573259e2d73
+  metadata.gz: 9facd77ce7d71802b439c4e8cd074f8729f0d7de4492430f0de893e0712aecad2d7dcd2296845601477848670508b1423b90f077dceeb483993951207b47967b
+  data.tar.gz: c55c18f21e057426a1e634a731106a13a85028c2f2327d00b969b98917e047cfadd646eaa372ef97524aa34160acc4af2681d8cd25467ba24f2ce20c64647873

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG for bigid_bgcheck
 
+## v0.3.1-20220202 - Danilo Carolino
+
+* [QC-79](https://qflash.atlassian.net/jira/software/projects/QC/boards/31?selectedIssue=QC-79)
+Reduzir uso de pipelines em projetos Ruby [Dependabot]
+* Bump Ruby version to v3.1.0
+
+## 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

data/LICENSE.txt

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

data/README.md

@@ -1,8 +1,26 @@
 BigId Background Check's Library for Ruby
 ==============
 
+Build Status
+-----------------
+
 [![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/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/bigid_bgcheck/actions/workflows/ruby.yml)
+[![Quality Gate Status](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=alert_status&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Coverage](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=coverage&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Maintainability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=sqale_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+
+Project Scores
+-----------------
+
+[![Bugs](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=bugs&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Code Smells](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=code_smells&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Duplicated Lines (%)](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=duplicated_lines_density&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Lines of Code](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=ncloc&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Reliability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=reliability_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Security Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=security_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Technical Debt](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=sqale_index&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
+[![Vulnerabilities](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=vulnerabilities&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
 
 Requirements
 -----------------
@@ -18,66 +36,79 @@ Included Modules
 Global Installation
 -----------------
 
-    gem install bigid_bgcheck
+```sh
+gem install bigid_bgcheck
+```
 
 Installation for Rails
 -----------------
 
-    # Add to the Gemfile
-    gem 'bigid_bgcheck', '~> 0.1.0'
+```ruby
+# Add to the Gemfile
+gem "bigid_bgcheck", "~> 0.3"
+gem "bigid_bgcheck", github: "Quasar-Flash/bigid_bgcheck"
+```
 
 Setting the BigID credentials
 -----------------
 
-    # Set the env variables
-    ENV['BIGID_USERNAME'] = 'your_username'
-    ENV['BIGID_PASSWORD'] = 'your_password'
+```ruby
+# Set the env variables
+ENV["BIGID_USERNAME"] = "your_username"
+ENV["BIGID_PASSWORD"] = "your_password"
+```
 
 Setting the BigID credentials - Rails Project
 -----------------
 
 Create the config/initializers/bigid.rb file and define:
 
-    # Set the env variables
-    Bigid.configure do |config|
-        config.username = 'your_username'
-        config.password = 'your_password'
-    end
+```ruby
+# Set the env variables
+Bigid.configure do |config|
+  config.username = "your_username"
+  config.password = "your_password"
+end
+```
 
 Applying a background check
 -----------------
 
-    require 'bigid_bgcheck'
+```ruby
+require "bigid_bgcheck"
 
-    Bigid::Bgcheck::Request.new.call(
-        document: '000.000.000-00',
-        document_type: 'CPF',
-        group: 'Default'
-    )
+Bigid::Bgcheck::Request.new.call(
+  document: "000.000.000-00",
+  document_type: "CPF",
+  group: "Default"
+)
+```
 
 Result Example
 -----------------
 
-    #<Bigid::Bgcheck::Result:0x0000560fef3c1068
-        @approved=false,
-        @ticket_id="00000000000000000",
-        @code=-1100,
-        @message="Not Approved",
-        @score=0,
-        @limit_score=0.0>
+```ruby
+#<Bigid::Bgcheck::Result:0x0000560fef3c1068
+  @approved=false,
+  @ticket_id="00000000000000000",
+  @code=-1100,
+  @message="Not Approved",
+  @score=0,
+  @limit_score=0.0>
+```
 
 Problems?
 -----------------
 
 **Please do not directly email any committers with questions or problems.**  A community is best served when discussions are held in public.
 
-Searching the [issues](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/issues) for your problem is also a good idea.
+Searching the [issues](https://github.com/Quasar-Flash/bigid_bgcheck/issues) for your problem is also a good idea.
 
 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;
@@ -87,7 +118,7 @@ Contributing
 License
 -----------------
 
-Please see [LICENSE](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/blob/master/LICENSE.txt) for licensing details.
+Please see [LICENSE](https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/LICENSE.txt) for licensing details.
 
 Authors
 -----------------

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

@@ -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.3"
+    VERSION = "0.3.1"
   end
 end

data/lib/bigid_bgcheck.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "faraday"
 require "i18n"
 require "json"
+require "cpf_cnpj"
 
 require "bigid_auth"
 
@@ -26,24 +26,24 @@ I18n.load_path += Dir[File.join(__dir__, "locales", "**/*.yml")]
 I18n.reload! if I18n.backend.initialized?
 
 module Bigid
-  module Bgcheck
-    SRV_ENDPOINT = "backgroundcheck"
-
-    class << self
-      attr_writer :configuration
+  class << self
+    attr_writer :configuration
 
-      def configuration
-        @configuration ||= Configuration.new
-      end
+    def configuration
+      @configuration ||= Configuration.new
     end
+  end
 
-    def self.configure
-      self.configuration ||= Configuration.new
+  def self.configure
+    self.configuration ||= Configuration.new
 
-      yield(configuration)
-    end
+    yield(configuration)
+  end
 
-    class Configuration
-    end
+  class Configuration
+  end
+
+  module Bgcheck
+    SRV_ENDPOINT = "backgroundcheck"
   end
 end

data/spec/bigid/bgcheck/bad_request_error_spec.rb

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

data/spec/bigid/bgcheck/base_error_spec.rb

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

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-require "bigid/bgcheck/doc_type"
-
 RSpec.describe Bigid::Bgcheck::DocType do
   describe ".valid?(document_type)" do
     subject { described_class.valid?(document_type) }

data/spec/bigid/bgcheck/document_not_supported_error_spec.rb

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

data/spec/bigid/bgcheck/internal_error_spec.rb

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

data/spec/bigid/bgcheck/invalid_credentials_error_spec.rb

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

data/spec/bigid/bgcheck/invalid_document_value_error_spec.rb

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

data/spec/bigid/bgcheck/no_info_error_spec.rb

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

data/spec/bigid/bgcheck/request_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+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

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-require "bigid/bgcheck/result_code"
-
 RSpec.describe Bigid::Bgcheck::ResultCode do
   describe ".valid?(code)" do
     subject { described_class.valid?(code) }

data/spec/bigid/bgcheck/server_error_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.describe Bigid::Bgcheck::ServerError do
+  include_examples "error"
+end

data/spec/bigid_bgcheck_spec.rb

@@ -1,44 +1,23 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-require "bigid_bgcheck"
-
 RSpec.describe Bigid::Bgcheck do
-  describe "BASE_URL" do
-    subject { defined? Bigid::Bgcheck::BASE_URL }
-
-    it { expect(subject).to be_truthy }
-  end
-
-  describe "AUTH_ENDPOINT" do
-    subject { defined? Bigid::Bgcheck::AUTH_ENDPOINT }
-
-    it { expect(subject).to be_truthy }
-  end
-
   describe "SRV_ENDPOINT" do
     subject { defined? Bigid::Bgcheck::SRV_ENDPOINT }
 
     it { expect(subject).to be_truthy }
   end
 
-  describe "TOKEN_EXPIRATION" do
-    subject { defined? Bigid::Bgcheck::TOKEN_EXPIRATION }
-
-    it { expect(subject).to be_truthy }
-  end
-
   describe ".configure" do
     before do
-      described_class.configuration = nil
+      Bigid.configuration = nil
       ENV.clear
     end
 
-    subject { described_class.configuration }
+    subject { Bigid.configuration }
 
     context "when configuration is defined" do
       before do
-        described_class.configure do |config|
+        Bigid.configure do |config|
           config.username = "username_value"
           config.password = "password_value"
         end
@@ -77,7 +56,7 @@ RSpec.describe Bigid::Bgcheck do
         ENV["BIGID_USERNAME"] = "username_value"
         ENV["BIGID_PASSWORD"] = "password_value"
 
-        described_class.configure do |config|
+        Bigid.configure do |config|
           config.username = "username_value2"
           config.password = "password_value2"
         end

data/spec/factories/result.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :result, class: "Bigid::Bgcheck::Result" do
+    trait :approved do
+      approved { true }
+      code { Bigid::Bgcheck::ResultCode::APPROVED }
+      score_details { {} }
+      limit_score { 10.0 }
+      message { "Approved" }
+      score { 10.0 }
+      ticket_id { SecureRandom.hex(8) }
+      raw_data { "{}" }
+      raw_response { "{\"ScoreDetails\":#{score_details},\"LimitScore\":#{limit_score},\"ResultCode\":#{code},\"ResultMessage\":\"#{message}\",\"Score\":#{score},\"TicketId\":\"#{ticket_id}\"}" }
+      related_score_details { "{}" }
+    end
+
+    trait :unapproved do
+      approved { false }
+      code { Bigid::Bgcheck::ResultCode::NOT_APPROVED }
+      score_details { }
+      limit_score { 10.0 }
+      message { "Not Approved" }
+      raw_response { "{\"ScoreDetails\":null,\"LimitScore\":10.0,\"ResultCode\":90,\"ResultMessage\":\"Approved\",\"Score\":10.0,\"TicketId\":\"d735711aeb909de9\"}" }
+      score { 1.0 }
+      ticket_id { SecureRandom.hex(8) }
+    end
+
+    initialize_with do
+      new(
+        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,
+        score_details: score_details,
+        ticket_id: ticket_id
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,28 @@
 # frozen_string_literal: true
 
+require "simplecov"
+
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter]
+SimpleCov.minimum_coverage 70.0
+
+SimpleCov.start do
+  add_filter "/spec/"
+  minimum_coverage 70
+  minimum_coverage_by_file 50
+end
+
+require "bigid_auth"
+require "bigid/bgcheck/base_error"
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+Dir["./spec/initializers/**/*.rb"].each { |f| require f }
+Dir["./lib/**/*.rb"].sort.each { |file| require file }
+
 require "rubygems"
 require "bundler"
+require "bigid_bgcheck"
+require "factory_bot"
+require "pry"
 
 begin
   Bundler.setup(:default, :development, :test)
@@ -12,14 +33,15 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
-require "simplecov"
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
 
-SimpleCov.start do
-  add_filter "spec"
-end
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
 
-RSpec.configure do |config|
-  # some (optional) config here
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end
 
-# minitest/mock # Uncomment me to use minitest mocks
+FactoryBot.find_definitions

data/spec/support/shared_examples/errors_shared_examples.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "error" do
+  describe ".initialize" do
+    context "when message parameter is null" do
+      subject { described_class.new.message }
+
+      it { expect(subject).to eq(described_class.default_message) }
+    end
+
+    context "when message parameter is not null" do
+      subject { described_class.new(message).message }
+
+      let(:message) { "message" }
+
+      it { expect(subject).to eq(message) }
+    end
+  end
+
+  describe ".default_message" do
+    let(:expected_result) { I18n.t("errors.#{described_class.name.underscore.tr("/", ".")}") }
+
+    subject { described_class.default_message }
+
+    it "searches the default message in I18n using the class name" do
+      expect(subject).to eq(expected_result)
+    end
+  end
+end
+
+RSpec.shared_examples "http_error" do
+  include_examples "error"
+
+  describe "#http_status" do
+    subject { described_class.new.http_status }
+
+    it { expect(subject).to eq(described_class::HTTP_STATUS) }
+  end
+
+  describe "#status" do
+    subject { described_class.new.status }
+
+    it { expect(subject).to eq(described_class::STATUS) }
+  end
+
+  describe "#status_code" do
+    subject { described_class.new.status_code }
+
+    it { expect(subject).to eq(described_class::STATUS_CODE) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigid_bgcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Danilo Carolino
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigid_auth
@@ -16,27 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -46,106 +40,92 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: cpf_cnpj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-- !ruby/object:Gem::Dependency
-  name: gemsurance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -172,70 +152,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '1.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.2'
 description: A library to use BigData Corps background check features
 email:
 - danilo.carolino@qflash.com.br
@@ -263,18 +257,29 @@ files:
 - lib/bigid_bgcheck.rb
 - lib/locales/en.yml
 - lib/locales/pt-BR.yml
+- spec/bigid/bgcheck/bad_request_error_spec.rb
+- spec/bigid/bgcheck/base_error_spec.rb
+- spec/bigid/bgcheck/doc_type_spec.rb
+- spec/bigid/bgcheck/document_not_supported_error_spec.rb
+- spec/bigid/bgcheck/internal_error_spec.rb
+- spec/bigid/bgcheck/invalid_credentials_error_spec.rb
+- spec/bigid/bgcheck/invalid_document_value_error_spec.rb
+- spec/bigid/bgcheck/no_info_error_spec.rb
+- spec/bigid/bgcheck/request_spec.rb
+- spec/bigid/bgcheck/result_code_spec.rb
+- spec/bigid/bgcheck/server_error_spec.rb
 - spec/bigid_bgcheck_spec.rb
-- spec/lib/bgcheck/doc_type_spec.rb
-- spec/lib/bgcheck/result_code_spec.rb
+- spec/factories/result.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Quasar-Flash/bigid-bgcheck-ruby
+- spec/support/shared_examples/errors_shared_examples.rb
+homepage: https://github.com/Quasar-Flash/bigid_bgcheck
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby
-  bug_tracker_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby/issues
-post_install_message: 
+  changelog_uri: https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/Quasar-Flash/bigid_bgcheck
+  bug_tracker_uri: https://github.com/Quasar-Flash/bigid_bgcheck/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -282,19 +287,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Bigid Background Check Library
 test_files:
+- spec/bigid/bgcheck/bad_request_error_spec.rb
+- spec/bigid/bgcheck/base_error_spec.rb
+- spec/bigid/bgcheck/doc_type_spec.rb
+- spec/bigid/bgcheck/document_not_supported_error_spec.rb
+- spec/bigid/bgcheck/internal_error_spec.rb
+- spec/bigid/bgcheck/invalid_credentials_error_spec.rb
+- spec/bigid/bgcheck/invalid_document_value_error_spec.rb
+- spec/bigid/bgcheck/no_info_error_spec.rb
+- spec/bigid/bgcheck/request_spec.rb
+- spec/bigid/bgcheck/result_code_spec.rb
+- spec/bigid/bgcheck/server_error_spec.rb
 - spec/bigid_bgcheck_spec.rb
-- spec/lib/bgcheck/result_code_spec.rb
-- spec/lib/bgcheck/doc_type_spec.rb
+- spec/factories/result.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/errors_shared_examples.rb