github-to-canvas 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 732a757e941548fa67c1ede523fe03575dc22e8890d87300ce8e41732a2f01e3
-  data.tar.gz: 9966442368051e67fea9e6b7ce44ebb1555c645bd61f0512feea8e9ca3486995
+  metadata.gz: 292c75129f49e571976390d008441b48b83af93ffcecbabc5071799aef6656f8
+  data.tar.gz: 831f32335f994923d179b8e819bbed986ee7a57ababa8789064b904b39407f32
 SHA512:
-  metadata.gz: 6f67897ee3991f5e914524e04a7b90fb0985092c106ce57b16d64cb8afa74ec1555dbd8dbd57ad0a4be780595b6c8a02af9d914d5e6a63dbc9f5fac662418285
-  data.tar.gz: 8e2793cc5b58f7ad2e0a1e2e9a4244d34172736e0d69f34940f87b0603432287ddb088876392905c36adaef4809298791a1164118e6ab8dec95a06469bb6cc24
+  metadata.gz: c0b0a5114f5e92d37ba700713c6d8071034f5915e9000e9e0174fef948f56b32ed42355badddf367fc6863e2f6947efbbaa450a7d0887a5b343c97fb75e76d22
+  data.tar.gz: df8a0118fccacf35ac7c93823899830c4ec7e82f62915f15d29ae4e713161a097997b254510089f1b79aca1c298939f2c01bd42f55cc1aab15d89808f4b8b982

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
 
@@ -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.
+
+Once you have the course id, you will need to do the following:
 
-1. clone down the repository to a local folder and change directory into it.
-2. Run `github-to-canvas --create <your-course-id>`
+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
 

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/version.rb

@@ -1,3 +1,3 @@
 class LearnTool
-  VERSION = "0.0.9"
+  VERSION = "0.0.12"
 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.12
 platform: ruby
 authors:
 - maxwellbenton