ruql-canvas 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3418ecd8bce903e51bfeab3af00cc5d5ac0cbcc1c1043d35e730cdc9cf2df924
-  data.tar.gz: 2445969de592cba48c164fae63ebcdf3cbfd0670840fe518274f31a3b305e48d
+  metadata.gz: fdc05b1cc995933e8a0b76fa2b29c0f351ce002605e25c21ae1f1f411d1841bd
+  data.tar.gz: bf751328a381352dc45a221f87ffaffe086c65087f2c65b826c68415781648a7
 SHA512:
-  metadata.gz: cf0f232a4ce1981fc8636b3f8840a66efe8a8bf152085f6129780177344f655d44f36159308ca91f9b25406de96e284efb6a034ad5c8f11010e05a1ca49db4ef
-  data.tar.gz: c01c3ff0a897fd33530577231d80eba5a64a7d9aa8b7cdf599a06886cd33b2836bd421b1b71427bc26828ed357bee9efd59be05961dacc8ceea0dcfd4a6a9343
+  metadata.gz: 1a68292bf05596303e9cd7ab6d377e06ae92999fb119ff095882115b84c53f69de9deeb6db1f7f9f454f97a8f8c22cec1e1ed7e9da93a0506b6bd5ef824b425d
+  data.tar.gz: 16da6cf1a5e248652b26e35fca2ea008c33c2c94b7d48302f5e89386d82eaf7f03f94cd9287bf9bd4320fe7ac0454df67255ed92d40fac07c19a4a7b6af2746c

data/lib/ruql/canvas/canvas.rb

@@ -24,9 +24,11 @@ module Ruql
       yaml = YAML.load_file(yaml_options)
       logger.warn "Doing dry run without making any changes" if
         (@dry_run = yaml['dry_run'] || options['--canvas-dry-run'])
-      set_canvas_options(yaml['canvas'])
+      @canvas_options = yaml['canvas']
+      set_canvas_options(@canvas_options)
 
       @quiz_options = YAML.load_file(@default_quiz_options_file)['quiz'].merge(yaml['quiz'] || {})
+      @quiz_id = @quiz_options['quiz_id'] # may be nil if new quiz is to be created.
       logger.info "Using quiz options:\n#{@quiz_options.inspect}"
 
       verify_valid_quiz!
@@ -48,16 +50,20 @@ module Ruql
       help = <<eos
 The Canvas renderer adds the given file as a quiz in Canvas, with these options:
   --canvas-dry-run  - don't actually change anything, but do all non-state-changing API calls.
-               You can also set dry_run: true in the YAML file instead.
+               You can also set dry_run: true in the YAML file instead.  The presence of either
+               mechanism will turn this into a dry run.
   --canvas-config=file.yml - A Yaml file that must contain at least the following:
     dry_run: true   #  don't actually change anything, but check API connection and parsability
     canvas:
       api_base: https://bcourses.berkeley.edu/api/v1 # base URL for Canvas LMS API
       auth_token: 012345    #  Bearer auth token for Canvas API
       course_id: 99999      #  Course ID in Canvas to which a NEW quiz should be added
-      # If a quiz_id is given and exists within that course, that quiz's contents
-      # will be completely replaced, otherwise a new quiz will be created:
-      quiz_id: 99999 
+      # If quiz_id given, replace that quiz's questions and time limit; if not, create new
+      quiz_id: 99999
+      #  How quiz time limit is set, eg 20-point quiz = 40 minutes. Default is 1
+      minutes_per_point: 2  
+      # Fixed extra time in addition to minutes/point. Default 5. Total time rounded up to multiple of 5.
+      extra_minutes: 5
     quiz:
       # various options that control quiz; defaults are in #{@default_quiz_options_file}
 eos
@@ -86,10 +92,32 @@ eos
         create_quiz!
         @output = "New quiz #{@quiz_id}"
       end
