GVIVE Ruby SDK
This gem is a wrapper around GVIVE Identity Verification API offered at https://gvivegh.com/ by Bsystems Limited Ghana. The SDK currently supports Voter ID, Passport & Driver License verifications.
This gem was extracted from a private project I was working on for reuse in other projects, hope it saves u some code time :)
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install gvive
You can simply set
GVIVE_USERNAME environment variables and gem should work flawlessly. You may check your OS documentations on how to set environment variables.
On Mac OS X & Linux Systems you can set these variables in your
export GVIVE_API_KEY=some_api_key export GVIVE_USERNAME=some_username
Initializer Setup (Optional)
If you do not prefer or want to override the environment variable option you can simply initialize a config setting. If you using Rails you can put this in your
initializers directory eg
. do |config| config.api_key = 'some_api_key' # Provided by GVIVE config.username = 'some_username' # Provided by GVIVE end
Voter ID Verification
You are required to provide the Voter ID number
voter = ::::.('6580676543') if voter.valid? p voter.data.fullname p voter.data.polling_station p voter.data.residential_address # ... else p voter.data. end
Passport ID Verification
You are required to provide the Passport ID number
passport = ::::.('G00827283') if passport.valid? p passport.data.first_name p passport.data.last_name p passport.data.gender p passport.data.expiry_date # ... else p passport.data. end
Driver License Verification
You are required to provide the Certificate of Competence Number & the full name as printed exactly on the card.
driver = ::::.('COO92930','Alfred Rowe') if driver.valid? p driver.data.first_name p driver.data.last_name p driver.data.class_of_licence p driver.data.date_of_issue # ... else p driver.data. end
In order to protect valid identity information, all valid IDs have been moved to environment variables. You will need to set them up before tests can pass for valid ID specs.
export GVIVE_VALID_VID=VOTER_ID_NUMBER export GVIVE_VALID_PID=PASSPORT_ID_NUMBER export GVIVE_VALID_DCOC=DRIVER_CERTIFICATE_OF_COMPETENCE_NUMBER export GVIVE_VALID_DNAME="Full name as printed exactly on ID card"
After checking out the repo, run
bin/setup to install dependencies. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/nukturnal/gvive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Gvive project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.