Skip to content

generate_request_xml: add LTI launch url option #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

generate_request_xml: add LTI launch url option #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b20bfa
generate_request_xml: add LTI launch url option
sdreher Dec 27, 2017
f4cb5cc
add default parameter
sdreher Dec 27, 2017
250cc3e
flake8
sdreher Dec 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion pylti/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ def verify_request_common(consumers, url, method, headers, params):


def generate_request_xml(message_identifier_id, operation,
lis_result_sourcedid, score):
lis_result_sourcedid, score, launch_url=None):
# pylint: disable=too-many-locals
"""
Generates LTI 1.1 XML for posting result to LTI consumer.
Expand All @@ -315,6 +315,7 @@ def generate_request_xml(message_identifier_id, operation,
:param operation:
:param lis_result_sourcedid:
:param score:
:param launch_url:
:return: XML string
"""
root = etree.Element(u'imsx_POXEnvelopeRequest',
Expand Down Expand Up @@ -343,6 +344,10 @@ def generate_request_xml(message_identifier_id, operation,
language.text = 'en'
text_string = etree.SubElement(result_score, 'textString')
text_string.text = score.__str__()
if launch_url:
result_data = etree.SubElement(result, 'resultData')
lti_launch_url = etree.SubElement(result_data, 'ltiLaunchUrl')
lti_launch_url.text = launch_url
ret = "<?xml version='1.0' encoding='utf-8'?>\n{}".format(
etree.tostring(root, encoding='utf-8').decode('utf-8'))

Expand Down
14 changes: 14 additions & 0 deletions pylti/tests/test_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,20 @@ def test_generate_xml(self):
<imsx_POXBody><operationRequest><resultRecord><sourcedGUID><sourcedId>\
lis_result_sourcedid</sourcedId></sourcedGUID></resultRecord></operationRequest>\
</imsx_POXBody></imsx_POXEnvelopeRequest>""")
xml = generate_request_xml('message_identifier_id', 'operation',
'lis_result_sourcedid', 'score',
'https://somelaunchurl/')
self.assertEqual(xml, """<?xml version='1.0' encoding='utf-8'?>
<imsx_POXEnvelopeRequest xmlns="http://www.imsglobal.org/services/ltiv1p1/xsd/\
imsoms_v1p0"><imsx_POXHeader><imsx_POXRequestHeaderInfo><imsx_version>V1.0\
</imsx_version><imsx_messageIdentifier>message_identifier_id\
</imsx_messageIdentifier></imsx_POXRequestHeaderInfo></imsx_POXHeader>\
<imsx_POXBody><operationRequest><resultRecord><sourcedGUID><sourcedId>\
lis_result_sourcedid</sourcedId></sourcedGUID><result><resultScore>\
<language>en</language><textString>score</textString></resultScore>\
<resultData><ltiLaunchUrl>https://somelaunchurl/</ltiLaunchUrl></resultData>\
</result></resultRecord></operationRequest></imsx_POXBody>\
</imsx_POXEnvelopeRequest>""")

@staticmethod
def generate_oauth_request(url_to_sign=None):
Expand Down