OmnyStudio Client

An unofficial Ruby client for the OmnyStudio API

Installation

gem 'omnystudio_client', github:"scpr/omnystudio_client"

Usage

Note: OmnyStudio API props, such as externalId, are in camelCase instead of snake_case because OmnyStudio's API expects it when accessing their API. So when passing params or putting/posting a hash, use camelCase. When interfacing with the gem's API, use snake_case.

Configuration

Configure your app to connect to OmnyStudio, either in an initializer or from your environment files:

omnystudio = OmnyStudioClient.new({
  token: "{omnystudio api token}",
})

Documentation

You can view OmnyStudioClient's documentation in RDoc format here: http://www.rubydoc.info/github/SCPR/omnystudio_client/master/

Tests

To run the tests:

bundle exec rspec spec

Contributing

Pull Requests are encouraged! Suggested practice:

  • Fork and make changes
  • Submit a PR from fork to this master