Panoptes::Client

Build Status Yard Docs

Installation

gem 'panoptes-client'

Usage

In general, this library is supposed to be a thin, flat layer over our HTTP-based API. All public API methods can be found on the Client object.

A lot of methods are still missing. We've only just started with this wrapper. You can either issue a PR adding the one you need, or use the generic get / post methods on Client.

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.

The test suite uses VCR to record HTTP requests, so if you're not making any new requests you should be fine with the existing cassettes. If you are, the test suite uses environment variables to pull in authentication credentials. You'll need to create an OAuth application on staging, and set the following env vars:

Variable Value
ZOONIVERSE_CLIENT_ID The application id
ZOONIVERSE_CLIENT_SECRET The application secret
ZOONIVERSE_ACCESS_TOKEN An OAuth access token for the API

We recommend Direnv as good utility to allow you to specify environment variables per directory.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/panoptes-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.