ruql-canvas 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdc05b1cc995933e8a0b76fa2b29c0f351ce002605e25c21ae1f1f411d1841bd
-  data.tar.gz: bf751328a381352dc45a221f87ffaffe086c65087f2c65b826c68415781648a7
+  metadata.gz: 73803c74a762e5057c6791f20f6bbf163c8d380c00d66ca4fe082fdc8419b817
+  data.tar.gz: 87772de849750aa549b9dad4fbcfd96072f331cd1eca0817c97fe0f7a618ab39
 SHA512:
-  metadata.gz: 1a68292bf05596303e9cd7ab6d377e06ae92999fb119ff095882115b84c53f69de9deeb6db1f7f9f454f97a8f8c22cec1e1ed7e9da93a0506b6bd5ef824b425d
-  data.tar.gz: 16da6cf1a5e248652b26e35fca2ea008c33c2c94b7d48302f5e89386d82eaf7f03f94cd9287bf9bd4320fe7ac0454df67255ed92d40fac07c19a4a7b6af2746c
+  metadata.gz: aa1b86386c24541ef4b3849d3b9685d797ceaac703b8dd045af4f214e0acfd94ca14c7aca2ce9d1791c29ad0a2945a73bf84b29a4dd58b1d5913fcc87dc5070c
+  data.tar.gz: 89bf1704b396f81f3355cfcf545cb989b85760c8b336c03867aa70599675869fe0c81dbc161d883d7c9b5e75ec76cb1752accccc9cc8529a1dce68abed81b232

data/README.md

@@ -23,30 +23,30 @@ Or install it yourself as:
 
 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.
+API endpoint.  Say `ruql canvas -h` for help on the file contents
+or take a look at `config.yml.sample`.
 
 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.
+If you specify an existing quiz ID, the existing quiz will be 
+truncated (all questions deleted)  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.
 
+Quiz time limits are computed by the `ruql` gem itself (`ruql -h` for info)
+but can be overridden in the `.yml` file.
+
 If you turn on verbose mode (`--verbose` or `-V`) when running `ruql`,
 you can see the REST requests being made against Canvas.
 
-## Development
+## Development/Contributing
 
 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/config.yml.sample

@@ -0,0 +1,29 @@
+# Uncomment the dry_run line to try/show what would be done, but not actually make changes:
+#dry_run: true
+canvas:
+  # replace with your institution's Canvas API base:
+  api_base: https://bcourses.yourschool.edu/api/v1
+  # replace with an auth_token you generate while logged into Canvas:
+  auth_token: "LONG_AUTH_TOKEN"
+  # replace with canvas Course ID of your course
+  course_id: 1487863
+  # replace with existing Quiz ID, or if omitted, will create new quiz
+  quiz_id:  2311075
+
+# Properties of the quiz - can be changed using canvas GUI after import:
+
+quiz:
+  # Description shown to students when quiz started
+  description: "You must now complete the entire quiz within the given time limit. Your work is automatically saved periodically, but once you press Submit Quiz, your answers cannot be changed.  So only click Submit once, when you are sure your answers are final. As a reminder, NO COLLABORATION is allowed on quizzes: closed book, closed Internet, closed friends. Good skill!"
+  # Most quizzes show up as "assignments" in canvas; see canvas API docs
+  quiz_type: assignment
+  # Should student see correct answer after submitting their own?
+  show_correct_answers: false
+  # Randomize order of answers?
+  shuffle_answers: true
+  # Quiz due date
+  due_at: "2020-08-01T23:00Z"
+  # When students can first access quiz
+  unlock_at: "2020-05-21T00:00Z"
+  # Initially published or not?
+  published: false

data/lib/ruql/canvas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruql-canvas
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Armando Fox
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - fox@berkeley.edu
 executables: []
@@ -82,10 +82,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config.yml.sample
 - 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
@@ -94,7 +94,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Upload RuQL quizzes into Instructure Canvas using its REST API.
 test_files: []

data/result.json

@@ -1 +0,0 @@
-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