Nova::API

Introduction

Installation

Add this line to your application's Gemfile:

gem 'nova-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nova-api

Usage

First set your credentials and subdomain using the configure method of the Nova::API class:

Nova::API.configure do |config|
  config.api_key = 'your-api-key'
  config.subdomain = 'your-subdomain'
end

After that you can start using the resources either by:

Instantiating a new Nova::API::Client object;

Using directly the available resource class (check the resources under api/resource folder)

To know the operations that are supported by a resource, please check the resource source code under the api/resource folder.

Querying

For most of the query methods, you can pass either a Hash with the parameters described in the API documentation or, if you prefer an object oriented way, you can use the SearchParams classes, that offer the same functionality but as an object.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/coyosoftware/nova-api.

License

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