bearcat 1.3.53 → 1.3.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0cf8e258d39569d2594318b7ab932d6330a6c431457209296ef15a2a0e2ce1c
-  data.tar.gz: 0271b96f8803739253365ab53c65246927a94f81a762f2ab935f1f5ecb47cb6e
+  metadata.gz: 2168e1b83a6cea7ae22cd280352d3c5865aae3811800c789cd122b6240e05ebe
+  data.tar.gz: bbd67cb26a64ba4d80f5b69a1d51514a7497b28b5cce86fe58a9a49ad4595857
 SHA512:
-  metadata.gz: f786b3e10b6c69e1de4d98221167099ea626abca6769394eff4d72eb53c99eb0fa4594070c08e259302e401dfca44b314c89246aead3e39afd1b038250e27e87
-  data.tar.gz: adb1e066f78c93c80e7ce0f326ddb9bfee40a93493fe5c184dd2f873111db53c44fe9bbd00d72ca2aef658177885e6b6acb959eee9f3fc7e9b5f57e5bd78c115
+  metadata.gz: e2f98fb58293a2151fc7920ec482f2527080c0f36e36ddb18e12b828cfbc09e002899d4cc341f55b4fdf323485b89a07988229c52bcde7f0257694a2bbaf7a30
+  data.tar.gz: ee7d9d0fd7cc50ae7d8ca073e2f201cb867c72b077db922ef3607d6e1b90b541c4dda1894f3acae31ac8a1bedbdd36cf0c8cdfeb457a22bdf21a280cb74b9368

data/lib/bearcat/client.rb

@@ -7,6 +7,7 @@ module Bearcat
     require 'bearcat/api_array'
     require 'bearcat/client/file_helper'
     require 'bearcat/client/assignments'
+    require 'bearcat/client/blueprint_courses'
     require 'bearcat/client/courses'
     require 'bearcat/client/enrollments'
     require 'bearcat/client/outcome_groups'
@@ -46,6 +47,7 @@ module Bearcat
     include Assignments
     include Accounts
     include Analytics
+    include BlueprintCourses
     include Courses
     include Enrollments
     include OutcomeGroups

data/lib/bearcat/client/blueprint_courses.rb

@@ -0,0 +1,31 @@
+module Bearcat
+  class Client < Footrest::Client
+    module BlueprintCourses
+
+      # Get blueprint information
+      # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.show
+      def blueprint_template(course, template_id='default')
+        get("/api/v1/courses/#{course}/blueprint_templates/#{template_id}")
+      end
+
+      # List blueprint subscriptions
+      # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.subscriptions_index
+      def blueprint_subscriptions(course)
+        get("/api/v1/courses/#{course}/blueprint_subscriptions")
+      end
+
+      # Update associated courses
+      # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.update_associations
+      def blueprint_update_associations(course, template_id='default', params={})
+        put("/api/v1/courses/#{course}/blueprint_templates/#{template_id}/update_associations", params)
+      end
+
+      # Begin a migration to push to associated courses
+      # https://canvas.instructure.com/doc/api/blueprint_courses.html#method.master_courses/master_templates.queue_migration
+      def start_blueprint_migration(course, template_id='default', params={})
+        post("/api/v1/courses/#{course}/blueprint_templates/#{template_id}/migrations", params)
+      end
+
+    end
+  end
+end

data/lib/bearcat/client/courses.rb

@@ -63,9 +63,6 @@ module Bearcat
         get("api/v1/courses/#{course}/gradebook_history/feed", params)
       end
 
-      def blueprint_subscriptions(course)
-        get("/api/v1/courses/#{course}/blueprint_subscriptions")
-      end
     end
   end
 end

data/lib/bearcat/spec_helpers.rb

@@ -32,12 +32,9 @@ module Bearcat::SpecHelpers
       bits << between if between.present?
 
       bits.map do |bit|
-        case bit
-        when Regexp
-          bit.source
-        when String
-          Regexp.escape(bit)
-        end
+        next bit.source if bit.is_a?(Regexp)
+        bit = bit.canvas_id if bit.respond_to?(:canvas_id)
+        Regexp.escape(bit.to_s)
       end.join
     when String
       Regexp.escape(endpoint)

data/lib/bearcat/version.rb

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

data/spec/bearcat/client/blueprint_courses_spec.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+describe Bearcat::Client::BlueprintCourses do
+  before do
+    @client = Bearcat::Client.new(prefix: "http://canvas.instructure.com", token: "test_token")
+  end
+
+  it 'returns a list of blueprint subscriptions for the given course' do
+    stub_get(@client, "/api/v1/courses/1/blueprint_subscriptions").to_return(json_response("blueprint_subscriptions.json"))
+    subs = @client.blueprint_subscriptions(1)
+    expect(subs['id']).to eq 101
+    expect(subs['template_id']).to eq 1
+    expect(subs['blueprint_course']).to be_present
+  end
+
+  it 'returns a blueprint template for the given course' do
+    stub_get(@client, "/api/v1/courses/2/blueprint_templates/default").to_return(json_response("blueprint_template.json"))
+    template = @client.blueprint_template(2)
+    expect(template['id']).to eq 1
+    expect(template['course_id']).to eq 2
+  end
+
+  it 'updates assocations for a blueprint course' do
+    stub_put(@client, "/api/v1/courses/2/blueprint_templates/default/update_associations").to_return(json_response("blueprint_update_assocations_success.json"))
+    result = @client.blueprint_update_associations(2, 'default', course_ids_to_add: [123])
+    expect(result['success']).to eq true
+  end
+
+  it 'starts a migration for a blueprint course' do
+    stub_post(@client, "/api/v1/courses/2/blueprint_templates/default/migrations").to_return(json_response("blueprint_migration.json"))
+    migration = @client.start_blueprint_migration(2, 'default', {
+      comment: 'An optional comment to be included in the sync history.',
+      send_notification: false,
+      copy_settings: true
+    })
+    expect(migration['id']).to eq 1
+    expect(migration['template_id']).to eq 2
+    expect(migration['subscription_id']).to eq 101
+    expect(migration['user_id']).to eq 3
+    expect(migration['workflow_state']).to eq 'running'
+  end
+
+end

