class ProfitBricks::User

User class

Public Class Methods

add_to_group(group_id, user_id) click to toggle source

Add an user to a group

# File lib/profitbricks/user.rb, line 70
def add_to_group(group_id, user_id)
  response = ProfitBricks.request(
    method: :post,
    path: "/um/groups/#{group_id}/users",
    expects: 202,
    body: {id: user_id}.to_json
  )
  add_parent_identities(response)
  instantiate_objects(response)
end
create(options = {}) click to toggle source

Create a new user.

# File lib/profitbricks/user.rb, line 32
def create(options = {})
  response = ProfitBricks.request(
    method: :post,
    path: "/um/users",
    expects: 202,
    body: { properties: options }.to_json
  )
  add_parent_identities(response)
  instantiate_objects(response)
end
get(user_id,options = {}) click to toggle source

Retrieve an user.

# File lib/profitbricks/user.rb, line 58
def get(user_id,options = {})
  response = ProfitBricks.request(
    method: :get,
    path: "/um/users/#{user_id}",
    expects: 200,
    query: options
  )
  add_parent_identities(response)
  instantiate_objects(response)
end
list(options = {}) click to toggle source

List all users.

# File lib/profitbricks/user.rb, line 44
def list(options = {})
  path = "/um/users"
  path = "/um/groups/#{options[:group_id]}/users" if options[:group_id]
  response = ProfitBricks.request(
    method: :get,
    path: path,
    expects: 200,
    query: options
  )
  add_parent_identities(response)
  instantiate_objects(response)
end
remove_from_group(group_id, user_id) click to toggle source

Remove an user from a group

# File lib/profitbricks/user.rb, line 82
def remove_from_group(group_id, user_id)
  response = ProfitBricks.request(
    method: :delete,
    path: "/um/groups/#{group_id}/users/#{user_id}",
    expects: 202
  )
  return true
end

Public Instance Methods

delete() click to toggle source

Delete the user.

# File lib/profitbricks/user.rb, line 5
def delete
  response = ProfitBricks.request(
    method: :delete,
    path: "/um/users/#{id}",
    expects: 202
  )
  self.requestId = response[:requestId]
  self
end
update(options = {}) click to toggle source

Update the user.

# File lib/profitbricks/user.rb, line 16
def update(options = {})
  response = ProfitBricks.request(
    method: :put,
    path: "/um/users/#{id}",
    expects: 202,
    body: { properties: options }.to_json
  )
  if response
    self.requestId = response['requestId']
    @properties = @properties.merge(response['properties'])
  end
  self
end