github-to-canvas 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 157424448fb4396e7ae200733bf3c27fb45b9d74546f026bf1c9aad55fe958f1
+  data.tar.gz: a675bce4eb13531be6b80867798bf260ecc6edba8ef0e555bbb7b861d24397b3
+SHA512:
+  metadata.gz: df3a924b7ab026c0101af16e538b333f9b0aac17e4f9a5e66301d5ad690bad3ec7c229aa1547254f532b8d69ca5a27468c6935ee4db69e1544b57add7d0d8859
+  data.tar.gz: 51f8d7055e94c7cc0deaf11defa4a5c9a39ab7300dc10e69f337578a6417f4da4a95ebad9223d46cb22539ec6b3d59f091a2467cb2952cd26c4aaedba768cbdc

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Learn.co Curriculum
+
+We're really excited that you're about to contribute to the
+[open curriculum](https://learn.co/content-license) on
+[Learn.co](https://learn.co). If this is your first time contributing, please
+continue reading to learn how to make the most meaningful and useful impact
+possible.
+
+## Raising an Issue to Encourage a Contribution
+
+If you notice a problem with the curriculum that you believe needs improvement
+, but you're unable to make the change yourself, you should raise a Github issue
+containing a clear description of the problem. Include relevant snippets of the
+content and screenshots if applicable. Curriculum owners regularly review
+issue lists, and your issue will be prioritized and addressed as appropriate.
+
+## Submitting a Pull Request to Suggest an Improvement
+
+If you see an opportunity for improvement and can make the change yourself go
+ahead and use a typical git workflow to make it happen:
+
+* Fork this curriculum repository
+* Make the change on your fork, with descriptive commits in the standard format
+* Open a Pull Request against this repo
+
+A curriculum owner will review your change and approve or comment on it in due
+course.
+
+## Why Contribute?
+
+Curriculum on Learn is publicly and freely available under Learn's
+[Educational Content License](https://learn.co/content-license). By embracing an
+open-source contribution model, our goal is for the curriculum on Learn to
+become, in time, the best educational content the world has ever seen.
+
+We need help from the community of Learners to maintain and improve the
+educational content. Everything from fixing typos, to correcting out-dated
+information, to improving exposition, to adding better examples, to fixing
+tests—all contributions to making the curriculum more effective are welcome.

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+ruby "2.6.1"
+
+gem 'require_all'
+gem 'json'
+gem 'redcarpet'
+gem 'rest-client'
+# Specify your gem's dependencies in github-to-canvas.gemspec

data/LICENSE.md

@@ -0,0 +1,24 @@
+# Learn.co Educational Content License
+
+Copyright (c) 2020 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
+School supports the development and availability of educational materials in the
+public domain. Therefore, the Flatiron School grants Users of the Flatiron
+Educational Content set forth in this repository certain rights to reuse, build
+upon and share such Educational Content subject to the terms of the Educational
+Content License set forth
+[here](http://learn.co/content-license)(http://learn.co/content-license). You
+must read carefully the terms and conditions contained in the Educational
+Content License as such terms govern access to and use of the Educational
+Content.
+
+Flatiron School is willing to allow you access to and use of the Educational
+Content only on the condition that you accept all of the terms and conditions
+contained in the Educational Content License set forth
+[here](http://learn.co/content-license) (http://learn.co/content-license).  By
+accessing and/or using the Educational Content, you are agreeing to all of the
+terms and conditions contained in the Educational Content License.  If you do
+not agree to any or all of the terms of the Educational Content License, you are
+prohibited from accessing, reviewing or using in any way the Educational
+Content.

data/README.md

@@ -0,0 +1,80 @@
+# GitHub to Canvas Gem
+
+## Introduction
+
+The `github-to-canvas` gem is designed to enable GitHub to Canvas LMS
+integration. This gem is designed to take a GitHub repository's `README.md`
+file, convert it to HTML, and push it to Canvas. The gem also updates the
+repository to include a `.canvas` file containing Canvas specific information.
+
+With  the `.canvas` file in place, this gem can be used to continuously align
+content between GitHub and Canvas.
+
+This gem is built for use internally at [Flatiron School][]. Access to the
+[Canvas LMS API][] and the ability to add pages and assignments to a Canvas
+course are required.
+
+## Installation
+
+`gem install github-to-canvas`
+
+## Setup
+
+### Generate Canvas API Key
+
+In order to access the Canvas API, you must first generate an API key. Go to
+your Canvas Account Settings and under **Approved Integrations**, create a
+**New Access Token**. You will need to store this API key as an `ENV` variable
+called `CANVAS_API_KEY`. Use the following command to add your new key to
+`~/.zshrc`:
+
+```sh
+echo "$(echo 'CANVAS_API_KEY=<your-new-API-key-here>' | cat  - ~/.zshrc)" > ~/.zshrc
+```
+
+> **Note:** The command above assumes you are using Zsh. Change the dotfile if
+> you are using something else like Bash.
+
+### Add Canvas API Base Path
+
+The exact Canvas API path is specific to where you Canvas LMS is located. For example,
+Flatiron School's base path is `https://learning.flatironschool.com/api/v1`. Add this path
+as an `ENV` variable like the API key. **Do not add a `/` at the end after `/api/v1`.**
+
+```sh
+echo "$(echo 'CANVAS_API_PATH=<your-base-api-path>' | cat  - ~/.zshrc)" > ~/.zshrc
+```
+
+After both the API key and path are added to `~/.zshrc`, run `source ~/.zshrc`
+to make them available in your current terminal. You can verify these variables
+are present by running `ENV`.
+
+## Usage
+
+To migrate a GitHub `README.md` file to Canvas, at minimum, you will need to know the
+Canvas course id you are going to add to. This id can be found in the URL of the course.
+
+1. clone down the repository to a local folder and change directory into it.
+2. Run `github-to-canvas --create <your-course-id>`
+
+If everything is set up properly, `github-to-canvas` will create a Canvas lesson
+using `master` branch `README.md` and the name of the current folder. By
+default, if the repository contains folders, an **assignment** will be created.
+Otherwise, a **page** will be created.
+
+After a successful lesson creation, `github-to-canvas` will use the API response
+to build a `.canvas` YAML file. This file contains the course id, the newly created
+page id, and the Canvas URL to the lesson for future reference.
+
+### Options
+
+You can override the default behaviors with the following arguments:
+
+* `--name NAME` uses the provided name instead of the repository's folder name
+* `--branch BRANCH` uses the provided git branch instead of `master`
+* `--type TYPE` will accept either `'page'` or `'assignment'` and create the
+  appropriate Canvas lesson type instead of relying on the repository's
+  directory structure
+
+[Canvas LMS API]: https://canvas.instructure.com/doc/api/index.html
+[Flatiron School]: https://flatironschool.com/

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

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'github-to-canvas'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<-EOBANNER
+    GitHub To Canvas
+    ====================
+    A tool for migrating and aligning GitHub content with the Canvas LMS. Access
+    to the Canvas API and a GitHub org required. For configuration and setup, visit
+    https://github.com/learn-co-curriculum/github-to-canvas
+
+    Commands:
+    github-to-canvas --create COURSE
+    github-to-canvas --create COURSE [--branch BRANCH]
+    github-to-canvas --create COURSE [--branch BRANCH] [--name NAME]
+    github-to-canvas --create COURSE [--branch BRANCH] [--name NAME] [--type TYPE]
+    github-to-canvas --align
+    github-to-canvas --reverse-align 
+    github-to-canvas --version
+    
+    Run these commands from inside a local GitHub repository. This gem is built for Flatiron School's internal use.
+    Some default behaviors assume this, like the default Canvas API path.
+
+    Example usage:
+
+    github-to-canvas --create 154                                      -> Creates a lesson in course 154, deriving the name and type from the local repo
+    github-to-canvas --create 154 --name "Fetch Lab"                   -> Creates a lesson in course 154 with the provided name, deriving the type from the local repo
+    github-to-canvas --create 154 --name "Fetch Lab" --type assignment -> Creates an assignment in course 154 with the provided name
+    github-to-canvas --create 154 --name "Fetch Lab" --branch solution -> Creates a lesson in course 154 with the provided name, using the repositorie's solution branch and deriving the type from the local repo
+    
+  EOBANNER
+
+  opts.on("-cCOURSE", "--create COURSE", 
+          "Creates a new canvas lesson, converting the local repository's README.md to HTML. Adds .canvas file to remote repository") do |course| 
+            options[:create] = true
+            options[:course] = course
+          end
+  opts.on("-bBRANCH", "--branch BRANCH", 
+          "Sets the repository branch used for lesson creation") do |branch| 
+            options[:branch] = branch
+          end
+  opts.on("-nNAME", "--name NAME", 
+          "Sets the name of the new Canvas lesson to be created. If no name is given, repository folder name is used") do |name| 
+            options[:name] = name
+          end
+  opts.on("-tTYPE", "--type TYPE", 
+          "Sets the type Canvas lesson to be created (page or assignment). If no type, type decided based on repository structure") do |type| 
+            if t == 'page' || t == 'assignment'
+              options[:type] = type
+            else
+              puts "Invalid type. Defaulting to page"
+              options[:type] = "page"
+            end
+          end
+  opts.on("-a", "--align", 
+          "Updates a canvas lesson based on the local repository's README.md") do |a|
+            options[:align] = true 
+          end
+  opts.on("-r", "--reverse-align",
+          "Updates a remote repository, converting the Canvas lesson body to markdown and pushing it remotely as the README.md") do |r| 
+            options[:reverse_align] = true 
+          end
+  opts.on("-v", "--version",
+          "Displays current gem version") do |v|
+            options[:version] = true
+          end
+  
+end.parse!
+
+if options[:version]
+  GithubToCanvas.new(mode: 'version',  course: nil)
+end
+
+if Dir.entries(Dir.pwd).select {|entry| File.directory? entry and !(entry =='.' || entry == '..')}.empty?
+  options[:type] = "page"
+else
+  options[:type] = "assignment"
+end
+
+if !options[:branch]
+  options[:branch] = 'master'
+end
+
+if !options[:name]
+  options[:name] = File.basename(Dir.getwd)
+end
+
+if options[:create]
+  GithubToCanvas.new(mode: "create", course: options[:course], filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type])
+end
+
+if options[:align]
+  puts 'feature not working yet'
+end
+
+if options[:reverse_align]
+  puts 'feature not working yet'
+end

data/lib/github-to-canvas.rb

@@ -0,0 +1,18 @@
+require_relative './github-to-canvas/create-canvas-lesson'
+require_relative './github-to-canvas/version'
+
+class GithubToCanvas
+
+  def initialize(mode:, course:, filepath:Dir.pwd, branch:'master', name:File.basename(Dir.getwd), type:"page")
+    if mode == 'version'
+      puts VERSION
+      return
+    end
+
+    if mode == 'create'
+      puts "github-to-canvas will now create a Canvas lesson based on the current repo"
+      CreateCanvasLesson.new(course, filepath, branch, name, type)
+    end
+  end
+
+end

data/lib/github-to-canvas/create-canvas-lesson.rb

@@ -0,0 +1,156 @@
+require 'redcarpet'
+require 'rest-client'
+require 'json'
+require 'yaml'
+require 'byebug'
+
+class CreateCanvasLesson
+
+  def initialize(course, filepath, branch, name, type)
+    @course = course
+    @filepath = filepath
+    @branch = branch
+    @name = name.split(/[ -]/).map(&:capitalize).join(' ')
+    @type = type
+    @renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options={tables: true, autolink: true, fenced_code_blocks: true})
+    @original_readme = File.read("#{filepath}/README.md")
+    if !@original_readme
+      puts 'README.md not found in current directory. Exiting...'
+      abort
+    end
+    create_canvas_lesson
+  end
+
+  def create_canvas_lesson
+    git_co_branch
+    git_pull
+    @raw_remote_url = set_raw_image_remote_url
+    adjust_local_markdown_images
+    adjust_local_html_images
+    @new_readme = @renderer.render(@original_readme)
+    write_to_html
+    @response = push_to_canvas
+    if @response.code != 200
+      puts "Canvas push failed. #{@response.code} status code returned "
+    end
+    @response = JSON.parse(@response.body)
+    create_canvas_dotfile
+    commit_canvas_dotfile
+    git_push
+  end
+
+  def cd_into_and(command)
+    cmd = "cd #{@filepath} && #{command}"
+    puts cmd
+    `#{cmd}`
+  end
+
+  def git_co_branch
+    cmd = "git co #{@branch}"
+    branch = cd_into_and(cmd)
+    if branch.to_s.strip.empty?
+      puts "#{b@ranch} branch not found. Exiting..."
+      abort
+    end
+  end
+
+  def git_pull
+    if @branch != 'master'
+      cmd = "git pull #{@branch}"
+    else
+      cmd =  "git pull"
+    end
+    puts "git pulling latest version of #{@branch}"
+    cd_into_and(cmd)
+  end
+
+  def git_remote
+    cmd = "git config --get remote.origin.url"
+    cd_into_and(cmd)
+  end
+
+  def git_add(file)
+    cmd = "git add #{file}"
+    puts "git adding #{file}"
+    cd_into_and(cmd)
+  end
+
+  def git_commit(message)
+    cmd = "git commit -m '#{message}'"
+    puts "git commit: '#{message}'"
+    cd_into_and(cmd)
+  end
+
+  def git_push
+    cmd = "git push"
+    puts "git pushing #{@branch}"
+    cd_into_and(cmd)
+  end
+  
+  def set_raw_image_remote_url
+    remote = git_remote
+    remote.gsub!("git@github.com:","https://raw.githubusercontent.com/")
+    remote.gsub!(/.git$/,"")
+    remote.strip!
+  end
+
+  def adjust_local_markdown_images
+    @original_readme.gsub!(/\!\[.+\]\(.+\)/) {|image|
+      if !image.match('amazonaws.com') && !image.match('https://')
+        image.gsub!(/\(.+\)/) { |path|
+          path.delete_prefix!("(")
+          path.delete_suffix!(")")
+          "(" + remote + "/#{@branch}/" + path + ")"
+        }
+      end
+      image
+    }
+  end
+
+  def adjust_local_html_images
+    @original_readme.gsub!(/src=\"[\s\S]*?" /) { |img|
+      img.gsub!(/\"/, "")
+      img.gsub!(/src=/, '')
+      img.strip!
+      'src="' + @raw_remote_url + '/master/' + img + '"'
+    }
+  end
+
+  def write_to_html
+    File.write("#{@filepath}/README.html", @new_readme)
+  end
+
+  def push_to_canvas
+    url = "#{ENV['CANVAS_API_PATH']}/courses/#{@course}/#{@type}s"
+    if @type == "assignment"
+      payload = {
+        'assignment[name]' => @name,
+        'assignment[description]' => @new_readme
+      }
+    else
+      payload = {
+        'wiki_page[title]' => @name,
+        'wiki_page[body]' => @new_readme,
+        'wiki_page[editing_roles]' => "teachers" 
+      }
+    end
+
+    RestClient.post(url, payload, headers={
+      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+    })
+  end
+
+  def create_canvas_dotfile
+    canvas_data = {
+      page_id: @response['page_id'],
+      course_id: @course.to_i,
+      canvas_url: @response['html_url']
+    }
+    File.write("#{@filepath}/.canvas", canvas_data.to_yaml)
+  end
+
+  def commit_canvas_dotfile
+    git_add('.canvas')
+    git_commit('AUTO: add .canvas file after migration')
+  end
+end

data/lib/github-to-canvas/version.rb

@@ -0,0 +1,3 @@
+class LearnTool
+  VERSION = "0.0.8"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: github-to-canvas
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- maxwellbenton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email: maxwell@flatironschool.com
+executables:
+- github-to-canvas
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/github-to-canvas
+- lib/github-to-canvas.rb
+- lib/github-to-canvas/create-canvas-lesson.rb
+- lib/github-to-canvas/version.rb
+homepage: https://github.com/learn-co-curriculum/github-to-canvas
+licenses:
+- MIT
+metadata: {}
+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: github-to-canvas is a tool for migrating and aligning GitHub content with
+  the Canvas LMS
+test_files: []