Class: AtomicLti::Definitions

Inherits:

Object

Object
AtomicLti::Definitions

show all

Defined in:: app/lib/atomic_lti/definitions.rb

Constant Summary collapse

LTI_VERSION =

"https://purl.imsglobal.org/spec/lti/claim/version".freeze

LAUNCH_PRESENTATION =

"https://purl.imsglobal.org/spec/lti/claim/launch_presentation".freeze

DEPLOYMENT_ID =

"https://purl.imsglobal.org/spec/lti/claim/deployment_id".freeze

MESSAGE_TYPE =

"https://purl.imsglobal.org/spec/lti/claim/message_type".freeze

CONTEXT_CLAIM = Claims

"https://purl.imsglobal.org/spec/lti/claim/context".freeze

RESOURCE_LINK_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/resource_link".freeze

TOOL_PLATFORM_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/tool_platform".freeze

AGS_CLAIM =

"https://purl.imsglobal.org/spec/lti-ags/claim/endpoint".freeze

BASIC_OUTCOME_CLAIM =

"https://purl.imsglobal.org/spec/lti-bo/claim/basicoutcome".freeze

FOR_USER_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/for_user".freeze

MENTOR_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/role_scope_mentor".freeze

ROLES_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/roles".freeze

CUSTOM_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/custom".freeze

EXTENSION_CLAIM =

"http://www.ExamplePlatformVendor.com/session".freeze

LIS_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/lis".freeze

TARGET_LINK_URI_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/target_link_uri".freeze

LTI11_LEGACY_USER_ID_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/lti11_legacy_user_id".freeze

DEEP_LINKING_CLAIM =

"https://purl.imsglobal.org/spec/lti-dl/claim/deep_linking_settings".freeze

DEEP_LINKING_DATA_CLAIM =

"https://purl.imsglobal.org/spec/lti-dl/claim/data".freeze

DEEP_LINKING_TOOL_MSG_CLAIM =

"https://purl.imsglobal.org/spec/lti-dl/claim/msg".freeze

DEEP_LINKING_TOOL_LOG_CLAIM =

"https://purl.imsglobal.org/spec/lti-dl/claim/log".freeze

CONTENT_ITEM_CLAIM =

"https://purl.imsglobal.org/spec/lti-dl/claim/content_items".freeze

NAMES_AND_ROLES_CLAIM =

"https://purl.imsglobal.org/spec/lti-nrps/claim/namesroleservice".freeze

NAMES_AND_ROLES_SERVICE_VERSIONS =

["2.0"].freeze

PLATFORM_NOTIFICATION_SERVICE_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/platformnotificationservice".freeze

PLATFORM_NOTIFICATION_SERVICE_VERSIONS =

["1.0".freeze].freeze

NOTICE_TYPE_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/notice_type".freeze

PLATFORM_NOTIFICATION_CONTEXT_COPY_NOTICE =

"LtiContextCopyNotice".freeze

PLATFORM_NOTIFICATION_CONTEXT_COPY_ORIGINS_CLAIM =

"https://purl.imsglobal.org/spec/lti/claim/origin_contexts".freeze

CALIPER_CLAIM =

"https://purl.imsglobal.org/spec/lti-ces/claim/caliper-endpoint-service".freeze

TOOL_LAUNCH_CALIPER_CONTEXT =

"http://purl.imsglobal.org/ctx/caliper/v1p1/ToolLaunchProfile-extension".freeze

TOOL_USE_CALIPER_CONTEXT =

"http://purl.imsglobal.org/ctx/caliper/v1p1".freeze

AGS_SCOPE_LINE_ITEM = Scopes

"https://purl.imsglobal.org/spec/lti-ags/scope/lineitem".freeze

AGS_SCOPE_LINE_ITEM_READONLY =

"https://purl.imsglobal.org/spec/lti-ags/scope/lineitem.readonly".freeze

AGS_SCOPE_RESULT =

"https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly".freeze

AGS_SCOPE_SCORE =

"https://purl.imsglobal.org/spec/lti-ags/scope/score".freeze

NAMES_AND_ROLES_SCOPE =

"https://purl.imsglobal.org/spec/lti-nrps/scope/contextmembership.readonly".freeze

CALIPER_SCOPE =

"https://purl.imsglobal.org/spec/lti-ces/v1p0/scope/send".freeze

PNS_SCOPE_NOTICEHANDLERS =

"https://purl.imsglobal.org/spec/lti/scope/noticehandlers".freeze

STUDENT_SCOPE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student".freeze

INSTRUCTOR_SCOPE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor".freeze

LEARNER_SCOPE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Learner".freeze

MENTOR_SCOPE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor".freeze

MENTOR_ROLE_SCOPE =

"a62c52c02ba262003f5e".freeze

