bigid_bgcheck 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 061bab2e6ded3cddad6973dca46452ac88a24b5930ad9d774a1dcd6b33b26a1e
-  data.tar.gz: 95de36d25c4b50fb8680917b9dd2bef2f9fc3c74fa27ce238f9f250859130cfd
+  metadata.gz: b0e56b8286ff8c62b9e3fc0e4b4c147df0737c1bf8af5d32ac6c12fb162ba1cd
+  data.tar.gz: cc0203dfb074f3960d6c96ed832279f8d07e52927fbb3f6880219d502b96403f
 SHA512:
-  metadata.gz: 354a23277c46fab26ca4982b0ce52335249ea0305cfd49166e506e7b2c06bf3eb9d455ee9ca7c2683936b83ed1cd191af51c8d3a4012d855551fdc21b0a591c0
-  data.tar.gz: febce1e53fa05ab98ef4ad058a0331a5f0f90247094734378eafb8ed288e1aa6c80d6dec442883d868d614f6a288b23d0066bb0542660a76ac5ef91941e3d137
+  metadata.gz: e7cc45959661c9cb9d62d1237253544af5545454b8de12047d824968cdf7b76c36752b8b12b7ab4d70205c669ba6b749813a3ae40b226b6473fc1afcf60dbce4
+  data.tar.gz: a2f88c24add0312d6e2871432ead1c5eba93d8cca6fe4ebfea966c0ca751a9e320686e4d8b1261a6dc65031de8a0fc17c65e403ead78b9dcac300429f5ec4e40

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG for bigid_bgcheck
 
+## v0.1.1
+
+* Fix a problem with the credentials when its get by the env variables
+* Fix rubocop warnings
+
 ## v0.1.0
 
 * Initial release of bigid_bgcheck

data/README.md

@@ -0,0 +1,96 @@
+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
+-----------------
+
+- Ruby: Any version
+- Bundler
+
+Global Installation
+-----------------
+
+    gem install bigid_bgcheck
+
+Installation for Rails
+-----------------
+
+    # Add to the Gemfile
+    gem 'bigid_bgcheck', '~> 0.1.0'
+
+Setting the BigID credentials
+-----------------
+
+    # 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_bgcheck.rb file and define:
+
+    # Set the env variables
+    Bigid::Bgcheck.configure do |config|
+        config.username = 'your_username'
+        config.password = 'your_password'
+    end
+
+Applying a background check
+-----------------
+
+    require 'bigid_bgcheck'
+
+    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>
+
+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.
+
+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;
+- Fork the project;
+- Start a feature/bugfix branch;
+- Commit and push until you are happy with your contribution;
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+License
+-----------------
+
+Please see [LICENSE](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/blob/master/LICENSE.txt) for licensing details.
+
+Authors
+-----------------
+
+Danilo Carolino, [@danilogco](https://github.com/danilogco) / [@Quasar-Flash](https://github.com/Quasar-Flash)

data/Rakefile

@@ -1,38 +1,48 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
+
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+
   RDoc::Task = Rake::RDocTask
 end
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'bigid_bgcheck'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "bigid_bgcheck"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
+begin
+  require "rake/testtask"
+  require "rubocop/rake_task"
+
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = ["--display-cop-names"]
+  end
+rescue LoadError
+  # no rspec available
+end
 
-require "rake/testtask"
+begin
+  require "rspec/core/rake_task"
 
-Rake::TestTask.new(:spec) do |t|
-  t.libs << 'lib'
-  t.libs << 'spec'
-  t.pattern = "spec/**/*_spec.rb"
-  t.verbose = true
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # no rspec available
 end
 
-task :default => :spec
+task default: %i[rubocop ]

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Auth
       class AuthenticatedConnection < Connection
-        COOKIE_CACHE_KEY = 'BIG_ID_AUTHENTICATION_COOKIE_CACHE_KEY'.freeze
+        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)
+                       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
@@ -20,24 +22,23 @@ module Bigid
         end
 
         private
+          def auth_token
+            response = @authentication.login
+            extract_token(response.body)
+          end
 
-        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
+          def cached_token
+            @cache.fetch(COOKIE_CACHE_KEY, expires_in: @token_expiration_time_in_seconds.seconds) do
+              auth_token
+            end
           end
-        end
 
