Similarity Detection Reference Tool

A reference tool demonstrating the basic usage of the Canvas plagiarism detection platform. For a simple reference on doing basic LTI 2.1 registration and launches please see the LTI 2.1 reference tool.

Setup

For setup, simply run the setup file file. If you'd rather run things manually, then go ahead and follow the following steps. Otherwise, move on to the next section.

First, create a copy of the ./docker-compose.override.example.yml file and rename it to docker-compose.override.yml. You can use this for any additions or overrides. It also specifies allows you to specify an env file, which you'll need later for setting the tool up to work with a local installation of Canvas.

Then, just run the following commands:

docker-compose build
docker-compose run web rails db:create
docker-compose run web rails db:migrate

Installing in Canvas

1. Create a developer key in Canvas. The "Vendor code" should be set to Instructure.com
2. Create a .env file in the lti_originality_report_example project with the following lines:

CANVAS_DEV_KEY=<your developer key id>
CANVAS_DEV_SECRET=<your deveoper key secret>

3. Create a Tool Consumer Profile in Canvas via the Rails console:

key = DeveloperKey.find(<your developer key id>)
Lti::ToolConsumerProfile.create!(
    services: Lti::ToolConsumerProfile::RESTRICTED_SERVICES,
    capabilities: Lti::ToolConsumerProfile::RESTRICTED_CAPABILITIES,
    developer_key: key
)

4. Navigate to a Canvas course or account and go to settings > +App and Change the configuration type to "By LTI 2 Registration URL."
5. Paste in the tools registration URL (found on the tool's home page) to install the tool in Canvas.

Note: Creating the .env file didn't seem to work in some instances. Until the bug is fixed, you may need to manually set the secret/key directly in the Ruby code (currently, registration_helper.rb:30-31) You may also disable Canvas from trying to send to the Subscription service. You can do this by editing app/models/assignment_configuration_tool_lookup.rb

# assignment_configuration_tool_lookup.rb: 97 (comment out line)

# Lti::AssignmentSubscriptionsHelper.new(tool_proxy).destroy_subscription(subscription_id)

# assignment_configuration_tool_lookup.rb: 117 (change line)

self.update_attributes(subscription_id: SecureRandom.uuid)

Usage

1. When creating an assignment in Canvas and associating it with this tool, an assignment record in the tool's data is also created.
   Because the canvas assignment did not have an id when initially created, we need to create that association if the tool's record has a null value for tc_id. We can do that using the following commands:

a = Assignment.last
a[:tc_id] = 12 # get from Canvas data
a.save

2. Create a submission in Canvas and find its id. Then back in the rails console:

a.submissions.create(tc_id: 7)

3. Launch the tool from tool from Course Navigation menu in Canvas
4. The submission should show, click the button in the last column
5. Set the score and click "Update Report"