bigid_bgcheck 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: be95a78ca1f565303461532c086f52e0fdc83dcfac235fed73c995f9f81493e1
4
- data.tar.gz: 5fdeb2b9f0a5aeb97282cd55289030cd85584ab6da1879cc480c46590128e0a2
3
+ metadata.gz: 7886a04c546951d77a298933cad061760cc783c4b86fe4fcaa38d985bafa0e31
4
+ data.tar.gz: fcd09ead79b995ae82230b76c82cc710be22f52432e4ef023d37454c3358de99
5
5
  SHA512:
6
- metadata.gz: 9facd77ce7d71802b439c4e8cd074f8729f0d7de4492430f0de893e0712aecad2d7dcd2296845601477848670508b1423b90f077dceeb483993951207b47967b
7
- data.tar.gz: c55c18f21e057426a1e634a731106a13a85028c2f2327d00b969b98917e047cfadd646eaa372ef97524aa34160acc4af2681d8cd25467ba24f2ce20c64647873
6
+ metadata.gz: 55959edbe9aa5859c749622a9572ab4e9da398c6e3846561170a2da20f9e6b653cb1a5bfeb21e79181cc1cb00889d7f0866b791b77e4055508ec1060c4fed5e3
7
+ data.tar.gz: be555051741add4b5b3cc12b7b8f384a8c43501731eb640af6706514be1013c16517dd0c7b3c74639e8e569c11eea5a387e2288596f6d3635e4d4e60f5a6522f
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
data/docs/CHANGELOG.md ADDED
@@ -0,0 +1,76 @@
1
+ # Changelog
2
+
3
+ All notable Changed to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [0.3.2] - 2022-06-13
11
+
12
+ ### Changed
13
+
14
+ - build(deps): bump bigid_auth version from 0.2.1 to 0.2.2 #31
15
+
16
+ ## [0.3.1.3] - 2022-05-06
17
+
18
+ ### Added
19
+
20
+ - feat: automatize the project deployment proccess
21
+
22
+ ### Changed
23
+
24
+ - build(deps): bump ruby version from 3.1.0 to 3.1.2
25
+ - build(deps): bump bigid_auth version to v0.2.1.4
26
+
27
+ ## [0.3.1.1] - 2022-02-09
28
+
29
+ ### Changed
30
+
31
+ - bump bigid_auth version to v0.2.1.1
32
+
33
+ ## [0.3.1] - 2022-02-02
34
+
35
+ ### Changed
36
+
37
+ - [QC-79](https://qflash.atlassian.net/jira/software/projects/QC/boards/31?selectedIssue=QC-79)
38
+ Reduzir uso de pipelines em projetos Ruby [Dependabot]
39
+ - Bump Ruby version to v3.1.0
40
+
41
+ ## [0.3.0]
42
+
43
+ ### Changed
44
+
45
+ - Bump "bigid_auth" version from v0.1.0 to v0.2.0
46
+
47
+ ## [0.2.0]
48
+
49
+ ### Added
50
+
51
+ - Add fields to service return: "raw_data", "score_details", "related_score_details" and "raw_response" (the complete json file)
52
+
53
+ ## [0.1.3]
54
+
55
+ ### Fixed
56
+
57
+ - Fix a problem with the locale initialization in Rails projects
58
+
59
+ ## [0.1.2]
60
+
61
+ ### Changed
62
+
63
+ - Move auth service to an external package
64
+
65
+ ## [0.1.1]
66
+
67
+ ### Fixed
68
+
69
+ - Fix a problem with the credentials when its get by the env variables
70
+ - Fix rubocop warnings
71
+
72
+ ## [0.1.0]
73
+
74
+ ### Added
75
+
76
+ - 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
@@ -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.2"
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.2
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-02-02 00:00:00.000000000 Z
11
+ date: 2022-06-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bigid_auth
@@ -16,14 +16,20 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.2'
19
+ version: 0.2.2
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 0.2.0
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
27
  - - "~>"
25
28
  - !ruby/object:Gem::Version
26
- version: '0.2'
29
+ version: 0.2.2
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 0.2.0
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: i18n
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -88,16 +94,22 @@ dependencies:
88
94
  name: bundler
89
95
  requirement: !ruby/object:Gem::Requirement
90
96
  requirements:
97
+ - - "~>"
98
+ - !ruby/object:Gem::Version
99
+ version: '2.3'
91
100
  - - ">="
92
101
  - !ruby/object:Gem::Version
93
- version: '1.2'
102
+ version: 2.3.0
94
103
  type: :development
95
104
  prerelease: false
96
105
  version_requirements: !ruby/object:Gem::Requirement
97
106
  requirements:
107
+ - - "~>"
108
+ - !ruby/object:Gem::Version
109
+ version: '2.3'
98
110
  - - ">="
99
111
  - !ruby/object:Gem::Version
100
- version: '1.2'
112
+ version: 2.3.0
101
113
  - !ruby/object:Gem::Dependency
102
114
  name: factory_bot
103
115
  requirement: !ruby/object:Gem::Requirement
@@ -118,21 +130,21 @@ dependencies:
118
130
  requirements:
119
131
  - - "~>"
120
132
  - !ruby/object:Gem::Version
121
- version: '0.14'
133
+ version: 0.14.1
122
134
  type: :development
123
135
  prerelease: false
124
136
  version_requirements: !ruby/object:Gem::Requirement
125
137
  requirements:
126
138
  - - "~>"
127
139
  - !ruby/object:Gem::Version
128
- version: '0.14'
140
+ version: 0.14.1
129
141
  - !ruby/object:Gem::Dependency
130
142
  name: rake
131
143
  requirement: !ruby/object:Gem::Requirement
132
144
  requirements:
133
145
  - - "~>"
134
146
  - !ruby/object:Gem::Version
135
- version: '13.0'
147
+ version: 13.0.6
136
148
  - - ">="
137
149
  - !ruby/object:Gem::Version
138
150
  version: 10.0.0
@@ -142,7 +154,7 @@ dependencies:
142
154
  requirements:
143
155
  - - "~>"
144
156
  - !ruby/object:Gem::Version
145
- version: '13.0'
157
+ version: 13.0.6
146
158
  - - ">="
147
159
  - !ruby/object:Gem::Version
148
160
  version: 10.0.0
@@ -152,84 +164,84 @@ dependencies:
152
164
  requirements:
153
165
  - - "~>"
154
166
  - !ruby/object:Gem::Version
155
- version: '3.10'
167
+ version: 3.11.0
156
168
  type: :development
157
169
  prerelease: false
158
170
  version_requirements: !ruby/object:Gem::Requirement
159
171
  requirements:
160
172
  - - "~>"
161
173
  - !ruby/object:Gem::Version
162
- version: '3.10'
174
+ version: 3.11.0
163
175
  - !ruby/object:Gem::Dependency
164
176
  name: rubocop
165
177
  requirement: !ruby/object:Gem::Requirement
166
178
  requirements:
167
179
  - - "~>"
168
180
  - !ruby/object:Gem::Version
169
- version: '1.25'
181
+ version: 1.30.1
170
182
  type: :development
171
183
  prerelease: false
172
184
  version_requirements: !ruby/object:Gem::Requirement
173
185
  requirements:
174
186
  - - "~>"
175
187
  - !ruby/object:Gem::Version
176
- version: '1.25'
188
+ version: 1.30.1
177
189
  - !ruby/object:Gem::Dependency
178
190
  name: rubocop-packaging
179
191
  requirement: !ruby/object:Gem::Requirement
180
192
  requirements:
181
193
  - - "~>"
182
194
  - !ruby/object:Gem::Version
183
- version: '0.5'
195
+ version: 0.5.1
184
196
  type: :development
185
197
  prerelease: false
186
198
  version_requirements: !ruby/object:Gem::Requirement
187
199
  requirements:
188
200
  - - "~>"
189
201
  - !ruby/object:Gem::Version
190
- version: '0.5'
202
+ version: 0.5.1
191
203
  - !ruby/object:Gem::Dependency
192
204
  name: rubocop-performance
193
205
  requirement: !ruby/object:Gem::Requirement
194
206
  requirements:
195
207
  - - "~>"
196
208
  - !ruby/object:Gem::Version
197
- version: '1.13'
209
+ version: 1.14.2
198
210
  type: :development
199
211
  prerelease: false
200
212
  version_requirements: !ruby/object:Gem::Requirement
201
213
  requirements:
202
214
  - - "~>"
203
215
  - !ruby/object:Gem::Version
204
- version: '1.13'
216
+ version: 1.14.2
205
217
  - !ruby/object:Gem::Dependency
206
218
  name: simplecov
207
219
  requirement: !ruby/object:Gem::Requirement
208
220
  requirements:
209
221
  - - "~>"
210
222
  - !ruby/object:Gem::Version
211
- version: '0.21'
223
+ version: 0.21.2
212
224
  type: :development
213
225
  prerelease: false
214
226
  version_requirements: !ruby/object:Gem::Requirement
215
227
  requirements:
216
228
  - - "~>"
217
229
  - !ruby/object:Gem::Version
218
- version: '0.21'
230
+ version: 0.21.2
219
231
  - !ruby/object:Gem::Dependency
220
232
  name: simplecov-json
221
233
  requirement: !ruby/object:Gem::Requirement
222
234
  requirements:
223
235
  - - "~>"
224
236
  - !ruby/object:Gem::Version
225
- version: '0.2'
237
+ version: 0.2.3
226
238
  type: :development
227
239
  prerelease: false
228
240
  version_requirements: !ruby/object:Gem::Requirement
229
241
  requirements:
230
242
  - - "~>"
231
243
  - !ruby/object:Gem::Version
232
- version: '0.2'
244
+ version: 0.2.3
233
245
  description: A library to use BigData Corps background check features
234
246
  email:
235
247
  - danilo.carolino@qflash.com.br
@@ -237,10 +249,12 @@ executables: []
237
249
  extensions: []
238
250
  extra_rdoc_files: []
239
251
  files:
240
- - CHANGELOG.md
241
- - LICENSE.txt
242
- - README.md
243
252
  - Rakefile
253
+ - docs/CHANGELOG.md
254
+ - docs/CODE_OF_CONDUCT.md
255
+ - docs/CONTRIBUTING.md
256
+ - docs/LICENSE.txt
257
+ - docs/PUBLISHING.md
244
258
  - lib/bigid/bgcheck/bad_request_error.rb
245
259
  - lib/bigid/bgcheck/base_error.rb
246
260
  - lib/bigid/bgcheck/doc_type.rb
@@ -279,7 +293,7 @@ metadata:
279
293
  changelog_uri: https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/CHANGELOG.md
280
294
  source_code_uri: https://github.com/Quasar-Flash/bigid_bgcheck
281
295
  bug_tracker_uri: https://github.com/Quasar-Flash/bigid_bgcheck/issues
282
- post_install_message:
296
+ post_install_message:
283
297
  rdoc_options: []
284
298
  require_paths:
285
299
  - lib
@@ -294,23 +308,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
294
308
  - !ruby/object:Gem::Version
295
309
  version: '0'
296
310
  requirements: []
297
- rubygems_version: 3.3.3
298
- signing_key:
311
+ rubygems_version: 3.1.6
312
+ signing_key:
299
313
  specification_version: 4
300
314
  summary: Bigid Background Check Library
301
315
  test_files:
302
- - spec/bigid/bgcheck/bad_request_error_spec.rb
303
- - spec/bigid/bgcheck/base_error_spec.rb
304
- - spec/bigid/bgcheck/doc_type_spec.rb
305
- - spec/bigid/bgcheck/document_not_supported_error_spec.rb
306
- - spec/bigid/bgcheck/internal_error_spec.rb
307
316
  - spec/bigid/bgcheck/invalid_credentials_error_spec.rb
308
- - spec/bigid/bgcheck/invalid_document_value_error_spec.rb
317
+ - spec/bigid/bgcheck/base_error_spec.rb
309
318
  - spec/bigid/bgcheck/no_info_error_spec.rb
319
+ - spec/bigid/bgcheck/invalid_document_value_error_spec.rb
320
+ - spec/bigid/bgcheck/doc_type_spec.rb
310
321
  - spec/bigid/bgcheck/request_spec.rb
311
322
  - spec/bigid/bgcheck/result_code_spec.rb
323
+ - spec/bigid/bgcheck/document_not_supported_error_spec.rb
324
+ - spec/bigid/bgcheck/internal_error_spec.rb
312
325
  - spec/bigid/bgcheck/server_error_spec.rb
326
+ - spec/bigid/bgcheck/bad_request_error_spec.rb
327
+ - spec/support/shared_examples/errors_shared_examples.rb
313
328
  - spec/bigid_bgcheck_spec.rb
314
329
  - spec/factories/result.rb
315
330
  - spec/spec_helper.rb
316
- - spec/support/shared_examples/errors_shared_examples.rb
data/CHANGELOG.md DELETED
@@ -1,34 +0,0 @@
1
- # CHANGELOG for bigid_bgcheck
2
-
3
- ## v0.3.1-20220202 - Danilo Carolino
4
-
5
- * [QC-79](https://qflash.atlassian.net/jira/software/projects/QC/boards/31?selectedIssue=QC-79)
6
- Reduzir uso de pipelines em projetos Ruby [Dependabot]
7
- * Bump Ruby version to v3.1.0
8
-
9
- ## v0.3.0
10
-
11
- * Bump "bigid_auth" version from v0.1.0 to v0.2.0
12
-
13
- ## v0.2.0
14
-
15
- Features
16
-
17
- * Add fields to service return: "raw_data", "score_details", "related_score_details" and "raw_response" (the complete json file)
18
-
19
- ## v0.1.3
20
-
21
- * Fix a problem with the locale initialization in Rails projects
22
-
23
- ## v0.1.2
24
-
25
- * Move auth service to an external package
26
-
27
- ## v0.1.1
28
-
29
- * Fix a problem with the credentials when its get by the env variables
30
- * Fix rubocop warnings
31
-
32
- ## v0.1.0
33
-
34
- * Initial release of bigid_bgcheck
data/README.md DELETED
@@ -1,126 +0,0 @@
1
- BigId Background Check's Library for Ruby
2
- ==============
3
-
4
- Build Status
5
- -----------------
6
-
7
- [![Gem Version](https://badge.fury.io/rb/bigid_bgcheck.svg)](https://badge.fury.io/rb/bigid_bgcheck)
8
- [![bigid_bgcheck](https://github.com/Quasar-Flash/bigid_bgcheck/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/bigid_bgcheck/actions/workflows/ruby.yml)
9
- [![Quality Gate Status](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=alert_status&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
10
- [![Coverage](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=coverage&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
11
- [![Maintainability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=sqale_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
12
-
13
- Project Scores
14
- -----------------
15
-
16
- [![Bugs](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=bugs&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
17
- [![Code Smells](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=code_smells&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
18
- [![Duplicated Lines (%)](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=duplicated_lines_density&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
19
- [![Lines of Code](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=ncloc&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
20
- [![Reliability Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=reliability_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
21
- [![Security Rating](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=security_rating&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
22
- [![Technical Debt](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=sqale_index&token=23b79ee0eebe63611e370ffb911d9be245c99154)](https://sonarqube.eks.qflash.com.br/dashboard?id=Quasar-Flash_bigid_bgcheck)
23
- [![Vulnerabilities](https://sonarqube.eks.qflash.com.br/api/project_badges/measure?project=Quasar-Flash_bigid_bgcheck&metric=vulnerabilities&token=23b79ee0eebe63611e370ffb911d9be245c99154)](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)