Helio Ruby Library

The first production release will be version 1.0.0. Until then, consider this gem unstable as the Helio API is in flux.

You don't need this source code unless you want to modify the gem. If you just want to use the package, just run:

gem install helio-ruby

If you want to build the gem from source:

gem build helio-ruby.gemspec

• Ruby 2.0+.

If you are installing via bundler, you should be sure to use the https rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised in transit and alter the code of gems fetched securely over https:

source 'https://rubygems.org'

gem 'rails'
gem 'helio-ruby'

The library needs to be configured with your account's secret key which is available in your [Helio Dashboard][api-keys]. Set Helio.api_token to its value:

require "helio"
Helio.api_id = "..."
Helio.api_token = "..."

# list participants
Helio::Participant.list()

# retrieve single participant
Helio::Participant.retrieve(
  "id",
)

It's also possible to set a per-request key and/or account:

require "helio"

Helio::Participant.list(
  {},
  :api_token => "...",
  :api_id => "..."
)

Helio::Participant.retrieve(
  "id",
  :api_token => "...",
  :api_id => "..."
)

While a default HTTP client is used by default, it's also possible to have the library use any client supported by [Faraday][faraday] by initializing a Helio::HelioClient object and giving it a connection:

conn = Faraday.new
client = Helio::HelioClient.new(conn)
participant, resp = client.request do
  Helio::Participant.retrieve(
    "id",
  )
end
puts resp.request_id

By default, the library will use its own internal bundle of known CA certificates, but it's possible to configure your own:

Helio.ca_bundle_path = "path/to/ca/bundle"

The library can be configured to automatically retry requests that fail due to an intermittent network problem:

Helio.max_network_retries = 2

Open and read timeouts are configurable:

Helio.open_timeout = 30 // in seconds
Helio.read_timeout = 80

Please take care to set conservative read timeouts. Some API requests can take some time, and a short timeout increases the likelihood of a problem within our servers.

The library can be configured to emit logging that will give you better insight into what it's doing. The info logging level is usually most appropriate for production use, but debug is also available for more verbosity.

There are a few options for enabling it:

1. Set the environment variable HELIO_LOG to the value debug or info:

   $ export HELIO_LOG=info
   

2. Set Helio.log_level:

   Helio.log_level = Helio::LEVEL_INFO

If you're writing a plugin that uses the library, we'd appreciate it if you identified using #set_app_info:

Helio.set_app_info("MyAwesomePlugin", version: "1.2.34", url: "https://myawesomeplugin.info");

This information is passed along when the library makes calls to the Helio API.

Run the linter:

bundle exec rake rubocop

Update bundled CA certificates from the [Mozilla cURL release][curl]:

bundle exec rake update_certs