github-to-canvas 0.0.24 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d720431e21790c476e0cb901dc357a6c9535df029f9a73739a2d6d7acccb0758
-  data.tar.gz: a4826c7a1a660e85754f26063a24c277f4991261d460617042e8f14b3df83fb1
+  metadata.gz: 277ca5f225d7b666fd529a1914309ce575622645455b0b073bd37a8ab19145cf
+  data.tar.gz: 8849918914e4201e73f6a6143e847ce2f30ea6d7bfcb8a6aa48f3adb8c6b88e3
 SHA512:
-  metadata.gz: b0cf044ec46931fc2ff748b6e05a57513ab669aed896118a6db61d745b2f7546af8366dc3a33ea92e98c4b3278be62e0dea024a211f23aadf7ff95967c44558a
-  data.tar.gz: 3b2115286e05dc581c3b953c778e5ab00a4781ca46560666365481cc92bfaa80789080a9002a622a9faed43cd11626e45bdeaaf47406df21adbd81e5552d8b50
+  metadata.gz: 04adb2efc3fe4b57e358de6974ecbd0097cd67a26c5a72bbbf1de1bd49dbd48dad44af6828a67c9ab8f0ef97bbe73b58d911be49637c3f24992ecd14bbe20ab8
+  data.tar.gz: bdf9b9f2fa0bf3a0bba2b5816d89f3461081f81a5ad92262b0a3a0599f1da21ba1b041f445ca1c13e6766333d2197d90dab17a0481b091345efb68c157c26d3b

data/bin/github-to-canvas

@@ -2,7 +2,7 @@
 
 require 'optparse'
 require 'github-to-canvas'
-
+require 'byebug'
 options = {}
 OptionParser.new do |opts|
   opts.banner = <<-EOBANNER
@@ -13,13 +13,13 @@ OptionParser.new do |opts|
     https://github.com/learn-co-curriculum/github-to-canvas
 
     Commands:
-    github-to-canvas --create COURSE
-    github-to-canvas --create COURSE [--branch BRANCH]
-    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 --create-lesson COURSE
+    github-to-canvas --create-lesson COURSE [--save]
+    github-to-canvas --create-lesson COURSE [--branch BRANCH]
+    github-to-canvas --create-lesson COURSE [--branch BRANCH] [--name NAME]
+    github-to-canvas --create-lesson COURSE [--branch BRANCH] [--name NAME] [--type TYPE]
+    github-to-canvas --create-lesson COURSE [--fis-links]
+    github-to-canvas --create-lesson 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]
@@ -31,19 +31,19 @@ OptionParser.new do |opts|
 
     Example usage:
 
-    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, uses the repository's solution branch and derives the type from the local repo
+    github-to-canvas --create-lesson 154                                      -> Creates a lesson in course 154, derives the name and type from the local repo
+    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                           -> Patches existing lessons in Canvas based on the .canvas file, removes top lesson header before converting to 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", 
+  opts.on("-cCOURSE", "--create-lesson COURSE", 
           "Creates a new canvas lesson, converting the local repository's README.md to HTML. Adds .canvas file to remote repository") do |course| 
-            options[:create] = true
+            options[:create_lesson] = true
             options[:course] = course
           end
   opts.on("-bBRANCH", "--branch BRANCH", 
@@ -63,6 +63,14 @@ OptionParser.new do |opts|
               options[:type] = "page"
             end
           end
+  opts.on("-fFILE", "--file FILE", 
+          "Looks for and uses a markdown file in the currentt folder as source for conversion. Default file is README.md. Skips writing .canvas to repository") do |file| 
+            options[:file_to_convert] = file
+          end
+  opts.on("-s", "--save-to-github",
+          "Creates a local .canvas file and attempts to commit and push it to the GitHub repository") do |s| 
+            options[:save_to_github] = true 
+          end
   opts.on("-a", "--align", 
           "Updates a canvas lesson based on the local repository's README.md") do |a|
             options[:align] = true 
@@ -71,17 +79,13 @@ OptionParser.new do |opts|
           "Displays current gem version") do |v|
             options[:version] = true
           end
