Contents

# api.acuitydata.co.za API Client
An API client for AcuityData
This is an unofficial project and still a work in progress (WIP)

Based on this website: api.acuitydata.co.za

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'acuitydata'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install acuitydata

## Usage

```ruby
  require 'acuitydata'
  client  = AcuityData::Client.new

  client.make
  client.model(make, year = nil)
  client.year(make, model = nil)
  client.variant(make, model, year)
  client.report(make, model, variant, year, mileage)
```

### Endpoints
-

Other endpoints have not been implemented.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).

### Tests
To run tests execute:

    $ rake test

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/acuitydata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
acuitydata-0.0.4	README.md
acuitydata-0.0.3	README.md