bigid_bgcheck 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e56b8286ff8c62b9e3fc0e4b4c147df0737c1bf8af5d32ac6c12fb162ba1cd
-  data.tar.gz: cc0203dfb074f3960d6c96ed832279f8d07e52927fbb3f6880219d502b96403f
+  metadata.gz: 0f078e2eba71cbc4578ee9a4c1ceec003435b4f3331ec52924c9b2a30eb873b5
+  data.tar.gz: bada7c2db0bbc0a3cbb2f7470a3f1d9d9a366a9f150cb95313e3f49aadc66f75
 SHA512:
-  metadata.gz: e7cc45959661c9cb9d62d1237253544af5545454b8de12047d824968cdf7b76c36752b8b12b7ab4d70205c669ba6b749813a3ae40b226b6473fc1afcf60dbce4
-  data.tar.gz: a2f88c24add0312d6e2871432ead1c5eba93d8cca6fe4ebfea966c0ca751a9e320686e4d8b1261a6dc65031de8a0fc17c65e403ead78b9dcac300429f5ec4e40
+  metadata.gz: 53249dd591e3b909a88fb5bdc0b3a70e89b56364c5ba86945cf6620f842e6c5cdf750bb07b75bca4c29ea24106a384e9fab06b43873590f0770504325549ae67
+  data.tar.gz: 6ddbe14002b9525f7b447cbfa4982eea4dd83458b0c6457344711acd7c72cf95ac971e31d8793a007b17d496d5ab5186a27337f13f5fe1fb30361c2cdb1a1c67

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG for bigid_bgcheck
 
+## 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/README.md

@@ -4,18 +4,17 @@ 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)
 
-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
 -----------------
 
@@ -37,10 +36,10 @@ Setting the BigID credentials
 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|
+    Bigid.configure do |config|
         config.username = 'your_username'
         config.password = 'your_password'
     end

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)

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.1.2"
   end
 end

data/lib/bigid_bgcheck.rb

@@ -4,38 +4,27 @@ require "faraday"
 require "i18n"
 require "json"
 
-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
+    SRV_ENDPOINT = "backgroundcheck"
 
     class << self
       attr_writer :configuration
@@ -52,19 +41,11 @@ module Bigid
     end
 
     class Configuration
-      attr_writer :username, :password
-
-      def username
-        @username ||= ENV["BIGID_USERNAME"]
-      end
-
-      def password
-        @password ||= ENV["BIGID_PASSWORD"]
-      end
     end
 
     I18n.load_path << Dir["#{File.expand_path('config/locales')}/*.yml"]
     I18n.config.available_locales = :en, :'pt-BR'
     I18n.default_locale = :en
+    I18n.reload!
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigid_bgcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danilo Carolino
@@ -10,6 +10,26 @@ bindir: bin
 cert_chain: []
 date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigid_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -227,23 +247,14 @@ 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

data/lib/bigid/bgcheck/auth/authenticated_connection.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Auth
-      class AuthenticatedConnection < Connection
-        COOKIE_CACHE_KEY = "BIG_ID_AUTHENTICATION_COOKIE_CACHE_KEY"
-
-        def initialize(authentication: Bigid::Bgcheck::Auth::Authentication.new,
-                       cache: defined?(Rails) ? Rails.cache : nil,
-                       request_class: Faraday,
-                       base_url: Bigid::Bgcheck::BASE_URL,
-                       token_expiration_time_in_seconds: Bigid::Bgcheck::TOKEN_EXPIRATION)
-          super(request_class: request_class, base_url: base_url)
-          @authentication = authentication
-          @cache = cache
-          @token_expiration_time_in_seconds = token_expiration_time_in_seconds
-        end
-
-        def default_headers
-          super.merge(Authorization: (@cache ? cached_token : auth_token))
-        end
-
-        private
-          def auth_token
-            response = @authentication.login
-            extract_token(response.body)
-          end
-
-          def cached_token
-            @cache.fetch(COOKIE_CACHE_KEY, expires_in: @token_expiration_time_in_seconds.seconds) do
-              auth_token
-            end
-          end
-
-          def extract_token(value)
-            raise Bigid::Bgcheck::AuthenticationError unless value
-
-            value_json = JSON.parse(value)
-            "Bearer #{value_json['token']}"
-          end
-      end
-    end
-  end
-end

data/lib/bigid/bgcheck/auth/authenticated_resource.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Auth
-      class AuthenticatedResource
-        def initialize(connection: AuthenticatedConnection.new)
-          @connection = connection
-        end
-      end
-    end
-  end
-end

