bigid_bgcheck 0.1.0 → 0.1.1

data/lib/bigid/bgcheck/integration/multipart_flat.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Integration
       class MultipartFlat < Faraday::Request::Multipart
-        self.mime_type = 'multipart/form-data'.freeze
-        DEFAULT_BOUNDARY_PREFIX = "-----------RubyMultipartPost".freeze unless defined? DEFAULT_BOUNDARY_PREFIX
+        self.mime_type = "multipart/form-data"
+        DEFAULT_BOUNDARY_PREFIX = "-----------RubyMultipartPost" unless defined? DEFAULT_BOUNDARY_PREFIX
 
         def process_params(params, prefix = nil, pieces = nil, &block)
           params.inject(pieces || []) do |all, (key, value)|
-            key = "#{prefix}" if prefix
+            key = prefix.to_s if prefix
 
             case value
             when Array
-              values = value.inject([]) { |a,v| a << [nil, v] }
+              values = value.inject([]) { |a, v| a << [nil, v] }
               process_params(values, key, all, &block)
             when Hash
               process_params(value, key, all, &block)

data/lib/bigid/bgcheck/integration/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Integration

data/lib/bigid/bgcheck/integration/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Integration

data/lib/bigid/bgcheck/internal_error.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class InternalError < BaseError
       HTTP_STATUS = 400
-      STATUS      = 'internal_error'.freeze
-      STATUS_CODE = '-1101'.freeze
+      STATUS      = "internal_error"
+      STATUS_CODE = "-1101"
 
       def http_status
         HTTP_STATUS

data/lib/bigid/bgcheck/invalid_credentials_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class InvalidCredentialsError < BaseError

data/lib/bigid/bgcheck/invalid_document_value_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class InvalidDocumentValueError < BaseError

data/lib/bigid/bgcheck/no_info_error.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class NoInfoError < BaseError
       HTTP_STATUS = 200
-      STATUS      = 'no_info_error'.freeze
-      STATUS_CODE = '-1102'.freeze
+      STATUS      = "no_info_error"
+      STATUS_CODE = "-1102"
 
       def http_status
         HTTP_STATUS

data/lib/bigid/bgcheck/not_permission_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class NotPermissionError < BaseError

data/lib/bigid/bgcheck/request.rb

@@ -1,19 +1,15 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class Request < Bigid::Bgcheck::Auth::AuthenticatedResource
-      VALID_DOCUMENTS = %w[CPF CNPJ].freeze
-
-      APPROVED = 90.freeze
-      NOT_APPROVED = -1100.freeze
-      ERROR = -1101.freeze
-      NO_INFO = -1102.freeze
-
       def call(document:, document_type:, group:)
-        res = @connection.post(url: Bigid::Bgcheck::SRV_ENDPOINT, body: payload(document, document_type, group).to_json)
+        res = @connection.post(url: Bigid::Bgcheck::SRV_ENDPOINT,
+                               body: payload(document, document_type, group).to_json)
 
         check_status(res.status)
 
-        return parse_response_body(res.body)
+        parse_response_body(res.body)
       end
 
       def self.call(document:, document_type:, group:)
@@ -21,48 +17,43 @@ module Bigid
       end
 
       private
+        def check_status(status)
+          raise Bigid::Bgcheck::InternalError unless status
+          raise Bigid::Bgcheck::ServerError if status == 500
+          raise Bigid::Bgcheck::InvalidCredentialsError if status == 401
+          raise Bigid::Bgcheck::BadRequestError if status == 400
+        end
 
-      def check_status(status)
-        raise Bigid::Bgcheck::InternalError unless status
-        raise Bigid::Bgcheck::ServerError if status == 500
-        raise Bigid::Bgcheck::InvalidCredentialsError if status == 401
-        raise Bigid::Bgcheck::BadRequestError if status == 400
-      end
-
-      def payload(document, document_type, group, parameters = {})
-        login = Bigid::Bgcheck.configuration&.username || ENV['BIGID_USERNAME']
-        document_type = document_type.upcase.strip
+        def payload(document, document_type, group, parameters = {})
+          login = Bigid::Bgcheck.configuration.username
+          document_type = document_type.upcase.strip
 
-        if !VALID_DOCUMENTS.include?(document_type)
-          raise Bigid::Bgcheck::DocumentNotSupportedError
-        end
+          raise Bigid::Bgcheck::DocumentNotSupportedError unless DocType.valid?(document_type)
 
-        parameters[:"#{document_type}"] = document
+          parameters[:"#{document_type}"] = document
 
-        { Login: login, parameters: parameters, Group: group }
-      end
+          { Login: login, parameters: parameters, Group: group }
+        end
 
-      def check_result_code(code)
-        raise Bigid::Bgcheck::InvalidDocumentValueError unless code
-        raise Bigid::Bgcheck::NoInfoError if code == NO_INFO
-      end
+        def check_result_code(code)
+          raise Bigid::Bgcheck::InvalidDocumentValueError unless code
+          raise Bigid::Bgcheck::NoInfoError if ResultCode.no_info?(code)
+        end
 
-      def parse_response_body(body)
-        body = JSON.parse(body)
+        def parse_response_body(body)
+          body = JSON.parse(body)
 
-        check_result_code(body['ResultCode'])
+          check_result_code(body["ResultCode"])
 
