github-to-canvas 0.0.40 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47468e628c6efba04bc04fc9f356e4b8f6866d1fe8bab6cfb5b4cfd7cf3a136e
-  data.tar.gz: 6ea24930762e969677a535bf4e01e227e590eb9770d67819697fdd782ccfc389
+  metadata.gz: 06a0c55312a2f98cfab18af28e44eff85e7e278178c92c2f87b0ea06e274dc7b
+  data.tar.gz: e6692af5eb0439d14239a3945d522a55986943a95f2987ba14c651e579459c34
 SHA512:
-  metadata.gz: 73f226acaf498238218114b38587581dd7f9a2cd15a2f3f5058cb8ad4e2915319315c8d9f1d038ed48c635447e714df66f1ee0e06cb1a812ec3b7a8267d19931
-  data.tar.gz: 1ae3ebf8b2cb9965bfbbb5a34647529d34fc3dc9e87a1e4ecab142c0e577c78dc4425ac4fa554e3a9cad55520c23421164b930316f023dadbc2dce777ad14e47
+  metadata.gz: a1396b11ac39793429af8dc9ae34272d3ebc988475e68294acea92f0df1fd59d190eb5dce02671a1389267c62fed234b207dd67dcf894116b66ea4e914493adf
+  data.tar.gz: d9ce9f1eb8ef7c8ce1f3675b16f5d8b57e1cdecd1e39f0988a2dad6c14439903e1bad9dce3ff39a7f132d0a1afcd265142d8bf5a2f607fa7ac29cd1510c46dcd

data/README.md

@@ -2,19 +2,21 @@
 
 ## 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.
+The `github-to-canvas` gem is designed to aid in integrating GitHub and the
+Canvas LMS. This gem takes a GitHub repository's `README.md` file, converts it
+to HTML, and pushes it to Canvas using the Canvas API. The gem also has the ability
+to updates a 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 using the GitHub repository as the single
 source of truth.
 
-This gem is built for use internally at [Flatiron School][]. Access to the
+This gem is built for use internally at [Flatiron School][], so some features may be
+specific to Flatiron School branding and needs. Access to the
 [Canvas LMS API][] and the ability to add pages and assignments to a Canvas
 course are required. Write access to the GitHub repository being converted is
-also required.
+also required for committing `.canvas` files.
 
 ## Installation
 
@@ -27,15 +29,21 @@ also required.
 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`:
+called `CANVAS_API_KEY`. 
+
+If you are using Zsh, the following command will add your new key to the top of `~/.zshrc`:
+
+```sh
+echo "$(export 'CANVAS_API_KEY=your-new-API-key-here' | cat - ~/.zshrc)" > ~/.zshrc
+```
+
+If you are using Bash, use this command instead:
 
 ```sh
