SolovisApiClient

An API client to communicate with the Solovis API.

Installation

The SolovisApiClient gem is included in the main Synap app (animated-ninja).

Add this line to your application's Gemfile:

gem 'solovis_api_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install solovis_api_client

Usage

Create an API client by instantiating SolovisApiClient::Base, passing the Solovis environment's URL and a corresponding API key, formatted as api_key__api_secret

  client = SolovisApiClient::Base.new(url: 'https://synap-demo.gateway.solovis.com', api_key: 'my-api-key__my-api-secret');

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

Built by Synap