canvas-workflow 0.5.0

data/spec/file_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+# [ ] test with incorrect authorization [error]
+# [ ]      with non-existing prefix [error]
+# [X]      with non-existing course [error]
+# [X]      for non-existing path [error]
+# [X]      for non-existing file [error]
+# [ ]      for ambiguous file [error]
+# [X]      for existing file in root folder [pass]
+# [X]      for existing file in nested folder [pass]
+
+describe Canvas::Workflow::Tags::FileTag do
+  let(:doc) { doc_with_content(content) }
+  let(:prefix) { doc.site.config['canvas']['prefix'] }
+  let(:course) { doc.site.config['canvas']['course'] }
+  let(:content) { "{% file #{path}#{file} %}" }
+  let(:output) do
+    doc.content = content
+    doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+  end
+
+  before :each do
+    stub_request(:get, url1).to_return(:status => status1, :body => fixture(fixture1), :headers => { "Content-Type" => "application/json; charset=utf-8" })
+    stub_request(:get, url2).to_return(:status => status2, :body => fixture(fixture2), :headers => { "Content-Type" => "application/json; charset=utf-8" })
+  end
+  let(:url1) { "#{prefix}/api/v1/courses/#{course}/folders/by_path/#{path}" }
+  let(:url2) { "#{prefix}/api/v1/folders/#{folder}/files?search_term=#{file}" }
+
+  context "with existing file" do
+    let(:status1)  { 200 }
+    let(:status2)  { 200 }
+    let(:fixture2) { "file" }
+    let(:file)     { "file.txt" }
+
+    context "in course folder" do
+      let(:fixture1) { "root" }
+      let(:path)     { "" }
+      let(:folder)   { 2937 } # from id of :path in folders.json
+
+      it "produces the correct url" do
+        expect(output).to eq("<p>http://www.canvas.instructure.com/files/569/download?download_frd=1&amp;verifier=c6HdZmxOZa0Fiin2cbvZeI8I5ry7yqD7RChQzb6P</p>\n")
+      end
+    end
+
+    context "in nested folder" do
+      let(:fixture1) { "nested" }
+      let(:path)     { "nested/examples/" }
+      let(:folder)   { 2939 } # from id of :path in folders.json
+
+      it "produces the correct url" do
+        expect(output).to eq("<p>http://www.canvas.instructure.com/files/569/download?download_frd=1&amp;verifier=c6HdZmxOZa0Fiin2cbvZeI8I5ry7yqD7RChQzb6P</p>\n")
+      end
+    end
+  end
+
+  context "with non-existing component" do
+    context "course does not exist" do
+      let(:output) do
+        doc.site.config['canvas']['course'] = course
+        doc.content = content
+        doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+      end
+
+      let(:course)   { "0123456789" }
+      let(:status1)  { 404 }
+      let(:fixture1) { "doesnotexist" }
+      let(:path)     { "nested/examples/" }
+
+      let(:status2)  { "unused" }
+      let(:fixture2) { "doesnotexist" }
+      let(:folder)   { "unused" }
+      let(:file)     { "unused" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(Footrest::HttpError::NotFound)
+      end
+    end
+
+    context "path does not exist" do
+      let(:status1)  { 404 }
+      let(:fixture1) { "doesnotexist" }
+      let(:path)     { "non-existent/path/" }
+
+      let(:status2)  { "unused" }
+      let(:fixture2) { "doesnotexist" }
+      let(:folder)   { "unused" }
+      let(:file)     { "unused" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(Footrest::HttpError::NotFound)
+      end
+    end
+
+    context "file does not exist on path" do
+      let(:status1)  { 200 }
+      let(:status2)  { 404 }
+      let(:fixture1) { "nested" }
+      let(:fixture2) { "doesnotexist" }
+      let(:path)     { "nested/examples/" }
+      let(:folder)   { 2939 } # from id of :path in folders.json
+      let(:file)     { "non-existent-file.txt" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(Footrest::HttpError::NotFound)
+      end
+    end
+  end
+end

data/spec/fixtures/assignment.json

@@ -0,0 +1,191 @@
+[
+  {
+    // the ID of the assignment
+    "id": 4,
+    // the name of the assignment
+    "name": "some assignment",
+    // the assignment description, in an HTML fragment
+    "description": "<p>Do the following:</p>...",
+    // The time at which this assignment was originally created
+    "created_at": "2012-07-01T23:59:00-06:00",
+    // The time at which this assignment was last modified in any way
+    "updated_at": "2012-07-01T23:59:00-06:00",
+    // the due date for the assignment. returns null if not present. NOTE: If this
+    // assignment has assignment overrides, this field will be the due date as it
+    // applies to the user requesting information from the API.
+    "due_at": "2012-07-01T23:59:00-06:00",
+    // the lock date (assignment is locked after this date). returns null if not
+    // present. NOTE: If this assignment has assignment overrides, this field will be
+    // the lock date as it applies to the user requesting information from the API.
+    "lock_at": "2012-07-01T23:59:00-06:00",
+    // the unlock date (assignment is unlocked after this date) returns null if not
+    // present NOTE: If this assignment has assignment overrides, this field will be
+    // the unlock date as it applies to the user requesting information from the API.
+    "unlock_at": "2012-07-01T23:59:00-06:00",
+    // whether this assignment has overrides
+    "has_overrides": true,
+    // (Optional) all dates associated with the assignment, if applicable
+    "all_dates": null,
+    // the ID of the course the assignment belongs to
+    "course_id": 123,
+    // the URL to the assignment's web page
+    "html_url": "https://...",
+    // the URL to download all submissions as a zip
+    "submissions_download_url": "https://example.com/courses/:course_id/assignments/:id/submissions?zip=1",
+    // the ID of the assignment's group
+    "assignment_group_id": 2,
+    // Boolean flag indicating whether the assignment requires a due date based on the
+    // account level setting
+    "due_date_required": true,
+    // Allowed file extensions, which take effect if submission_types includes
+    // 'online_upload'.
+    "allowed_extensions": ["docx", "ppt"],
+    // An integer indicating the maximum length an assignment's name may be
+    "max_name_length": 15,
+    // Boolean flag indicating whether or not Turnitin has been enabled for the
+    // assignment. NOTE: This flag will not appear unless your account has the Turnitin
+    // plugin available
+    "turnitin_enabled": true,
+    // Boolean flag indicating whether or not VeriCite has been enabled for the
+    // assignment. NOTE: This flag will not appear unless your account has the VeriCite
+    // plugin available
+    "vericite_enabled": true,
+    // Settings to pass along to turnitin to control what kinds of matches should be
+    // considered. originality_report_visibility can be 'immediate', 'after_grading',
+    // 'after_due_date', or 'never' exclude_small_matches_type can be null, 'percent',
+    // 'words' exclude_small_matches_value: - if type is null, this will be null also -
+    // if type is 'percent', this will be a number between 0 and 100 representing match
+    // size to exclude as a percentage of the document size. - if type is 'words', this
+    // will be number > 0 representing how many words a match must contain for it to be
+    // considered NOTE: This flag will not appear unless your account has the Turnitin
+    // plugin available
+    "turnitin_settings": null,
+    // If this is a group assignment, boolean flag indicating whether or not students
+    // will be graded individually.
+    "grade_group_students_individually": false,
+    // (Optional) assignment's settings for external tools if submission_types include
+    // 'external_tool'. Only url and new_tab are included (new_tab defaults to false).
+    // Use the 'External Tools' API if you need more information about an external
+    // tool.
+    "external_tool_tag_attributes": null,
+    // Boolean indicating if peer reviews are required for this assignment
+    "peer_reviews": false,
+    // Boolean indicating peer reviews are assigned automatically. If false, the
+    // teacher is expected to manually assign peer reviews.
+    "automatic_peer_reviews": false,
+    // Integer representing the amount of reviews each user is assigned. NOTE: This key
+    // is NOT present unless you have automatic_peer_reviews set to true.
+    "peer_review_count": 0,
+    // String representing a date the reviews are due by. Must be a date that occurs
+    // after the default due date. If blank, or date is not after the assignment's due
+    // date, the assignment's due date will be used. NOTE: This key is NOT present
+    // unless you have automatic_peer_reviews set to true.
+    "peer_reviews_assign_at": "2012-07-01T23:59:00-06:00",
+    // Boolean representing whether or not members from within the same group on a
+    // group assignment can be assigned to peer review their own group's work
+    "intra_group_peer_reviews": false,
+    // The ID of the assignment’s group set, if this is a group assignment. For group
+    // discussions, set group_category_id on the discussion topic, not the linked
+    // assignment.
+    "group_category_id": 1,
+    // if the requesting user has grading rights, the number of submissions that need
+    // grading.
+    "needs_grading_count": 17,
+    // if the requesting user has grading rights and the
+    // 'needs_grading_count_by_section' flag is specified, the number of submissions
+    // that need grading split out by section. NOTE: This key is NOT present unless you
+    // pass the 'needs_grading_count_by_section' argument as true.  ANOTHER NOTE: it's
+    // possible to be enrolled in multiple sections, and if a student is setup that way
+    // they will show an assignment that needs grading in multiple sections
+    // (effectively the count will be duplicated between sections)
+    "needs_grading_count_by_section": [{"section_id":"123456","needs_grading_count":5}, {"section_id":"654321","needs_grading_count":0}],
+    // the sorting order of the assignment in the group
+    "position": 1,
+    // (optional, present if Sync Grades to SIS feature is enabled)
+    "post_to_sis": true,
+    // (optional, Third Party unique identifier for Assignment)
+    "integration_id": "12341234",
+    // (optional, Third Party integration data for assignment)
+    "integration_data": "12341234",
+    // whether the assignment is muted
+    "muted": null,
+    // the maximum points possible for the assignment
+    "points_possible": 12,
+    // the types of submissions allowed for this assignment list containing one or more
+    // of the following: 'discussion_topic', 'online_quiz', 'on_paper', 'none',
+    // 'external_tool', 'online_text_entry', 'online_url', 'online_upload'
+    // 'media_recording'
+    "submission_types": ["online_text_entry"],
+    // If true, the assignment has been submitted to by at least one student
+    "has_submitted_submissions": true,
+    // The type of grading the assignment receives; one of 'pass_fail', 'percent',
+    // 'letter_grade', 'gpa_scale', 'points'
+    "grading_type": "points",
+    // The id of the grading standard being applied to this assignment. Valid if
+    // grading_type is 'letter_grade' or 'gpa_scale'.
+    "grading_standard_id": null,
+    // Whether the assignment is published
+    "published": true,
+    // Whether the assignment's 'published' state can be changed to false. Will be
+    // false if there are student submissions for the assignment.
+    "unpublishable": false,
+    // Whether the assignment is only visible to overrides.
+    "only_visible_to_overrides": false,
+    // Whether or not this is locked for the user.
+    "locked_for_user": false,
+    // (Optional) Information for the user about the lock. Present when locked_for_user
+    // is true.
+    "lock_info": null,
+    // (Optional) An explanation of why this is locked for the user. Present when
+    // locked_for_user is true.
+    "lock_explanation": "This assignment is locked until September 1 at 12:00am",
+    // (Optional) id of the associated quiz (applies only when submission_types is
+    // ['online_quiz'])
+    "quiz_id": 620,
+    // (Optional) whether anonymous submissions are accepted (applies only to quiz
+    // assignments)
+    "anonymous_submissions": false,
+    // (Optional) the DiscussionTopic associated with the assignment, if applicable
+    "discussion_topic": null,
+    // (Optional) Boolean indicating if assignment will be frozen when it is copied.
+    // NOTE: This field will only be present if the AssignmentFreezer plugin is
+    // available for your account.
+    "freeze_on_copy": false,
+    // (Optional) Boolean indicating if assignment is frozen for the calling user.
+    // NOTE: This field will only be present if the AssignmentFreezer plugin is
+    // available for your account.
+    "frozen": false,
+    // (Optional) Array of frozen attributes for the assignment. Only account
+    // administrators currently have permission to change an attribute in this list.
+    // Will be empty if no attributes are frozen for this assignment. Possible frozen
+    // attributes are: title, description, lock_at, points_possible, grading_type,
+    // submission_types, assignment_group_id, allowed_extensions, group_category_id,
+    // notify_of_update, peer_reviews NOTE: This field will only be present if the
+    // AssignmentFreezer plugin is available for your account.
+    "frozen_attributes": ["title"],
+    // (Optional) If 'submission' is included in the 'include' parameter, includes a
+    // Submission object that represents the current user's (user who is requesting
+    // information from the api) current submission for the assignment. See the
+    // Submissions API for an example response. If the user does not have a submission,
+    // this key will be absent.
+    "submission": null,
+    // (Optional) If true, the rubric is directly tied to grading the assignment.
+    // Otherwise, it is only advisory. Included if there is an associated rubric.
+    "use_rubric_for_grading": true,
+    // (Optional) An object describing the basic attributes of the rubric, including
+    // the point total. Included if there is an associated rubric.
+    "rubric_settings": {"points_possible":12},
+    // (Optional) A list of scoring criteria and ratings for each rubric criterion.
+    // Included if there is an associated rubric.
+    "rubric": null,
+    // (Optional) If 'assignment_visibility' is included in the 'include' parameter,
+    // includes an array of student IDs who can see this assignment.
+    "assignment_visibility": [137, 381, 572],
+    // (Optional) If 'overrides' is included in the 'include' parameter, includes an
+    // array of assignment override objects.
+    "overrides": null,
+    // (Optional) If true, the assignment will be omitted from the student's final
+    // grade
+    "omit_from_final_grade": true
+  }
+]

data/spec/fixtures/doesnotexist.json

@@ -0,0 +1 @@
+while(1);{"errors":[{"message":"The specified resource does not exist."}],"error_report_id":7039743803}

data/spec/fixtures/file.json

@@ -0,0 +1,28 @@
+[
+  {
+    "size": 4,
+    "content-type": "text/plain",
+    "url": "http://www.canvas.instructure.com/files/569/download?download_frd=1&verifier=c6HdZmxOZa0Fiin2cbvZeI8I5ry7yqD7RChQzb6P",
+    "id": 569,
+    "display_name": "file.txt",
+    "created_at": "2012-07-06T14:58:50Z",
+    "updated_at": "2012-07-06T14:58:50Z",
+    "unlock_at": null,
+    "modified_at": "2012-07-06T14:58:50Z",
+    "locked": false,
+    "hidden": false,
+    "lock_at": null,
+    "locked_for_user": false,
+    "lock_info": null,
+    "lock_explanation": "This assignment is locked until September 1 at 12:00am",
+    "hidden_for_user": false,
+    "thumbnail_url": null,
+    // simplified content-type mapping
+    "mime_class": null,
+    // identifier for file in third-party transcoding service
+    "media_entry_id": null,
+    // optional: url to the document preview. This url is specific to the user
+    // making the api call. Only included in submission endpoints.
+    "preview_url": null
+  }
+]

data/spec/fixtures/nested.json

@@ -0,0 +1,68 @@
+[
+  {
+    "context_type": "Course",
+    "context_id": 1401,
+    "files_count": 1,
+    "position": 3,
+    "updated_at": "2012-07-06T14:58:50Z",
+    "folders_url": "https://www.canvas.instructure.com/api/v1/folders/2937/folders",
+    "files_url": "https://www.canvas.instructure.com/api/v1/folders/2937/files",
+    "full_name": "course files",
+    "lock_at": "2012-07-06T14:58:50Z",
+    "id": 2937,
+    "folders_count": 1,
+    "name": "course files",
+    "parent_folder_id": null,
+    "created_at": "2012-07-06T14:58:50Z",
+    "unlock_at": null,
+    "hidden": false,
+    "hidden_for_user": false,
+    "locked": true,
+    "locked_for_user": false,
+    "for_submissions": false
+  },
+  {
+    "context_type": "Course",
+    "context_id": 1401,
+    "files_count": 0,
+    "position": 3,
+    "updated_at": "2012-07-06T14:58:50Z",
+    "folders_url": "https://www.canvas.instructure.com/api/v1/folders/2938/folders",
+    "files_url": "https://www.canvas.instructure.com/api/v1/folders/2938/files",
+    "full_name": "course files/nested",
+    "lock_at": "2012-07-06T14:58:50Z",
+    "id": 2938,
+    "folders_count": 1,
+    "name": "nested",
+    "parent_folder_id": 2937,
+    "created_at": "2012-07-06T14:58:50Z",
+    "unlock_at": null,
+    "hidden": false,
+    "hidden_for_user": false,
+    "locked": true,
+    "locked_for_user": false,
+    "for_submissions": false
+  },
+  {
+    "context_type": "Course",
+    "context_id": 1401,
+    "files_count": 1,
+    "position": 3,
+    "updated_at": "2012-07-06T14:58:50Z",
+    "folders_url": "https://www.canvas.instructure.com/api/v1/folders/2939/folders",
+    "files_url": "https://www.canvas.instructure.com/api/v1/folders/2939/files",
+    "full_name": "course files/nested/examples",
+    "lock_at": "2012-07-06T14:58:50Z",
+    "id": 2939,
+    "folders_count": 0,
+    "name": "examples",
+    "parent_folder_id": 2938,
+    "created_at": "2012-07-06T14:58:50Z",
+    "unlock_at": null,
+    "hidden": false,
+    "hidden_for_user": false,
+    "locked": true,
+    "locked_for_user": false,
+    "for_submissions": false
+  }
+]

data/spec/fixtures/root.json

@@ -0,0 +1,24 @@
+[
+  {
+    "context_type": "Course",
+    "context_id": 1401,
+    "files_count": 1,
+    "position": 3,
+    "updated_at": "2012-07-06T14:58:50Z",
+    "folders_url": "https://www.canvas.instructure.com/api/v1/folders/2937/folders",
+    "files_url": "https://www.canvas.instructure.com/api/v1/folders/2937/files",
+    "full_name": "course files",
+    "lock_at": "2012-07-06T14:58:50Z",
+    "id": 2937,
+    "folders_count": 1,
+    "name": "course files",
+    "parent_folder_id": null,
+    "created_at": "2012-07-06T14:58:50Z",
+    "unlock_at": null,
+    "hidden": false,
+    "hidden_for_user": false,
+    "locked": true,
+    "locked_for_user": false,
+    "for_submissions": false
+  }
+]

data/spec/gist_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Canvas::Workflow::Tags::GistTag do
+  let(:doc) { doc_with_content(content) }
+  let(:content) { "{% gist #{gist} %}" }
+  let(:output) do
+    doc.content = content
+    doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+  end
+  let(:html) { "<p><iframe style=\"width: 100%; height: 400px;\" title=\"GitHub gist\" src=\"https://www.edu-apps.org/tools/github/github_summary_gist.html\##{gist}\" width=\"100%\" height=\"400\" allowfullscreen=\"allowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\"></iframe></p>\n" }
+
+  context "valid gist" do
+    let(:gist) { "jiverson002/a409d902fcea90800c9ea6c02c71d97d" }
+
+    it "produces the correct html" do
+      expect(output).to eq(html)
+    end
+  end
+
+  context "invalid gist" do
+    context "no gist present" do
+      let(:gist) { "" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(ArgumentError, "Cannot have empty gist")
+      end
+    end
+  end
+end