github-to-canvas-quiz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9447384b555ce88188b53b1781b61fde9ea90a561ff9aeb43cc4814348c094a
+  data.tar.gz: 908ee5738930ccc75f45393974d1153084aae97c25030b53bb1fe8889b0a9289
+SHA512:
+  metadata.gz: ff3c1151b55aa5dde13e8ade9e8a9dddefa1401889e01c61a678aa50639c679f99b293b6bfeb07513117a451b52d9863588a1c7a69e4a62e21ef756eb526a114
+  data.tar.gz: 80d5f2a76c7674995a39d56639fb1bbeabf2da890a72052ec415a5f36446c6261ebe694dc57e10dffd45225fa6644f1cb8ec20d246162c2288bb0ab61de5bb95

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,48 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: false
+  # Exclude:
+  #   - "*.gemspec"
+  #   - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Max: 15
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ianholla@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ihollander
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/NOTES.md

@@ -0,0 +1,53 @@
+## Refactor
+
+Features:
+
+- Add a RepositoryInterface class to allow easier testing of repo commit etc
+  functionality and slim down builder/synchronizer classes
+- can read the repo data from the directory (local) or url (GitHub API)
+- rename `build` to `backup` in CLI
+- move a bunch of methods from build/sync to models?? would make more testable.
+  questionable if the models should be responsible for saving to file
+  system/working with git/interacting with API...
+- issue when syncing: points not updated when questions added/removed?
+
+Question:
+
+- what is public API for this library, besides the CLI?
+- What class is responsible for loading a quiz from the API?
+- What class is responsible for saving a quiz to the file system?
+- use Capybara/HTML matchers for testing HTML strings?
+- probably not necessary to save repo name to YAML, and may cause more issues
+  if repo URL changes...
+
+```rb
+quiz = Quiz.from(:canvas, course_id: 1, quiz_id: 2)
+quiz = Quiz.from(:markdown, path: '')
+
+class Quiz
+  def self.from(loader, options)
+    case loader
+    when :api
+      # where does the API call happen?
+      Parser::Canvas::Quiz.new()
+    when :file
+      Parser::Markdown::Quiz.new(options[:path])
+    end
+  end
+end
+```
+
+Syncing notes:
+
+- When a question is **removed** and a blueprint is synced:
+  - students who have already taken the quiz keep their old score unless the
+    quiz is re-graded
+    - 11/12 => 11/11
+  - Canvas sez: "The quiz has changed significantly since this submission was
+    made. This submission may need re-grading."
+- When a question is **added** and a blueprint is synced:
+  - students who have already taken the quiz keep their old score unless the
+    quiz is re-graded
+    - 5/6 => 5/7
+  - Canvas sez: "The quiz has changed significantly since this submission was
+    made. This submission may need re-grading."

data/README.md

@@ -0,0 +1,89 @@
+# GithubToCanvasQuiz
+
+
+A tool for resizing and uploading images to AWS S3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github-to-canvas-quiz'
+```
+
+And then execute:
+
+```console
+$ bundle install
+```
+
+Or install it yourself as:
+
+```console
+$ gem install github-to-canvas-quiz
+```
+
+## Configuration
+
+Interacting with the Canvas API requires that you have the following environment
+variables set:
+
+- `ENV['CANVAS_API_PATH']`
+  - The base URL for your institution's Canvas API (`https://flatironlearn.beta.instructure.com/api/v1`)
+- `ENV['CANVAS_API_KEY']`
+  - Your [Canvas Access Token](https://canvas.instructure.com/doc/api/file.oauth.html#manual-token-generation)
+
+## Usage
+
+This gem provides two key features via the CLI: backing up Canvas quizzes to
+markdown, and updating a Canvas quiz from an existing directory of markdown files.
+
+### Backup
+
+To backup a Canvas quiz to the current directory:
+
+```console
+$ github-to-canvas-quiz backup --course $COURSE_ID --quiz $QUIZ_ID
+```
+
+This will create a set of markdown files representing the quiz data (one for the
+quiz itself, and one for each question).
+
+### Align
+
+To update a Canvas quiz based on the markdown files in the current directory:
+
+```console
+$ github-to-canvas-quiz align
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rspec` 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 the created tag, 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/ihollander/flatiron-s3-uploader. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the
+[code of conduct](https://github.com/ihollander/flatiron-s3-uploader/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FlatironS3Uploader project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/ihollander/flatiron-s3-uploader/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'github_to_canvas_quiz'
+
+def client
+  @client ||= GithubToCanvasQuiz::CanvasAPI::Client.new(api_key: ENV['CANVAS_API_KEY'], host: ENV['CANVAS_API_PATH'])
+end
+
+def slugify(string)
+  string.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+end
+
+def build_all(course_id, repo_prefix)
+  quizzes = client.list_quizzes(course_id)
+  quizzes.each do |quiz|
+    quiz_path = "./tmp/#{repo_prefix}-quiz-#{slugify(quiz['title'])}"
+    GithubToCanvasQuiz::Builder::Quiz.new(client, course_id, quiz['id'], quiz_path).build
+  end
+end
+
+Pry.start

data/bin/github-to-canvas-quiz

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'github_to_canvas_quiz'
+
+if ENV['GEM_ENV'] == 'development'
+  require 'dotenv'
+  Dotenv.overload('.env.development.local')
+end
+
+GithubToCanvasQuiz::CLI.start

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/github-to-canvas-quiz.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'lib/github_to_canvas_quiz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github-to-canvas-quiz'
+  spec.version       = GithubToCanvasQuiz::VERSION
+  spec.authors       = ['ihollander']
+  spec.email         = ['ianholla@gmail.com']
+
+  spec.summary       = 'Synchronize Canvas quiz content with GitHub'
+  spec.homepage      = 'https://github.com/learn-co-curriculum/github-to-canvas-quiz'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(/\A(?:(?:test|spec|features)\/|\.(?:git|travis|circleci)|appveyor)/)
+    end
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'github-to-canvas-quiz'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'front_matter_parser', '~> 1.0'
+  spec.add_dependency 'git', '~> 1.9'
+  spec.add_dependency 'htmlentities', '~> 4.3'
+  spec.add_dependency 'nokogiri', '~> 1.12'
+  spec.add_dependency 'redcarpet', '~> 3.5'
+  spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'reverse_markdown', '~> 2.0'
+  spec.add_dependency 'rouge', '~> 3.26'
+  spec.add_dependency 'thor', '~> 1.1.0'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/github_to_canvas_quiz/builder/quiz.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  # CanvasAPI => Markdown
+  module Builder
+    # Create markdown files from a Canvas Quiz
+    class Quiz
+      attr_reader :client, :course_id, :quiz_id, :path
+
+      def initialize(client, course_id, quiz_id, path = '.')
+        @path = path
+        @client = client
+        @course_id = course_id
+        @quiz_id = quiz_id
+      end
+
+      def build
+        prepare_directory!
+        save_quiz!
+        save_questions!
+        backup_canvas_to_json!
+        commit!
+      end
+
+      private
+
+      def repo
+        @repo ||= RepositoryInterface.new(path)
+      end
+
+      def prepare_directory!
+        Dir.mkdir(path) unless Pathname(path).directory?
+      end
+
+      def save_quiz!
+        File.write(quiz_readme_path, quiz.to_markdown)
+      end
+
+      def save_questions!
+        Dir.mkdir(questions_path) unless Pathname(questions_path).directory?
+        questions.each.with_index do |question, index|
+          File.write(question_readme_path(index), question.to_markdown)
+        end
+      end
+
+      def backup_canvas_to_json!
+        quiz = client.get_single_quiz(course_id, quiz_id)
+        questions = client.list_questions(course_id, quiz_id)
+
+        json_data = JSON.pretty_generate({ quiz: quiz, questions: questions })
+        File.write(json_path, json_data)
+      end
+
+      def commit!
+        repo = RepositoryInterface.new(path)
+        repo.commit_files('README.md', 'questions', '.canvas-snapshot.json', 'Created Canvas backup')
+      end
+
+      def json_path
+        File.join(path, '.canvas-snapshot.json')
+      end
+
+      def quiz_readme_path
+        File.join(path, 'README.md')
+      end
+
+      def questions_path
+        File.join(path, 'questions')
+      end
+
+      def question_readme_path(index)
+        filename = "#{index.to_s.rjust(2, '0')}.md"
+        File.join(questions_path, filename)
+      end
+
+      # Get quiz data from the Canvas API and return a Model::Quiz
+      # memoized to prevent unnecessary API calls
+      def quiz
+        return @quiz if defined? @quiz
+
+        @quiz = begin
+          quiz = Parser::Canvas::Quiz.new(canvas_quiz_data).parse
+          # use file path as repo if not present
+          quiz.repo = path.split('/').last unless quiz.repo
+          quiz
+        end
+      end
+
+      def canvas_quiz_data
+        quiz_data = client.get_single_quiz(course_id, quiz_id)
+        quiz_data.merge({ 'course_id' => course_id })
+      end
+
+      # Get question data from the Canvas API and return an array of Model::Question
+      # memoized to prevent unnecessary API calls
+      def questions
+        @questions ||= canvas_question_data.map do |question_data|
+          Parser::Canvas::Question.new(question_data).parse
+        end
+      end
+
+      def canvas_question_data
+        questions_data = client.list_questions(course_id, quiz_id)
+        questions_data.map do |question_data|
+          question_data.merge({ 'course_id' => course_id, 'quiz_id' => quiz_id })
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/canvas_api/client.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module CanvasAPI
+    class Client
+      include Endpoints
+
+      attr_reader :host, :api_key
+
+      def initialize(host:, api_key:)
+        @host = host
+        @api_key = api_key
+      end
+
+      private
+
+      def get(endpoint)
+        response = RestClient.get(host + endpoint, {
+          'Authorization' => "Bearer #{api_key}"
+        })
+        JSON.parse(response)
+      rescue RestClient::BadRequest => e
+        report_error(e)
+      end
+
+      def get_all(endpoint)
+        data = []
+        url = host + endpoint
+        while url
+          response = RestClient.get(url, {
+            'Authorization' => "Bearer #{api_key}"
+          })
+          data += JSON.parse(response)
+          url = next_url(response.headers[:link])
+        end
+        data
+      rescue RestClient::BadRequest => e
+        report_error(e)
+      end
+
+      def post(endpoint, payload)
+        response = RestClient.post(host + endpoint, payload, {
+          'Authorization' => "Bearer #{api_key}"
+        })
+        JSON.parse(response)
+      rescue RestClient::BadRequest => e
+        report_error(e)
+      end
+
+      def put(endpoint, payload)
+        response = RestClient.put(host + endpoint, payload, {
+          'Authorization' => "Bearer #{api_key}"
+        })
+        JSON.parse(response)
+      rescue RestClient::BadRequest => e
+        report_error(e)
+      end
+
+      def delete(endpoint)
+        RestClient.delete(host + endpoint, {
+          'Authorization' => "Bearer #{api_key}"
+        })
+      rescue RestClient::BadRequest => e
+        report_error(e)
+      end
+
+      def next_url(link)
+        link.split(/,/).detect { |rel| rel.match(/rel="next"/) }.split(/;/).first.strip[1..-2]
+      rescue NoMethodError
+        nil
+      end
+
+      def report_error(err)
+        puts "Request failed. #{err.response.code} status code returned."
+        puts JSON.parse(err.response.body)
+        abort
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/canvas_api/endpoints/quiz_questions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module CanvasAPI
+    module Endpoints
+      module QuizQuestions
+        def list_questions(course_id, quiz_id)
+          get_all("/courses/#{course_id}/quizzes/#{quiz_id}/questions")
+        end
+
+        def get_single_question(course_id, quiz_id, id)
+          get("/courses/#{course_id}/quizzes/#{quiz_id}/questions/#{id}")
+        end
+
+        def create_question(course_id, quiz_id, payload)
+          post("/courses/#{course_id}/quizzes/#{quiz_id}/questions", payload)
+        end
+
+        def update_question(course_id, quiz_id, id, payload)
+          put("/courses/#{course_id}/quizzes/#{quiz_id}/questions/#{id}", payload)
+        end
+
+        def delete_question(course_id, quiz_id, id)
+          delete("/courses/#{course_id}/quizzes/#{quiz_id}/questions/#{id}")
+        end
+      end
+    end
+  end
+end

data/lib/github_to_canvas_quiz/canvas_api/endpoints/quizzes.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GithubToCanvasQuiz
+  module CanvasAPI
+    module Endpoints
+      module Quizzes
+        def list_quizzes(course_id)
+          get_all("/courses/#{course_id}/quizzes")
+        end
+
+        def get_single_quiz(course_id, id)
+          get("/courses/#{course_id}/quizzes/#{id}")
+        end
+
+        def create_quiz(course_id, payload)
+          post("/courses/#{course_id}/quizzes", payload)
+        end
+
+        def update_quiz(course_id, id, payload)
+          put("/courses/#{course_id}/quizzes/#{id}", payload)
+        end
+      end
+    end
+  end
+end