svbclient Ruby gem
A gem which you can use in your Ruby / Ruby on Rails app to simplify HMAC-signing and headers.
Install
On the command line:
gem install svbclient
In a Gemfile:
gem 'svbclient', '~> 3.2.1'Direct API access
require 'svbclient'
require 'json'
client = SVBClient.new(API_KEY, HMAC_SECRET)
# full client options
SVBClient.new(API_KEY, HMAC_SECRET, base_url: 'https://api.svb.com')
response = client.get("/v1", "query=test")
# you receive the full response from the Rest-Client gem
# https://github.com/rest-client/rest-client
# here's how you get the data:
response_data = JSON.parse(response.body)
# { "data": { "address_line1": "", ... } }
core_response = JSON.parse(response.body)["data"]
# create
client.post("/v1", { "body": "content" })
# update
client.patch("/v1/companies/:id", { "body": "content" })
# delete
client.delete("/v1/companies/:id")
# uploading a file (png, jpg, or pdf)
client.upload('/v1/files', File.new('./images/test.png'), 'image/png')Onboarding API helpers
client = SVBClient.new(api_key, hmac)
Onboarding = SVBClient::Onboarding.new(client)
# create an address
address = Onboarding.address(street_line1: '221B Baker St', city: 'London', country: 'GB')
# address is a new SVBClient::Onboarding::Address object
puts address.id
# update the address
address.update({ street_line1: '222 Baker St' })
# poll the server for up-to-date data on this record
address.data
# retrieve an old address record
old_address = Onboarding.address(id: 101)
old_address.data
# { "street_line1": "", ... }
# delete
old_address.delete
# a reference to an address, address -> address_id
person = Onboarding.person(address: address, first_name: '', ...)
# file upload
file = Onboarding.file(file: File.new('test.png'), mimetype: 'image/png')ACH API helpers
require 'svbclient'
client = SVBClient.new(API_KEY, HMAC_SECRET)
handler = SVBClient::ACHHandler.new(client)
my_ach = handler.create({ account_number: '', ... })
# returns SVBClient::ACH object
# poll the server for up-to-date data on this record
my_ach.data
# cancel an ACH
# you cannot set any other status
my_ach.update_status('canceled')
# return a list of filtered ACHs (one or both filters)
handler.find({ status: 'pending', effective_date: '2017-05-30' })