SWAMPy

✎ CARVE FLESH

EDITING: general_api_spec.rb

# frozen_string_literal: true

#
# Copyright (C) 2011 - 2012 Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

require_relative "api_spec_helper"

describe "API", type: :request do
  describe "Api::V1::Json" do
    it "merges user options with the default api behavior" do
      obj = Object.new
      obj.extend Api::V1::Json
      course_with_teacher
      session = double
      expect(@course).to receive(:as_json).with({ include_root: false, permissions: { user: @user, session:, include_permissions: false }, only: [:name, :sis_source_id] })
      obj.api_json(@course, @user, session, only: [:name, :sis_source_id])
    end
  end

describe "as_json extensions" do
    it "skips attribute filtering if obj doesn't respond" do
      course_with_teacher
      expect(@course.respond_to?(:filter_attributes_for_user)).to be_truthy
      expect(@course.as_json(include_root: false, permissions: { user: @user }, only: %w[name sis_source_id]).keys.sort).to eq %w[name permissions sis_source_id]
    end

it "does attribute filtering if obj responds" do
      course_with_teacher
      @course.send(:extend, RSpec::Matchers)
      def @course.filter_attributes_for_user(hash, user, session)
        expect(user).to eq teachers.first
        expect(session).to be_nil
        hash.delete("sis_source_id")
      end
      expect(@course.as_json(include_root: false, permissions: { user: @user }, only: %w[name sis_source_id]).keys.sort).to eq %w[name permissions]
    end

it "does not return the permissions list if include_permissions is false" do
      course_with_teacher
      expect(@course.as_json(include_root: false, permissions: { user: @user, include_permissions: false }, only: %w[name sis_source_id]).keys.sort).to eq %w[name sis_source_id]
    end

it "serializes permissions if obj responds" do
      course_with_teacher
      expect(@course).to receive(:serialize_permissions).once.with(anything, @teacher, nil)
      json = @course.as_json(include_root: false, permissions: { user: @user, session: nil, include_permissions: true, policies: ["update"] }, only: %w[name])
      expect(json.keys.sort).to eq %w[name permissions]
    end
  end

describe "json post format" do
    before :once do
      course_with_teacher(user: user_with_pseudonym, active_all: true)
      enable_default_developer_key!
      @token = @user.access_tokens.create!(purpose: "specs")
    end

it "uses html form encoding by default" do
      html_request = "assignment[name]=test+assignment&assignment[points_possible]=15"
      # no content-type header is sent
      post "/api/v1/courses/#{@course.id}/assignments", params: html_request, headers: { "HTTP_AUTHORIZATION" => "Bearer #{@token.full_token}" }
      expect(response).to be_successful
      expect(response.header[content_type_key]).to eq "application/json; charset=utf-8"

@assignment = @course.assignments.order(:id).last
      expect(@assignment.title).to eq "test assignment"
      expect(@assignment.points_possible).to eq 15
    end

it "supports json POST request bodies" do
      json_request = { "assignment" => { "name" => "test assignment", "points_possible" => 15 } }
      post "/api/v1/courses/#{@course.id}/assignments", params: json_request.to_json, headers: { "CONTENT_TYPE" => "application/json", "HTTP_AUTHORIZATION" => "Bearer #{@token.full_token}" }
      expect(response).to be_successful
      expect(response.header[content_type_key]).to eq "application/json; charset=utf-8"

@assignment = @course.assignments.order(:id).last
      expect(@assignment.title).to eq "test assignment"
      expect(@assignment.points_possible).to eq 15
    end

it "uses array params without the [] on the key" do
      assignment_model(course: @course, submission_types: "online_upload")
      @user = user_with_pseudonym
      course_with_student(course: @course, user: @user, active_all: true)
      @token = @user.access_tokens.create!(purpose: "specs")
      a1 = attachment_model(context: @user)
      a2 = attachment_model(context: @user)
      json_request = { "comment" => {
                         "text_comment" => "yay"
                       },
                       "submission" => {
                         "submission_type" => "online_upload",
                         "file_ids" => [a1.id, a2.id]
                       } }
      post "/api/v1/courses/#{@course.id}/assignments/#{@assignment.id}/submissions",
           params: json_request.to_json,
           headers: { "CONTENT_TYPE" => "application/json", "HTTP_AUTHORIZATION" => "Bearer #{@token.full_token}" }
      expect(response).to be_successful
      expect(response.header[content_type_key]).to eq "application/json; charset=utf-8"

@submission = @assignment.submissions.where(user_id: @user).first
      sub_a1 = Attachment.where(root_attachment_id: a1).first
      sub_a2 = Attachment.where(root_attachment_id: a2).first
      expect(@submission.attachments.map(&:id).sort).to eq [sub_a1.id, sub_a2.id]
      expect(@submission.submission_comments.first.comment).to eq "yay"
    end
  end

describe "application/json+canvas-string-ids" do
    it "stringifies fields with Accept header" do
      account = Account.default.sub_accounts.create!
      account_admin_user(active_all: true, account:)
      json = api_call(:get,
                      "/api/v1/accounts/#{account.id}",
                      { controller: "accounts", action: "show", id: account.to_param, format: "json" },
                      {},
                      { "Accept" => "application/json+canvas-string-ids" })
      expect(json["id"]).to eq account.id.to_s
      expect(json["root_account_id"]).to eq Account.default.id.to_s
    end

it "does not stringify fields without Accept header" do
      account = Account.default.sub_accounts.create!
      account_admin_user(active_all: true, account:)
      json = api_call(:get,
                      "/api/v1/accounts/#{account.id}",
                      { controller: "accounts", action: "show", id: account.to_param, format: "json" })
      expect(json["id"]).to eq account.id
      expect(json["root_account_id"]).to eq Account.default.id
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 html/	DIR	—	2023-09-24 03:36
📁 lti/	DIR	—	2023-09-24 03:36
📁 swagger/	DIR	—	2023-09-24 03:36
📁 v1/	DIR	—	2023-09-24 03:39
📄 api_spec_helper.rb	RB	10.4 KB	2023-09-24 03:36	EDIT
📄 auth_spec.rb	RB	47.8 KB	2023-09-24 03:36	EDIT
📄 error_handling_spec.rb	RB	2 KB	2023-09-24 03:36	EDIT
📄 file_uploads_spec_helper.rb	RB	24 KB	2023-09-24 03:39	EDIT
📄 general_api_spec.rb	RB	6.6 KB	2023-09-24 03:39	EDIT
📄 locked_examples.rb	RB	3.5 KB	2023-09-24 03:36	EDIT
📄 user_content_spec.rb	RB	25.5 KB	2023-09-24 03:36	EDIT