class Runcible::Resources::User

@see docs.pulpproject.org/dev-guide/integration/rest-api/user/index.html

Public Class Methods

path(login = nil) click to toggle source

Generates the API path for Users

@param [String] login the user's login @return [String] the user path, may contain the login if passed

# File lib/runcible/resources/user.rb, line 9
def self.path(login = nil)
  login.nil? ? 'users/' : "users/#{login}/"
end

Public Instance Methods

create(login, optional = {}) click to toggle source

Creates a user

@param [String] login the login requested for the user @param [Hash] optional container for all optional parameters @return [RestClient::Response]

# File lib/runcible/resources/user.rb, line 25
def create(login, optional = {})
  required = required_params(binding.send(:local_variables), binding)
  call(:post, path, :payload => { :required => required, :optional => optional })
end
delete(login) click to toggle source

Deletes a user

@param [String] login the login of the user being deleted @return [RestClient::Response]

# File lib/runcible/resources/user.rb, line 42
def delete(login)
  call(:delete, path(login))
end
retrieve(login) click to toggle source

Retrieves a user

@param [String] login the login of the user being retrieved @return [RestClient::Response]

# File lib/runcible/resources/user.rb, line 34
def retrieve(login)
  call(:get, path(login))
end
retrieve_all() click to toggle source

Retrieves all users

@return [RestClient::Response]

# File lib/runcible/resources/user.rb, line 16
def retrieve_all
  call(:get, path)
end