github-to-canvas 0.0.19 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfda203dbd3a7e66e56136021641ab5145f47fa4e8995c35ef26e412e5ebde4e
-  data.tar.gz: 23601eb1f2c9b50b5286d60295c2c33537b56ff37d7e19118899b2f8ec299d01
+  metadata.gz: d720431e21790c476e0cb901dc357a6c9535df029f9a73739a2d6d7acccb0758
+  data.tar.gz: a4826c7a1a660e85754f26063a24c277f4991261d460617042e8f14b3df83fb1
 SHA512:
-  metadata.gz: 30bfb4f75c02de44d9363e0b2ca548c43b62ccb066e418ac1c29b2ae90066a14fb966bbde4aa37e4a70b48d271b53ff143f9fa81448c1b35369469f70ae1cab7
-  data.tar.gz: dd8177964070c9d305692c83f89827e016140c30f100f01f0f01df008cc8eec67b963babe6767b95233a46e1acc7f9c52804bfde8434bea62dabe1dce56b2696
+  metadata.gz: b0cf044ec46931fc2ff748b6e05a57513ab669aed896118a6db61d745b2f7546af8366dc3a33ea92e98c4b3278be62e0dea024a211f23aadf7ff95967c44558a
+  data.tar.gz: 3b2115286e05dc581c3b953c778e5ab00a4781ca46560666365481cc92bfaa80789080a9002a622a9faed43cd11626e45bdeaaf47406df21adbd81e5552d8b50

data/bin/github-to-canvas

@@ -18,19 +18,27 @@ OptionParser.new do |opts|
     github-to-canvas --create COURSE [--branch BRANCH] [--name NAME]
     github-to-canvas --create COURSE [--branch BRANCH] [--name NAME] [--type TYPE]
     github-to-canvas --create COURSE [--dry-run]
+    github-to-canvas --create COURSE [--fis-links]
+    github-to-canvas --create COURSE [--fis-links] [--remove-header]
     github-to-canvas --align
+    github-to-canvas --align [--branch BRANCH]
+    github-to-canvas --align [--branch BRANCH] [--fis-links]
     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                                      -> Creates a lesson in course 154, derives 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, derives 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
-    
+    github-to-canvas --create 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                           -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to HTML
+
   EOBANNER
 
   opts.on("-cCOURSE", "--create COURSE", 
@@ -48,7 +56,7 @@ OptionParser.new do |opts|
           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 type == 'page' || type == 'assignment'
+            if type == 'page' || type == 'assignment' || type == 'discussion'
               options[:type] = type
             else
               puts "Invalid type. Defaulting to page"
@@ -64,9 +72,17 @@ OptionParser.new do |opts|
             options[:version] = true
           end
   opts.on("-d", "--dry-run",
-          "Runs through creation without pushing to Canvas or GitHub") do |v|
+          "Runs through creation without pushing to Canvas or GitHub") do |d|
             options[:dry] = true
           end
+  opts.on("-f", "--fis-links",
+          "Adds additional Flatiron School HTML after markdown conversion") do |f|
+            options[:fis] = true
+          end
+  opts.on("-r", "--remove-header",
+          "Removes top lesson header before converting to HTML") do |r|
+            options[:remove_header] = true
+          end
   
 end.parse!
 
@@ -74,10 +90,12 @@ if options[:version]
   GithubToCanvas.new(mode: 'version',  course: nil)
 end
 
-if Dir.glob("**/*/").empty? && !options[:type]
-  options[:type] = "page"
-else
-  options[:type] = "assignment"
+if !options[:type]
+  if Dir.glob("**/*/").empty?
+    options[:type] = "page"
+  else
+    options[:type] = "assignment"
+  end
 end
 
 if !options[:branch]
@@ -89,9 +107,25 @@ if !options[:name]
 end
 
 if options[:create]
