bearcat 1.4.11 → 1.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 65992dcbb43af93a7a7f34bdf322bd82dd7ee45c
-  data.tar.gz: 3bf3d5f3e0849977b01b64df3c544519c2da928c
+SHA256:
+  metadata.gz: 56127337ffe67a0c9a01aa12a8c7d858331c49a8c608c2ec7e82de2b10abaadc
+  data.tar.gz: ef63a06ce0fc281a255763afbd1d7e0d07e85b2d40bf2a45b01a4a41f21efb1b
 SHA512:
-  metadata.gz: 2936b59a7848832d98927f55e16abcce88f975a48319acaa2d8888ac5fe0ddb3e824f2eb1b638c44e0adeb0e5269eb6dd1304b0866feefca1714ce4c2c58565e
-  data.tar.gz: 1f176cce865ed38077e99e8a4960a09953d9c62bc0dbf7e0353caf8d1fc281152764ffbe05321ad13c01986b148c7f5154c20dee1096ab44ec444692cbb360c8
+  metadata.gz: 9dee94f956ca584cc6c0d892277e424430f81c62074106f040fe92974d926b5df72dc8b57d7e3f84dff64d135ba274967da32110bb8201aee061715b331b4969
+  data.tar.gz: 114bbcc3a2374c8b8774da933c412ea73f57a9adb0273a5d1683ee4949fd077088bdb12ca91e430011cda1740023a4c9b480a45c573c9685ee30a9215488d2c0

data/lib/bearcat/api_array.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/module'
+
 module Bearcat
   class ApiArray
     include Enumerable

data/lib/bearcat/client/file_helper.rb

@@ -5,7 +5,7 @@ module Bearcat
         {
           size: File.open(file_path).size,
           name: File.basename(file_path)
-        }
+        }.with_indifferent_access
       end
 
       def declare_file(api_path, params)

