bigid_bgcheck 0.1.1 → 0.3.0

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

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

data/spec/bigid/bgcheck/server_error_spec.rb

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

data/spec/bigid_bgcheck_spec.rb

@@ -1,44 +1,25 @@
 # 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 +58,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,53 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+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,42 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: bigid_bgcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Danilo Carolino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: bigid_auth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -66,66 +66,86 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cpf_cnpj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        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
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.2'
 - !ruby/object:Gem::Dependency
-  name: gemsurance
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.5'
 - !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
@@ -152,70 +172,70 @@ 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.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '1.17'
 - !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.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.21.2
 description: A library to use BigData Corps background check features
 email:
 - danilo.carolino@qflash.com.br
@@ -227,37 +247,44 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/bigid/bgcheck/auth/authenticated_connection.rb
-- lib/bigid/bgcheck/auth/authenticated_resource.rb
-- lib/bigid/bgcheck/auth/authentication.rb
-- lib/bigid/bgcheck/auth/connection.rb
 - lib/bigid/bgcheck/bad_request_error.rb
 - lib/bigid/bgcheck/base_error.rb
 - lib/bigid/bgcheck/doc_type.rb
 - lib/bigid/bgcheck/document_not_supported_error.rb
-- lib/bigid/bgcheck/integration/connection.rb
-- lib/bigid/bgcheck/integration/multipart_flat.rb
-- lib/bigid/bgcheck/integration/request.rb
-- lib/bigid/bgcheck/integration/response.rb
 - lib/bigid/bgcheck/internal_error.rb
 - lib/bigid/bgcheck/invalid_credentials_error.rb
 - lib/bigid/bgcheck/invalid_document_value_error.rb
 - lib/bigid/bgcheck/no_info_error.rb
-- lib/bigid/bgcheck/not_permission_error.rb
 - lib/bigid/bgcheck/request.rb
 - lib/bigid/bgcheck/result.rb
 - lib/bigid/bgcheck/result_code.rb
 - lib/bigid/bgcheck/server_error.rb
 - lib/bigid/bgcheck/version.rb
 - 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
+- spec/support/shared_examples/errors_shared_examples.rb
 homepage: https://github.com/Quasar-Flash/bigid-bgcheck-ruby
 licenses:
 - MIT
-metadata: {}
+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: 
 rdoc_options: []
 require_paths:
@@ -266,7 +293,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -279,6 +306,17 @@ specification_version: 4
 summary: Bigid Background Check Library
 test_files:
 - spec/bigid_bgcheck_spec.rb
-- spec/lib/bgcheck/result_code_spec.rb
-- spec/lib/bgcheck/doc_type_spec.rb
+- spec/support/shared_examples/errors_shared_examples.rb
+- spec/factories/result.rb
 - spec/spec_helper.rb
+- spec/bigid/bgcheck/invalid_document_value_error_spec.rb
+- spec/bigid/bgcheck/bad_request_error_spec.rb
+- spec/bigid/bgcheck/no_info_error_spec.rb
+- spec/bigid/bgcheck/internal_error_spec.rb
+- spec/bigid/bgcheck/result_code_spec.rb
+- spec/bigid/bgcheck/server_error_spec.rb
+- spec/bigid/bgcheck/request_spec.rb
+- spec/bigid/bgcheck/invalid_credentials_error_spec.rb
+- spec/bigid/bgcheck/document_not_supported_error_spec.rb
+- spec/bigid/bgcheck/doc_type_spec.rb
+- spec/bigid/bgcheck/base_error_spec.rb