-  GithubToCanvas.new(mode: "create", course: options[:course], filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type], dry: !!options[:dry])
+  GithubToCanvas.new(mode: "create", 
+                    course: options[:course], 
+                    filepath: Dir.pwd, 
+                    branch: options[:branch], 
+                    name: options[:name], 
+                    type: options[:type], 
+                    dry: !!options[:dry], 
+                    fis_links: !!options[:fis], 
+                    remove_header: !!options[:remove_header])
 end
 
 if options[:align]
-  GithubToCanvas.new(mode: "align", course: nil, filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type], dry: !!options[:dry])
+  GithubToCanvas.new(mode: "align", 
+                    course: nil, 
+                    filepath: Dir.pwd, 
+                    branch: options[:branch], 
+                    name: options[:name], 
+                    type: options[:type], 
+                    dry: !!options[:dry], 
+                    fis_links: !!options[:fis], 
+                    remove_header: !!options[:remove_header])
 end

data/lib/github-to-canvas.rb

@@ -9,7 +9,16 @@ require_relative './github-to-canvas/version'
 
 class GithubToCanvas
 
-  def initialize(mode:, course:, filepath:Dir.pwd, branch:'master', name:File.basename(Dir.getwd), type:"page", dry:false)
+  def initialize(mode:, 
+                course:, 
+                filepath:Dir.pwd, 
+                branch:'master', 
+                name:File.basename(Dir.getwd), 
+                type:"page", 
+                dry:false, 
+                fis_links:false,
+                remove_header:false)
+
     if mode == 'version'
       puts VERSION
       return
@@ -17,12 +26,12 @@ class GithubToCanvas
 
     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, dry)
+      CreateCanvasLesson.new(course, filepath, branch, name, type, dry, fis_links, remove_header)
     end
 
     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, branch, name, type, dry)
+      UpdateCanvasLesson.new(filepath, branch, name, type, dry, fis_links, remove_header)
     end
   end
 

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

@@ -17,20 +17,31 @@ class CanvasInterface
   end
 
   def self.push_to_canvas(course_id, type, name, new_readme)
-    url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s"
+    if type == 'discussion'
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}_topics"
+    else
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s"
+    end
     payload = self.build_payload(type, name, new_readme)
-
-    RestClient.post(url, payload, headers={
-      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-    })
+    begin
+      RestClient.post(url, payload, headers={
+        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+      })
+    rescue
+      puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+    end
   end
 
   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']}"
-    })
+    begin
+      RestClient.put(url, payload, headers={
+        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+      })
+    rescue
+      puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+    end
   end
 
   def self.build_payload(type, name, new_readme)
@@ -39,6 +50,11 @@ class CanvasInterface
         'assignment[name]' => name,
         'assignment[description]' => new_readme
       }
+    elsif type == "discussion"
+      payload = {
+        'title' => name,
+        'message' => new_readme
+      }
     else
       payload = {
         'wiki_page[title]' => name,

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

@@ -1,18 +1,21 @@
 class CreateCanvasLesson
 
-  def initialize(course, filepath, branch, name, type, dry_run)
+  def initialize(course, filepath, branch, name, type, dry_run, fis_links, remove_header)
     name = name.split(/[- _]/).map(&:capitalize).join(' ')
     original_readme = File.read("#{filepath}/README.md")
     if !original_readme
       puts 'README.md not found in current directory. Exiting...'
       abort
     end
-    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run)
+    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
   end
 
-  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run)
+  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    if fis_links
+      new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
+    end
     response = CanvasInterface.submit_to_canvas(course, type, name, new_readme, dry_run)
     if dry_run
       puts 'DRY RUN: Skipping dotfile creation and push to GitHub'

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

@@ -1,20 +1,26 @@
-
+require 'byebug'
 class GithubInterface
 
+  def self.cd_into_and(filepath, command)
+    cmd = "cd #{filepath} && #{command}"
+    puts cmd
+    `#{cmd}`
+  end
+
   def self.get_updated_repo(filepath, branch)
    self.git_co_branch(filepath, branch)
    self.git_pull(filepath, branch)
   end
 
