https://github.com/fusionauth/fusionauth-example-rails-lob-integration
Integration with lob to allow you to send letters for real world address verification
https://github.com/fusionauth/fusionauth-example-rails-lob-integration
fusionauth lob login-system oauth oauth2 oidc rails
Last synced: 6 months ago
JSON representation
Integration with lob to allow you to send letters for real world address verification
- Host: GitHub
- URL: https://github.com/fusionauth/fusionauth-example-rails-lob-integration
- Owner: FusionAuth
- License: apache-2.0
- Created: 2021-02-27T00:10:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-28T05:55:38.000Z (about 1 year ago)
- Last Synced: 2025-04-05T17:38:06.985Z (6 months ago)
- Topics: fusionauth, lob, login-system, oauth, oauth2, oidc, rails
- Language: Ruby
- Homepage:
- Size: 172 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# README
This application uses the Lob and FusionAuth APIs to verify a user's home address.
## Prereqs
* FusionAuth installed with an API key
* At least the developer edition (for the registration forms), and an activated reactor
* A lob.com account with an API key
## Set up
### Envt
You need to set these variables:
```
export HMAC_SECRET=... # get from FusionAuth keymaster
export FA_API_KEY=... # setup a key
export LOB_API_KEY=... # get from Lob
```
### Rails
Run bundle install
`rails db:migrate`, this creates some forms
`rails s -b 0.0.0.0`
### FusionAuth
set up an application in FusionAuth. Set the oauth config to be `http://localhost:3000/oauth2-callback` for the redirect url and `http://localhost:3000` for the logout url.
Optionally add the first and last name fields to the registration form.
set up a webhook to respond to the user.registration.create event, and point it to `http://localhost:3000/registration_webhook`. Configure the tenant to do the same.
Optionally add the following to the default messages file for your theme. this populates the tooltips on the registration page
```
user.email=Email
user.password=Password
user.birthDate=Birthdate
user.firstName=First name
user.lastName=Last name
user.data.streetaddress1=Address line 1
user.data.streetaddress2=Address line 2
user.data.zipcode=Zip code
```
## Test it out
Using an incognito window, go to http://localhost:3000
Register a user
View the user's data in the admin panel, you'll see the code
Log into lob and you should see a test letter sent
As the user, verify your account using the code
View the user's data in the admin panel, you'll see verification status has changed
You can also query the API for users who have not yet verified their email address:
```
API_KEY=...
curl -XPOST -H "Authorization: $API_KEY" -H "Content-Type: application/json" 'http://localhost:9011/api/user/search' -d '{
"search": {
"numberOfResults": 50,
"query":"{\"match\":{\"data.mailingAddressVerified\":{\"query\":\"false\"}}}",
"startRow": 0
}
}'
```
## Next steps
* Make it look good.
* Actually send the letter instead of the test letter.
* Move the bulk of the webhook into a active job or sidekiq job.
* Figure out log out, which doesn't work smoothly
* Actually display some 'home address verified' protected info