# LingutestClient

This library will allow you to communicate with Lingu Test API. You can create examinations for client, and receive examination results. You need API token from Lingu Test to use this gem. Check [documentation](https://test.lingu.com/documentation) for API calls.


## Installation

Add this line to your application's Gemfile:

```ruby
gem 'lingutest_client'
```

And then execute:

    $ bundle install

## Configuration

```ruby
# config/initializers/lingutest_client.rb

LingutestClient.configure do |config|
  config.api_base = 'https://test.lingu.com/api/v1/'
  config.api_key  = 'yourLinguTestApiKey'
end
```

## Usage

```ruby
LingutestClient::Exam.list

LingutestClient::Candidate.list
LingutestClient::Candidate.find(id)
LingutestClient::Candidate.create(fname:, lname:, email:, ssn:, gender:, mobile:)
LingutestClient::Candidate.update(fname:, lname:, email:, ssn:, gender:, mobile:)

LingutestClient::Examination.list
LingutestClient::Examination.find(id)
LingutestClient::Examination.create(candidate_id:, exam_id:, expires_at:)
```

## 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/AdeptLMS/lingutest_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/AdeptLMS/lingutest_client/blob/master/CODE_OF_CONDUCT.md).


## Code of Conduct

Everyone interacting in the LingutestClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AdeptLMS/lingutest_client/blob/master/CODE_OF_CONDUCT.md).