https://github.com/rubyonworld/checkr-ruby
You don't need this source code unless you want to modify the gem.
https://github.com/rubyonworld/checkr-ruby
code gem modify source
Last synced: 4 months ago
JSON representation
You don't need this source code unless you want to modify the gem.
- Host: GitHub
- URL: https://github.com/rubyonworld/checkr-ruby
- Owner: RubyOnWorld
- License: other
- Created: 2022-09-27T15:23:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-27T16:44:00.000Z (over 3 years ago)
- Last Synced: 2025-05-19T20:32:56.771Z (8 months ago)
- Topics: code, gem, modify, source
- Language: Ruby
- Homepage:
- Size: 187 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Checkr Ruby bindings [](https://github.com/checkr/checkr-ruby/actions) [](https://codeclimate.com/github/checkr/checkr-ruby)
## Installation
You don't need this source code unless you want to modify the gem. If
you just want to use the Checkr Ruby bindings, you should run:
```bash
gem install checkr-official
```
If you want to build the gem from source:
```bash
gem build checkr-official.gemspec
```
If you want to include the gem in IRB you will need to require `checkr`. This naming will hopefully be cleared up if we are given ownership of the `checkr` gem on rubygems.
```ruby
require 'checkr'
```
## Bundler
If you are installing via bundler, you should be sure to use the https
rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised.
```ruby
source 'https://rubygems.org'
gem 'rails'
gem 'checkr-official'
```
## Development
Test cases can be run with: `bundle exec rake test`
## Test Rake Task
To hit the API with some test calls run:
```bash
bundle exec rake test_api["sk_test_api_key"]
```