An open API service indexing awesome lists of open source software.

https://github.com/openware/kycaid-ruby

kycaid.com ruby library
https://github.com/openware/kycaid-ruby

Last synced: 5 months ago
JSON representation

kycaid.com ruby library

Awesome Lists containing this project

README

          

# Ruby KYCAID

Ruby gem to interact with KYC provider https://www.kycaid.com/

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'kycaid'
```

And then execute:

$ bundle install

Or install it yourself as:

$ gem install kycaid

## Usage

Configure the gem using your issued KYCAID credentials in an initializer file. For example, in config/initializers/kycaid.rb:

```
KYCAID.configure do |config|
config.authorization_token = ENV['KYCAID_AUTHORIZATION_TOKEN']
config.sandbox_mode = ENV['KYCAID_SANDBOX_MODE']
end
```

## 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.

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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/openware/ruby-kycaid.