auth-armor 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -8
- data/lib/auth/armor/version.rb +1 -1
- data/lib/auth_armor.rb +3 -2
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f7c3ec99ceb52b0874a0e5232883438c7d0cfef54e3faa042a85f262bd236f85
|
|
4
|
+
data.tar.gz: 06776bf656f10471830b6ac2f327054cc18548b74dd64d3a48bfd8d99fec5e5d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8de484e60045964e910ab185dfbcf0c3514f13f3bc38d81216496d790750c361b29f6199d0ca975ef429ad64eeee2e949a8b5b997447f8076f830c1f78f525ce
|
|
7
|
+
data.tar.gz: e892b894a422e48dd6cc682d86df36bdcfdbfeb0aec97def8e04767bd759ef364dd54d2d5f0443e79e093ea652d3bab3c60d86596b559a9d1361ff702b9c0627
|
data/README.md
CHANGED
|
@@ -26,7 +26,7 @@ The library needs to be instantiated with your client_id and client_secret. This
|
|
|
26
26
|
|
|
27
27
|
```ruby
|
|
28
28
|
require "auth-armor"
|
|
29
|
-
AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
|
|
29
|
+
client = AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
|
|
30
30
|
|
|
31
31
|
```
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
|
|
|
36
36
|
To send an Auth request to the a mobile device or security key, call the `auth_request` method with the following arguments
|
|
37
37
|
|
|
38
38
|
```ruby
|
|
39
|
-
|
|
39
|
+
client.auth_request(
|
|
40
40
|
nickname: "NICKNAME",
|
|
41
41
|
action_name: "Login",
|
|
42
42
|
short_msg: "This is a test message",
|
|
@@ -46,7 +46,7 @@ AuthArmor::Client.auth_request(
|
|
|
46
46
|
### Auth Request for Mobile Device
|
|
47
47
|
|
|
48
48
|
```ruby
|
|
49
|
-
|
|
49
|
+
client.auth_request(
|
|
50
50
|
nickname: "NICKNAME",
|
|
51
51
|
action_name: "Login",
|
|
52
52
|
short_msg: "This is a test message",
|
|
@@ -57,7 +57,7 @@ AuthArmor::Client.auth_request(
|
|
|
57
57
|
### Auth Request for Mobile Device when Biometrics are enforced
|
|
58
58
|
|
|
59
59
|
```ruby
|
|
60
|
-
|
|
60
|
+
client.auth_request(
|
|
61
61
|
nickname: "NICKNAME",
|
|
62
62
|
action_name: "Login",
|
|
63
63
|
short_msg: "This is a test message",
|
|
@@ -69,7 +69,7 @@ AuthArmor::Client.auth_request(
|
|
|
69
69
|
### Auth Request for Security Key
|
|
70
70
|
|
|
71
71
|
```ruby
|
|
72
|
-
|
|
72
|
+
client.auth_request(
|
|
73
73
|
nickname: "NICKNAME",
|
|
74
74
|
action_name: "Login",
|
|
75
75
|
short_msg: "This is a test message",
|
|
@@ -98,7 +98,7 @@ AuthArmor::Client.auth_request(
|
|
|
98
98
|
To generate an invite, call the `invite_request` method with a `nickname`
|
|
99
99
|
|
|
100
100
|
```ruby
|
|
101
|
-
|
|
101
|
+
client.invite_request(
|
|
102
102
|
nickname: "NICKNAME"
|
|
103
103
|
)
|
|
104
104
|
```
|
|
@@ -107,12 +107,14 @@ AuthArmor::Client.invite_request(
|
|
|
107
107
|
|
|
108
108
|
`reference_id` - This is an optional value that you can set to further cross reference your records.
|
|
109
109
|
|
|
110
|
+
`reset_and_reinvite` - If you need to reset the current user and reinvite, set this flag to true. This will remove all mobile devices and/or active pending invites and create a new invite. Use caution when using this - it will reset any existing user with this nickname
|
|
111
|
+
|
|
110
112
|
### Consuming an invite using QR code
|
|
111
113
|
|
|
112
114
|
Once an invite request is created, calling the `generate_qr_code` method returns a JSON that you can generate a QR code.
|
|
113
115
|
|
|
114
116
|
```ruby
|
|
115
|
-
|
|
117
|
+
client.generate_qr_code
|
|
116
118
|
|
|
117
119
|
```
|
|
118
120
|
|
|
@@ -122,7 +124,7 @@ Once an invite request is created, calling the `get_invite_link` method returns
|
|
|
122
124
|
|
|
123
125
|
|
|
124
126
|
```ruby
|
|
125
|
-
|
|
127
|
+
client.get_invite_link
|
|
126
128
|
```
|
|
127
129
|
|
|
128
130
|
## Development
|
data/lib/auth/armor/version.rb
CHANGED
data/lib/auth_armor.rb
CHANGED
|
@@ -74,10 +74,11 @@ module AuthArmor
|
|
|
74
74
|
connect(payload: payload, method: :post, endpoint: "auth/request")
|
|
75
75
|
end
|
|
76
76
|
|
|
77
|
-
def invite_request(reference_id: nil, nickname:)
|
|
77
|
+
def invite_request(reference_id: nil, reset_and_reinvite: false, nickname:)
|
|
78
78
|
payload = {
|
|
79
79
|
nickname: nickname,
|
|
80
|
-
|
|
80
|
+
reference_id: reference_id,
|
|
81
|
+
reset_and_reinvite: reset_and_reinvite
|
|
81
82
|
}
|
|
82
83
|
|
|
83
84
|
response = connect(payload: payload, method: :post, endpoint: "invite/request")
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: auth-armor
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Hannah Masila
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-
|
|
11
|
+
date: 2020-09-10 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|