canvas_sync 0.23.1 → 0.23.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ae5e4352ec2cd93ccbda29fdb2b101695f901842c39a24d7a4084694336a76
-  data.tar.gz: d1eada607b543891b5d657d1fe0db3d211275bf2af8fb32a8ee4e4a1a5d78491
+  metadata.gz: 87dcb3a29883abf28f3be7ef70a6aaa6b8b303c7115d5a52e8a7ae9785c1ba3d
+  data.tar.gz: ac6c904f3ce0af3e8cdcd32dea735b69dbb856a21c6a2122a0cf9a4d6fe910cc
 SHA512:
-  metadata.gz: 0f05dfc8155287d2b636f1e064ee6180a064c3c02cb087ffcf2e8eb68477d6f7c6baeabb669c068aa5aa63c5f36152d7056155c62ca7949a22cb1976a19ef9e8
-  data.tar.gz: a9ae2c98e3944468142bee9f072ba79f9cd59d7608f8f85edf178cf29badd3942a3d7e7b2c762137b1beac4e8909377c2dd6979dbe26017b4985131b71eccd6a
+  metadata.gz: 398b3bf5a5da8cc4709c49a69587000a48d56cf86e9b46b5ada2768dab58f2b8dc14125c70885074dc4311c4b0aa818105283b6c0d3edc820e5c1e092b1e38d7
+  data.tar.gz: b89d3d9d41fd62f9c017742ee7b08c5b50ca0e379dfa3bd48e9e78598dfd7b113917666211c146efa9b471b2a9827d4acb6e8620c0da4806d9c99dd0a51f314c

data/lib/canvas_sync/generators/templates/migrations/create_courses.rb

@@ -13,6 +13,8 @@ class CreateCourses < ActiveRecord::Migration[5.1]
       t.datetime :start_at
       t.datetime :end_at
       t.bigint :grading_standard_id
+      # Optional opt-in columns
+      # t.string :public_description
 
       t.timestamps
     end

data/lib/canvas_sync/generators/templates/models/course.rb

@@ -34,7 +34,10 @@ class Course < ApplicationRecord
     canvas_account_id: :account_id,
     start_at: :start_at,
     end_at: :end_at,
+    # If opting in the public_description, make sure to also add the 'include' array in the api call
+    # public_description: :public_description,
   }, -> (api) { api.course(canvas_id) })
+  # }, -> (api) { api.course(canvas_id, { include: ['public_description'] }) })
 
   scope :active, -> { where(workflow_state: 'active') }
 

data/lib/canvas_sync/processors/model_mappings.yml

@@ -104,6 +104,9 @@ courses:
     grading_standard_id:
       database_column_name: grading_standard_id
       type: integer
+    public_description:
+      database_column_name: public_description
+      type: string
 
 course_progresses:
   conflict_target:

data/lib/canvas_sync/processors/provisioning_report_processor.rb

@@ -24,8 +24,8 @@ module CanvasSync
         if options[:models].length == 1
           run_import(options[:models][0], report_file_path)
         else
-          unzipped_file_path = extract(report_file_path)
-          Dir[unzipped_file_path + "/*.csv"].sort.each do |file_path|
+          unzipped_file_dir = extract(report_file_path)
+          Dir[unzipped_file_dir + "/*.csv"].sort.each do |file_path|
             model_name = file_path.split("/").last.split(".").first
             run_import(model_name, file_path)
           end
@@ -35,17 +35,23 @@ module CanvasSync
       private
 
       def extract(file_path)
-        unzipped_file_path = "#{file_path}_unzipped"
+        unzipped_file_dir = "#{file_path}_unzipped"
 
         Zip::File.open(file_path) do |zip_file|
           zip_file.each do |f|
-            f_path = File.join(unzipped_file_path, f.name)
+            f_path = File.join(unzipped_file_dir, f.name)
             FileUtils.mkdir_p(File.dirname(f_path))
