Class: Artifactory::Resource::User

Inherits:
Base
  • Object
show all
Defined in:
lib/artifactory/resources/user.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

attribute, attributes, #attributes, #client, #client=, #client?, #extract_client!, extract_client!, find_from_config, #format_repos!, format_repos!, from_hash, from_url, has_attribute?, #initialize, #inspect, list_from_config, #set, #to_hash, #to_json, #to_matrix_properties, #to_query_string_parameters, #to_s, #url_safe, url_safe

Constructor Details

This class inherits a constructor from Artifactory::Resource::Base

Class Method Details

.all(options = {}) ⇒ Array<Resource::User>

Get a list of all users in the system.

Parameters:

  • options (Hash) (defaults to: {}) —

    the list of options

Options Hash (options):

Returns:



32
33
34
35
36
37
 
# File 'lib/artifactory/resources/user.rb', line 32

def all(options = {})
  client = extract_client!(options)
  client.get("/api/security/users").map do |hash|
    from_url(hash["uri"], client: client)
  end
end

.find(name, options = {}) ⇒ Resource::User?

Find (fetch) a user by its name.

Examples:

Find a user by its name

User.find('readers') #=> #<User name: 'readers' ...>

Parameters:

  • name (String) —

    the name of the user to find

  • options (Hash) (defaults to: {}) —

    the list of options

Options Hash (options):

Returns:

  • (Resource::User, nil) —

    an instance of the user that matches the given name, or nil if one does not exist



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/artifactory/resources/user.rb', line 57

def find(name, options = {})
  client = extract_client!(options)

  response = client.get("/api/security/users/#{url_safe(name)}")
  from_hash(response, client: client)
rescue Error::HTTPError => e
  raise unless e.code == 404

  nil
end

Instance Method Details

#admin ⇒ Object

Return this object’s admin

Returns:

  • (Object) 


69
 
# File 'lib/artifactory/resources/user.rb', line 69

attribute :admin, false

#admin=(value) ⇒ Object

Set this object’s admin

Parameters:

  • value (Object) —

    the value to set for admin

  • default (Object) —

    the default value for this attribute



69
 
# File 'lib/artifactory/resources/user.rb', line 69

attribute :admin, false

#admin? ⇒ Boolean

Determines if the admin value exists and is truthy

Returns:

  • (Boolean) 


69
 
# File 'lib/artifactory/resources/user.rb', line 69

attribute :admin, false

#delete ⇒ Boolean

Delete this user from artifactory, suppressing any ResourceNotFound exceptions might occur.

Returns:

  • (Boolean) —

    true if the object was deleted successfully, false otherwise



86
87
88
89
90
91
 
# File 'lib/artifactory/resources/user.rb', line 86

def delete
  client.delete(api_path)
  true
rescue Error::HTTPError => e
  false
end

#email ⇒ Object

Return this object’s email

Returns:

  • (Object) 


70
 
# File 'lib/artifactory/resources/user.rb', line 70

attribute :email

#email=(value) ⇒ Object

Set this object’s email

Parameters:

  • value (Object) —

    the value to set for email

  • default (Object) —

    the default value for this attribute



70
 
# File 'lib/artifactory/resources/user.rb', line 70

attribute :email

#email? ⇒ Boolean

Determines if the email value exists and is truthy

Returns:

  • (Boolean) 


70
 
# File 'lib/artifactory/resources/user.rb', line 70

attribute :email

#groups ⇒ Object

Return this object’s groups

Returns:

  • (Object) 


71
 
# File 'lib/artifactory/resources/user.rb', line 71

attribute :groups, []

#groups=(value) ⇒ Object

Set this object’s groups

Parameters:

  • value (Object) —

    the value to set for groups

  • default (Object) —

    the default value for this attribute



71
 
# File 'lib/artifactory/resources/user.rb', line 71

attribute :groups, []

#groups? ⇒ Boolean

Determines if the groups value exists and is truthy

Returns:

  • (Boolean) 


71
 
# File 'lib/artifactory/resources/user.rb', line 71

attribute :groups, []

#internal_password_disabled ⇒ Object

Return this object’s internal_password_disabled

Returns:

  • (Object) 


72
 
# File 'lib/artifactory/resources/user.rb', line 72

attribute :internal_password_disabled, false