-      quiz.ungrouped_questions.each do |q|
-        canvas_question = render_multiple_choice(q)
-        add_question_to_current_group(canvas_question)
+      emit_ungrouped_questions
+      emit_grouped_questions
+      @output << " now has #{@qcount} questions in #{@group_count} pool(s)"
+    end
+    #####
+
+    
+    private
+
+    # all "ungrouped" questions go into a single big group that can be shuffled.
+    # Caveat 1: where groups are typically "pick 1 of the following N", this big group has to be "pick N of the
+    #   following N" so that all questions are presented, just in a shuffled order.
+    # Caveat 2: all questions in a group must be worth same # points, so we actually have to subdivide
+    #   ungrouped questions into subgroups by point value.
+    def emit_ungrouped_questions
+      ungrouped_question_sets = quiz.ungrouped_questions.group_by(&:points)
+      ungrouped_question_sets.each_pair do |points,questions|
+        start_new_group(:name => "Group:unpooled:#{points}", :pick_count => questions.length, :question_points => points)
+        questions.each do |q|
+          canvas_question = render_multiple_choice(q)
+          add_question_to_current_group(canvas_question)
+        end
       end
+    end
+
+    def emit_grouped_questions
       current_group = nil
       quiz.grouped_questions.each do |q|
         if q.question_group != current_group
@@ -99,12 +127,8 @@ eos
         canvas_question = render_multiple_choice(q)
         add_question_to_current_group(canvas_question)
       end
-      @output << " now has #{@qcount} questions in #{@group_count} pool(s)"
     end
-    #####
-
-    private
-
+    
     def set_canvas_options(canvas)
       @course_id = canvas['course_id'] || raise(Ruql::OptionsError.new("course_id missing from config file"))
       @quiz_id = canvas['quiz_id'] # may be nil => create new quiz
@@ -137,8 +161,12 @@ eos
     def time_limit_for_quiz
       # intent is 1 point per minute, add 5 minutes for slop, round total up to nearest 5 minutes
       # but # questions is really # unique groups.
-      limit =  5 * (quiz.points.to_i / 5 + 1)
-      logger.info "Time limit #{limit} based on #{quiz.points} grouped points"
+      minutes_per_point = (@canvas_options['minutes_per_point'] || 1).to_i
+      slop = (@canvas_options['extra_minutes'] || 5).to_i
+      limit =  quiz.points.to_i * minutes_per_point + slop
+      # round up to 5 minutes
+      limit += 5 - (limit % 5)
+      logger.info "Time limit #{limit} based on #{quiz.points} points"
       limit
     end
     
@@ -157,14 +185,19 @@ eos
       group_ids.each do |gid|
         canvas("Delete group #{gid}", :delete, path + "/groups/#{gid}")
       end
+      # modify time limit to reflect the questions we're about to replace them with
+      # and update quiz title
+      update_quiz = {'quiz' => {
+          'title' => quiz.title,
+          'time_limit' => time_limit_for_quiz
+        }}.to_json
+      canvas("Update quiz title and time limit", :put, path, data: update_quiz)
     end
 
     def create_quiz!
       quiz_opts = @quiz_options.merge({
           'title' => quiz.title,
           'time_limit' => time_limit_for_quiz,
-          'due_at' => "2020-08-01T23:00Z",
-          'unlock_at' => "2020-05-21T00:00Z"
         })
       quiz_object = {:quiz => quiz_opts}.to_json
       path = "courses/#{@course_id}/quizzes"

data/lib/ruql/canvas/version.rb

@@ -1,5 +1,5 @@
 module Ruql
   class Canvas
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/templates/quiz.yml

@@ -1,10 +1,16 @@
+# See canvas.instructure.com/doc/api/quizzes.html for valid values
 quiz:
   title: "Will be overridden by argument of 'quiz' in RuQL file"
   description: "Short description seen when quiz is started"
   quiz_type: assignment
   show_correct_answers: false
   shuffle_answers: true
-  time_limit: 60
-  due_at: "2020-08-01T23:00Z"
-  unlock_at: "2020-05-21T00:00Z"
+  due_at:    "2030-01-01T00:00Z"
+  unlock_at: "2030-01-01T00:00Z"
+  lock_at:   "2030-01-01T00:00Z"
   published: false
+  # when can student see correct answer and results? (see Canvas docs)
+  hide_results: always
+  one_question_at_a_time: false
+  # to put it into an assignment group:
+  # assignment_group_id: 9999

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruql-canvas
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday