github-to-canvas 0.0.20 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a4f7a0afcf69fa3c6a3b2c06eb36d73e3bfaef2691653202478bab81c2db709
-  data.tar.gz: 975fb0c2f4cd1a19628da5f641f9b057852b3f2f5efa7ffdcc0868119bef3912
+  metadata.gz: a4ebf48161f0c0ac7ad012460961650eba100d006aa84a945a863278238a27a5
+  data.tar.gz: 1316e7036aa3032cbe4fa0d883b32f9c2bb142f585915d3045acbcb884e326b5
 SHA512:
-  metadata.gz: d4fa7f6eee1eb0e7e30d21a47602df34e323daab0237fd85fcd1b7cdb613ab1ca7b2b68a7939ece0c91b9c840bd3ed7554f404839b45c95a843bb5f0e5df9fd8
-  data.tar.gz: f2c98036eedb4d14ebade41064091c8c85f093bd6434e8769d6a952536916de03d96cf7ab08d21ff5be8336fe183915bc6570f7a5305ff95d8341a2682e0dc88
+  metadata.gz: a7005054aae77a3c0212c6be57e9ecd1a6c6066d3882a25ef2fef6bafd96abf71b2ad2283bde23a80830379adfffb5dd56913d56709d8ed4ecd9b4c7aa5a745f
+  data.tar.gz: d3516690ddcbec8c8df013530c399a38f8d8ddb4f69513385dc1339eb1a04dac141446931000a6aa37daea1b74905fafa8793657107aea9075d41c1d6bf1d988

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-and-footer]
     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-and-footer                           -> 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-and-footer",
+          "Removes top lesson header and any Learn.co specific footer links before converting to HTML") do |r|
+            options[:remove_header_and_footer] = 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_and_footer: !!options[:remove_header_and_footer])
 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_and_footer: !!options[:remove_header_and_footer])
 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_and_footer: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_and_footer)
     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_and_footer)
     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_and_footer)
     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_and_footer)
   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_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
+    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

@@ -1,11 +1,23 @@
 require 'redcarpet'
 class RepositoryConverter
 
-  def self.convert(filepath, readme, branch)
+  def self.convert(filepath, readme, branch, remove_header_and_footer)
+    if remove_header_and_footer
+      readme = self.remove_header(readme)
+      readme = self.remove_footer(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.remove_footer(readme)
+    readme.gsub(/<p (.+?)<\/p>/,"")
+  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)
@@ -20,6 +32,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')
@@ -52,4 +71,16 @@ class RepositoryConverter
     redcarpet.render(readme)
   end
 
+  def self.add_fis_links(filepath, readme)
+    repo = self.get_repo_url(filepath)
+    github_repo_link = "<a class='fis-git-link' href='#{repo}' target='_blank' rel='noopener'><img id='repo-img' title='Open GitHub Repo' alt='GitHub Repo' /></a>"
+    github_issue_link = "<a class='fis-git-link' href='#{repo}/issues/new' target='_blank' rel='noopener'><img id='issue-img' title='Create New Issue' alt='Create New Issue' /></a>"
+    thumbs_up_link = "<a id='thumbs-up' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs up!' alt='thumbs up' /></a>"
+    thumbs_down_link = "<a id='thumbs-down' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs down!' alt='thumbs down' /></a>"
+    feedback_link = "<h5>Have specific feedback? <a href='#{repo}/issues/new'>Tell us here!</a></h5>"
+    header = "<header class='fis-header' style='visibility: hidden;'>#{github_repo_link}#{github_issue_link}</header>"
+    footer = "<footer class='fis-footer' style='visibility: hidden;'><div class='fis-feedback'><h5>How do you feel about this lesson?</h5>#{thumbs_up_link}#{thumbs_down_link}</div>#{feedback_link}</footer>"
+    header + readme + footer
+  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_and_footer)
     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_and_footer)
   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_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
+    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.20"
+  VERSION = "0.0.25"
 end

metadata

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