data/lib/bearcat/client/learning_outcomes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bearcat
+  class Client < Footrest::Client
+    module LearningOutcomes
+
+      def learning_outcome(outcome, params={})
+        get("/api/v1/outcomes/#{outcome}", params)
+      end
+
+      def update_learning_outcome(outcome, params={})
+        put("/api/v1/outcomes/#{outcome}", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/submissions.rb

@@ -34,22 +34,12 @@ module Bearcat
         put("/api/v1/sections/#{section}/assignments/#{assignment}/submissions/#{user}", params)
       end
 
-      def course_file_upload_submission(course, assignment, user, file_path, params={})
-        response = upload_file("/api/v1/courses/#{course}/assignments/#{assignment}/submissions/#{user}/files", file_path, params)
-        params['submission'] = {
-          'submission_type' => 'online_upload',
-          'file_ids'=> [response['id']]
-        }
-        course_submission(course, assignment, params)
+      def course_file_upload_submission(course, assignment, user, file_data, params={})
+        file_upload_submission(course, assignment, user, file_data, params, type: :course)
       end
 
-      def section_file_upload_submission(section, assignment, user, file_path, params={})
-        response = upload_file("/api/v1/sections/#{section}/assignments/#{assignment}/submissions/#{user}/files", file_path, params)
-        params['submission'] = {
-          'submission_type' => 'online_upload',
-          'file_ids'=> [response['id']]
-        }
-        section_submission(section, assignment, params)
+      def section_file_upload_submission(section, assignment, user, file_data, params={})
+        file_upload_submission(section, assignment, user, file_data, params, type: :section)
       end
 
       def course_update_grades(course, assignment, params={})
@@ -60,6 +50,43 @@ module Bearcat
         post("/api/v1/sections/#{section}/assignments/#{assignment}/submissions/update_grades", params)
       end
 
+      protected
+
+      # @param file_data One of an array of file_path strings or an array of Hashes, each being upload file params plus the file's path
+      def file_upload_submission(type_id, assignment, user, file_data=nil, params={}, type:)
+        raise ArgumentError, 'Invalid type' unless [:course, :section].include?(type)
+        raise ArgumentError, 'Must provide either file paths or fully formed submission params' if params.dig(:submission, :file_ids).nil? && file_data.nil?
+
+        params = params.with_indifferent_access
+        sub_params = if params.dig(:submission, :file_ids).present?
+                       {}
+                     else
+                       file_data = Array.wrap(file_data)
+                       file_ids = file_data.map do |datum|
+                         if datum.is_a?(Hash) && datum[:file_path].present?
+                           # datum is a param hash for upload_file API plus the file_path
+                           path = datum[:file_path]
+                           upload_params = datum.except(:file_path)
+                         else
+                           # treat datum as a file_path string
+                           path = datum
+                           upload_params = params
+                         end
+
+                         response = upload_file("/api/v1/#{type}s/#{type_id}/assignments/#{assignment}/submissions/#{user}/files", path, upload_params)
+                         response['id']
+                       end
+
+                       {
+                         submission_type: 'online_upload',
+                         file_ids: file_ids,
+                       }
+                     end
+        sub_params.merge!(params[:submission]) if params[:submission].present?
+        params[:submission] = sub_params
+        send("#{type}_submission".to_sym, type_id, assignment, params)
+      end
+
     end
   end
 end

data/lib/bearcat/version.rb

@@ -1,3 +1,3 @@
 module Bearcat
-  VERSION = '1.4.11' unless defined?(Bearcat::VERSION)
+  VERSION = '1.4.13' unless defined?(Bearcat::VERSION)
 end

data/spec/bearcat/client/canvas_files_spec.rb

@@ -13,8 +13,8 @@ describe Bearcat::Client::CanvasFiles do
     stub_request(:post, "https://upload-url.invalid/").
       to_return(status: 302, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
 
-    stub_post(@client, "/confirm").
-      with(:body => {"param" => ["true"]}).to_return(json_response('canvas_files', 'upload_success.json'))
+    stub_get(@client, "/confirm").
+      with(:query => {"param" => ["true"]}).to_return(json_response('canvas_files', 'upload_success.json'))
 
     response = @client.upload_file('my/upload/path', fixture('bearcat.jpg'))
     expect(response['id']).to eq 123

data/spec/bearcat/client/content_migrations_spec.rb

@@ -7,12 +7,12 @@ describe Bearcat::Client::ContentMigrations do
 
   it 'uploads a file' do
     stub_post(@client, "/my/upload/path").
-    to_return(json_response('content_migration_files/response.json'))
+      to_return(json_response('content_migration_files/response.json'))
 
     stub_request(:post, "http://host/files_api").
       to_return(status: 302, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
 
-    stub_post(@client, '/confirm').to_return(json_response('content_migration_files/upload_success.json'))
+    stub_get(@client, '/confirm').with(:query => {"param" => ["true"]}).to_return(json_response('content_migration_files/upload_success.json'))
 
     opts = {migration_type: 'canvas_cartridge_importer', pre_attachment: {name: 'cc.imscc', size: '2034'}}
     response = @client.upload_content_package('my/upload/path', fixture('cc.imscc'), opts)

data/spec/bearcat/client/courses_spec.rb

@@ -49,8 +49,8 @@ describe Bearcat::Client::Sections do
     stub_request(:post, "http://host/files_api").
       to_return(status: 302, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
 
-    stub_post(@client, "/confirm").
-      with(:body => {"param" => ["true"]}).to_return(json_response('content_migration_files', 'upload_success.json'))
+    stub_get(@client, "/confirm").
+      with(:query => {"param" => ["true"]}).to_return(json_response('content_migration_files', 'upload_success.json'))
 
     opts = {'migration_type' => 'canvas_cartridge_importer', 'pre_attachment[name]' => 'cc.imscc', 'pre_attachment[size]' => '2034'}
     response = @client.create_content_migration('659', fixture('cc.imscc'), opts)
@@ -66,8 +66,8 @@ describe Bearcat::Client::Sections do
       stub_request(:post, "http://host/files_api").
         to_return(status: 302, headers: {'Location' => 'https://confirm-upload.invalid/confirm?param=true'})
 
-      stub_post(@client, "/confirm").
-        with(:body => {"param" => ["true"]}).to_return(json_response('content_migration_files', 'upload_success.json'))
+      stub_get(@client, "/confirm").
+        with(:query => {"param" => ["true"]}).to_return(json_response('content_migration_files', 'upload_success.json'))
 
       opts = {'migration_type' => 'canvas_cartridge_importer', 'pre_attachment[name]' => 'cc.imscc', 'pre_attachment[size]' => '2034'}
       content_migration_response, file_upload_response = @client.create_content_migration_with_both_responses('659', fixture('cc.imscc'), opts)

data/spec/bearcat/client/learning_outcomes_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'helper'
+
+describe Bearcat::Client::LearningOutcomes do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  it "returns an individual learning outcome" do
+    stub_get(@client, "/api/v1/outcomes/1").to_return(json_response("learning_outcome.json"))
+    outcome = @client.learning_outcome(1)
+    outcome["id"].should == 1
+    outcome["context_type"].should == "Course"
+    outcome["title"].should == "First Outcome"
+  end
+
+  it "updates an individual learning outcome" do
+    stub_put(@client, "/api/v1/outcomes/1").to_return(json_response("learning_outcome.json"))
+    outcome = @client.update_learning_outcome(1)
+    outcome["id"].should == 1
+    outcome["context_type"].should == "Course"
+    outcome["title"].should == "First Outcome"
+  end
+end

data/spec/bearcat/client/submissions_spec.rb

@@ -45,6 +45,13 @@ describe Bearcat::Client::Submissions do
       response['id'].should == 8444510
     end
 
+    it "submits multiple files" do
+      @client.stub(:upload_file).and_return({})
+      stub_post(@client, '/api/v1/courses/1/assignments/2/submissions').to_return(json_response('submissions', 'submission.json'))
+      response = @client.course_file_upload_submission(1, 2, 3, [fixture('bearcat.jpg'), fixture('file.csv')])
+      response['id'].should == 8444510
+    end
+
     it "updates grades" do
       params = {"grade_data[123]" => "19"}
       stub_post(@client, "/api/v1/courses/1/assignments/1/submissions/update_grades").with(body: {"grade_data"=>["19"]}).to_return(json_response("progress.json"))
@@ -56,6 +63,13 @@ describe Bearcat::Client::Submissions do
 
   context 'section' do
     it "submits a file" do
+      @client.stub(:upload_file).and_return({})
+      stub_post(@client, '/api/v1/sections/1/assignments/2/submissions').to_return(json_response('submissions', 'submission.json'))
+      response = @client.section_file_upload_submission(1, 2, 3, [fixture('bearcat.jpg'), fixture('file.csv')])
+      response['id'].should == 8444510
+    end
+
+    it "submits multiple files" do
       @client.stub(:upload_file).and_return({})
       stub_post(@client, '/api/v1/sections/1/assignments/2/submissions').to_return(json_response('submissions', 'submission.json'))
       response = @client.section_file_upload_submission(1, 2, 3, fixture('bearcat.jpg'))

data/spec/fixtures/learning_outcome.json

@@ -0,0 +1,32 @@
+{
+  "id": 1,
+  "context_id": 1,
+  "context_type": "Course",
+  "vendor_guid": null,
+  "display_name": "",
+  "title": "First Outcome",
+  "url": "/api/v1/outcomes/1",
+  "can_edit": true,
+  "has_updateable_rubrics": false,
+  "description": "<p>Description</p>",
+  "friendly_description": null,
+  "points_possible": 5.0,
+  "mastery_points": 3.0,
+  "ratings": [
+    {
+      "description": "Exceeds Expectations",
+      "points": 5.0
+    },
+    {
+      "description": "Meets Expectations",
+      "points": 3.0
+    },
+    {
+      "description": "Does Not Meet Expectations",
+      "points": 0.0
+    }
+  ],
+  "calculation_method": "decaying_average",
+  "calculation_int": 65,
+  "assessed": true
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.4.11
+  version: 1.4.13
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -158,6 +158,7 @@ files:
 - lib/bearcat/client/group_categories.rb
 - lib/bearcat/client/group_memberships.rb
 - lib/bearcat/client/groups.rb
+- lib/bearcat/client/learning_outcomes.rb
 - lib/bearcat/client/module_items.rb
 - lib/bearcat/client/modules.rb
 - lib/bearcat/client/o_auth2.rb
@@ -202,6 +203,7 @@ files:
 - spec/bearcat/client/group_categories_spec.rb
 - spec/bearcat/client/group_membership_spec.rb
 - spec/bearcat/client/groups_spec.rb
+- spec/bearcat/client/learning_outcomes_spec.rb
 - spec/bearcat/client/module_items_spec.rb
 - spec/bearcat/client/modules_spec.rb
 - spec/bearcat/client/o_auth2_spec.rb
@@ -318,6 +320,7 @@ files:
 - spec/fixtures/group_category_groups.json
 - spec/fixtures/group_conferences.json
 - spec/fixtures/group_membership.json
+- spec/fixtures/learning_outcome.json
 - spec/fixtures/link_unlink_outcome.json
 - spec/fixtures/merge_user.json
 - spec/fixtures/module.json
@@ -383,8 +386,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Canvas API
@@ -423,6 +425,7 @@ test_files:
 - spec/bearcat/client/external_tools_spec.rb
 - spec/bearcat/client/rubric_spec.rb
 - spec/bearcat/client/accounts_spec.rb
+- spec/bearcat/client/learning_outcomes_spec.rb
 - spec/bearcat/client/outcomes_spec.rb
 - spec/bearcat/client/courses_spec.rb
 - spec/bearcat/client/reports_spec.rb
@@ -540,6 +543,7 @@ test_files:
 - spec/fixtures/account_admin_delete.json
 - spec/fixtures/account_reports_result_success.json
 - spec/fixtures/deleted_conversation.json
+- spec/fixtures/learning_outcome.json
 - spec/fixtures/user_details.json
 - spec/fixtures/outcome_group_import.json
 - spec/fixtures/modules.json