Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 1.21 KB

README.md

File metadata and controls

51 lines (30 loc) · 1.21 KB
Raw

Checkr Ruby bindings Build Status Code Climate

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:

gem install checkr-official

If you want to build the gem from source:

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.

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.

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:

bundle exec rake test_api["sk_test_api_key"]