Class: LtiProvider::Launch

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/lti_provider/launch.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#lti_errormsg ⇒ Object

Returns the value of attribute lti_errormsg.



7
8
9
 
# File 'app/models/lti_provider/launch.rb', line 7

def lti_errormsg
  @lti_errormsg
end

Class Method Details

.initialize_from_request(provider, request) ⇒ Object

serialize :tool_params



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'app/models/lti_provider/launch.rb', line 12

def self.initialize_from_request(provider, request)
  launch = new

  launch.validate_provider(provider, request)

  launch.provider_params = provider.to_params
  launch.canvas_url      = launch.api_endpoint(provider)
  launch.nonce           = launch.provider_params['oauth_nonce']

  ### QALAM ###
  launch.launch_tool = request.params[:launch_tool] if request.params[:launch_tool]
  # launch.tool_params = {timetable_date: request.params[:timetable_date], section_room: request.params[:section_room]}.to_params if request.params[:timetable_date] && request.params[:section_room]
  ### END ###

  launch
end

.xml_config(lti_launch_url) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'app/models/lti_provider/launch.rb', line 29

def self.xml_config(lti_launch_url)
  tc = IMS::LTI::ToolConfig.new({
    launch_url: lti_launch_url,
    title: LtiProvider::XmlConfig.tool_title,
    description: LtiProvider::XmlConfig.tool_description
  })

  tc.extend IMS::LTI::Extensions::Canvas::ToolConfig
  platform = IMS::LTI::Extensions::Canvas::ToolConfig::PLATFORM

  privacy_level = LtiProvider::XmlConfig.privacy_level || "public"
  tc.send("canvas_privacy_#{privacy_level}!")

  if LtiProvider::XmlConfig.tool_id
    tc.set_ext_param(platform, :tool_id, LtiProvider::XmlConfig.tool_id)
  end

  if LtiProvider::XmlConfig.course_navigation
    tc.canvas_course_navigation!(LtiProvider::XmlConfig.course_navigation.symbolize_keys)
  end

  if LtiProvider::XmlConfig.
    tc.(LtiProvider::XmlConfig..symbolize_keys)
  end

  if LtiProvider::XmlConfig.user_navigation
    tc.canvas_user_navigation!(LtiProvider::XmlConfig.user_navigation.symbolize_keys)
  end

  ### QALAM ###

  if LtiProvider::XmlConfig.course_home_sub_navigation
    tc.canvas_course_home_sub_navigation!(LtiProvider::XmlConfig.course_home_sub_navigation.symbolize_keys)
  end

  if LtiProvider::XmlConfig.course_settings_sub_navigation
    tc.canvas_course_settings_sub_navigation!(LtiProvider::XmlConfig.course_settings_sub_navigation.symbolize_keys)
  end

  if LtiProvider::XmlConfig.global_navigation
    tc.canvas_global_navigation!(LtiProvider::XmlConfig.global_navigation.symbolize_keys)
  end

  if LtiProvider::XmlConfig.module_menu
    tc.canvas_module_menu!(LtiProvider::XmlConfig.module_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.module_index_menu
    tc.canvas_module_index_menu!(LtiProvider::XmlConfig.module_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.module_group_menu
    tc.canvas_module_group_menu!(LtiProvider::XmlConfig.module_group_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.quiz_menu
    tc.canvas_quiz_menu!(LtiProvider::XmlConfig.quiz_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.quiz_index_menu
    tc.canvas_quiz_index_menu!(LtiProvider::XmlConfig.quiz_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.assignment_menu
    tc.canvas_assignment_menu!(LtiProvider::XmlConfig.assignment_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.assignment_index_menu
    tc.canvas_assignment_index_menu!(LtiProvider::XmlConfig.assignment_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.assignment_group_menu
    tc.canvas_assignment_group_menu!(LtiProvider::XmlConfig.assignment_group_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.discussion_topic_menu
    tc.canvas_discussion_topic_menu!(LtiProvider::XmlConfig.discussion_topic_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.discussion_topic_index_menu
    tc.canvas_discussion_topic_index_menu!(LtiProvider::XmlConfig.discussion_topic_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.wiki_page_menu
    tc.canvas_wiki_page_menu!(LtiProvider::XmlConfig.wiki_page_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.wiki_index_menu
    tc.canvas_wiki_index_menu!(LtiProvider::XmlConfig.wiki_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.file_menu
    tc.canvas_file_menu!(LtiProvider::XmlConfig.file_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.file_index_menu
    tc.canvas_file_index_menu!(LtiProvider::XmlConfig.file_index_menu.symbolize_keys)
  end

  if LtiProvider::XmlConfig.editor_button
    tc.canvas_editor_button!(LtiProvider::XmlConfig.editor_button.symbolize_keys)
  end
  
  ### END ###

  if LtiProvider::XmlConfig.environments
    tc.set_ext_param(platform, :environments, LtiProvider::XmlConfig.environments.symbolize_keys)
  end

  tc.to_xml(:indent => 2)
end

Instance Method Details

#api_endpoint(provider) ⇒ Object 



174
175
176
177
178
179
180
181
 
# File 'app/models/lti_provider/launch.rb', line 174

def api_endpoint(provider)
  if provider.launch_presentation_return_url
    uri = URI.parse(provider.launch_presentation_return_url)
    domain = "#{uri.scheme}://#{uri.host}"
    domain += ":#{uri.port}" unless uri.port.nil? || [80, 443].include?(uri.port.to_i)
    return domain
  end
end

#valid_provider? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'app/models/lti_provider/launch.rb', line 154

def valid_provider?
  !!@valid_provider
end

#validate_provider(provider, request) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'app/models/lti_provider/launch.rb', line 158

def validate_provider(provider, request)
  self.lti_errormsg =
    if provider.consumer_key.blank?
      "Consumer key not provided."
    elsif provider.consumer_secret.blank?
      "Consumer secret not configured on provider."
    elsif !provider.valid_request?(request) && false
      ### Should remove false from condition, by solving its problem with attendance per da from 'ims-lti' gem
      "The OAuth signature was invalid."
    elsif oauth_timestamp_too_old?(provider.request_oauth_timestamp)
      "Your request is too old."
    end

  @valid_provider = self.lti_errormsg.blank?
end