TONIC: Templates for organizing nifty information containers
GIN users will use their GIN credential to login to the tonic application. In this application, they will be able to perform some function that are either complex (requiring many steps) and/or functions they do not have the access rights to perform. In the backend, the application will login to GIN using the tonic-bot.
tonic-bot will create organisation, teams and repositories on behalf of the loged-in user. In order to use the application on existing repositories or organisations, one needs to add tonic-bot as a collaborator on a repository, or as an owner of an organisation (this step is automatized when tonic-bot is creating them).
Instead of creating simple repositories, tonic-bot creates research repositories (RR): these repositories are created from a template and include submodules (themselves created from templates). Submodules allow for a differentiation of access rights and easy publication of part of a repository.
After login, the application will know the userโs credential, and can therefore access the metadata associated and find:
The principle is to create an organisation, where tonic-bot and the logged-user will become owners. The organisation also get two teams per default: the read-access-team and the write-access-team, with read and write access rights respectively.
Create the organisation: (code not working: no admin access)
. setgin.sh
## create an organisation, with bot
botname="jcolomb"
loginuser="bruce-wayne"
#Inputs
thisorga="testorga"
createorga(){
organame=$1
data="{\"username\":\"${organame}\",\"Description\":\"${organame}\"}"
echo post ${data} ${ginhost}/api/v1/admin/users/${botname}/orgs
}
createorga ${thisorga}
#POST /admin/users/:username/orgs
# username string Required Organization user name
# full_name string Full name of organization
# description string Description to the organization
# website string Official website
# location string Organization locationAdd login user as organisation owner: (code not working, probably because put does not work ?)
. setgin.sh
botname="jcolomb"
loginuser="bruce-wayne"
thisorga="testorga"
addusertoorga(){
organame=$1
user=$2
data="{\"role\":admin}"
echo put ${data} ${ginhost}/api/v1/orgs/${organame}/memberships/${user}
}
addusertoorga ${thisorga} ${loginuser}## put {"role":admin} https://gin.g-node.org/api/v1/orgs/testorga/memberships/bruce-wayneCreate the teams:
. setgin.sh
botname="jcolomb"
loginuser="jcolomb"
thisorga="testorga"
createteam() {
teamname=$1
organisation=$2
permission=$3
data="{\"name\":\"${teamname}\",\"description\":\"default team\",\"permission\":\"${permission}\"}"
#post ${data} ${ginhost}/api/v1/orgs/${organisation}/teams
echo post ${data} ${ginhost}/api/v1/orgs/${organisation}/teams
}
createteam readaccess ${thisorga} read
createteam writeaccess ${thisorga} admin
## post {"name":"readaccess","description":"default team","permission":"read"} https://gin.g-node.org/api/v1/orgs/testorga/teams
## post {"name":"writeaccess","description":"default team","permission":"admin"} https://gin.g-node.org/api/v1/orgs/testorga/teamsHere, we will add the member to an organisation, with member permission and add him to the default teams.
## add someone to organisation + teams
. setgin.sh
botname="jcolomb"
loginuser="bruce-wayne"
#Inputs:
thisorga="testorga"
newuser="bruce-wayne"
# PUT /orgs/:orgname/memberships/:username
# role="member"
addusertoorga_m(){
organame=$1
user=$2
data="{\"role\":member}"
echo put ${data} ${ginhost}/api/v1/orgs/${organame}/memberships/${user}
}
addusertoorga_m ${thisorga} ${newuser}
## for each team:
#PUT /admin/teams/:teamid/members/:username
addusertoteam(){
organame=$1
teamname=$2
user=$3
teamlist="GET /orgs/${organame}/teams"
teamid="id from teamlist with name==teamname"
data="{\"role\":member}"
echo put ${data} ${ginhost}/api/v1//admin/teams/${teamid}/members/${user}
}
addusertoteam ${thisorga} readaccess ${newuser}
addusertoteam ${thisorga} writeaccess ${newuser}
# PS there is no way to get all members of an organisation ?## put {"role":member} https://gin.g-node.org/api/v1/orgs/testorga/memberships/bruce-wayne
## put {"role":member} https://gin.g-node.org/api/v1//admin/teams/id from teamlist with name==teamname/members/bruce-wayne
## put {"role":member} https://gin.g-node.org/api/v1//admin/teams/id from teamlist with name==teamname/members/bruce-wayneWe call the research repository, a GIN repository created from a template folder structure developed for (neuro-)research, and that hosts submodules. The user may be able to select submodules and templates, during or after the creation of the research repository.
Because users must get access to all repository at once, each research repository comes with its team, which get admin access to the parent repository and all submodules.
message: additional submodules (for data for instance) may be added later
logic: