Class: ScormEngine::Models::Registration
- Defined in:
- lib/scorm_engine/models/registration.rb
Instance Attribute Summary collapse
- #activity_details ⇒ ScormEngine::Models::RegistrationActivityDetail
-
#completed_date ⇒ Time
Time of the learner’s first completion of this registration.
- #course ⇒ ScormEngine::Models::Course
-
#created_date ⇒ Time
Time of the creation of this registration.
-
#first_access_date ⇒ Time
Time of the learner’s first interaction with this registration.
-
#id ⇒ String
The external identification of the registration.
- #instance ⇒ String
-
#last_access_date ⇒ Time
Time of the learner’s last interaction with this registration.
- #learner ⇒ ScormEngine::Models::Learner
-
#registration_completion ⇒ String
Has this registration been completed?.
-
#registration_completion_amount ⇒ Float
A decimal value between 0 and 1 representing the percentage of this course that the learner has completed so far, if known.
-
#registration_success ⇒ String
Has this registration been passed?.
-
#score ⇒ Float
Scaled score between 0 and 100.
-
#total_seconds_tracked ⇒ Integer
How long the learner spent taking this registration, in seconds.
- #updated ⇒ Time
Class Method Summary collapse
-
.get_completed_at_from_api(options = {}) ⇒ Time
Extract and normalize the completed date from the API options.
-
.get_score_from_api(options = {}) ⇒ Float
Extract and normalize the scaled passing score from the API options.
- .new_from_api(options = {}) ⇒ Object
Instance Method Summary collapse
-
#complete? ⇒ Boolean
Has this registration been completed?.
-
#failed? ⇒ Boolean
Has this registration failed?.
-
#incomplete? ⇒ Boolean
Is this registration incomplete?.
-
#passed? ⇒ Boolean
Has this registration been passed?.
Methods inherited from Base
Instance Attribute Details
#activity_details ⇒ ScormEngine::Models::RegistrationActivityDetail
63 64 65 |
# File 'lib/scorm_engine/models/registration.rb', line 63 def activity_details @activity_details end |
#completed_date ⇒ Time
Time of the learner’s first completion of this registration.
78 79 80 |
# File 'lib/scorm_engine/models/registration.rb', line 78 def completed_date @completed_date end |
#course ⇒ ScormEngine::Models::Course
53 54 55 |
# File 'lib/scorm_engine/models/registration.rb', line 53 def course @course end |
#created_date ⇒ Time
Time of the creation of this registration.
83 84 85 |
# File 'lib/scorm_engine/models/registration.rb', line 83 def created_date @created_date end |
#first_access_date ⇒ Time
Time of the learner’s first interaction with this registration.
68 69 70 |
# File 'lib/scorm_engine/models/registration.rb', line 68 def first_access_date @first_access_date end |
#id ⇒ String
The external identification of the registration.
7 8 9 |
# File 'lib/scorm_engine/models/registration.rb', line 7 def id @id end |
#instance ⇒ String
33 34 35 |
# File 'lib/scorm_engine/models/registration.rb', line 33 def instance @instance end |
#last_access_date ⇒ Time
Time of the learner’s last interaction with this registration.
73 74 75 |
# File 'lib/scorm_engine/models/registration.rb', line 73 def last_access_date @last_access_date end |
#learner ⇒ ScormEngine::Models::Learner
58 59 60 |
# File 'lib/scorm_engine/models/registration.rb', line 58 def learner @learner end |
#registration_completion ⇒ String
Has this registration been completed?
12 13 14 |
# File 'lib/scorm_engine/models/registration.rb', line 12 def registration_completion @registration_completion end |
#registration_completion_amount ⇒ Float
A decimal value between 0 and 1 representing the percentage of this course that the learner has completed so far, if known. Note: for learning standards other than SCORM 2004 4th Edition, this value is based on the percentage of activities completed/passed. This means that single-activity courses in those standards will always return either 0 or 1.
27 28 29 |
# File 'lib/scorm_engine/models/registration.rb', line 27 def registration_completion_amount @registration_completion_amount end |
#registration_success ⇒ String
Has this registration been passed?
17 18 19 |
# File 'lib/scorm_engine/models/registration.rb', line 17 def registration_success @registration_success end |
#score ⇒ Float
Scaled score between 0 and 100.
48 49 50 |
# File 'lib/scorm_engine/models/registration.rb', line 48 def score @score end |
#total_seconds_tracked ⇒ Integer
How long the learner spent taking this registration, in seconds.
43 44 45 |
# File 'lib/scorm_engine/models/registration.rb', line 43 def total_seconds_tracked @total_seconds_tracked end |
#updated ⇒ Time
38 39 40 |
# File 'lib/scorm_engine/models/registration.rb', line 38 def updated @updated end |
Class Method Details
.get_completed_at_from_api(options = {}) ⇒ Time
Extract and normalize the completed date from the API options.
179 180 181 182 183 184 |
# File 'lib/scorm_engine/models/registration.rb', line 179 def self.get_completed_at_from_api( = {}) completed_date = ["completedDate"] completed_date ||= .fetch("score", {})["completedDate"] return if completed_date.nil? Time.parse(completed_date) end |
.get_score_from_api(options = {}) ⇒ Float
Extract and normalize the scaled passing score from the API options.
164 165 166 167 168 |
# File 'lib/scorm_engine/models/registration.rb', line 164 def self.get_score_from_api( = {}) score = .fetch("score", {})["scaled"] return if score.nil? score.to_f end |
.new_from_api(options = {}) ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/scorm_engine/models/registration.rb', line 85 def self.new_from_api( = {}) this = new this. = .dup this.id = ["id"] this.instance = ["instance"] this.updated = Time.parse(["updated"]) if .key?("updated") this.registration_completion = ["registrationCompletion"]&.upcase this.registration_success = ["registrationSuccess"]&.upcase this.total_seconds_tracked = ["totalSecondsTracked"]&.to_i this.first_access_date = Time.parse(["firstAccessDate"]) if .key?("firstAccessDate") this.last_access_date = Time.parse(["lastAccessDate"]) if .key?("lastAccessDate") this.created_date = Time.parse(["createdDate"]) if .key?("createdDate") this.updated = Time.parse(["updated"]) if .key?("updated") this.registration_completion_amount = ["registrationCompletionAmount"].to_f # Sometimes it returns "NaN" this.score = get_score_from_api() this.completed_date = get_completed_at_from_api() this.activity_details = RegistrationActivityDetail.new_from_api(["activityDetails"]) if .key?("activityDetails") this.course = Course.new_from_api(["course"]) if .key?("course") this.learner = Learner.new_from_api(["learner"]) if .key?("learner") this end |
Instance Method Details
#complete? ⇒ Boolean
Has this registration been completed?
117 118 119 120 |
# File 'lib/scorm_engine/models/registration.rb', line 117 def complete? return nil if registration_completion == "UNKNOWN" registration_completion == "COMPLETED" end |
#failed? ⇒ Boolean
Has this registration failed?
150 151 152 153 |
# File 'lib/scorm_engine/models/registration.rb', line 150 def failed? return nil if registration_success == "UNKNOWN" registration_success == "FAILED" end |
#incomplete? ⇒ Boolean
Is this registration incomplete?
128 129 130 131 |
# File 'lib/scorm_engine/models/registration.rb', line 128 def incomplete? return nil if registration_completion == "UNKNOWN" registration_completion == "INCOMPLETE" end |
#passed? ⇒ Boolean
Has this registration been passed?
139 140 141 142 |
# File 'lib/scorm_engine/models/registration.rb', line 139 def passed? return nil if registration_success == "UNKNOWN" registration_success == "PASSED" end |