bigid_bgcheck 0.3.0 → 0.3.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +41 -29
  3. data/lib/bigid/bgcheck/version.rb +1 -1
  4. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d94fea79e3d064b136018dea55150a1839ce25218b82054626a1c32e05495961
4
- data.tar.gz: 55164f99a7d2804515214a8b7db4610e04d5a1a0270bf94c2f8da188534206a5
3
+ metadata.gz: e3c762eb563f762b7422597ffb3854fc268a4d90737b31aedd8bf3eebb629987
4
+ data.tar.gz: f16a28500e579ca49a5f4b00e5dd632e005470bd3023a11585ec8633d93d7435
5
5
  SHA512:
6
- metadata.gz: b2a7bc286c6fabb63e6524c8882923414c7e940016fc9952fd2dd6f6484e6518df3ab910e4df21f205b957def7bbb698fbdfedd58bb7ade69671b251335d3026
7
- data.tar.gz: 7f4218efcdff8cffacee26fbce626d3d14339f776fe0017657ef9b254157ce7e4a1c75e2c4db8467bc3baf760ffb48241838317cb730b00d6532917aad6f50c3
6
+ metadata.gz: b434e3f68d691114a83d6b27b9932b6e3112b41fb49748e4a6d387a475c169c66c2e47697138590198e9a503e8f8337334b05b237d38a86e7d9267c5ef362e97
7
+ data.tar.gz: 8a65f2b886f4603ea8f0bd4de448aad82b6c640ad98088a19c93f02d8d3ab8f4684e5b385ede0021f3a88496a55ee99b4d47b392b895ddbf3d7e470068d646ae
data/README.md CHANGED
@@ -2,8 +2,8 @@ BigId Background Check's Library for Ruby
2
2
  ==============
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/bigid_bgcheck.svg)](https://badge.fury.io/rb/bigid_bgcheck)
5
- [![Build Status](https://travis-ci.com/Quasar-Flash/bigid-bgcheck-ruby.svg?branch=master)](https://travis-ci.com/Quasar-Flash/bigid-bgcheck-ruby)
6
- [![bigid_bgcheck](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/actions/workflows/ruby.yml)
5
+ [![Build Status](https://travis-ci.com/Quasar-Flash/bigid_bgcheck.svg?branch=master)](https://travis-ci.com/Quasar-Flash/bigid_bgcheck)
6
+ [![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)
7
7
 
8
8
  Requirements
9
9
  -----------------
@@ -19,61 +19,73 @@ Included Modules
19
19
  Global Installation
20
20
  -----------------
21
21
 
22
- gem install bigid_bgcheck
22
+ ```sh
23
+ gem install bigid_bgcheck
24
+ ```
23
25
 
24
26
  Installation for Rails
25
27
  -----------------
26
28
 
27
- # Add to the Gemfile
28
- gem "bigid_bgcheck", "~> 0.2"
29
- gem "bigid_bgcheck", github: "Quasar-Flash/bigid-bgcheck-ruby"
29
+ ```ruby
30
+ # Add to the Gemfile
31
+ gem "bigid_bgcheck", "~> 0.3"
32
+ gem "bigid_bgcheck", github: "Quasar-Flash/bigid_bgcheck"
33
+ ```
30
34
 
31
35
  Setting the BigID credentials
32
36
  -----------------
33
37
 
34
- # Set the env variables
35
- ENV["BIGID_USERNAME"] = "your_username"
36
- ENV["BIGID_PASSWORD"] = "your_password"
38
+ ```ruby
39
+ # Set the env variables
40
+ ENV["BIGID_USERNAME"] = "your_username"
41
+ ENV["BIGID_PASSWORD"] = "your_password"
42
+ ```
37
43
 
38
44
  Setting the BigID credentials - Rails Project
39
45
  -----------------
40
46
 
41
47
  Create the config/initializers/bigid.rb file and define:
42
48
 
43
- # Set the env variables
44
- Bigid.configure do |config|
45
- config.username = "your_username"
46
- config.password = "your_password"
47
- end
49
+ ```ruby
50
+ # Set the env variables
51
+ Bigid.configure do |config|
52
+ config.username = "your_username"
53
+ config.password = "your_password"
54
+ end
55
+ ```
48
56
 
49
57
  Applying a background check
50
58
  -----------------
51
59
 
52
- require "bigid_bgcheck"
60
+ ```ruby
61
+ require "bigid_bgcheck"
53
62
 
54
- Bigid::Bgcheck::Request.new.call(
55
- document: "000.000.000-00",
56
- document_type: "CPF",
57
- group: "Default"
58
- )
63
+ Bigid::Bgcheck::Request.new.call(
64
+ document: "000.000.000-00",
65
+ document_type: "CPF",
66
+ group: "Default"
67
+ )
68
+ ```
59
69
 
60
70
  Result Example
61
71
  -----------------
62
72
 
63
- #<Bigid::Bgcheck::Result:0x0000560fef3c1068
64
- @approved=false,
65
- @ticket_id="00000000000000000",
66
- @code=-1100,
67
- @message="Not Approved",
68
- @score=0,
69
- @limit_score=0.0>
73
+ ```ruby
74
+ #<Bigid::Bgcheck::Result:0x0000560fef3c1068
75
+ @approved=false,
76
+ @ticket_id="00000000000000000",
77
+ @code=-1100,
78
+ @message="Not Approved",
79
+ @score=0,
80
+ @limit_score=0.0>
81
+ ```
70
82
 
71
83
  Problems?
72
84
  -----------------
73
85
 
74
86
  **Please do not directly email any committers with questions or problems.** A community is best served when discussions are held in public.
75
87
 
76
- Searching the [issues](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/issues) for your problem is also a good idea.
88
+ Searching the [issues](https://github.com/Quasar-Flash/bigid_bgcheck/issues) for your problem is also a good idea.
77
89
 
78
90
  Contributing
79
91
  -----------------
@@ -89,7 +101,7 @@ Contributing
89
101
  License
90
102
  -----------------
91
103
 
92
- Please see [LICENSE](https://github.com/Quasar-Flash/bigid-bgcheck-ruby/blob/master/LICENSE.txt) for licensing details.
104
+ Please see [LICENSE](https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/LICENSE.txt) for licensing details.
93
105
 
94
106
  Authors
95
107
  -----------------
data/lib/bigid/bgcheck/version.rb CHANGED
@@ -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.0"
12
+ VERSION = "0.3.0.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.0
4
+ version: 0.3.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Danilo Carolino
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-21 00:00:00.000000000 Z
11
+ date: 2021-07-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bigid_auth
@@ -278,13 +278,13 @@ files:
278
278
  - spec/factories/result.rb
279
279
  - spec/spec_helper.rb
280
280
  - spec/support/shared_examples/errors_shared_examples.rb
281
- homepage: https://github.com/Quasar-Flash/bigid-bgcheck-ruby
281
+ homepage: https://github.com/Quasar-Flash/bigid_bgcheck
282
282
  licenses:
283
283
  - MIT
284
284
  metadata:
285
- changelog_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby/blob/master/CHANGELOG.md
286
- source_code_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby
287
- bug_tracker_uri: https://github.com/Quasar-Flash/bigid-bgcheck-ruby/issues
285
+ changelog_uri: https://github.com/Quasar-Flash/bigid_bgcheck/blob/master/CHANGELOG.md
286
+ source_code_uri: https://github.com/Quasar-Flash/bigid_bgcheck
287
+ bug_tracker_uri: https://github.com/Quasar-Flash/bigid_bgcheck/issues
288
288
  post_install_message:
289
289
  rdoc_options: []
290
290
  require_paths: