ruql-canvas 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3418ecd8bce903e51bfeab3af00cc5d5ac0cbcc1c1043d35e730cdc9cf2df924
+  data.tar.gz: 2445969de592cba48c164fae63ebcdf3cbfd0670840fe518274f31a3b305e48d
+SHA512:
+  metadata.gz: cf0f232a4ce1981fc8636b3f8840a66efe8a8bf152085f6129780177344f655d44f36159308ca91f9b25406de96e284efb6a034ad5c8f11010e05a1ca49db4ef
+  data.tar.gz: c01c3ff0a897fd33530577231d80eba5a64a7d9aa8b7cdf599a06886cd33b2836bd421b1b71427bc26828ed357bee9efd59be05961dacc8ceea0dcfd4a6a9343

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fox@cs.berkeley.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruql-canvas.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Ruql::Canvas
+
+This formatter requires [ruql](https://github.com/saasbook/ruql) and
+allos uploading RuQL quizzes into the Canvas LMS using its REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruql-canvas'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruql-canvas
+
+## Usage
+
+Prior to processing a quiz file, you'll need to create a simple `.yml`
+file containing information about connecting to your Canvas instance's
+API endpoint.  Say `ruql canvas -h` for help on the file contents.
+
+The file also lets you specify all the features of a Canvas quiz, such
+as start time, whether to show one question at a time, etc.  Of course
+you can change these manually after the quiz is uploaded.
+
+If you specify an existing quiz ID, that quiz will be completely
+truncated and its contents replaced with the one you're processing.
+This is useful for modifying a quiz "in place" when external links to
+the quiz ID already exist.
+
+If you turn on verbose mode (`--verbose` or `-V`) when running `ruql`,
+you can see the REST requests being made against Canvas.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruql-canvas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Ruql::Canvas project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruql-canvas/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruql/canvas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruql/canvas.rb

@@ -0,0 +1,2 @@
+require "ruql/canvas/version"
+require "ruql/canvas/canvas"

data/lib/ruql/canvas/canvas.rb

@@ -0,0 +1,224 @@
+module Ruql
+  class Canvas
+    require 'uri'
+    require 'faraday'
+    #require 'byebug'
+    require 'json'
+    require 'yaml'
+    
+    class CanvasApiError < StandardError ; end
+
+    attr_reader :quiz
+    attr_reader :default_quiz_options_file
+    attr_reader :logger
+    attr_reader :dry_run
+    attr_reader :output
+    
+    def initialize(quiz,options={})
+      @quiz = quiz
+      @logger = quiz.logger
+      @gem_root = Gem.loaded_specs['ruql-canvas'].full_gem_path rescue '.'
+      @default_quiz_options_file = File.join(@gem_root, 'templates', 'quiz.yml')
+      # read YAML options
+      yaml_options = options.delete('--canvas-config') || raise(Ruql::OptionsError.new("Canvas config file must be provided"))
+      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'])
+
+      @quiz_options = YAML.load_file(@default_quiz_options_file)['quiz'].merge(yaml['quiz'] || {})
+      logger.info "Using quiz options:\n#{@quiz_options.inspect}"
+
+      verify_valid_quiz!
+      
+      @current_group_id = nil
+      @response = nil
+      @group_count = 0
+      @qcount = 0
+
+      @output = ''
+      
+    end
+
+    def self.allowed_options
+      opts = [
+        ['--canvas-config', GetoptLong::REQUIRED_ARGUMENT],
+        ['--canvas-dry-run', GetoptLong::NO_ARGUMENT],
+      ]
+      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.
+  --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 
+    quiz:
+      # various options that control quiz; defaults are in #{@default_quiz_options_file}
+eos
+      return [help, opts]
+    end
+
+    # We must set up the following before adding questions:
+    #  1) create quiz with given options (unless quiz ID is given)
+    #  2) for each question in quiz, sorted so that same-pool questions are together:
+    #     - if part of a new pool, start new QuizGroup
+    #     - add it to the quiz, specifying its group
+    # docs: canvas.instructure.com/doc/api/{quizzes,quiz_question_groups,quiz_questions}.html
+    
+    def verify_valid_quiz!
+      unless quiz.questions.all? { |q| MultipleChoice === q || SelectMultiple === q }
+        raise Ruql::QuizContentError.new(
+          "Canvas renderer currently only supports Multiple Choice and Select All That Apply questions")
+      end
+    end
+    
+    def render_quiz
+      if @quiz_id
+        truncate_quiz!
+        @output = "Existing quiz #{@quiz_id}"
+      else
+        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)
+      end
+      current_group = nil
+      quiz.grouped_questions.each do |q|
+        if q.question_group != current_group
+          start_new_group(:name => "Group:#{q.question_group}", :question_points => q.points)
+          current_group = q.question_group
+        end
+        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
+      token = canvas['auth_token'] || raise(Ruql::OptionsError.new("auth_token missing from config file"))
+      base = canvas['api_base'] || raise(Ruql::OptionsError.new("api_base missing from config file"))
+      logger.info "Using #{@base}"
+      @canvas = Faraday.new(
+        :url => base,
+        :headers => {
+          'Authorization' => "Bearer #{token}",
+          'Content-Type' => 'application/json'
+        })
+    end
+
+    def canvas(description, method, path, data: nil)
+      logger.info "#{method} #{path} #{data}"
+      return if dry_run && method.to_s != 'get'
+      if data
+        response = @canvas.send(method, path, data)
+      else
+        response = @canvas.send(method, path)
+      end
+      if response.success?
+        return response.body
+      else
+        raise CanvasApiError.new("#{description}: #{response.status} #{response.body}")
+      end
+    end
+    
+    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"
+      limit
+    end
+    
+    def truncate_quiz!
+      # list, then remove, all questions from existing quiz ID
+      path = "courses/#{@course_id}/quizzes/#{@quiz_id}"
+      response = canvas("Truncating quiz #{@quiz_id}", :get, path + "/questions")
+      questions = JSON.parse(response)
+      # delete all questions
+      questions.each do |q|
+        qid = q['id']
+        canvas("Delete question #{qid}", :delete, path + "/questions/#{qid}")
+      end
+      # collect all group numbers, since we have to delete them too
+      group_ids = questions.map { |q| q['quiz_group_id'] }.compact.uniq
+      group_ids.each do |gid|
+        canvas("Delete group #{gid}", :delete, path + "/groups/#{gid}")
+      end
+    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"
+      new_quiz = canvas("Create quiz", :post, path, data: quiz_object)
+      @quiz_id = (dry_run ? 'XXXXX' : JSON.parse(new_quiz)['id'])
+      logger.info "Created new quiz #{@quiz_id} in course #{@course_id}"
+    end
+
+    def start_new_group(options = {})
+      options[:question_points] ||= 1
+      options[:pick_count] ||= 1
+      options[:name] ||= "group:#{@group_count}"
+      group = { quiz_groups: [ options ] }
+      resp = canvas("Creating new group with #{group.inspect}", :post, "courses/#{@course_id}/quizzes/#{@quiz_id}/groups", data: group.to_json)
+      @current_group_id = (dry_run ? 1000+rand(1000) : JSON.parse(resp)['quiz_groups'][0]['id'])
+      @group_count += 1
+    end
+
+    # Return a Ruby hash representation of a MCQ for Canvas API.  May be modified by caller
+    # before converting to JSON.
+    def render_multiple_choice(q)
+      ans = array_of_answers(q)
+      question_text = q.multiple ? '(Select all that apply.) ' + q.question_text : q.question_text
+      question_type = q.multiple ? 'multiple_answers_question' : 'multiple_choice_question'
+      comments_key = q.raw? ? :incorrect_comments_html : :incorrect_comments_text
+
+      ques = {
+        :quiz_group_id => @current_group_id,
+        :question_name => "#{q.points} point#{'s' if q.points > 1}",
+        :question_type => question_type,
+        :points_possible =>  q.points,
+        :question_text => question_text,
+        :position => 10000,
+        :answers => ans
+      }
+      { question: ques }
+    end
+    
+    def array_of_answers(question)
+      question.answers.map do |answer|
+        weight = answer.correct? ? 100 : 0
+        text_key = question.raw? ? :answer_html : :answer_text
+        { text_key => answer.answer_text,
+          :answer_weight => weight
+        }
+      end
+    end
+    
+    def add_question_to_current_group(question)
+      question_json = question.to_json
+      canvas("Adding to group #{@current_group_id}:\n#{question_json}", :post,
+        "courses/#{@course_id}/quizzes/#{@quiz_id}/questions", data: question_json)
+      @qcount += 1
+    end
+
+  end
+end

data/lib/ruql/canvas/version.rb

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

data/result.json

@@ -0,0 +1 @@
+curl -X POST -H Authorization: Bearer 1072~v2YlFRSHpWOC7Sm8ovy6W5GiDTzlSBc6EDH7CtPKiRje0jH2PAKj7L8C2b0SwxQ4 -H Content-Type: application/json -d @quiz.json https://bcourses.berkeley.edu/api/v1/courses/1487863/quizzes

data/ruql-canvas.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruql/canvas/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruql-canvas"
+  spec.version       = Ruql::Canvas::VERSION
+  spec.authors       = ["Armando Fox"]
+  spec.email         = ["fox@berkeley.edu"]
+
+  spec.summary       = %q{Upload RuQL quizzes into Instructure Canvas using its REST API.}
+  spec.homepage      = %q{https://github.com/saasbook/ruql-canvas}
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/saasbook/ruql-canvas"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/templates/quiz.yml

@@ -0,0 +1,10 @@
+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"
+  published: false

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ruql-canvas
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Armando Fox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- fox@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruql/canvas.rb
+- lib/ruql/canvas/canvas.rb
+- lib/ruql/canvas/version.rb
+- result.json
+- ruql-canvas.gemspec
+- templates/quiz.yml
+homepage: https://github.com/saasbook/ruql-canvas
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saasbook/ruql-canvas
+  source_code_uri: https://github.com/saasbook/ruql-canvas
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Upload RuQL quizzes into Instructure Canvas using its REST API.
+test_files: []