README.md in auth-armor-0.1.2 vs README.md in auth-armor-0.1.3
- old
+ new
@@ -24,42 +24,42 @@
The library needs to be instantiated with your client_id and client_secret. This returns a client object that is authenticated with Oauth2.
```ruby
require "auth-armor"
-AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
+client = AuthArmor::Client.new(client_id: "CLIENT_ID", client_secret: "CLIENT_SECRET")
```
## Auth Request
To send an Auth request to the a mobile device or security key, call the `auth_request` method with the following arguments
```ruby
-AuthArmor::Client.auth_request(
+client.auth_request(
nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
)
```
### Auth Request for Mobile Device
```ruby
-AuthArmor::Client.auth_request(
+client.auth_request(
nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "mobiledevice"
)
```
### Auth Request for Mobile Device when Biometrics are enforced
```ruby
-AuthArmor::Client.auth_request(
+client.auth_request(
nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "mobiledevice",
forcebiometric: true
@@ -67,11 +67,11 @@
```
### Auth Request for Security Key
```ruby
-AuthArmor::Client.auth_request(
+client.auth_request(
nickname: "NICKNAME",
action_name: "Login",
short_msg: "This is a test message",
accepted_auth_methods: "securitykey"
)
@@ -96,34 +96,36 @@
## Invite Request
To generate an invite, call the `invite_request` method with a `nickname`
```ruby
-AuthArmor::Client.invite_request(
+client.invite_request(
nickname: "NICKNAME"
)
```
### Optional arguments
`reference_id` - This is an optional value that you can set to further cross reference your records.
+`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
+
### Consuming an invite using QR code
Once an invite request is created, calling the `generate_qr_code` method returns a JSON that you can generate a QR code.
```ruby
-AuthArmor::Client.generate_qr_code
+client.generate_qr_code
```
### Consuming an invite using link
Once an invite request is created, calling the `get_invite_link` method returns a link that can be shared.
```ruby
-AuthArmor::Client.get_invite_link
+client.get_invite_link
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.