Self Ruby SDK

The official Self SDK for Ruby.

This SDK provides a toolset to interact with Self network from your ruby code.

Installation

Dependencies

• Ruby 3.0 or later
• Self OMEMO
• Flatbuffers

Debian/Ubuntu

curl -LO https://github.com/joinself/self-omemo/releases/download/0.5.0/self-omemo_0.5.0_amd64.deb
apt install -y ./self-omemo_0.5.0_amd64.deb

apt install -y cmake g++
git clone https://github.com/google/flatbuffers.git
cd flatbuffers
git checkout v2.0.0
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
make install

CentOS/Fedora/RedHat

yum install -y openssl-devel ruby-devel
rpm -Uvh https://github.com/joinself/self-omemo/releases/download/0.5.0/self-omemo-0.5.0-1.x86_64.rpm

yum install -y cmake gcc-c++
git clone https://github.com/google/flatbuffers.git
cd flatbuffers
git checkout v2.0.0
cmake -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Release -D FLATBUFFERS_CXX_FLAGS="-Wno-error"
make install

MacOS - AMD64

brew tap joinself/crypto
brew install joinself/crypto/libself-omemo joinself/crypto/flatbuffers

MacOS - ARM64

Brew on M1 macs currently lacks environment variables needed for the SDK to find the omemo library, so you will need to add some additional configuration to your system:

In your ~/.zshrc, add:

export C_INCLUDE_PATH=/opt/homebrew/include/
export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib

You should then be able to run:

source ~/.zshrc
brew tap joinself/crypto
brew install joinself/crypto/libself-omemo joinself/crypto/flatbuffers

Note, you may also need to create /usr/local/lib if it does not exist:

sudo mkdir /usr/local/lib

Install

gem install selfsdk

Usage

Register Application

Before the SDK can be used you must first register an application on the Self Developer Portal. Once registered, the portal will generate credentials for the application that the SDK will use to authenticate against the Self network.

Self provides two isolated networks:

Developer Portal (production network) - Suitable for production services
Developer Portal (sandbox network) - Suitable for testing and experimentation

Register your application using one of the links above (further information).

Examples

Client Setup

require 'selfsdk'

@client = SelfSDK::App.new(
  "<application-id>",
  "<application-secret-key>",
  "random-secret-string",
  "/data",
  env: :sandbox  # optional (defaults to production)
)

@client.start

Authentication

Authentication allows your users to authenticate or register on your app.

Blocking:

auth = @client.authentication.request("<self-id>")
puts "You are now authenticated 🤘" if auth.accepted?

Non-blocking:

@client.authentication.request("<self-id>") do |auth|
  puts "You are now authenticated 🤘" if auth.accepted?
end

Process Incoming Messages

Other peers on self network can send you messages, this client offers you a subscription model to process them by type.

@client.authentication.subscribe do |auth|
  if auth.accepted?
    puts "#{auth.id} has accepted your auth request"
  else
    puts "#{auth.id} has rejected your auth request"
  end
end

Information or Fact Requests

You can request some information to other peers on the network. Same as with authentication you can do this using blocking and non-blocking approaches.

Blocking:

res = @client.facts.request("<self-id>", [:unverified_phone_number])
puts "Requested phone number is #{res.attestation(:unverified_phone_number).value}"

Non-blocking:

@client.facts.request("<self-id>", [:unverified_phone_number]) do |res|
  puts "Requested phone number is #{res.attestation(:unverified_phone_number).value}"
end

ACL Management

ACL's control who can and can't interact with the application. When registering your application you can set a default ACL to allow Everyone or Just you.

List ACL's:

@client.messaging.allowed_connections

Allow connection from a specific identity:

@client.messaging.permit_connection "<self-id>"

Block connection from specific identity:

@client.messaging.revoke_connection "<self-id>"

Documentation

• SDK documentation
• General documentation
• Examples

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

This project uses semantic versioning https://semver.org/. To create a new version run bundle exec rake bump:(major|minor|patch) depending on the version number you wish to increment. This will update the applications version as well as rebuild the dependencies to include the new version. Upon changes being merged into mainstream a new gem will be built, tagged and published to RubyGems.

Developer commands

rake sources:generate

Generates the valid sources based on a json file (config/sources.json) instead of have them hardcoded on the gem.

Support

Looking for help? Reach out to us at support@joinself.com

Contributing

See Contributing.

License

See License.