github-to-canvas 0.0.42 → 0.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c38080e6c0827bce0491f53aaada600e08d92ebf0b7a2d61c6d363a460e42ef
-  data.tar.gz: b1099325700aadcc9bb0e12115ac5a3c67992ce62ab62277a0aaebd638736319
+  metadata.gz: d00d3f8b2e4a748b6d8840c365904d980f7bc6f7ad8046cc44b0f28372cad834
+  data.tar.gz: 2cf19fe82846d2cb544ba8cccacd078e08c71c7270f4ecfa1a954d894cdf6750
 SHA512:
-  metadata.gz: ec29a4070f46afe5a7dd580ab24688d9f19dba943d2f93e4850278516eccd583cf41e9793228b77e488aa8ef491d6015634116648339c6f2f0a6fb8f1cb1b8ec
-  data.tar.gz: 325b22cf79ef204466723ab79d638ce3c1790bdaf9a8e3485184200b6947d73b4d543fba55e8580591b794216483428faf997d3033a8b2ce128463bd495cd595
+  metadata.gz: 74598233da7a1ecfc041937a838a06e14511fbc98c65a981c8a408f997289e0c3520fa600e023bba1c3800ee84c742bb79598ca067e8ba2e0957972df390173c
+  data.tar.gz: b81aca6a1ebd575642e438a60af63a24db731728b144de5e6f7e5be2ed8c36f6c5cdc93411aa7e64e6e6e231946d0db359a51497b7417b25c40d9f4c2b36f6fb

data/README.md

@@ -1,4 +1,4 @@
-# GitHub to Canvas Gem Test
+# GitHub to Canvas Gem
 
 ## Introduction
 

data/bin/github-to-canvas

@@ -36,7 +36,7 @@ OptionParser.new do |opts|
     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 --fis-links                                      -> Patches existing lessons in Canvas based on the .canvas file, adds additional Flatiron School specific HTML and meta-data
     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    
 
@@ -104,6 +104,10 @@ OptionParser.new do |opts|
           "Displays a course's lessons and assignments") do |course|
             options[:query] = course
           end
+  opts.on("--remote",
+          "Retrieves a Canvas lesson. Requires --course and --id") do |remote|
+            options[:remote] = true
+          end
   
 end.parse!
 
@@ -115,6 +119,14 @@ if options[:query]
   GithubToCanvas.new(mode: 'query',  course: options[:query], id: options[:id])
 end
 
+if options[:remote]
+  if !options[:course] || !options[:id]
+    puts "Both --course and --id required when using --remote"
+    abort
+  end
+  GithubToCanvas.new(mode: 'remote', course: options[:course], id: options[:id])
+end
+
 if !options[:type]
   if Dir.glob("**/*/").empty?
     options[:type] = "page"
@@ -129,11 +141,20 @@ end
 
 if !options[:name]
   if options[:file_to_convert]
