Unit Ruby

A Ruby SDK for the Unit's Banking-as-a-Service API.

[!IMPORTANT]

The development of the unit-ruby gem is sponsored and used in production by Retirable.

If you are starting a new project, you might want to consider Unit's officially supported gem, unit-ruby-sdk

Features

• Ruby SDK for Unit's Banking-as-a-Service API
• Support for all major Unit API endpoints
• Built-in error handling and response parsing
• Production-ready and battle-tested by Retirable
• Ruby 3.3+ compatibility

Installation

Requirements: Ruby 3.3+

Add this line to your application's Gemfile:

gem 'unit-ruby'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install unit-ruby

Configuration

Configure the library with your credentials from Unit, (e.g., in config/initializers/unit.rb if you are using Ruby on Rails):

require 'unit-ruby'

Unit.configure do |config|
  config.api_key = ENV['UNIT_API_KEY'] # Your Unit API key (required)
  config.base_url = ENV['UNIT_BASE_URL'] # Unit API base URL (required)
  config.trust_token = ENV['UNIT_TRUST_TOKEN'] # Trust token for enhanced security (optional, requires additional configuration from Unit's support team)
end

Usage

my_user_id = 'some-user-id-from-your-app'

# Create an Individual Application
application = Unit::IndividualApplication.create(
    full_name: Unit::Types::FullName.new(first: 'John', last: 'Doe'),
    email: 'individual@example.com',
    ssn: rand(10**9).to_s.rjust(9, '0'),
    phone: Unit::Types::Phone.new(country_code: '1', number: '5555555555'),
    occupation: 'ArchitectOrEngineer',
    address: Unit::Types::Address.new(
        street: '123 Main St.',
        city: 'Brooklyn',
        state: 'NY',
        postal_code: '11211',
        country: 'US'
    ),
    date_of_birth: '2000-01-01',
    tags: {
      externalUserId: my_user_id
    }
)

customer = application.customer

deposit_account = Unit::DepositAccount.create(
    deposit_product: 'checking',
    customer: customer
)

debit_card = Unit::IndividualDebitCard.create(
    idempotency_key: "debit-card-for-#{my_user_id}",
    customer: customer,
    account: deposit_account,
    shipping_address: customer.address,
    tags: { externalUserId: my_user_id }
)

[!TIP]

Refer to the examples in ./spec/** for further examples

Development

After checking out the repo, install dependencies:

$ bin/setup

Run the tests:

$ bin/test

For an interactive prompt to experiment with the gem:

$ bin/console

To install this gem onto your local machine:

$ bundle exec rake install

Releasing

Releases are minted automatically. When a change to lib/unit-ruby/version.rb lands on main, the Release workflow builds the gem, tags the commit vX.Y.Z, and publishes to RubyGems.org. No manual gem push is required, and no RubyGems API key is stored — the workflow authenticates via OIDC trusted publishing.

To cut a release:

1. Make your changes, then bump the version in lib/unit-ruby/version.rb following semantic versioning and add an entry to CHANGELOG.md.
2. Open a PR and get it approved by the appropriate member(s) of the engineering team.
3. Merge to main. The Release workflow publishes the new version automatically. If the version is unchanged, no release is cut.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/retirable/unit-ruby.

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.

License

The gem is available as open source under the terms of the MIT License.