Module: Roles

Included in:
Config
Defined in:
lib/user/config/roles.rb

Instance Method Summary collapse

Instance Method Details

#create_role(data) ⇒ Object

Create role.

Create a role with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "name": "new-role",
  "display_name": "New Role",
  "description": "Role description"
}
@data = @mints_user.create_role(data)
[View source]

61
62
63
 
# File 'lib/user/config/roles.rb', line 61

def create_role(data)
    return @client.raw("post", "/config/roles", nil, data_transform(data))
end

#duplicate_role(id, data) ⇒ Object

Duplicate role.

Duplicate a role.

Parameters

id

(Integer) – Role id.

data

(Hash) – Data to be submited.

Example

data = { 
  "options": [] 
}
@data = @mints_user.duplicate_role(1, data.to_json)
[View source]

22
23
24
 
# File 'lib/user/config/roles.rb', line 22

def duplicate_role(id, data)
    return @client.raw("post", "/config/roles/#{id}/duplicate", nil, data)
end

#get_role(id) ⇒ Object

Get role.

Get a role info.

Parameters

id

(Integer) – Role id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

Example

@data = @mints_user.get_role(1)
[View source]

44
45
46
 
# File 'lib/user/config/roles.rb', line 44

def get_role(id)
    return @client.raw("get", "/config/roles/#{id}")
end

#get_roles ⇒ Object

Get roles.

Get a collection of roles.

Example

@data = @mints_user.get_roles
[View source]

31
32
33
 
# File 'lib/user/config/roles.rb', line 31

def get_roles
    return @client.raw("get", "/config/roles")
end

#update_role(id, data) ⇒ Object

Update role.

Update a role info.

Parameters

id

(Integer) – Role id.

data

(Hash) – Data to be submited.

Example

data = {
  "name": "new-role",
  "display_name": "New Role Display Name Modified",
  "description": "Role description",
  "permissions": 1
}
@data = @mints_user.update_role(8, data)
[View source]

80
81
82
83
 
# File 'lib/user/config/roles.rb', line 80

def update_role(id, data) #FIXME: This action is unauthorized
    #TODO: Research permissions variable type. This would be the error's solution.
    return @client.raw("put", "/config/roles/#{id}", nil, data_transform(data))
end