-    options[:name] = options[:file_to_convert]
+    markdown = File.read("#{Dir.pwd}/#{options[:file_to_convert]}")
+    if markdown.match?(/^# .+?\n\n/)
+      options[:name] = markdown.match(/^# .+?\n\n/)[0].strip.gsub("# ","").gsub("#","")
+    elsif markdown.match?(/^# .+?\n/)
+      options[:name] = markdown.match(/^# .+?\n/)[0].strip.gsub("# ","").gsub("#","")
+    else
+      options[:name] = options[:file_to_convert]
+    end
   else
     markdown = File.read("#{Dir.pwd}/README.md")
     if markdown.match?(/^# .+?\n\n/)
-      options[:name] = markdown.match(/^# .+?\n\n/)[0].strip.slice(2,markdown.length)
+      options[:name] = markdown.match(/^# .+?\n\n/)[0].strip.gsub("# ","").gsub("#","")
+    elsif markdown.match?(/^# .+?\n/)
+      options[:name] = markdown.match(/^# .+?\n/)[0].strip.gsub("# ","").gsub("#","")
     else
       options[:name] = File.basename(Dir.getwd)
     end    

data/lib/github-to-canvas.rb

@@ -6,7 +6,6 @@ require_relative './github-to-canvas/canvas_interface'
 require_relative './github-to-canvas/canvas_dotfile'
 require_relative './github-to-canvas/version'
 
-
 class GithubToCanvas
 
   def initialize(mode:, 
@@ -30,6 +29,18 @@ class GithubToCanvas
       CanvasInterface.get_course_info(course, id)
     end
 
+    if mode == 'remote'
+      lesson_data = CanvasInterface.get_lesson_info(course, id)
+      if !lesson_data[1]
+        puts "No lesson with id #{id} was found in course #{course}."
+      else
+        pp lesson_data[0]
+        puts "\nLesson Type: #{lesson_data[1]}"
+      end
+      
+      
+    end
+
     if mode == 'create'
       puts "github-to-canvas will now create a Canvas lesson based on the current repo"
       CreateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer)

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

@@ -1,8 +1,12 @@
 require 'yaml'
 class CanvasDotfile
 
+  def self.exists?
+    File.file?(".canvas")
+  end
+
   def self.update_or_create(filepath, response, course, type)
-    if File.file?(".canvas")
+    if self.exists?
       if type == "assignment" || type == "discussion"
         canvas_data = self.update_assignment_data(response, course, type)
       else
@@ -22,11 +26,6 @@ class CanvasDotfile
     File.write("#{filepath}/.canvas", canvas_data.to_yaml)
   end
 
-  def self.commit_canvas_dotfile(filepath)
-    GithubInterface.git_add(filepath, '.canvas')
-    GithubInterface.git_commit(filepath, 'AUTO: add .canvas file after migration')
-  end
-
   def self.read_canvas_data
     if File.file?(".canvas")
        YAML.load(File.read(".canvas"))

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

@@ -3,41 +3,41 @@ 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}"
+
+    lesson_types = ["quizzes", "assignments", "pages", "discussion_topics"]
+    lesson_type_urls = []
+    lesson_types.each do |type|
+      lesson_type_urls << "#{ENV['CANVAS_API_PATH']}/courses/#{course}/#{type}/#{id}"
+    end
+
     type = nil
     info = ""
+    lesson_type_urls.each do |url|
       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={
+        response = RestClient.get(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"
+        if [200, 201].include? response.code
+          info = JSON.parse(response.body)
+          type = lesson_types.find {|type| url.match?("#{type}")}
+          type.delete_suffix!('zes')
+          type.delete_suffix!('s')
+          puts "\nA Canvas #{type} was found in course #{course} with the id #{id}"
+          break
         end
       rescue
       end
+    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]
+      lesson_data = self.get_lesson_info(course, id)
+      pp lesson_data[0]
+      pp "\nLesson Type: #{lesson_data[1]}"
       return
     end
 
@@ -58,7 +58,8 @@ class CanvasInterface
             index = nil
           end 
         end
-
+        puts ""
+        puts ""
         puts "Info for Course #{course} from #{ENV['CANVAS_API_PATH']}"
         puts ""
         puts "## Pages ##"
@@ -114,7 +115,7 @@ class CanvasInterface
       })
     rescue
       puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
-      # abort
+      nil
     end
   end
 

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

@@ -1,7 +1,7 @@
 class CreateCanvasLesson
 
   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(' ')
+    # name = name.split(/[- _]/).map(&:capitalize).join(' ')
     begin
       markdown = File.read("#{filepath}/#{file_to_convert}")
     rescue
@@ -18,15 +18,21 @@ class CreateCanvasLesson
       new_html = RepositoryConverter.add_fis_links(filepath, new_html)
     end
     response = CanvasInterface.submit_to_canvas(course, type, name, new_html)
+    
+    puts 'Creating .canvas file'
+    CanvasDotfile.update_or_create(filepath, response, course, type) 
+
+    puts "Canvas lesson created. Lesson available at #{response['html_url']}."
+
+    # If --save option is used, the .canvas file gets committed and pushed to the remote repo
     if save_to_github
-      puts 'Creating .canvas file'
-      CanvasDotfile.update_or_create(filepath, response, course, type)
+      puts 'Adding .canvas file'
+      GithubInterface.git_add(filepath, '.canvas')
       puts 'Commiting .canvas file'
-      CanvasDotfile.commit_canvas_dotfile(filepath)
+      GithubInterface.git_commit(filepath, 'AUTO: add .canvas file after migration')
       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/repository_converter.rb

@@ -11,7 +11,8 @@ class RepositoryConverter
   end
 
   def self.remove_header(readme)
-    readme.gsub(/^# .+?\n\n/,"")
+    readme.gsub!(/^# .+?\n\n/,"")
+    readme.gsub(/^# .+?\n/,"")
   end
 
   def self.remove_footer(readme)
@@ -40,27 +41,27 @@ class RepositoryConverter
   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')
-        image.gsub!(/\(.+\)/) { |path|
+    readme.gsub!(/\!\[.+\]\(.+\)/) {|image_markdown|
+      if !image_markdown.match?('amazonaws.com') && !image_markdown.match?('https://') && !image_markdown.match?('http://') && !image_markdown.match?('youtube')
+        image_markdown.gsub!(/\(.+\)/) { |path|
           path.delete_prefix!("(")
           path.delete_suffix!(")")
           "(" + raw_remote_url + "/#{branch}/" + path + ")"
         }
       end
-      image
+      image_markdown
     }
   end
 
   def self.adjust_local_html_images(readme, raw_remote_url)
-    readme.gsub!(/src=\"[\s\S]*?" /) { |img|
-      if !img.match('amazonaws.com') && !img.match('https://') && !img.match('youtube')
-        img.gsub!(/\"/, "")
-        img.gsub!(/src=/, '')
-        img.strip!
-        'src="' + raw_remote_url + '/master/' + img + '"'
+    readme.gsub!(/src=(\'|\")[\s\S]*?(\'|\")/) { |image_source|
+      if !image_source.match?('amazonaws.com') && !image_source.match?('https://') && !image_source.match?('http://') && !image_source.match?('youtube')
+        image_source.gsub!(/(\'|\")/, "")
+        image_source.gsub!(/src=/, '')
+        image_source.strip!
+        'src="' + raw_remote_url + '/master/' + image_source + '"'
       else
-        img
+        image_source
       end
     }
   end
@@ -72,15 +73,24 @@ class RepositoryConverter
   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 = "<img id='thumbs-up' data-repository='#{repo.split('/')[-1]}' title='Thumbs up!' alt='thumbs up' />"
-    thumbs_down_link = "<img id='thumbs-down' data-repository='#{repo.split('/')[-1]}' title='Thumbs down!' alt='thumbs down' />"
-    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
+    repo_path = self.get_repo_url(filepath)
+    header = self.create_github_link_header(repo_path)
+    header + readme
+  end
+
+  def self.create_github_link_header(repo_path)
+    repo_name = repo_path.split('/')[-1]
+
+    # add link to fork (forking handled by separate Flatiron server, generation of link handled via custom Canvas JS theme file)
+    github_fork_link = "<a class='fis-git-link' data-repo='#{repo_name}' href='#' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
+
+    # add link to associated repository
+    # github_repo_link = "<a class='fis-git-link' href='#{repo_path}' target='_blank' rel='noopener'><img id='repo-img' title='Open GitHub Repo' alt='GitHub Repo' /></a>"
+    
+    # add link to new issue form
+    github_issue_link = "<a class='fis-git-link' href='#{repo_path}/issues/new' target='_blank' rel='noopener'><img id='issue-img' title='Create New Issue' alt='Create New Issue' /></a>"
+    
+    "<header class='fis-header' style='visibility: hidden;'>#{github_fork_link}#{github_issue_link}</header>"
   end
 
 end

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

@@ -1,7 +1,7 @@
 class UpdateCanvasLesson
 
   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(' ')
+    # name = name.split(/[- _]/).map(&:capitalize).join(' ')
     begin
       markdown = File.read("#{filepath}/#{file_to_convert}")
     rescue
@@ -12,25 +12,46 @@ class UpdateCanvasLesson
   end
 
   def update_canvas_lesson(course, markdown, filepath, branch, name, type, save_to_github, fis_links, remove_header_and_footer, only_update_content, id)
+    # Pulls any updates that exist on GitHub
     GithubInterface.get_updated_repo(filepath, branch)
+    
+    # Converts markdown to HTML
+    # Default is README.md. --file <FILENAME> can be used to override default.
     new_html = RepositoryConverter.convert(filepath, markdown, branch, remove_header_and_footer)
+    
+    # adds Flatiron School specific header and footer
     if fis_links
-      new_html = RepositoryConverter.add_fis_links(filepath, new_html) # adds Flatiron School specific header and footer
+      new_html = RepositoryConverter.add_fis_links(filepath, new_html) 
     end
+
+    # Read the local .canvas file if --id <ID> is not used. Otherwise, use provided ID (--course <COURSE> also required)
     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|
+      canvas_data[:lessons] = canvas_data[:lessons].map { |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
+      # If an ID (and course) are provided, they are used instead of the .canvas file
+      # Gets the current lesson's type (page or assignment)
       info = CanvasInterface.get_lesson_info(course, id)
-      CanvasInterface.update_existing_lesson(course, id, info[1], name, new_html, only_update_content)
+
+      # Implements update on Canvas
+      response = JSON.parse(CanvasInterface.update_existing_lesson(course, id, info[1], name, new_html, only_update_content))
+      
+      # Updates or creates a local .canvas file
+      CanvasDotfile.update_or_create(filepath, response, course, info[1])
     end
+    # If --save option is used, the .canvas file gets committed and pushed to the remote repo
+    if save_to_github
+      puts 'Adding .canvas file'
+      GithubInterface.git_add(filepath, '.canvas')
+      puts 'Commiting .canvas file'
+      GithubInterface.git_commit(filepath, 'AUTO: add .canvas file after migration')
+      puts 'Pushing .canvas file'
+      GithubInterface.git_push(filepath, branch)
+    end
+    
   end
-
   
 
 end

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.42"
+  VERSION = "0.0.48"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.48
 platform: ruby
 authors:
 - maxwellbenton
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: github-to-canvas is a tool for migrating and aligning GitHub content with