Class: Isaca::Model::GetUserByID

Inherits:
Object
  • Object
show all
Defined in:
lib/isaca/models/get_user_by_id.rb

Overview

Class is used as an object representation of the response from Request::GetUserByID.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params) ⇒ GetUserByID

Returns a new instance of GetUserByID.

Parameters:

  • params (Hash) —

    The parameters used to create the object

Options Hash (params):

  • :ActiveMember (String)
  • :ExpirationDate (String)
  • :MemberType (String)
  • :iMISID (String) 


26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/isaca/models/get_user_by_id.rb', line 26

def initialize(params)
  @active_member = Isaca::Helpers.parse_boolean(params[:ActiveMember])
  @expiration_date = Isaca::Helpers.strptime(params[:ExpirationDate])
  @member_type = Isaca::Helpers.normalize_member_type(params[:MemberType])

  if params[:iMISID].to_s.strip.empty?
    raise ServiceError.new('User with given IMIS ID not found')
  else
    @imis_id = params[:iMISID]
  end
end

Instance Attribute Details

#active_member ⇒ Boolean

Returns Whether or not the membership is active.

Returns:

  • (Boolean) —

    Whether or not the membership is active.



9
10
11
 
# File 'lib/isaca/models/get_user_by_id.rb', line 9

def active_member
  @active_member
end

#expiration_date ⇒ DateTime|nil

Returns The date the membership expires. Never expires if nil.

Returns:

  • (DateTime|nil) —

    The date the membership expires. Never expires if nil.



9
10
11
 
# File 'lib/isaca/models/get_user_by_id.rb', line 9

def expiration_date
  @expiration_date
end

#imis_id ⇒ String

Returns The membership’s unique ID.

Returns:

  • (String) —

    The membership’s unique ID



17
18
19
 
# File 'lib/isaca/models/get_user_by_id.rb', line 17

def imis_id
  @imis_id
end

#member_type ⇒ Symbol

Returns The membership’s classification.

Returns:

  • (Symbol) —

    The membership’s classification.



13
14
15
 
# File 'lib/isaca/models/get_user_by_id.rb', line 13

def member_type
  @member_type
end

Instance Method Details

#active_member? ⇒ Boolean

A method that identifies whether or not the membership is active

Returns:

  • (Boolean) —

    Whether or not the membership is active.



41
42
43
 
# File 'lib/isaca/models/get_user_by_id.rb', line 41

def active_member?
  active_member
end