-  opts.on("-d", "--dry-run",
-          "Runs through creation without pushing to Canvas or GitHub") do |d|
-            options[:dry] = true
-          end
-  opts.on("-f", "--fis-links",
+  opts.on("-l", "--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
+  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!
@@ -90,6 +94,10 @@ if options[:version]
   GithubToCanvas.new(mode: 'version',  course: nil)
 end
 
+if !options[:file_to_convert]
+  options[:file_to_convert] = "README.md"
+end
+
 if !options[:type]
   if Dir.glob("**/*/").empty?
     options[:type] = "page"
@@ -106,26 +114,30 @@ if !options[:name]
   options[:name] = File.basename(Dir.getwd)
 end
 
-if options[:create]
+byebug
+
+if options[:create_lesson]
   GithubToCanvas.new(mode: "create", 
                     course: options[:course], 
                     filepath: Dir.pwd, 
+                    file_to_convert: options[:file_to_convert],
                     branch: options[:branch], 
                     name: options[:name], 
                     type: options[:type], 
-                    dry: !!options[:dry], 
+                    save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
-                    remove_header: !!options[:remove_header])
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 end
 
 if options[:align]
   GithubToCanvas.new(mode: "align", 
                     course: nil, 
-                    filepath: Dir.pwd, 
+                    filepath: Dir.pwd,
+                    file_to_convert: options[:file_to_convert], 
                     branch: options[:branch], 
                     name: options[:name], 
                     type: options[:type], 
-                    dry: !!options[:dry], 
+                    save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
-                    remove_header: !!options[:remove_header])
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 end

data/lib/github-to-canvas.rb

@@ -12,12 +12,13 @@ class GithubToCanvas
   def initialize(mode:, 
                 course:, 
                 filepath:Dir.pwd, 
-                branch:'master', 
+                file_to_convert:'README.md',
+                branch:'master',
                 name:File.basename(Dir.getwd), 
                 type:"page", 
-                dry:false, 
+                save_to_github:false, 
                 fis_links:false,
-                remove_header:false)
+                remove_header_and_footer:false)
 
     if mode == 'version'
       puts VERSION
@@ -26,12 +27,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, fis_links, remove_header)
+      CreateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, 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, fis_links, remove_header)
+      UpdateCanvasLesson.new(filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
     end
   end
 

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

@@ -1,16 +1,15 @@
 require 'yaml'
-
 class CanvasDotfile
 
   def self.update_or_create(filepath, response, course, type)
     if File.file?(".canvas")
-      if type == "assignment"
+      if type == "assignment" || type == "discussion"
         canvas_data = self.update_assignment_data(response, course, type)
       else
         canvas_data = self.update_page_data(response, course, type)
       end
     else
-      if type == "assignment"
+      if type == "assignment" || type == "discussion"
         canvas_data = self.create_assignment_data(response, course, type)
       else
         canvas_data = self.create_page_data(response, course, type)

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

@@ -1,19 +1,14 @@
 require 'json'
 require 'rest-client'
-
 class CanvasInterface
 
-  def self.submit_to_canvas(course_id, type, name, readme, dry_run = false)
-    if dry_run
-      puts 'DRY RUN: Skipping push to Canvas'
-    else
-      response = self.push_to_canvas(course_id, type, name, readme)
-      if ![200, 201].include? response.code
-        puts "Canvas push failed. #{response.code} status code returned "
-        abort
-      end
-      JSON.parse(response.body)
+  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
+      puts "Canvas push failed. #{response.code} status code returned "
+      abort
     end
+    JSON.parse(response.body)
   end
 
   def self.push_to_canvas(course_id, type, name, new_readme)
@@ -29,11 +24,16 @@ class CanvasInterface
       })
     rescue
       puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+      abort
     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}"
+    if type == "discussion"
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}_topics/#{id}"
+    else
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s/#{id}"
+    end
     payload = self.build_payload(type, name, new_readme)
     begin
       RestClient.put(url, payload, headers={
@@ -41,6 +41,7 @@ class CanvasInterface
       })
     rescue
       puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+      # abort
     end
   end
 

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

@@ -1,29 +1,31 @@
 class CreateCanvasLesson
 
-  def initialize(course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def initialize(course, filepath, file_to_convert, branch, name, type, save_to_github, 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...'
+    markdown = File.read("#{filepath}/#{file_to_convert}")
+    if !markdown
+      puts "#{file_to_convert} not found in current directory. Exiting..."
       abort
     end
-    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+    create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
   end
 
-  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def create_canvas_lesson(markdown, course, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    new_html = RepositoryConverter.convert(filepath, markdown, branch, remove_header_and_footer)
     if fis_links
-      new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
+      new_html = RepositoryConverter.add_fis_links(filepath, new_html)
     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'
-    else
+    response = CanvasInterface.submit_to_canvas(course, type, name, new_html)
+    if save_to_github
+      puts 'Creating .canvas file'
       CanvasDotfile.update_or_create(filepath, response, course, type)
+      puts 'Commiting .canvas file'
       CanvasDotfile.commit_canvas_dotfile(filepath)
+      puts 'Pushing .canvas file'
       GithubInterface.git_push(filepath, branch)
     end
+    puts "Canvas lesson created. Lesson available at #{response['html_url']}."
   end
 
 end

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

@@ -1,4 +1,3 @@
-require 'byebug'
 class GithubInterface
 
   def self.cd_into_and(filepath, command)

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

@@ -1,17 +1,21 @@
 require 'redcarpet'
-require 'byebug'
 class RepositoryConverter
 
-  def self.convert(filepath, readme, branch, remove_header)
-    if remove_header
-      self.remove_header(readme)
+  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/,"")
+    readme.gsub(/^# .+?\n\n/,"")
+  end
+
+  def self.remove_footer(readme)
+    readme.gsub(/<p (.+?)<\/p>/,"")
   end
 
   def self.fix_local_images(filepath, readme, branch)
@@ -69,12 +73,14 @@ class RepositoryConverter
 
   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
+    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,24 +1,25 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def initialize(filepath, branch, name, type, save_to_github, 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...'
+    markdown = File.read("#{filepath}/#{file_to_convert}")
+    if !markdown
+      puts "#{file_to_convert} not found in current directory. Exiting..."
       abort
     end
-    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
+    update_canvas_lesson(markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
   end
 
-  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header)
+  def update_canvas_lesson(markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header)
+    new_html = RepositoryConverter.convert(filepath, markdown, branch, remove_header_and_footer)
     if fis_links
-      new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
+      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|
-      CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], type, name, new_readme, dry_run)
+      response = CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], lesson[:type], name, new_html, save_to_github)
+      puts "Canvas lesson created. Lesson available at #{response['html_url']}."
     }
   end
 

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

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

metadata

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