github-to-canvas 0.0.11 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 732a757e941548fa67c1ede523fe03575dc22e8890d87300ce8e41732a2f01e3
-  data.tar.gz: 9966442368051e67fea9e6b7ce44ebb1555c645bd61f0512feea8e9ca3486995
+  metadata.gz: 3152fc876a1490ceeb473de2839518c2ced04e535ea246de7fd49c0a07003ff6
+  data.tar.gz: d13329c8279a5b6cc971b6d3ef75a34bec6c4a4f329aba35f34a1bb7eb59a337
 SHA512:
-  metadata.gz: 6f67897ee3991f5e914524e04a7b90fb0985092c106ce57b16d64cb8afa74ec1555dbd8dbd57ad0a4be780595b6c8a02af9d914d5e6a63dbc9f5fac662418285
-  data.tar.gz: 8e2793cc5b58f7ad2e0a1e2e9a4244d34172736e0d69f34940f87b0603432287ddb088876392905c36adaef4809298791a1164118e6ab8dec95a06469bb6cc24
+  metadata.gz: 208aa644d3bcdec1c7f393c12cacaee4ad80b16ec818603cca5ff97f75d1414d7743219430e28d00a49b66d27caa9afbed49e00ecca31f1ae1df6442006866bc
+  data.tar.gz: e7539b042e5650952e1880da35a8b16b50da481eb59902e9012c2e3f964e2aacb8c3ec06f180c321bf256a8744e30c367e4f14566f62312cbb4c5006c08e5963

data/README.md

@@ -1,5 +1,5 @@
 # GitHub to Canvas Gem
-hello
+
 ## Introduction
 
 The `github-to-canvas` gem is designed to enable GitHub to Canvas LMS
@@ -8,11 +8,13 @@ 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.
+content between GitHub and Canvas using the GitHub repository as the single
+source of truth.
 
 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.
+course are required. Write access to the GitHub repository being converted is
+also required.
 
 ## Installation
 
@@ -29,7 +31,7 @@ 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
+echo "$(export 'CANVAS_API_KEY=<your-new-API-key-here>' | cat  - ~/.zshrc)" > ~/.zshrc
 ```
 
 > **Note:** The command above assumes you are using Zsh. Change the dotfile if
@@ -42,7 +44,7 @@ Flatiron School's base path is `https://learning.flatironschool.com/api/v1`. Add
 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
+echo "$(export 'CANVAS_API_PATH=<your-base-api-path>' | cat  - ~/.zshrc)" > ~/.zshrc
 ```
 
 After both the API key and path are added to `~/.zshrc`, run `source ~/.zshrc`
@@ -51,11 +53,17 @@ 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.
+### Create a Canvas Lesson
+
+To create a Canvas lesson from a GitHub `README.md` file, 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>`
+Once you have the course id, you will need to do the following:
+
+1. Clone down the repository you'd like to push to Canvas.
+2. Change directory into the new local repository
+3. Run `github-to-canvas --create <your-course-id>` from inside the local repo
 
 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
@@ -63,8 +71,30 @@ 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.
+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. With the
+newly created `.canvas` file, `github-to-canvas` will attempt to commit and push the
+file up to the remote GitHub repository.
+
+If you create multiple Canvas lessons from the same repository, each lesson's
+Canvas data will be stored in the `.canvas` file.
+
+> **Note:** If you don't have write access to the repository, the `.canvas` file
+> will still be created locally.
+
+### Update an existing Canvas Lesson
+
+To update an existing Canvas lesson using a local repository, **a `.canvas` file
+must be present in the repo**, as it contains the lesson information for the
+Canvas API.
+
+1. Clone down and/or change directory into the repository you'd like to update
+2. Run `github-to-canvas --align <your-course-id>` from inside the local repo
+
+`github-to-canvas` will get the course id and page/assignment id from the
+`.canvas` file and update the associated Canvas lesson. If there are multiple
+Canvas lessons included in the `.canvas` file, each lesson will be updated (i.e.
+you have the same lesson in two courses created from one repository).
 
 ### Options
 
@@ -76,5 +106,17 @@ You can override the default behaviors with the following arguments:
   appropriate Canvas lesson type instead of relying on the repository's
   directory structure
 
+## Examples of Valid Images This Gem Can Convert
+
+Inline Markdown:
+
+![example in-line image](https://curriculum-content.s3.amazonaws.com/fewpjs/fewpjs-fetch-lab/Image_25_AsynchronousJavaScript.png)
+
+HTML:
+
+<p align="center">
+  <img src="https://curriculum-content.s3.amazonaws.com/fewpjs/fewpjs-fetch-lab/Image_25_AsynchronousJavaScript.png" width="500">
+</p>
+
 [Canvas LMS API]: https://canvas.instructure.com/doc/api/index.html
 [Flatiron School]: https://flatironschool.com/

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

@@ -1,5 +1,5 @@
 require 'yaml'
-require 'byebug'
+
 class CanvasDotfile
 
   def self.update_or_create(filepath, response, course, type)

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

@@ -1,6 +1,6 @@
 require 'json'
 require 'rest-client'
-require 'byebug'
+
 class CanvasInterface
 
   def self.submit_to_canvas(course_id, type, name, readme, dry_run = false)
@@ -25,8 +25,8 @@ class CanvasInterface
     })
   end
 
-  def self.update_existing_lesson(course_id, page_id, type, name, new_readme, dry_run)
-    url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s/#{page_id}"
+  def self.update_existing_lesson(course_id, id, type, name, new_readme, dry_run)
+    url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s/#{id}"
     payload = self.build_payload(type, name, new_readme)
     RestClient.put(url, payload, headers={
       "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"

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

@@ -13,7 +13,7 @@ class GithubInterface
   end
 
   def self.git_co_branch(filepath, branch)
-    branch = self.cd_into_and(filepath, "git co #{branch}")
+    branch = self.cd_into_and(filepath, "git checkout #{branch}")
     if branch.to_s.strip.empty?
       puts "#{branch} branch not found. Exiting..."
       abort

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

@@ -26,7 +26,7 @@ class RepositoryConverter
         image.gsub!(/\(.+\)/) { |path|
           path.delete_prefix!("(")
           path.delete_suffix!(")")
-          "(" + remote + "/#{branch}/" + path + ")"
+          "(" + raw_remote_url + "/#{branch}/" + path + ")"
         }
       end
       image
@@ -35,12 +35,14 @@ class RepositoryConverter
 
   def self.adjust_local_html_images(readme, raw_remote_url)
     readme.gsub!(/src=\"[\s\S]*?" /) { |img|
-      if !image.match('amazonaws.com') && !image.match('https://') && !image.match('youtube')
+      if !img.match('amazonaws.com') && !img.match('https://') && !img.match('youtube')
         img.gsub!(/\"/, "")
         img.gsub!(/src=/, '')
         img.strip!
+        'src="' + raw_remote_url + '/master/' + img + '"'
+      else
+        img
       end
-      'src="' + raw_remote_url + '/master/' + img + '"'
     }
   end
 

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

@@ -1,3 +1,3 @@
-class LearnTool
-  VERSION = "0.0.9"
+class GithubToCanvas
+  VERSION = "0.0.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.16
 platform: ruby
 authors:
 - maxwellbenton