-            zip_file.extract(f, f_path) unless File.exist?(f_path)
+            next if File.exist?(f_path)
+
+            if Zip::VERSION < "3.0.0"
+              zip_file.extract(f, destination_directory: unzipped_file_dir)
+            else
+              zip_file.extract(f, f_path)
+            end
           end
         end
 
-        unzipped_file_path
+        unzipped_file_dir
       end
 
       def run_import(model_name, report_file_path)

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.23.1".freeze
+  VERSION = "0.23.3".freeze
 end

data/spec/dummy/app/models/course.rb

@@ -40,7 +40,11 @@ class Course < ApplicationRecord
     canvas_account_id: :account_id,
     start_at: :start_at,
     end_at: :end_at,
+    # If opting in the public_description, make sure to also add the 'include' array in the api call
+    # public_description: :public_description,
   }, -> (api) { api.course(canvas_id) })
+  # }, -> (api) { api.course(canvas_id, { include: ['public_description'] }) })
+
 
   scope :active, -> { where(workflow_state: 'active') }
 

data/spec/dummy/db/migrate/20190702203621_create_courses.rb

@@ -19,6 +19,8 @@ class CreateCourses < ActiveRecord::Migration[5.1]
       t.datetime :start_at
       t.datetime :end_at
       t.bigint :grading_standard_id
+      # Optional opt-in columns
+      # t.string :public_description
 
       t.timestamps
     end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.1].define(version: 2025_06_26_194330) do
+ActiveRecord::Schema[7.1].define(version: 2025_07_30_124426) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -214,6 +214,7 @@ ActiveRecord::Schema[7.1].define(version: 2025_06_26_194330) do
     t.datetime "start_at", precision: nil
     t.datetime "end_at", precision: nil
     t.bigint "grading_standard_id"
+    t.string "public_description"
     t.datetime "created_at", precision: nil, null: false
     t.datetime "updated_at", precision: nil, null: false
     t.index ["canvas_id"], name: "index_courses_on_canvas_id", unique: true
@@ -363,10 +364,10 @@ ActiveRecord::Schema[7.1].define(version: 2025_06_26_194330) do
   end
 
   create_table "roles", force: :cascade do |t|
-    t.integer "canvas_id", null: false
+    t.bigint "canvas_id", null: false
     t.string "label"
     t.string "base_role_type"
-    t.integer "canvas_account_id"
+    t.bigint "canvas_account_id"
     t.string "workflow_state"
     t.json "permissions"
     t.datetime "created_at", precision: nil, null: false

data/spec/support/fixtures/reports/courses.csv

@@ -1,3 +1,3 @@
-canvas_course_id,course_id,integration_id,short_name,long_name,canvas_account_id,account_id,canvas_term_id,term_id,status,start_date,end_date,course_format,created_by_sis
-1,course_sis_id_1,,C1,Course #1,1,,1,term_sis_id_1,active,2017-03-27T15:53:18-06:00,2017-04-27T06:21:18-06:00,,FALSE
-2,course_sis_id_2,,C2,Course #2,1,,1,term_sis_id_2,unpublished,2017-03-27T15:53:18-06:00,2017-04-27T06:21:18-06:00,,FALSE,5
+canvas_course_id,course_id,integration_id,short_name,long_name,canvas_account_id,account_id,canvas_term_id,term_id,status,start_date,end_date,course_format,created_by_sis,public_description
+1,course_sis_id_1,,C1,Course #1,1,,1,term_sis_id_1,active,2017-03-27T15:53:18-06:00,2017-04-27T06:21:18-06:00,,FALSE,"Description 1"
+2,course_sis_id_2,,C2,Course #2,1,,1,term_sis_id_2,unpublished,2017-03-27T15:53:18-06:00,2017-04-27T06:21:18-06:00,,FALSE,5,"Description 2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_sync
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.23.3
 platform: ruby
 authors:
 - Instructure CustomDev
@@ -289,6 +289,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: open-uri
   requirement: !ruby/object:Gem::Requirement
@@ -884,7 +898,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Gem for generating Canvas models and migrations and syncing data from Canvas
 test_files: