Module: Vortex

Defined in:: lib/vortex.rb,
lib/vortex/error.rb,
lib/vortex/rails.rb,
lib/vortex/types.rb,
lib/vortex/client.rb,
lib/vortex/sinatra.rb,
lib/vortex/version.rb

Overview

Vortex Ruby SDK

This gem provides a Ruby interface to the Vortex invitation system, with the same functionality and API compatibility as other Vortex SDKs (Node.js, Python, Java, Go).

Features:

JWT generation with identical algorithm to other SDKs
Complete invitation management API
Rails and Sinatra framework integrations
Same route structure for React provider compatibility

Basic usage:

require 'vortex'

client = Vortex::Client.new(ENV['VORTEX_API_KEY'])

jwt = client.generate_jwt(
  user_id: 'user123',
  identifiers: [{ type: 'email', value: '[email protected]' }],
  groups: [{ id: 'team1', type: 'team', name: 'Engineering' }],
  role: 'admin'
)

Framework integrations:

# Rails
require 'vortex/rails'

# Sinatra
require 'vortex/sinatra'

Defined Under Namespace

Modules: Rails, Sinatra, Types Classes: Client, VortexError

Constant Summary collapse

VERSION =

'1.1.3'

Class Method Summary collapse

.new(api_key, base_url: nil) ⇒ Vortex::Client

Create a new Vortex client instance.
.version ⇒ String

Get the current version of the SDK.

Class Method Details

.new(api_key, base_url: nil) ⇒ `Vortex::Client`

Create a new Vortex client instance



45
46
47

# File 'lib/vortex.rb', line 45

def new(api_key, base_url: nil)
  Client.new(api_key, base_url: base_url)
end

.version ⇒ `String`

Get the current version of the SDK



52
53
54

# File 'lib/vortex.rb', line 52

def version
  VERSION
end