-        def extract_token(value)
-          raise Bigid::Bgcheck::AuthenticationError unless value
+          def extract_token(value)
+            raise Bigid::Bgcheck::AuthenticationError unless value
 
-          value_json = JSON.parse(value)
-          "Bearer #{value_json['token']}"
-        end
+            value_json = JSON.parse(value)
+            "Bearer #{value_json['token']}"
+          end
       end
     end
   end

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

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

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

@@ -1,19 +1,21 @@
+# 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)
+                       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 ? username : ENV['BIGID_USERNAME']
-          @password = password ? password : ENV['BIGID_PASSWORD']
+          @username = username
+          @password = password
         end
 
         def login
-          res = @connection.post(url: 'Generate', body: login_body)
+          res = @connection.post(url: "Generate", body: login_body)
 
           return res if res.status == 200
 
@@ -23,14 +25,13 @@ module Bigid
         end
 
         private
-
-        def login_body
-          {
-            login: @username,
-            password: @password,
-            expires: @token_expiration_time_in_seconds.to_i
-          }.to_json
-        end
+          def login_body
+            {
+              login: @username,
+              password: @password,
+              expires: @token_expiration_time_in_seconds.to_i
+            }.to_json
+          end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Auth
@@ -8,8 +10,8 @@ module Bigid
 
         def default_headers
           {
-            'Content-Type': 'application/json',
-            'Accept': 'application/json'
+            'Content-Type': "application/json",
+            'Accept': "application/json"
           }
         end
       end

data/lib/bigid/bgcheck/bad_request_error.rb

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

data/lib/bigid/bgcheck/base_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     class BaseError < StandardError
@@ -11,12 +13,10 @@ module Bigid
         I18n.t("errors.#{underscore(name)}")
       end
 
-      protected
-
       def self.underscore(str)
-        str.gsub(/::/, '.')
-           .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-           .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        str.gsub(/::/, ".")
+           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
            .tr("-", "_")
            .downcase
       end

data/lib/bigid/bgcheck/doc_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bigid
+  module Bgcheck
+    class DocType
+      VALUES = %w[CPF CNPJ].freeze
+
+      def self.valid?(document_type)
+        VALUES.include?(document_type.upcase)
+      end
+
+      def self.values
+        VALUES
+      end
+    end
+  end
+end

data/lib/bigid/bgcheck/document_not_supported_error.rb

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

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Bigid
   module Bgcheck
     module Integration
       class Connection
         attr_reader :base_url
 
-        def initialize(request_class: Faraday, base_url:)
+        def initialize(base_url:, request_class: Faraday)
           @request_class = request_class
           @base_url = base_url
         end
 
-        def get(url: '', params: {}, headers: {})
+        def get(url: "", params: {}, headers: {})
           send_request(
             method: :get,
             url: url,
@@ -18,7 +20,7 @@ module Bigid
           )
         end
 
-        def post(url: '', params: {}, headers: {}, body: {}, multipart: false)
+        def post(url: "", params: {}, headers: {}, body: {}, multipart: false)
           send_request(
             method: :post,
             url: url,
@@ -29,7 +31,7 @@ module Bigid
           )
         end
 
-        def put(url: '', params: {}, headers: {}, body: {})
+        def put(url: "", params: {}, headers: {}, body: {})
           send_request(
             method: :put,
             url: url,
@@ -39,7 +41,7 @@ module Bigid
           )
         end
 
-        def patch(url: '', params: {}, headers: {}, body: {})
+        def patch(url: "", params: {}, headers: {}, body: {})
           send_request(
             method: :patch,
             url: url,
@@ -49,7 +51,7 @@ module Bigid
           )
         end
 
-        def delete(url: '', params: {}, headers: {}, body: {})
+        def delete(url: "", params: {}, headers: {}, body: {})
           send_request(
             method: :delete,
             url: url,
@@ -64,55 +66,54 @@ module Bigid
         end
 
         private
+          def send_request(method:, url:, params:, headers:, body: nil, multipart: false)
+            connection = multipart ? multipart_connection : @request_class.new(url: @base_url)
 
-        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)
 
-          merged_headers = default_headers.merge(headers)
+            request = build_request(
+              method, connection.build_url(url).to_s, params, merged_headers, body
+            )
 
-          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
 
-          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
+            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
+          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
-        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_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
+          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