-  def self.cd_into_and(filepath, command)
-    cmd = "cd #{filepath} && #{command}"
-    puts cmd
-    `#{cmd}`
+  def self.get_current_branch(filepath)
+    self.cd_into_and(filepath, "git rev-parse --abbrev-ref HEAD")
   end
 
   def self.git_co_branch(filepath, branch)
-    branch = self.cd_into_and(filepath, "git checkout #{branch}")
-    if branch.to_s.strip.empty?
+    self.cd_into_and(filepath, "git checkout #{branch}")
+    current_branch = self.get_current_branch(filepath)
+    puts "Current branch #{current_branch.strip}"
+    if !current_branch.match(branch)
       puts "#{branch} branch not found. Exiting..."
       abort
     end

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

@@ -2,11 +2,18 @@ require 'redcarpet'
 require 'byebug'
 class RepositoryConverter
 
-  def self.convert(filepath, readme, branch)
+  def self.convert(filepath, readme, branch, remove_header)
+    if remove_header
+      self.remove_header(readme)
+    end
     self.fix_local_images(filepath, readme, branch)
     self.convert_to_html(filepath, readme)
   end
 
+  def self.remove_header(readme)
+    readme.gsub!(/^#.+?\n\n/,"")
+  end
+
   def self.fix_local_images(filepath, readme, branch)
     raw_remote_url = self.set_raw_image_remote_url(filepath)
     self.adjust_local_markdown_images(readme, raw_remote_url, branch)
@@ -21,6 +28,13 @@ class RepositoryConverter
     remote.strip!
   end
 
+  def self.get_repo_url(filepath)
+    remote = GithubInterface.git_remote(filepath)
+    remote.gsub!("git@github.com:","https://github.com/")
+    remote.gsub!(/.git$/,"")
+    remote.strip!
+  end
+
   def self.adjust_local_markdown_images(readme, raw_remote_url, branch)
     readme.gsub!(/\!\[.+\]\(.+\)/) {|image|
       if !image.match('amazonaws.com') && !image.match('https://') && !image.match('youtube')
@@ -53,4 +67,14 @@ class RepositoryConverter
     redcarpet.render(readme)
   end
 
+  def self.add_fis_links(filepath, readme)
+    repo = self.get_repo_url(filepath)
+    github_repo_link = "<a style='text-decoration: none;' href='#{repo}' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Open GitHub Repo' src='https://curriculum-content.s3.amazonaws.com/git-logo-gray.png' alt='Link to GitHub Repo' /></a>"
+    github_issue_link = "<a style='text-decoration: none;' href='#{repo}/issues/new' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Create New Issue' src='https://curriculum-content.s3.amazonaws.com/flag-icon-gray.png' alt='Link to GitHub Repo Issue Form' /></a>"
+
+    html = "<p style='margin: 0; padding: 0; position: absolute; right: 5px; top: 5px; margin: 0; padding: 0;'>#{github_repo_link}#{github_issue_link}</p>"
+    
+    readme + html
+  end
+
 end

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

@@ -1,18 +1,21 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run)
+  def initialize(filepath, branch, name, type, dry_run, fis_links, remove_header)
     name = name.split(/[- _]/).map(&:capitalize).join(' ')
     readme = File.read("#{filepath}/README.md")
     if !readme
       puts 'README.md not found in current directory. Exiting...'
       abort
     end
-    update_canvas_lesson(readme, filepath, branch, name, type, dry_run)
+    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
   end
 
-  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run)
+  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    if fis_links
+      new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
+    end
     canvas_data = CanvasDotfile.read_canvas_data
     canvas_data[:lessons].each { |lesson|
       CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], type, name, new_readme, dry_run)

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.19"
+  VERSION = "0.0.24"
 end

metadata

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