Class: ESP::User

Inherits:
Resource show all
Defined in:
lib/esp/resources/user.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.all ⇒ ActiveResource::PaginatedCollection<ESP::User>

Return a paginated User list

Returns:




# File 'lib/esp/resources/user.rb', line 56

.create(attributes = {}) ⇒ ESP::User

Create a User. call-seq -> super.create(attributes={})

Examples:

user = ESP::User.create(first_name: 'John', last_name: 'Doe', email: "[email protected]")

Parameters:

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

    Required hash of user attributes.

    Valid Attributes

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/user.rb', line 61

.find(id, options = {}) ⇒ ESP::User

Find a User by id

call-seq -> super.find(id, options = {})

Parameters:

  • id (Integer, Numeric, #to_i) —

    Required ID of the user to retrieve.

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

    Optional hash of options.

    Valid Options

    include | The list of associated objects to return on the initial request.

    Valid Includable Associations

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/user.rb', line 40

.where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::User>

Return a paginated User list filtered by search parameters

call-seq -> super.where(clauses = {})

Parameters:

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

    A hash of attributes with appended predicates to search, sort and include.

    Valid Clauses

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/user.rb', line 29

Instance Method Details

#destroy ⇒ self

Delete a User.

Returns:

  • (self) 



# File 'lib/esp/resources/user.rb', line 85

#organization ⇒ ESP::Organization

The organization this user belongs to.

Returns:



6
 
# File 'lib/esp/resources/user.rb', line 6

belongs_to :organization, class_name: 'ESP::Organization'

#role ⇒ ESP::Role

The role assigned to this user.

Returns:



11
 
# File 'lib/esp/resources/user.rb', line 11

belongs_to :role, class_name: 'ESP::Role'

#save ⇒ Boolean

Create and update a User.

Valid Attributes

See API documentation for valid arguments

Examples:

user = ESP::User.new(first_name: 'John', last_name: 'Doe', email: "[email protected]")
user.save

Returns:

  • (Boolean) 



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

#sub_organizations ⇒ ActiveResource::PaginatedCollection<ESP::SubOrganization>

The collection of sub organizations that belong to the user.

Returns:



16
17
18
19
 
# File 'lib/esp/resources/user.rb', line 16

def sub_organizations
  return attributes['sub_organizations'] if attributes['sub_organizations'].present?
  SubOrganization.where(id_in: sub_organization_ids)
end

#teams ⇒ ActiveResource::PaginatedCollection<ESP::Team>

The collection of teams that belong to the user.

Returns:



24
25
26
27
 
# File 'lib/esp/resources/user.rb', line 24

def teams
  return attributes['teams'] if attributes['teams'].present?
  Team.where(id_in: team_ids)
end