data/spec/fixtures/blueprint_migration.json

@@ -0,0 +1,12 @@
+{
+  "id": 1,
+  "template_id": 2,
+  "subscription_id": 101,
+  "user_id": 3,
+  "workflow_state": "running",
+  "created_at": "2013-08-28T23:59:00-06:00",
+  "exports_started_at": "2013-08-28T23:59:00-06:00",
+  "imports_queued_at": "2013-08-28T23:59:00-06:00",
+  "imports_completed_at": "2013-08-28T23:59:00-06:00",
+  "comment": "Fixed spelling in question 3 of midterm exam"
+}

data/spec/fixtures/blueprint_subscriptions.json

@@ -0,0 +1,5 @@
+{
+  "id": 101,
+  "template_id": 1,
+  "blueprint_course": {"id":2,"name":"Biology 100 Blueprint","course_code":"BIOL 100 BP","term_name":"Default term"}
+}

data/spec/fixtures/blueprint_template.json

@@ -0,0 +1,7 @@
+{
+  "id": 1,
+  "course_id": 2,
+  "last_export_completed_at": "2013-08-28T23:59:00-06:00",
+  "associated_course_count": 3,
+  "latest_migration": null
+}

data/spec/fixtures/blueprint_update_assocations_success.json

@@ -0,0 +1,3 @@
+{
+    "success": true
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearcat
 version: !ruby/object:Gem::Version
-  version: 1.3.53
+  version: 1.3.55
 platform: ruby
 authors:
 - Nathan Mills, Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -139,6 +139,7 @@ files:
 - lib/bearcat/client/analytics.rb
 - lib/bearcat/client/assignment_groups.rb
 - lib/bearcat/client/assignments.rb
+- lib/bearcat/client/blueprint_courses.rb
 - lib/bearcat/client/calendar_events.rb
 - lib/bearcat/client/canvas_files.rb
 - lib/bearcat/client/conferences.rb
@@ -179,6 +180,7 @@ files:
 - spec/bearcat/client/analytics_spec.rb
 - spec/bearcat/client/assignment_groups_spec.rb
 - spec/bearcat/client/assignments_spec.rb
+- spec/bearcat/client/blueprint_courses_spec.rb
 - spec/bearcat/client/calendar_events_spec.rb
 - spec/bearcat/client/canvas_files_spec.rb
 - spec/bearcat/client/conferences_spec.rb
@@ -239,6 +241,10 @@ files:
 - spec/fixtures/assignment_section_override.json
 - spec/fixtures/assignments.json
 - spec/fixtures/bearcat.jpg
+- spec/fixtures/blueprint_migration.json
+- spec/fixtures/blueprint_subscriptions.json
+- spec/fixtures/blueprint_template.json
+- spec/fixtures/blueprint_update_assocations_success.json
 - spec/fixtures/calendar_event.json
 - spec/fixtures/calendar_events.json
 - spec/fixtures/canvas_files/declare_file.json
@@ -398,6 +404,7 @@ test_files:
 - spec/bearcat/client/graph_ql_spec.rb
 - spec/bearcat/client/group_categories_spec.rb
 - spec/bearcat/client/rubric_assessment_spec.rb
+- spec/bearcat/client/blueprint_courses_spec.rb
 - spec/bearcat/client/submissions_spec.rb
 - spec/bearcat/client/module_items_spec.rb
 - spec/bearcat/client/content_migrations_spec.rb
@@ -463,6 +470,8 @@ test_files:
 - spec/fixtures/account_admin_create.json
 - spec/fixtures/assignment.json
 - spec/fixtures/calendar_event.json
+- spec/fixtures/blueprint_subscriptions.json
+- spec/fixtures/blueprint_update_assocations_success.json
 - spec/fixtures/course.json
 - spec/fixtures/rubric_association.json
 - spec/fixtures/external_tools.json
@@ -498,6 +507,7 @@ test_files:
 - spec/fixtures/user_logins.json
 - spec/fixtures/module_item_sequence.json
 - spec/fixtures/enrollment_terms.json
+- spec/fixtures/blueprint_migration.json
 - spec/fixtures/cc.imscc
 - spec/fixtures/user_profile.json
 - spec/fixtures/create_course_discussion.json
@@ -505,6 +515,7 @@ test_files:
 - spec/fixtures/created_module.json
 - spec/fixtures/course_groups.json
 - spec/fixtures/reactivate_enrollment.json
+- spec/fixtures/blueprint_template.json
 - spec/fixtures/account_courses.json
 - spec/fixtures/calendar_events.json
 - spec/fixtures/submissions/submission.json