Project

trolley

0.01
There's a lot of open issues
trolleytrolley/ruby-sdkHomepageDocumentationSource CodeBug Tracker
Ruby SDK for interacting with the Trolley API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,764
Stars
6
Forks
8
Watchers
10
 Releases
Current version
1.0.3
Total releases
4
First release
2023-03-14
Latest release
2023-06-02
 Issues
Open Issues
2
Closed Issues
5
Total Issues
7
Issue Closure Rate
71%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
8
Merged Pull Requests
63
Pull Request Acceptance Rate
87%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-05-11
Reverse Dependencies
0

 Dependencies

Development

dotenv
~> 2
rake
~> 13
rubocop
~> 1
test-unit
~> 3
 Project Readme

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 test/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/