bigid_bgcheck 0.3.1.1 → 0.3.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile +0 -17
- data/{CHANGELOG.md → docs/CHANGELOG.md} +14 -8
- data/docs/CODE_OF_CONDUCT.md +128 -0
- data/docs/CONTRIBUTING.md +9 -0
- data/{LICENSE.txt → docs/LICENSE.txt} +0 -0
- data/docs/PUBLISHING.md +10 -0
- data/lib/bigid/bgcheck/version.rb +1 -1
- metadata +31 -23
- data/README.md +0 -126
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7cc6da1a532ea97383b76fa5b74613545b7dbb81ac23afa9c9188096293f9885
|
|
4
|
+
data.tar.gz: ce39bbc78f38f0e5080983487f259a8566d613939b177340ea4582e27835145e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9654b2b00618e9dd01c12e2e2ef8264fcac06c2866a16567f857d9aa20517409a1e9d6ec1c22d14836cb2edd0ca45654647bf368ac22615639dc1732f0b14d43
|
|
7
|
+
data.tar.gz: 225759d2b914aed42ed121630ebbda352cd8396f9899dffebf401adc40f55838ce6afd0d1e98201178c71ebdd8ae914e6b76cb328536b17c91b09ddb6e0bea5e
|
data/Rakefile
CHANGED
|
@@ -7,23 +7,6 @@ rescue LoadError
|
|
|
7
7
|
puts "You must `gem install bundler` and `bundle install` to run rake tasks"
|
|
8
8
|
end
|
|
9
9
|
|
|
10
|
-
begin
|
|
11
|
-
require "rdoc/task"
|
|
12
|
-
rescue LoadError
|
|
13
|
-
require "rdoc/rdoc"
|
|
14
|
-
require "rake/rdoctask"
|
|
15
|
-
|
|
16
|
-
RDoc::Task = Rake::RDocTask
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
RDoc::Task.new(:rdoc) do |rdoc|
|
|
20
|
-
rdoc.rdoc_dir = "rdoc"
|
|
21
|
-
rdoc.title = "bigid_bgcheck"
|
|
22
|
-
rdoc.options << "--line-numbers"
|
|
23
|
-
rdoc.rdoc_files.include("README.rdoc")
|
|
24
|
-
rdoc.rdoc_files.include("lib/**/*.rb")
|
|
25
|
-
end
|
|
26
|
-
|
|
27
10
|
Bundler::GemHelper.install_tasks
|
|
28
11
|
|
|
29
12
|
begin
|
|
@@ -1,38 +1,44 @@
|
|
|
1
1
|
# CHANGELOG for bigid_bgcheck
|
|
2
2
|
|
|
3
|
-
## v0.3.1.
|
|
3
|
+
## v0.3.1.3-20220506 - [Danilo Carolino](@danilogco)
|
|
4
|
+
|
|
5
|
+
* build(deps): bump ruby version from 3.1.0 to 3.1.2
|
|
6
|
+
* build(deps): bump bigid_auth version to v0.2.1.4
|
|
7
|
+
* feat: automatize the project deployment proccess
|
|
8
|
+
|
|
9
|
+
## v0.3.1.1-20220209 - [Danilo Carolino](@danilogco)
|
|
4
10
|
|
|
5
11
|
* bump bigid_auth version to v0.2.1.1
|
|
6
12
|
|
|
7
|
-
## v0.3.1-20220202 - Danilo Carolino
|
|
13
|
+
## v0.3.1-20220202 - [Danilo Carolino](@danilogco)
|
|
8
14
|
|
|
9
15
|
* [QC-79](https://qflash.atlassian.net/jira/software/projects/QC/boards/31?selectedIssue=QC-79)
|
|
10
16
|
Reduzir uso de pipelines em projetos Ruby [Dependabot]
|
|
11
17
|
* Bump Ruby version to v3.1.0
|
|
12
18
|
|
|
13
|
-
## v0.3.0
|
|
19
|
+
## v0.3.0 - [Danilo Carolino](@danilogco)
|
|
14
20
|
|
|
15
21
|
* Bump "bigid_auth" version from v0.1.0 to v0.2.0
|
|
16
22
|
|
|
17
|
-
## v0.2.0
|
|
23
|
+
## v0.2.0 - [Danilo Carolino](@danilogco)
|
|
18
24
|
|
|
19
25
|
Features
|
|
20
26
|
|
|
21
27
|
* Add fields to service return: "raw_data", "score_details", "related_score_details" and "raw_response" (the complete json file)
|
|
22
28
|
|
|
23
|
-
## v0.1.3
|
|
29
|
+
## v0.1.3 - [Danilo Carolino](@danilogco)
|
|
24
30
|
|
|
25
31
|
* Fix a problem with the locale initialization in Rails projects
|
|
26
32
|
|
|
27
|
-
## v0.1.2
|
|
33
|
+
## v0.1.2 - [Danilo Carolino](@danilogco)
|
|
28
34
|
|
|
29
35
|
* Move auth service to an external package
|
|
30
36
|
|
|
31
|
-
## v0.1.1
|
|
37
|
+
## v0.1.1 - [Danilo Carolino](@danilogco)
|
|
32
38
|
|
|
33
39
|
* Fix a problem with the credentials when its get by the env variables
|
|
34
40
|
* Fix rubocop warnings
|
|
35
41
|
|
|
36
|
-
## v0.1.0
|
|
42
|
+
## v0.1.0 - [Danilo Carolino](@danilogco)
|
|
37
43
|
|
|
38
44
|
* Initial release of bigid_bgcheck
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
|
10
|
+
and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
|
26
|
+
overall community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
|
31
|
+
advances of any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email
|
|
35
|
+
address, without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
danilogcarolino@gmail.com.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
|
86
|
+
of actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
|
93
|
+
permanent ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within
|
|
113
|
+
the community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.0, available at
|
|
119
|
+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
|
122
|
+
enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
|
|
126
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
127
|
+
<https://www.contributor-covenant.org/faq>. Translations are available at
|
|
128
|
+
<https://www.contributor-covenant.org/translations>.
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
|
|
4
|
+
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it;
|
|
5
|
+
- Fork the project;
|
|
6
|
+
- Start a feature/bugfix branch;
|
|
7
|
+
- Commit and push until you are happy with your contribution;
|
|
8
|
+
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
|
|
9
|
+
- 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.
|
|
File without changes
|
data/docs/PUBLISHING.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Publishing
|
|
2
|
+
|
|
3
|
+
After the Github and Rubygems authenticatication, push with the following command:
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
gem build bigid_bgcheck.gemspec
|
|
7
|
+
gem push --key github --host https://rubygems.pkg.github.com/quasar-flash bigid_bgcheck-0.3.0.gem
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
Don't forget to generate the release:
|
|
@@ -9,6 +9,6 @@ module Bigid
|
|
|
9
9
|
# Major - Incremented for incompatible changes with previous release (or big enough new features)
|
|
10
10
|
# Minor - Incremented for new backwards-compatible features + deprecations
|
|
11
11
|
# Patch - Incremented for backwards-compatible bug fixes
|
|
12
|
-
VERSION = "0.3.1.
|
|
12
|
+
VERSION = "0.3.1.3"
|
|
13
13
|
end
|
|
14
14
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bigid_bgcheck
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.3.1.
|
|
4
|
+
version: 0.3.1.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Danilo Carolino
|
|
8
|
-
autorequire:
|
|
8
|
+
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-
|
|
11
|
+
date: 2022-05-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bigid_auth
|
|
@@ -88,16 +88,22 @@ dependencies:
|
|
|
88
88
|
name: bundler
|
|
89
89
|
requirement: !ruby/object:Gem::Requirement
|
|
90
90
|
requirements:
|
|
91
|
+
- - "~>"
|
|
92
|
+
- !ruby/object:Gem::Version
|
|
93
|
+
version: '2.3'
|
|
91
94
|
- - ">="
|
|
92
95
|
- !ruby/object:Gem::Version
|
|
93
|
-
version:
|
|
96
|
+
version: 2.3.0
|
|
94
97
|
type: :development
|
|
95
98
|
prerelease: false
|
|
96
99
|
version_requirements: !ruby/object:Gem::Requirement
|
|
97
100
|
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '2.3'
|
|
98
104
|
- - ">="
|
|
99
105
|
- !ruby/object:Gem::Version
|
|
100
|
-
version:
|
|
106
|
+
version: 2.3.0
|
|
101
107
|
- !ruby/object:Gem::Dependency
|
|
102
108
|
name: factory_bot
|
|
103
109
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -166,14 +172,14 @@ dependencies:
|
|
|
166
172
|
requirements:
|
|
167
173
|
- - "~>"
|
|
168
174
|
- !ruby/object:Gem::Version
|
|
169
|
-
version: '1.
|
|
175
|
+
version: '1.28'
|
|
170
176
|
type: :development
|
|
171
177
|
prerelease: false
|
|
172
178
|
version_requirements: !ruby/object:Gem::Requirement
|
|
173
179
|
requirements:
|
|
174
180
|
- - "~>"
|
|
175
181
|
- !ruby/object:Gem::Version
|
|
176
|
-
version: '1.
|
|
182
|
+
version: '1.28'
|
|
177
183
|
- !ruby/object:Gem::Dependency
|
|
178
184
|
name: rubocop-packaging
|
|
179
185
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -237,10 +243,12 @@ executables: []
|
|
|
237
243
|
extensions: []
|
|
238
244
|
extra_rdoc_files: []
|
|
239
245
|
files:
|
|
240
|
-
- CHANGELOG.md
|
|
241
|
-
- LICENSE.txt
|
|
242
|
-
- README.md
|
|
243
246
|
- Rakefile
|
|
247
|
+
- docs/CHANGELOG.md
|
|
248
|
+
- docs/CODE_OF_CONDUCT.md
|
|
249
|
+
- docs/CONTRIBUTING.md
|
|
250
|
+
- docs/LICENSE.txt
|
|
251
|
+
- docs/PUBLISHING.md
|
|
244
252
|
- lib/bigid/bgcheck/bad_request_error.rb
|
|
245
253
|
- lib/bigid/bgcheck/base_error.rb
|
|
246
254
|
- lib/bigid/bgcheck/doc_type.rb
|
|
@@ -279,7 +287,7 @@ metadata:
|
|
|
279
287
|
changelog_uri: https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/CHANGELOG.md
|
|
280
288
|
source_code_uri: https://github.com/Quasar-Flash/bigid_bgcheck
|
|
281
289
|
bug_tracker_uri: https://github.com/Quasar-Flash/bigid_bgcheck/issues
|
|
282
|
-
post_install_message:
|
|
290
|
+
post_install_message:
|
|
283
291
|
rdoc_options: []
|
|
284
292
|
require_paths:
|
|
285
293
|
- lib
|
|
@@ -294,23 +302,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
294
302
|
- !ruby/object:Gem::Version
|
|
295
303
|
version: '0'
|
|
296
304
|
requirements: []
|
|
297
|
-
rubygems_version: 3.
|
|
298
|
-
signing_key:
|
|
305
|
+
rubygems_version: 3.1.2
|
|
306
|
+
signing_key:
|
|
299
307
|
specification_version: 4
|
|
300
308
|
summary: Bigid Background Check Library
|
|
301
309
|
test_files:
|
|
302
|
-
- spec/
|
|
303
|
-
- spec/
|
|
304
|
-
- spec/
|
|
305
|
-
- spec/
|
|
306
|
-
- spec/bigid/bgcheck/internal_error_spec.rb
|
|
310
|
+
- spec/support/shared_examples/errors_shared_examples.rb
|
|
311
|
+
- spec/bigid_bgcheck_spec.rb
|
|
312
|
+
- spec/factories/result.rb
|
|
313
|
+
- spec/spec_helper.rb
|
|
307
314
|
- spec/bigid/bgcheck/invalid_credentials_error_spec.rb
|
|
308
315
|
- spec/bigid/bgcheck/invalid_document_value_error_spec.rb
|
|
316
|
+
- spec/bigid/bgcheck/doc_type_spec.rb
|
|
309
317
|
- spec/bigid/bgcheck/no_info_error_spec.rb
|
|
310
318
|
- spec/bigid/bgcheck/request_spec.rb
|
|
311
|
-
- spec/bigid/bgcheck/
|
|
319
|
+
- spec/bigid/bgcheck/document_not_supported_error_spec.rb
|
|
320
|
+
- spec/bigid/bgcheck/internal_error_spec.rb
|
|
312
321
|
- spec/bigid/bgcheck/server_error_spec.rb
|
|
313
|
-
- spec/
|
|
314
|
-
- spec/
|
|
315
|
-
- spec/
|
|
316
|
-
- spec/support/shared_examples/errors_shared_examples.rb
|
|
322
|
+
- spec/bigid/bgcheck/result_code_spec.rb
|
|
323
|
+
- spec/bigid/bgcheck/bad_request_error_spec.rb
|
|
324
|
+
- spec/bigid/bgcheck/base_error_spec.rb
|
data/README.md
DELETED
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
BigId Background Check's Library for Ruby
|
|
2
|
-
==============
|
|
3
|
-
|
|
4
|
-
Build Status
|
|
5
|
-
-----------------
|
|
6
|
-
|
|
7
|
-
[](https://badge.fury.io/rb/bigid_bgcheck)
|
|
8
|
-
[](https://github.com/Quasar-Flash/bigid_bgcheck/actions/workflows/ruby.yml)
|
|
9
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
10
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
11
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
12
|
-
|
|
13
|
-
Project Scores
|
|
14
|
-
-----------------
|
|
15
|
-
|
|
16
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
17
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
18
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
19
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
20
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
21
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
22
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
23
|
-
[](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
|
|
24
|
-
|
|
25
|
-
Requirements
|
|
26
|
-
-----------------
|
|
27
|
-
|
|
28
|
-
- Ruby: Any version
|
|
29
|
-
- Bundler
|
|
30
|
-
|
|
31
|
-
Included Modules
|
|
32
|
-
-----------------
|
|
33
|
-
|
|
34
|
-
- [bigid-auth-ruby](https://github.com/Quasar-Flash/bigid-auth-ruby) - BigID API authentication module
|
|
35
|
-
|
|
36
|
-
Global Installation
|
|
37
|
-
-----------------
|
|
38
|
-
|
|
39
|
-
```sh
|
|
40
|
-
gem install bigid_bgcheck
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Installation for Rails
|
|
44
|
-
-----------------
|
|
45
|
-
|
|
46
|
-
```ruby
|
|
47
|
-
# Add to the Gemfile
|
|
48
|
-
gem "bigid_bgcheck", "~> 0.3"
|
|
49
|
-
gem "bigid_bgcheck", github: "Quasar-Flash/bigid_bgcheck"
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Setting the BigID credentials
|
|
53
|
-
-----------------
|
|
54
|
-
|
|
55
|
-
```ruby
|
|
56
|
-
# Set the env variables
|
|
57
|
-
ENV["BIGID_USERNAME"] = "your_username"
|
|
58
|
-
ENV["BIGID_PASSWORD"] = "your_password"
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Setting the BigID credentials - Rails Project
|
|
62
|
-
-----------------
|
|
63
|
-
|
|
64
|
-
Create the config/initializers/bigid.rb file and define:
|
|
65
|
-
|
|
66
|
-
```ruby
|
|
67
|
-
# Set the env variables
|
|
68
|
-
Bigid.configure do |config|
|
|
69
|
-
config.username = "your_username"
|
|
70
|
-
config.password = "your_password"
|
|
71
|
-
end
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Applying a background check
|
|
75
|
-
-----------------
|
|
76
|
-
|
|
77
|
-
```ruby
|
|
78
|
-
require "bigid_bgcheck"
|
|
79
|
-
|
|
80
|
-
Bigid::Bgcheck::Request.new.call(
|
|
81
|
-
document: "000.000.000-00",
|
|
82
|
-
document_type: "CPF",
|
|
83
|
-
group: "Default"
|
|
84
|
-
)
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
Result Example
|
|
88
|
-
-----------------
|
|
89
|
-
|
|
90
|
-
```ruby
|
|
91
|
-
#<Bigid::Bgcheck::Result:0x0000560fef3c1068
|
|
92
|
-
@approved=false,
|
|
93
|
-
@ticket_id="00000000000000000",
|
|
94
|
-
@code=-1100,
|
|
95
|
-
@message="Not Approved",
|
|
96
|
-
@score=0,
|
|
97
|
-
@limit_score=0.0>
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
Problems?
|
|
101
|
-
-----------------
|
|
102
|
-
|
|
103
|
-
**Please do not directly email any committers with questions or problems.** A community is best served when discussions are held in public.
|
|
104
|
-
|
|
105
|
-
Searching the [issues](https://github.com/Quasar-Flash/bigid_bgcheck/issues) for your problem is also a good idea.
|
|
106
|
-
|
|
107
|
-
Contributing
|
|
108
|
-
-----------------
|
|
109
|
-
|
|
110
|
-
- Check out the latest master to make sure the feature hasn"t been implemented or the bug hasn't been fixed yet;
|
|
111
|
-
- Check out the issue tracker to make sure someone already hasn"t requested it and/or contributed it;
|
|
112
|
-
- Fork the project;
|
|
113
|
-
- Start a feature/bugfix branch;
|
|
114
|
-
- Commit and push until you are happy with your contribution;
|
|
115
|
-
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
|
|
116
|
-
- 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.
|
|
117
|
-
|
|
118
|
-
License
|
|
119
|
-
-----------------
|
|
120
|
-
|
|
121
|
-
Please see [LICENSE](https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/LICENSE.txt) for licensing details.
|
|
122
|
-
|
|
123
|
-
Authors
|
|
124
|
-
-----------------
|
|
125
|
-
|
|
126
|
-
Danilo Carolino, [@danilogco](https://github.com/danilogco) / [@Quasar-Flash](https://github.com/Quasar-Flash)
|