data/lib/bigid/bgcheck/auth/authentication.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Auth
-      class Authentication
-        def initialize(connection: Connection.new,
-                       username: Bigid::Bgcheck.configuration.username,
-                       password: Bigid::Bgcheck.configuration.password,
-                       token_expiration_time_in_seconds: Bigid::Bgcheck::AUTH_ENDPOINT)
-          @connection = connection
-          @token_expiration_time_in_seconds = Bigid::Bgcheck::TOKEN_EXPIRATION
-          @username = username
-          @password = password
-        end
-
-        def login
-          res = @connection.post(url: "Generate", body: login_body)
-
-          return res if res.status == 200
-
-          raise Bigid::Bgcheck::InvalidCredentialsError if res.status == 401
-          raise Bigid::Bgcheck::BadRequestError if res.status == 400
-          raise Bigid::Bgcheck::ServerError if res.status == 500
-        end
-
-        private
-          def login_body
-            {
-              login: @username,
-              password: @password,
-              expires: @token_expiration_time_in_seconds.to_i
-            }.to_json
-          end
-      end
-    end
-  end
-end

data/lib/bigid/bgcheck/auth/connection.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Auth
-      class Connection < Bigid::Bgcheck::Integration::Connection
-        def initialize(request_class: Faraday, base_url: Bigid::Bgcheck::AUTH_ENDPOINT)
-          super(request_class: request_class, base_url: base_url)
-        end
-
-        def default_headers
-          {
-            'Content-Type': "application/json",
-            'Accept': "application/json"
-          }
-        end
-      end
-    end
-  end
-end

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

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Integration
-      class Connection
-        attr_reader :base_url
-
-        def initialize(base_url:, request_class: Faraday)
-          @request_class = request_class
-          @base_url = base_url
-        end
-
-        def get(url: "", params: {}, headers: {})
-          send_request(
-            method: :get,
-            url: url,
-            params: params,
-            headers: headers
-          )
-        end
-
-        def post(url: "", params: {}, headers: {}, body: {}, multipart: false)
-          send_request(
-            method: :post,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body,
-            multipart: multipart
-          )
-        end
-
-        def put(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :put,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def patch(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :patch,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def delete(url: "", params: {}, headers: {}, body: {})
-          send_request(
-            method: :delete,
-            url: url,
-            params: params,
-            headers: headers,
-            body: body
-          )
-        end
-
-        def default_headers
-          {}
-        end
-
-        private
-          def send_request(method:, url:, params:, headers:, body: nil, multipart: false)
-            connection = multipart ? multipart_connection : @request_class.new(url: @base_url)
-
-            merged_headers = default_headers.merge(headers)
-
-            request = build_request(
-              method, connection.build_url(url).to_s, params, merged_headers, body
-            )
-
-            result =
-              connection.send(method) do |request|
-                request.url(url)
-                request.params = params
-                request.headers = merged_headers
-                request.body = body if body
-              end
-
-            build_response(request, result.status, result.headers, result.body)
-          end
-
-          def multipart_connection
-            @request_class.new(url: @base_url) do |conn|
-              conn.use Bigid::Bgcheck::Integration::MultipartFlat
-              conn.request :url_encoded
-              conn.adapter @request_class.default_adapter
-            end
-          end
-
-          def build_request(method, url, params, headers, body)
-            Bigid::Bgcheck::Integration::Request.new(
-              method: method,
-              url: url,
-              params: params,
-              headers: headers,
-              body: body,
-              time: Time.now.utc
-            )
-          end
-
-          def build_response(request, status, headers, body)
-            Bigid::Bgcheck::Integration::Response.new(
-              request: request,
-              status: status,
-              headers: headers,
-              body: body,
-              time: Time.now.utc
-            )
-          end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Integration
-      class MultipartFlat < Faraday::Request::Multipart
-        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.to_s if prefix
-
-            case value
-            when Array
-              values = value.inject([]) { |a, v| a << [nil, v] }
-              process_params(values, key, all, &block)
-            when Hash
-              process_params(value, key, all, &block)
-            else
-              all << block.call(key, value)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Integration
-      class Request
-        attr_reader :method, :url, :params, :headers, :body, :time
-
-        def initialize(attributes)
-          @method = attributes.fetch(:method)
-          @url = attributes.fetch(:url)
-          @params = attributes[:params] || {}
-          @headers = attributes[:headers] || {}
-          @body = attributes[:body] || {}
-          @time = attributes[:time] || Time.current
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    module Integration
-      class Response
-        attr_reader :request, :status, :headers, :body, :time
-
-        def initialize(attributes)
-          @request = attributes.fetch(:request)
-          @status = attributes.fetch(:status)
-          @headers = attributes[:headers] || {}
-          @body = attributes[:body] || {}
-          @time = attributes[:time] || Time.current
-        end
-
-        def success?
-          @status.between?(200, 299)
-        end
-
-        def error?
-          !success?
-        end
-      end
-    end
-  end
-end

data/lib/bigid/bgcheck/not_permission_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Bigid
-  module Bgcheck
-    class NotPermissionError < BaseError
-    end
-  end
-end