COURSE_CONTEXT = Launch contexts

"http://purl.imsglobal.org/vocab/lis/v2/course#CourseOffering".freeze

ACCOUNT_CONTEXT =

"Account".freeze

TOOL_CONFIGURATION = Configuration

"https://purl.imsglobal.org/spec/lti-tool-configuration".freeze

CANVAS_PUBLIC_LTI_KEYS_URL =

"https://sso.canvaslms.com/api/lti/security/jwks".freeze

CANVAS_OIDC_URL =

"https://sso.canvaslms.com/api/lti/authorize_redirect".freeze

CANVAS_AUTH_TOKEN_URL =

"https://sso.canvaslms.com/login/oauth2/token".freeze

CANVAS_BETA_PUBLIC_LTI_KEYS_URL =

"https://sso.beta.canvaslms.com/api/lti/security/jwks".freeze

CANVAS_BETA_OIDC_URL =

"https://sso.beta.canvaslms.com/api/lti/authorize_redirect".freeze

CANVAS_BETA_AUTH_TOKEN_URL =

"https://sso.beta.canvaslms.com/login/oauth2/token".freeze

CANVAS_SUBMISSION_TYPE =

"https://canvas.instructure.com/lti/submission_type".freeze

ADMINISTRATOR_SYSTEM_ROLE = Roles Below are all the roles specified in the LTI 1.3 spec. (www.imsglobal.org/spec/lti/v1p3#role-vocabularies-0) Core system roles

"http://purl.imsglobal.org/vocab/lis/v2/system/person#Administrator".freeze

NONE_SYSTEM_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/system/person#None".freeze

ACCOUNT_ADMIN_SYSTEM_ROLE = Non‑core system roles

"http://purl.imsglobal.org/vocab/lis/v2/system/person#AccountAdmin".freeze

CREATOR_SYSTEM_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/system/person#Creator".freeze

SYS_ADMIN_SYSTEM_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/system/person#SysAdmin".freeze

SYS_SUPPORT_SYSTEM_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/system/person#SysSupport".freeze

USER_SYSTEM_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/system/person#User".freeze

ADMINISTRATOR_INSTITUTION_ROLE = Core institution roles

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Administrator".freeze

FACULTY_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Faculty".freeze

GUEST_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Guest".freeze

NONE_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#None".freeze

OTHER_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Other".freeze

STAFF_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Staff".freeze

STUDENT_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Student".freeze

ALUMNI_INSTITUTION_ROLE = Non‑core institution roles

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Alumni".freeze

INSTRUCTOR_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Instructor".freeze

LEARNER_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Learner".freeze

MEMBER_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Member".freeze

MENTOR_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Mentor".freeze

OBSERVER_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#Observer".freeze

PROSPECTIVE_STUDENT_INSTITUTION_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/institution/person#ProspectiveStudent".freeze

ADMINISTRATOR_CONTEXT_ROLE = Core context roles

"http://purl.imsglobal.org/vocab/lis/v2/membership#Administrator".freeze

CONTENT_DEVELOPER_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#ContentDeveloper".freeze

INSTRUCTOR_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Instructor".freeze

LEARNER_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Learner".freeze

MENTOR_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Mentor".freeze

MANAGER_CONTEXT_ROLE = Non‑core context roles

"http://purl.imsglobal.org/vocab/lis/v2/membership#Manager".freeze

MEMBER_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Member".freeze

OFFICER_CONTEXT_ROLE =

"http://purl.imsglobal.org/vocab/lis/v2/membership#Officer".freeze

ROLES =

[
  ADMINISTRATOR_SYSTEM_ROLE,
  NONE_SYSTEM_ROLE,
  ACCOUNT_ADMIN_SYSTEM_ROLE,
  CREATOR_SYSTEM_ROLE,
  SYS_ADMIN_SYSTEM_ROLE,
  SYS_SUPPORT_SYSTEM_ROLE,
  USER_SYSTEM_ROLE,
  ADMINISTRATOR_INSTITUTION_ROLE,
  FACULTY_INSTITUTION_ROLE,
  GUEST_INSTITUTION_ROLE,
  NONE_INSTITUTION_ROLE,
  OTHER_INSTITUTION_ROLE,
  STAFF_INSTITUTION_ROLE,
  STUDENT_INSTITUTION_ROLE,
  ALUMNI_INSTITUTION_ROLE,
  INSTRUCTOR_INSTITUTION_ROLE,
  LEARNER_INSTITUTION_ROLE,
  MEMBER_INSTITUTION_ROLE,
  MENTOR_INSTITUTION_ROLE,
  OBSERVER_INSTITUTION_ROLE,
  PROSPECTIVE_STUDENT_INSTITUTION_ROLE,
  ADMINISTRATOR_CONTEXT_ROLE,
  CONTENT_DEVELOPER_CONTEXT_ROLE,
  INSTRUCTOR_CONTEXT_ROLE,
  LEARNER_CONTEXT_ROLE,
  MENTOR_CONTEXT_ROLE,
  MANAGER_CONTEXT_ROLE,
  MEMBER_CONTEXT_ROLE,
  OFFICER_CONTEXT_ROLE,
].freeze

ADMINISTRATOR_ROLES =

[
  ADMINISTRATOR_SYSTEM_ROLE,
  ACCOUNT_ADMIN_SYSTEM_ROLE,
  ADMINISTRATOR_INSTITUTION_ROLE,
  ADMINISTRATOR_CONTEXT_ROLE,
].freeze

INSTRUCTOR_ROLES =

[
  INSTRUCTOR_INSTITUTION_ROLE,
  INSTRUCTOR_CONTEXT_ROLE,
].freeze

STUDENT_ROLES =

[
  STUDENT_INSTITUTION_ROLE,
  LEARNER_CONTEXT_ROLE,
].freeze

OBSERVER_ROLES =

[
  MENTOR_INSTITUTION_ROLE,
  MENTOR_CONTEXT_ROLE,
  # NON_CREDIT_LEARNER,
].freeze

Class Method Summary collapse

.assignment_and_grades_launch?(payload) ⇒ Boolean
.deep_link_launch?(payload) ⇒ Boolean
.lms_host(payload) ⇒ Object
.lms_url(payload) ⇒ Object
.names_and_roles_launch?(payload) ⇒ Boolean
.scopes ⇒ Object

Specfies all available scopes.

Class Method Details

.assignment_and_grades_launch?(payload) ⇒ `Boolean`

Returns:

(Boolean)



207
208
209

# File 'app/lib/atomic_lti/definitions.rb', line 207

def self.assignment_and_grades_launch?(payload)
  payload[AtomicLti::Definitions::AGS_CLAIM].present?
end

.deep_link_launch?(payload) ⇒ `Boolean`

Returns:

(Boolean)



196
197
198

# File 'app/lib/atomic_lti/definitions.rb', line 196

def self.deep_link_launch?(payload)
  payload[AtomicLti::Definitions::MESSAGE_TYPE] == "LtiDeepLinkingRequest"
end

.lms_host(payload) ⇒ `Object`

# File 'app/lib/atomic_lti/definitions.rb', line 181

def self.lms_host(payload)
  host = if deep_link_launch?(payload)
           payload.dig(AtomicLti::Definitions::DEEP_LINKING_CLAIM, "deep_link_return_url")
         else
           payload.dig(AtomicLti::Definitions::LAUNCH_PRESENTATION, "return_url")
         end

  host = "https://#{host}" unless host&.start_with?("http")
  URI.parse(host).host
end

.lms_url(payload) ⇒ `Object`



192
193
194

# File 'app/lib/atomic_lti/definitions.rb', line 192

def self.lms_url(payload)
  "https://#{lms_host(payload)}"
end

.names_and_roles_launch?(payload) ⇒ `Boolean`

Returns:

(Boolean)

# File 'app/lib/atomic_lti/definitions.rb', line 200

def self.names_and_roles_launch?(payload)
  return false unless payload[AtomicLti::Definitions::NAMES_AND_ROLES_CLAIM].present?

  payload[AtomicLti::Definitions::NAMES_AND_ROLES_CLAIM]["service_versions"] ==
    AtomicLti::Definitions::NAMES_AND_ROLES_SERVICE_VERSIONS
end

.scopes ⇒ `Object`

Specfies all available scopes.

# File 'app/lib/atomic_lti/definitions.rb', line 68

def self.scopes
  [
    AGS_SCOPE_LINE_ITEM,
    AGS_SCOPE_LINE_ITEM_READONLY,
    AGS_SCOPE_RESULT,
    AGS_SCOPE_SCORE,
    NAMES_AND_ROLES_SCOPE,
  ]
end

Class: AtomicLti::Definitions

Constant Summary collapse

Class Method Summary collapse

Class Method Details

.assignment_and_grades_launch?(payload) ⇒ Boolean

.deep_link_launch?(payload) ⇒ Boolean

.lms_host(payload) ⇒ Object

.lms_url(payload) ⇒ Object

.names_and_roles_launch?(payload) ⇒ Boolean

.scopes ⇒ Object

.assignment_and_grades_launch?(payload) ⇒ `Boolean`

.deep_link_launch?(payload) ⇒ `Boolean`

.lms_host(payload) ⇒ `Object`

.lms_url(payload) ⇒ `Object`

.names_and_roles_launch?(payload) ⇒ `Boolean`

.scopes ⇒ `Object`