{"id":20566196,"url":"https://github.com/aces/cbrain-client-gem","last_synced_at":"2026-05-30T22:32:07.349Z","repository":{"id":139175179,"uuid":"156040249","full_name":"aces/cbrain-client-gem","owner":"aces","description":"A Ruby gem implementing the CBRAIN API.","archived":false,"fork":false,"pushed_at":"2025-06-25T17:42:23.000Z","size":117,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-09-08T23:28:50.249Z","etag":null,"topics":["cbrain","cbrain-api","cbrain-service","ruby","rubygems"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aces.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-04T01:52:36.000Z","updated_at":"2025-06-25T17:42:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"044b4f28-8c3d-4376-b775-b780a7b5b8eb","html_url":"https://github.com/aces/cbrain-client-gem","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aces/cbrain-client-gem","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-client-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-client-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-client-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-client-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aces","download_url":"https://codeload.github.com/aces/cbrain-client-gem/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aces%2Fcbrain-client-gem/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33712579,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cbrain","cbrain-api","cbrain-service","ruby","rubygems"],"created_at":"2024-11-16T04:40:32.778Z","updated_at":"2026-05-30T22:32:07.288Z","avatar_url":"https://github.com/aces.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cbrain_client\n\nCbrainClient - the Ruby gem for the CBRAIN API\n\nAPI for interacting with the CBRAIN Platform\n\nThis SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 7.0.0\n- Package version: 7.0.0\n- Build package: io.swagger.codegen.languages.RubyClientCodegen\nFor more information, please visit [https://github.com/aces/cbrain](https://github.com/aces/cbrain)\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build cbrain_client.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./cbrain_client-7.0.0.gem\n```\n(for development, run `gem install --dev ./cbrain_client-7.0.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'cbrain_client', '~\u003e 7.0.0'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/aces/cbrain-client-gem, then add the following in the Gemfile:\n\n    gem 'cbrain_client', :git =\u003e 'https://github.com/aces/cbrain-client-gem'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n```ruby\n# Load the gem\nrequire 'cbrain_client'\n\n# Setup authorization\nCbrainClient.configure do |config|\n  # Configure API key authorization: BrainPortalSession\n  config.api_key['cbrain_api_token'] = 'YOUR API KEY'\n  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)\n  #config.api_key_prefix['cbrain_api_token'] = 'Bearer'\nend\n\napi_instance = CbrainClient::BourreauxApi.new\n\nopts = { \n  page: 56, # Integer | Page number when paginating. See also the per_page parameter\n  per_page: 56 # Integer | Size of each page when paginating. See also the page parameter\n}\n\nbegin\n  #Get a list of the Bourreaux available to be used by the current user.\n  result = api_instance.bourreaux_get(opts)\n  p result\nrescue CbrainClient::ApiError =\u003e e\n  puts \"Exception when calling BourreauxApi-\u003ebourreaux_get: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:3000*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*CbrainClient::BourreauxApi* | [**bourreaux_get**](docs/BourreauxApi.md#bourreaux_get) | **GET** /bourreaux | Get a list of the Bourreaux available to be used by the current user.\n*CbrainClient::BourreauxApi* | [**bourreaux_id_get**](docs/BourreauxApi.md#bourreaux_id_get) | **GET** /bourreaux/{id} | Get information about a Bourreau.\n*CbrainClient::DataProvidersApi* | [**data_providers_get**](docs/DataProvidersApi.md#data_providers_get) | **GET** /data_providers | Get a list of the Data Providers available to the current user.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_browse_get**](docs/DataProvidersApi.md#data_providers_id_browse_get) | **GET** /data_providers/{id}/browse | List the files on a Data Provider.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_delete_post**](docs/DataProvidersApi.md#data_providers_id_delete_post) | **POST** /data_providers/{id}/delete | Deletes unregistered files from a CBRAIN Data provider.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_get**](docs/DataProvidersApi.md#data_providers_id_get) | **GET** /data_providers/{id} | Get information on a particular Data Provider.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_is_alive_get**](docs/DataProvidersApi.md#data_providers_id_is_alive_get) | **GET** /data_providers/{id}/is_alive | Pings a Data Provider to check if it is running.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_register_post**](docs/DataProvidersApi.md#data_providers_id_register_post) | **POST** /data_providers/{id}/register | Registers a file as a Userfile in CBRAIN.\n*CbrainClient::DataProvidersApi* | [**data_providers_id_unregister_post**](docs/DataProvidersApi.md#data_providers_id_unregister_post) | **POST** /data_providers/{id}/unregister | Unregisters files as Userfile in CBRAIN.\n*CbrainClient::GroupsApi* | [**groups_get**](docs/GroupsApi.md#groups_get) | **GET** /groups | Get a list of the Groups (projects) available to the current user.\n*CbrainClient::GroupsApi* | [**groups_id_delete**](docs/GroupsApi.md#groups_id_delete) | **DELETE** /groups/{id} | Deletes a Group (project).\n*CbrainClient::GroupsApi* | [**groups_id_get**](docs/GroupsApi.md#groups_id_get) | **GET** /groups/{id} | Get information on a Group (project).\n*CbrainClient::GroupsApi* | [**groups_id_put**](docs/GroupsApi.md#groups_id_put) | **PUT** /groups/{id} | Update the properties of a Group (project).\n*CbrainClient::GroupsApi* | [**groups_post**](docs/GroupsApi.md#groups_post) | **POST** /groups | Creates a new Group.\n*CbrainClient::SessionsApi* | [**session_delete**](docs/SessionsApi.md#session_delete) | **DELETE** /session | Destroy the current session\n*CbrainClient::SessionsApi* | [**session_get**](docs/SessionsApi.md#session_get) | **GET** /session | Get session information\n*CbrainClient::SessionsApi* | [**session_post**](docs/SessionsApi.md#session_post) | **POST** /session | Create a new session\n*CbrainClient::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | Get a list of the tags currently in CBRAIN.\n*CbrainClient::TagsApi* | [**tags_id_delete**](docs/TagsApi.md#tags_id_delete) | **DELETE** /tags/{id} | Delete a tag.\n*CbrainClient::TagsApi* | [**tags_id_get**](docs/TagsApi.md#tags_id_get) | **GET** /tags/{id} | Get one tag.\n*CbrainClient::TagsApi* | [**tags_id_put**](docs/TagsApi.md#tags_id_put) | **PUT** /tags/{id} | Update a tag.\n*CbrainClient::TagsApi* | [**tags_post**](docs/TagsApi.md#tags_post) | **POST** /tags | Create a new tag.\n*CbrainClient::TasksApi* | [**tasks_get**](docs/TasksApi.md#tasks_get) | **GET** /tasks | Get the list of Tasks.\n*CbrainClient::TasksApi* | [**tasks_id_get**](docs/TasksApi.md#tasks_id_get) | **GET** /tasks/{id} | Get information on a Task.\n*CbrainClient::TasksApi* | [**tasks_operation_post**](docs/TasksApi.md#tasks_operation_post) | **POST** /tasks/operation | Control and apply operation to a set of tasks\n*CbrainClient::TasksApi* | [**tasks_post**](docs/TasksApi.md#tasks_post) | **POST** /tasks | Create a new Task.\n*CbrainClient::ToolConfigsApi* | [**tool_configs_get**](docs/ToolConfigsApi.md#tool_configs_get) | **GET** /tool_configs | Get a list of tool versions installed.\n*CbrainClient::ToolConfigsApi* | [**tool_configs_id_get**](docs/ToolConfigsApi.md#tool_configs_id_get) | **GET** /tool_configs/{id} | Get information about a particular tool configuration\n*CbrainClient::ToolsApi* | [**tools_get**](docs/ToolsApi.md#tools_get) | **GET** /tools | Get the list of Tools.\n*CbrainClient::UserfilesApi* | [**userfiles_change_provider_post**](docs/UserfilesApi.md#userfiles_change_provider_post) | **POST** /userfiles/change_provider | Moves the Userfiles from their current Data Provider to a new one.\n*CbrainClient::UserfilesApi* | [**userfiles_compress_post**](docs/UserfilesApi.md#userfiles_compress_post) | **POST** /userfiles/compress | Compresses many Userfiles each into their own GZIP archive.\n*CbrainClient::UserfilesApi* | [**userfiles_delete_files_delete**](docs/UserfilesApi.md#userfiles_delete_files_delete) | **DELETE** /userfiles/delete_files | Delete several files that have been registered as Userfiles\n*CbrainClient::UserfilesApi* | [**userfiles_download_post**](docs/UserfilesApi.md#userfiles_download_post) | **POST** /userfiles/download | Download several files\n*CbrainClient::UserfilesApi* | [**userfiles_get**](docs/UserfilesApi.md#userfiles_get) | **GET** /userfiles | List of the Userfiles accessible to the current user.\n*CbrainClient::UserfilesApi* | [**userfiles_id_content_get**](docs/UserfilesApi.md#userfiles_id_content_get) | **GET** /userfiles/{id}/content | Get the content of a Userfile\n*CbrainClient::UserfilesApi* | [**userfiles_id_get**](docs/UserfilesApi.md#userfiles_id_get) | **GET** /userfiles/{id} | Get information on a Userfile.\n*CbrainClient::UserfilesApi* | [**userfiles_id_put**](docs/UserfilesApi.md#userfiles_id_put) | **PUT** /userfiles/{id} | Update information on a Userfile.\n*CbrainClient::UserfilesApi* | [**userfiles_post**](docs/UserfilesApi.md#userfiles_post) | **POST** /userfiles | Creates a new Userfile and upload its content.\n*CbrainClient::UserfilesApi* | [**userfiles_sync_multiple_post**](docs/UserfilesApi.md#userfiles_sync_multiple_post) | **POST** /userfiles/sync_multiple | Syncs Userfiles to the local Data Providers cache.\n*CbrainClient::UserfilesApi* | [**userfiles_uncompress_post**](docs/UserfilesApi.md#userfiles_uncompress_post) | **POST** /userfiles/uncompress | Uncompresses many Userfiles.\n*CbrainClient::UsersApi* | [**users_get**](docs/UsersApi.md#users_get) | **GET** /users | Returns all of the users in CBRAIN. Only available to admins.\n*CbrainClient::UsersApi* | [**users_id_delete**](docs/UsersApi.md#users_id_delete) | **DELETE** /users/{id} | Deletes a CBRAIN user\n*CbrainClient::UsersApi* | [**users_id_get**](docs/UsersApi.md#users_id_get) | **GET** /users/{id} | Returns information about a user\n*CbrainClient::UsersApi* | [**users_id_patch**](docs/UsersApi.md#users_id_patch) | **PATCH** /users/{id} | Update information about a user\n*CbrainClient::UsersApi* | [**users_post**](docs/UsersApi.md#users_post) | **POST** /users | Create a new user in CBRAIN. Only available to admins.\n\n\n## Documentation for Models\n\n - [CbrainClient::BatchTaskModReq](docs/BatchTaskModReq.md)\n - [CbrainClient::Bourreau](docs/Bourreau.md)\n - [CbrainClient::CbrainTask](docs/CbrainTask.md)\n - [CbrainClient::CbrainTaskModReq](docs/CbrainTaskModReq.md)\n - [CbrainClient::DataProvider](docs/DataProvider.md)\n - [CbrainClient::FileInfo](docs/FileInfo.md)\n - [CbrainClient::Group](docs/Group.md)\n - [CbrainClient::GroupModReq](docs/GroupModReq.md)\n - [CbrainClient::MultiRegistrationModReq](docs/MultiRegistrationModReq.md)\n - [CbrainClient::MultiUserfilesModReq](docs/MultiUserfilesModReq.md)\n - [CbrainClient::RegistrationInfo](docs/RegistrationInfo.md)\n - [CbrainClient::SessionInfo](docs/SessionInfo.md)\n - [CbrainClient::Tag](docs/Tag.md)\n - [CbrainClient::TagModReq](docs/TagModReq.md)\n - [CbrainClient::Tool](docs/Tool.md)\n - [CbrainClient::ToolConfig](docs/ToolConfig.md)\n - [CbrainClient::User](docs/User.md)\n - [CbrainClient::UserModReq](docs/UserModReq.md)\n - [CbrainClient::Userfile](docs/Userfile.md)\n - [CbrainClient::UserfileModReq](docs/UserfileModReq.md)\n\n\n## Documentation for Authorization\n\n\n### BrainPortalSession\n\n- **Type**: API key\n- **API key parameter name**: cbrain_api_token\n- **Location**: URL query string\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-client-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faces%2Fcbrain-client-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faces%2Fcbrain-client-gem/lists"}