-echo "$(export 'CANVAS_API_KEY=<your-new-API-key-here>' | cat  - ~/.zshrc)" > ~/.zshrc
+echo "$(export 'CANVAS_API_KEY=your-new-API-key-here' | cat - ~/.bash_profile)" > ~/.bash_profile
 ```
 
-> **Note:** The command above assumes you are using Zsh. Change the dotfile if
-> you are using something else like Bash.
+> If you aren't sure which you use, run `echo $SHELL`
 
 ### Add Canvas API Base Path
 
@@ -47,9 +55,15 @@ as an `ENV` variable like the API key. **Do not add a `/` at the end after `/api
 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`
+Or for Bash:
+
+```sh
+echo "$(export 'CANVAS_API_PATH=<your-base-api-path>' | cat  - ~/.bash_profile)" > ~/.bash_profile
+```
+
+After both the API key and path are added to `~/.zshrc`, run `source ~/.zshrc` (`source ~/.bash_profile` for Bash)
 to make them available in your current terminal. You can verify these variables
-are present by running `ENV`.
+are present by running `ENV` and finding them in the output list.
 
 ## Usage
 
@@ -70,26 +84,23 @@ 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. With the
-newly created `.canvas` file, `github-to-canvas` will attempt to commit and push the
-file up to the remote GitHub repository.
+### Saving `.canvas` to GitHub
+
+Using `--save-to-github` will create a `.canvas` YAML file in the local repo and attempt to commit
+and push it to the remote repository. This file contains the course id, the newly
+created page id, and the Canvas URL to the lesson for future reference. 
 
 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
+### 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
+2. Run `github-to-canvas --align` 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
@@ -98,13 +109,20 @@ you have the same lesson in two courses created from one repository).
 
 ### 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
+This gem provides to the following options:
+
+* `-c, --create-lesson COURSE` - Creates a new Canvas lesson, converting the local repository's README.md to HTML. Adds .canvas file to remote repository
+* `-a, --align` - Updates a canvas lesson based on the local repository's README.md
+* `-n, --name NAME` - Sets the name of the new Canvas lesson to be created. If no name is given, repository folder name is used
+* `-t, --type TYPE` - Sets the type of Canvas lesson to be created (page, assignment or discussion). If no type, type decided based on repository structure
+* `-f, --file FILE` - Looks for and uses a markdown file in the currentt folder as source for conversion. Default file is README.md
+* `-b, --branch BRANCH` - Sets the repository branch used for lesson creation
+* `-s, --save-to-github` - Creates a local .canvas file and attempts to commit and push it to the GitHub repository
+* `-l, --fis-links` - Adds additional Flatiron School HTML after markdown conversion           
+* `-r, --remove-header-and-footer` - Removes top lesson header and any Learn.co specific footer links before converting to HTML             
+* `-o, --only-content` - For align functionality only - updates the HTML content of a lesson without changing the name
+* `-h, --help` - Outputs examples commands and all options
+                   
 
 ## Examples of Valid Images This Gem Can Convert
 
@@ -119,4 +137,4 @@ HTML:
 </p>
 
 [Canvas LMS API]: https://canvas.instructure.com/doc/api/index.html
-[Flatiron School]: https://flatironschool.com/
+[Flatiron School]: https://flatironschool.com/

data/bin/github-to-canvas

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require 'optparse'
 require 'github-to-canvas'
 options = {}
@@ -23,6 +22,7 @@ OptionParser.new do |opts|
     github-to-canvas --align [--branch BRANCH]
     github-to-canvas --align [--only-content]
     github-to-canvas --align [--branch BRANCH] [--fis-links]
+    github-to-canvas --info COURSE
     github-to-canvas --version
 
     
@@ -35,9 +35,10 @@ OptionParser.new do |opts|
     github-to-canvas --create-lesson 154 --name "Fetch Lab"                   -> Creates a lesson in course 154 with the provided name, derives the type from the local repo
     github-to-canvas --create-lesson 154 --name "Fetch Lab" --type assignment -> Creates an assignment in course 154 with the provided name
     github-to-canvas --create-lesson 154 --name "Fetch Lab" --branch solution -> Creates a lesson in course 154 with the provided name, uses the repository's solution branch and derives the type from the local repo
-    github-to-canvas --align                                           -> Patches existing lessons in Canvas based on the .canvas file  
-    github-to-canvas --align --fis-links                               -> Patches existing lessons in Canvas based on the .canvas file, adds addition Flatiron School specific HTML
-    github-to-canvas --align --remove-header-and-footer                           -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to HTML
+    github-to-canvas --align                                                  -> Patches existing lessons in Canvas based on the .canvas file  
+    github-to-canvas --align --fis-links                                      -> Patches existing lessons in Canvas based on the .canvas file, adds addition Flatiron School specific HTML
+    github-to-canvas --align --remove-header-and-footer                       -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to HTML
+    github-to-canvas --info COURSE                                            -> Displays a course's lesson and assignment names    
 
   EOBANNER
 
@@ -87,10 +88,22 @@ OptionParser.new do |opts|
           "Removes top lesson header and any Learn.co specific footer links before converting to HTML") do |r|
             options[:remove_header_and_footer] = true
           end
+  opts.on("--course COURSE",
+          "For align functionality only - updates the HTML content of a lesson using the provided course ID. Use with --id.") do |course|
+            options[:course] = course
+          end
+  opts.on("--id ID",
+          "For align functionality only - updates the HTML content of a lesson using the provided assignment or page ID. Use with --course.") do |id|
+            options[:id] = id
+          end
   opts.on("-o", "--only-content",
           "For align functionality only - updates the HTML content of a lesson without changing the name") do |o|
             options[:only_content] = true
           end
+  opts.on("-q COURSE", "--query COURSE", 
+          "Displays a course's lessons and assignments") do |course|
+            options[:query] = course
+          end
   
 end.parse!
 
@@ -98,6 +111,10 @@ if options[:version]
   GithubToCanvas.new(mode: 'version',  course: nil)
 end
 
+if options[:query]
+  GithubToCanvas.new(mode: 'query',  course: options[:query], id: options[:id])
+end
+
 if !options[:type]
   if Dir.glob("**/*/").empty?
     options[:type] = "page"
@@ -139,7 +156,8 @@ end
 
 if options[:align]
   GithubToCanvas.new(mode: "align", 
-                    course: nil, 
+                    course: options[:course], 
+                    id: options[:id],
                     filepath: Dir.pwd,
                     file_to_convert: options[:file_to_convert], 
                     branch: options[:branch],

data/lib/github-to-canvas.rb

@@ -10,7 +10,8 @@ require_relative './github-to-canvas/version'
 class GithubToCanvas
 
   def initialize(mode:, 
-                course:, 
+                course:nil, 
+                id:nil,
                 filepath:Dir.pwd, 
                 file_to_convert:'README.md',
                 branch:'master',
@@ -23,7 +24,10 @@ class GithubToCanvas
 
     if mode == 'version'
       puts VERSION
-      return
+    end
+
+    if mode == 'query'
+      CanvasInterface.get_course_info(course, id)
     end
 
     if mode == 'create'
@@ -33,7 +37,7 @@ class GithubToCanvas
 
     if mode == 'align'
       puts "github-to-canvas will now align any existing Canvas lessons based on the current repo. NOTE: .canvas file must be present"
-      UpdateCanvasLesson.new(filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content)
+      UpdateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
     end
   end
 

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

@@ -2,6 +2,79 @@ require 'json'
 require 'rest-client'
 class CanvasInterface
 
+  def self.get_lesson_info(course, id)
+    page_url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/pages/#{id}"
+    assignment_url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/assignments/#{id}"
+    type = nil
+    info = ""
+      begin
+        page_response = RestClient.get(page_url, headers={
+          "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+        })
+        if ([200, 201].include? page_response.code)
+          info = JSON.parse(page_response.body)
+          puts "A Canvas page with the ID #{id} was found in course #{course}:"
+          type = "page"
+        end
+      rescue
+      end
+
+      begin
+        assignment_response = RestClient.get(assignment_url, headers={
+          "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+        })
+        if ([200, 201].include? assignment_response.code)
+          info = JSON.parse(assignment_response.body)
+          puts "A Canvas assignment with the ID #{id} was found in course #{course}:"
+          type = "assignment"
+        end
+      rescue
+      end
+    [info, type]
+  end
+
+  def self.get_course_info(course, id)
+    if id
+      info = self.get_lesson_info(course, id)
+      pp info[1]
+      pp info[0]
+      return
+    end
+
+    begin
+        results = []
+        index = 1
+
+        while !!index
+          url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/pages?order=asc&sort=title&page=#{index}&per_page=10"
+          index += 1
+          response = RestClient.get(url, headers={
+            "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+          })
+          pages = JSON.parse(response.body)
+          if ([200, 201].include? response.code) && (!pages.empty?)
+            results = results + pages
+          else
+            index = nil
+          end 
+        end
+
+        puts "Info for Course #{course} from #{ENV['CANVAS_API_PATH']}"
+        puts ""
+        puts "## Pages ##"
+        puts "Title : Page ID"
+        puts ""
+
+        results.each {|result|
+          puts "#{result['title']} : #{result['page_id']}"
+        }
+      
+    rescue
+      puts "Something went wrong while getting info about course #{course}"
+      abort
+    end
+  end
+
   def self.submit_to_canvas(course_id, type, name, readme)
     response = self.push_to_canvas(course_id, type, name, readme)
     if ![200, 201].include? response.code

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

@@ -1,6 +1,6 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content)
+  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
     name = name.split(/[- _]/).map(&:capitalize).join(' ')
     begin
       markdown = File.read("#{filepath}/#{file_to_convert}")
@@ -8,20 +8,27 @@ class UpdateCanvasLesson
       puts "#{file_to_convert} not found in current directory. Exiting..."
       abort
     end
-    update_canvas_lesson(markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content)
+    update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
   end
 
-  def update_canvas_lesson(markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content)
+  def update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
     GithubInterface.get_updated_repo(filepath, branch)
     new_html = RepositoryConverter.convert(filepath, markdown, branch, remove_header_and_footer)
     if fis_links
       new_html = RepositoryConverter.add_fis_links(filepath, new_html) # adds Flatiron School specific header and footer
     end
-    canvas_data = CanvasDotfile.read_canvas_data
-    canvas_data[:lessons].each { |lesson|
-      response = CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], lesson[:type], name, new_html, only_update_content)
-      # puts "Canvas lesson created. Lesson available at #{response['html_url']}."
-    }
+    if !id
+      # If no assignment or page ID is provided, tries to get info from a .canvas file
+      canvas_data = CanvasDotfile.read_canvas_data
+      canvas_data[:lessons].each { |lesson|
+        response = CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], lesson[:type], name, new_html, only_update_content)
+        # puts "Canvas lesson created. Lesson available at #{response['html_url']}."
+      }
+    else
+      # If an ID is provided, uses the ID instead of the .canvas file
+      info = CanvasInterface.get_lesson_info(course, id)
+      CanvasInterface.update_existing_lesson(course, id, info[1], name, new_html, only_update_content)
+    end
   end
 
   

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.40"
+  VERSION = "0.0.41"
 end

metadata

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