#internal_password_disabled=(value) ⇒ Object

Set this object’s internal_password_disabled

Parameters:

  • value (Object) —

    the value to set for internal_password_disabled

  • default (Object) —

    the default value for this attribute



72
 
# File 'lib/artifactory/resources/user.rb', line 72

attribute :internal_password_disabled, false

#internal_password_disabled? ⇒ Boolean

Determines if the internal_password_disabled value exists and is truthy

Returns:

  • (Boolean) 


72
 
# File 'lib/artifactory/resources/user.rb', line 72

attribute :internal_password_disabled, false

#last_logged_in ⇒ Object

Return this object’s last_logged_in

Returns:

  • (Object) 


73
 
# File 'lib/artifactory/resources/user.rb', line 73

attribute :last_logged_in

#last_logged_in=(value) ⇒ Object

Set this object’s last_logged_in

Parameters:

  • value (Object) —

    the value to set for last_logged_in

  • default (Object) —

    the default value for this attribute



73
 
# File 'lib/artifactory/resources/user.rb', line 73

attribute :last_logged_in

#last_logged_in? ⇒ Boolean

Determines if the last_logged_in value exists and is truthy

Returns:

  • (Boolean) 


73
 
# File 'lib/artifactory/resources/user.rb', line 73

attribute :last_logged_in

#name ⇒ Object

Return this object’s name

Returns:

  • (Object) 


74
 
# File 'lib/artifactory/resources/user.rb', line 74

attribute :name, -> { raise "Name missing" }

#name=(value) ⇒ Object

Set this object’s name

Parameters:

  • value (Object) —

    the value to set for name

  • default (Object) —

    the default value for this attribute



74
 
# File 'lib/artifactory/resources/user.rb', line 74

attribute :name, -> { raise "Name missing" }

#name? ⇒ Boolean

Determines if the name value exists and is truthy

Returns:

  • (Boolean) 


74
 
# File 'lib/artifactory/resources/user.rb', line 74

attribute :name, -> { raise "Name missing" }

#password ⇒ Object

Return this object’s password

Returns:

  • (Object) 


75
 
# File 'lib/artifactory/resources/user.rb', line 75

attribute :password

#password=(value) ⇒ Object

Set this object’s password

Parameters:

  • value (Object) —

    the value to set for password

  • default (Object) —

    the default value for this attribute



75
 
# File 'lib/artifactory/resources/user.rb', line 75

attribute :password

#password? ⇒ Boolean

Determines if the password value exists and is truthy

Returns:

  • (Boolean) 


75
 
# File 'lib/artifactory/resources/user.rb', line 75

attribute :password

#profile_updatable ⇒ Object

Return this object’s profile_updatable

Returns:

  • (Object) 


76
 
# File 'lib/artifactory/resources/user.rb', line 76

attribute :profile_updatable, true

#profile_updatable=(value) ⇒ Object

Set this object’s profile_updatable

Parameters:

  • value (Object) —

    the value to set for profile_updatable

  • default (Object) —

    the default value for this attribute



76
 
# File 'lib/artifactory/resources/user.rb', line 76

attribute :profile_updatable, true

#profile_updatable? ⇒ Boolean

Determines if the profile_updatable value exists and is truthy

Returns:

  • (Boolean) 


76
 
# File 'lib/artifactory/resources/user.rb', line 76

attribute :profile_updatable, true

#realm ⇒ Object

Return this object’s realm

Returns:

  • (Object) 


77
 
# File 'lib/artifactory/resources/user.rb', line 77

attribute :realm

#realm=(value) ⇒ Object

Set this object’s realm

Parameters:

  • value (Object) —

    the value to set for realm

  • default (Object) —

    the default value for this attribute



77
 
# File 'lib/artifactory/resources/user.rb', line 77

attribute :realm

#realm? ⇒ Boolean

Determines if the realm value exists and is truthy

Returns:

  • (Boolean) 


77
 
# File 'lib/artifactory/resources/user.rb', line 77

attribute :realm

#save ⇒ Boolean

Creates or updates a user configuration depending on if the user configuration previously existed.

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
106
 
# File 'lib/artifactory/resources/user.rb', line 99

def save
  if self.class.find(name, client: client)
    client.post(api_path, to_json, headers)
  else
    client.put(api_path, to_json, headers)
  end
  true
end