-        Bigid::Bgcheck::Result.new(
-          approved: body['ResultCode'] == APPROVED,
-          ticket_id: body['TicketId'],
-          code: body['ResultCode'],
-          message: body['ResultMessage'],
-          score: body['Score'],
-          limit_score: body['LimitScore']
-        )
-      rescue StandardError
-        raise Bigid::Bgcheck::InternalError
-      end
+          Bigid::Bgcheck::Result.new(
+            approved: ResultCode.approved?(body["ResultCode"]),
+            ticket_id: body["TicketId"],
+            code: body["ResultCode"],
+            message: body["ResultMessage"],
+            score: body["Score"],
+            limit_score: body["LimitScore"]
+          )
+        end
     end
   end
 end

data/lib/bigid/bgcheck/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class Result

data/lib/bigid/bgcheck/result_code.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Bigid
+  module Bgcheck
+    class ResultCode
+      APPROVED = 90
+      ERROR = -1101
+      NO_INFO = -1102
+      NOT_APPROVED = -1100
+
+      VALUES = [APPROVED, NOT_APPROVED, ERROR, NO_INFO].freeze
+
+      def self.valid?(code)
+        VALUES.include?(code.to_i)
+      end
+
+      def self.values
+        VALUES
+      end
+
+      def self.approved?(code)
+        code.to_i == APPROVED
+      end
+
+      def self.no_info?(code)
+        code.to_i == NO_INFO
+      end
+    end
+  end
+end

data/lib/bigid/bgcheck/server_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class ServerError < BaseError

data/lib/bigid/bgcheck/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     # When updating version, keep in mind Semantic Versioning http://semver.org/
@@ -7,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.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/bigid_bgcheck.rb

@@ -1,43 +1,48 @@
-require 'faraday'
-require 'i18n'
-require 'json'
+# frozen_string_literal: true
 
-require 'bigid/bgcheck/version'
+require "faraday"
+require "i18n"
+require "json"
 
-require 'bigid/bgcheck/integration/multipart_flat'
-require 'bigid/bgcheck/integration/response'
-require 'bigid/bgcheck/integration/request'
-require 'bigid/bgcheck/integration/connection'
+require "bigid/bgcheck/version"
 
-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/integration/multipart_flat"
+require "bigid/bgcheck/integration/response"
+require "bigid/bgcheck/integration/request"
+require "bigid/bgcheck/integration/connection"
 
-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/no_info_error'
-require 'bigid/bgcheck/result'
-require 'bigid/bgcheck/server_error'
+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/request'
+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/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                 = 60000.freeze
-    # Welcome to your new gem!
-    # This file is the entry point for your gem. Logic can go in this file, though most gems are big enough to warrant splitting
-    # functionality out into multiple files namespaced under a module named the same as a gem.
-    # Create those files as lib/bigid_bgcheck/foo as BigidBgcheck::Foo remembering to require each file at the top of this file,
-    # unless you want your users to manually require a specific file (for example opt-in feature in a distinct file)
+    BASE_URL                         = "https://bigid.bigdatacorp.com.br"
+    AUTH_ENDPOINT                    = "https://accesstoken.bigdatacorp.com.br"
+    SRV_ENDPOINT                     = "backgroundcheck"
+    TOKEN_EXPIRATION                 = 60_000
+
     class << self
-      attr_accessor :configuration
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
     end
 
     def self.configure
@@ -47,16 +52,19 @@ module Bigid
     end
 
     class Configuration
-      attr_accessor :username, :password
+      attr_writer :username, :password
+
+      def username
+        @username ||= ENV["BIGID_USERNAME"]
+      end
 
-      def initialize
-        @username = ''
-        @password = ''
+      def password
+        @password ||= ENV["BIGID_PASSWORD"]
       end
     end
 
-    I18n.load_path << Dir[File.expand_path("config/locales") + "/*.yml"]
-    I18n.config.available_locales = :en
+    I18n.load_path << Dir["#{File.expand_path('config/locales')}/*.yml"]
+    I18n.config.available_locales = :en, :'pt-BR'
     I18n.default_locale = :en
   end
 end

data/spec/bigid_bgcheck_spec.rb

@@ -1,7 +1,99 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Bigid::Bgcheck do
-  it 'should have some tests' do
-    flunk "Please write some tests"
+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
+      ENV.clear
+    end
+
+    subject { described_class.configuration }
+
+    context "when configuration is defined" do
+      before do
+        described_class.configure do |config|
+          config.username = "username_value"
+          config.password = "password_value"
+        end
+      end
+
+      it { expect(subject).not_to be_nil }
+
+      it { expect(subject.username).to eq("username_value") }
+
+      it { expect(subject.password).to eq("password_value") }
+    end
+
+    context "when configuration is not defined" do
+      it { expect(subject).not_to be_nil }
+
+      it { expect(subject.username).to be_nil }
+
+      it { expect(subject.password).to be_nil }
+    end
+
+    context "when its configured by envs" do
+      before do
+        ENV["BIGID_USERNAME"] = "username_value"
+        ENV["BIGID_PASSWORD"] = "password_value"
+      end
+
+      it { expect(subject).not_to be_nil }
+
+      it { expect(subject.username).to eq("username_value") }
+
+      it { expect(subject.password).to eq("password_value") }
+    end
+
+    context "when its envs configured and configs setted" do
+      before do
+        ENV["BIGID_USERNAME"] = "username_value"
+        ENV["BIGID_PASSWORD"] = "password_value"
+
+        described_class.configure do |config|
+          config.username = "username_value2"
+          config.password = "password_value2"
+        end
+      end
+
+      it { expect(subject).not_to be_nil }
+
+      it { expect(subject.username).to eq("username_value2") }
+
+      it { expect(subject.password).to eq("password_value2") }
+    end
+
+    describe "I18n calls" do
+      it { expect(I18n.default_locale).to eq(:en) }
+
+      it { expect(I18n.config.available_locales).to contain_exactly(:en, :'pt-BR') }
+    end
   end
 end