Installation
Add this line to your application’s Gemfile:
gem "ribose"
And then execute:
$ bundle install
Or install it yourself as:
$ gem install ribose
Configure
We need to setup Ribose API configuration before we can perform any request throughout this client
First, obtain an API token as per this Github wiki. Using the token, configure the client by adding an initializer with the following code:
Ribose.configure do |config|
config.user_email = "[email protected]"
config.user_password = "your-password"
# INFRA_ID is a 7-digit id, which can be found from the network requests
# e.g. ed6af7b for current production environment
config.api_host = URI.parse('https://app-INFRA_ID.ribose.com')
# There are also some default configurations. Normally you do not need to
# change those unless you have some very specific use cases.
#
# config.debug_mode = false
# config.api_host = "www.ribose.com"
# Deprecated
# config.api_token = "SECRET_API_TOKEN"
# config.api_email = "[email protected]"
end
Or:
Ribose.configuration.api_host = "https://app-INFRA_ID.ribose.com"
Ribose.configuration.user_email = "[email protected]"
Ribose.configuration.user_password = "your-password"
```
=======
Usage
App Data
App Relation
List app relations
To retrieve the list of app relations, we can use the AppRelation.all
interface.
Fetch an app relation
To retrieve the details for a specific app relation, we can use the following interface.
Ribose::AppRelation.fetch(app_relation_id)
Profile
Settings
List user’s settings
To list user’s settings we can use the Setting.all
interface, and it will return all of the user’s settings.
Fetch a setting
To fetch the details for any specific settings we can use the Setting.fetch
interface with the specific Setting ID, and it will return the details for that setting.
Spaces
List user’s Spaces
To list a user’s Spaces we can use the Space.all
interface, and it will retrieve all of the Spaces for the currently configured user.
Fetch a user Space
To retrieve the details for a Space we can use the Space.fetch(space_id)
.
Create a user Space
To create a new user Space,
Update a user Space
Members
The members endpoint are Space-specific.
To retrieve the member details under any specific Space, we can use this interface.
Fetch Member Role
Ribose::MemberRole.fetch(space_id, member_id, )
Assign a role to member
Ribose::MemberRole.assign(space_id, member_id, role_id)
Files
List of Files
To retrieve the list of files for any specific Space,
Fetch a file icon
Ribose::SpaceFile.fetch_icon(space_id, file_id, = {})
Create a file upload
File Version
Fetch file version
Ribose::FileVersion.fetch(
space_id: space_id, file_id: file_id, version_id: version_id
)
Create a new file version
Ribose::FileVersion.create(
space_id: your_space_id,
file_id: existing_file_id_in_space,
file: file_path_for_the_new_version,
**any_other_additional_attributes
)
Conversations
Listing Space Conversations
Ribose::Conversation.all(space_id, = {})
Retrieve a conversation details
Ribose::Conversation.fetch(space_id, conversation_id)
Create A New Conversation
Ribose::Conversation.create(
space_id, name: "Sample conversation", tag_list: "sample, conversation"
)
Update a conversation
Ribose::Conversation.update(space_id, conversation_id, new_attributes_hash)
Remove A Conversation
Ribose::Conversation.destroy(space_id: "space_id", conversation_id: "12345")
Mark a conversation as favorite
Ribose::Conversation.mark_as_favorite(space_id, conversation_id)
Message
List Conversation Messages
Create a new message
Update an existing message
Leaderboard
Retrieve the current leadership board
To retrieve the current leadership board,
Connections
List of connections
To retrieve the list of connections, we can use the Connection.all
interface and it will return the connection as Sawyer::Resource
.
Disconnect a connection
To disconnect with an existing connection, we can use Connection.disconnect
interface as following.
This expect us to provide the connection id, and it also support an additional options hash to provide custom options.
Ribose::Connection.disconnect(connection_id, )
Connection suggestions
To retrieve the list of user connection suggestions,
Invitations
List connection invitations
List Space invitations
Fetch a connection invitation
Ribose::ConnectionInvitation.fetch(invitation_id)
Create mass connection invitations
Ribose::ConnectionInvitation.create(
emails: ["[email protected]", "[email protected]"],
body: "This contains the details message about the invitation",
)
Accept a connection invitation
Ribose::ConnectionInvitation.accept(invitation_id)
Reject a connection invitation
Ribose::ConnectionInvitation.reject(invitation_id)
Cancel a connection invitation
Ribose::ConnectionInvitation.cancel(invitation_id)
Invite user to a Space
Ribose::SpaceInvitation.create(
state: "0",
space_id: "123_456_789",
invitee_id: "456_789_012",
type: "Invitation::ToSpace",
body: "Please join to this amazing Space",
)
Create Space invitation - Mass
Ribose::SpaceInvitation.mass_create(
space_id,
emails: ["[email protected]"],
role_ids: ["role-for-email-address-in-sequance"],
body: "The complete message body for the invitation",
)
Update a Space invitation
Ribose::SpaceInvitation.update(invitation_id, new_attributes_hash)
Accept a Space invitation
Ribose::SpaceInvitation.accept(invitation_id)
Resend a Space invitation
Ribose::SpaceInvitation.resend(invitation_id)
Reject a Space invitation
Ribose::SpaceInvitation.reject(invitation_id)
Cancel a Space invitation
Ribose::SpaceInvitation.cancel(invitation_id)
Join Space Request
List Join Space Requests
Fetch a join space request
Ribose::JoinSpaceRequest.fetch(request_id)
Create a Join Space Request
Ribose::JoinSpaceRequest.create(
state: 0,
Space_id: 123_456_789,
type: "Invitation::JoinSpaceRequest",
body: "Hi, I would like to join to your Space",
)
Accept a Join Space Request
Ribose::JoinSpaceRequest.accept(invitation_id)
Reject a Join Space Requests
Ribose::JoinSpaceRequest.reject(invitation_id)
Update an Join Space Requests
Ribose::JoinSpaceRequest.update(invitation_id, new_attributes_hash)
Calendar
List user calendars
To retrieve the list of calendars accessible to the current user,
Create a calendar
Event
Create a calendar event
User
Create a signup request
Ribose::User.create(email: "[email protected]", **other_attributes)
Activate a signup request
Ribose::User.activate(
email: "[email protected]",
password: "ASecureUserPassword",
otp: "OTP Recived via the Email",
)
Wikis
Create a wiki page
Space categories
List space categories
Development
We are following Sandi Metz’s Rules for this gem, you can read the description of the rules here All new code should follow these rules. If you make changes in a pre-existing file that violates these rules you should fix the violations as part of your contribution.
Setup
Clone the repository.
git clone https://github.com/riboseinc/ribose-ruby
Setup your environment.
bin/setup
Run the test suite
bin/rspec
Contributing
First, thank you for contributing! We love pull requests from everyone. By participating in this project, you hereby grant Ribose Inc. the right to grant or transfer an unlimited number of non exclusive licenses or sub-licenses to third parties, under the copyright covering the contribution to use the contribution by all means.
Here are a few technical guidelines to follow:
-
Open an issue to discuss a new feature.
-
Write tests to support your new feature.
-
Make sure the entire test suite passes locally and on CI.
-
Open a Pull Request.
-
Squash your commits after receiving feedback.
-
Party!
Credits
This gem is developed, maintained and funded by Ribose Inc.
License
The gem is available as open source under the terms of the MIT License.