The Ruby SDK provides a generic set of wrappers so you can make API calls easily.
If you are logged in to an Arvados VM, the Ruby SDK should be installed.
To use it elsewhere, you can either install the arvados gem via RubyGems or build and install the package using the arvados source tree.
The SDK uses curl which depends on the libcurl C library. To build the module you may have to install additional packages. On supported versions of Debian and Ubuntu, run:
# apt install build-essential libcurl4-openssl-dev
# gem install arvados
If the SDK is installed, ruby -r arvados -e 'puts "OK!"' should produce no errors.
If your ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are set up correctly (see api-tokens for details), the following test script should work:
$ ruby -r arvados <<'EOF'
arv = Arvados.new api_version: 'v1'
my_full_name = arv.user.current[:full_name]
puts "arvados.v1.users.current.full_name = '#{my_full_name}'"
EOF
arvados.v1.users.current.full_name = 'Your Name'
The content of this documentation is licensed under the
Creative
Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the
Apache License, Version 2.0.