Trolley Ruby SDK

The Trolley Ruby SDK provides integration access to the Trolley API.

Requirements

Ruby version >= 2.4 is required. Bundler is required.

Installation & Usage (RubyGem)

Install the Gem

gem install trolley

Installation & Usage (Git)

Clone the SDK

git clone https://github.com/Trolley/ruby-sdk.git

Build & Install the gem

cd ruby-sdk
bundler install
gem build trolley.gemspec
gem install trolley-[version].gem

Running Tests

// set keys as environment variables
export SANDBOX_ACCESS_KEY="your_access_key"
export SANDBOX_SECRET_KEY="your_secret_key"

// run a single test file, for example:
bundle exec ruby spec/integration/RecipientTest.rb

Getting Started

require 'trolley'

client = Trolley.client('ACCESS-KEY', 'SECRET-KEY')

recipient = client.recipient.find('R-1234567abcdefg')
print recipient.id

Configuring a proxy

client = Trolley.client('ACCESS-KEY', 'SECRET-KEY', proxy_uri: 'peter_the_proxy.com')

Configuring a custom base API URL

client = Trolley.client('key', 'secret', api_base: 'https://api.railz.io')

Documentation for API Endpoints

All URIs are available at http://docs.trolley.com/