github-to-canvas 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5628681c8cda313989c521770b0b7f2a20e9b7a0aa0f661446d25d1040eca8d
-  data.tar.gz: da78038dd5492dbb897c9fb6d65e05c76f02e7e57df952630c859d9b446d6c79
+  metadata.gz: 18f61edcbd53e1e26f59fe6767ae09b3bb227dee2f6529797a1f0fc6ace94b00
+  data.tar.gz: 0757bd6b39a7fd9e4bb996156db33309cd96afbe2f8274c1261e95b4aad210e4
 SHA512:
-  metadata.gz: abc12344a24c0c7d67980dc4911462e7c7eb3aba0c31e18b42e5f95fda97fef7b60a994c4ce59fc6da3d6fb7db044fc47ae443979e06455a82906e4ae863f4cd
-  data.tar.gz: 467e1d799b929fccf52cb155d27411050232c30b704fde8d216516c1bc7891d69c6617252cfdd8782ceb35a10fd05b2d5efdf5dd6754bfb097f22ee740876f36
+  metadata.gz: 593e15eb02ee30c7d45b3ffb479efcd69ab3b80436a23b81f6f731e3ad7a2a3a81d05601baf15cd893a86a54029a919ac45617a20cdb4a2c5ad4e441b8529c4e
+  data.tar.gz: 8306e5d652b5e61c3aba33e09a70e0f8aa3a1455dea60269c685983793c443f7065944cf157aa365c693cec9ae12d49a579aec66efc73e390e2643c3fa07b198

data/README.md

@@ -294,29 +294,45 @@ includes HTML that is not meant to be rendered, the content will be rendered as
 part of the page's HTML, resulting in unusual display errors in Canvas. Examples of
 this would be lessons on HTML or JavaScript that include HTML code snippets.
 
-To fix any rendering issues in Canvas, go to the Canvas WYSIWYG editor for the
-afflicted lesson. Click the HTML editor option (`</>` button in the lower right) to
-switch to HTML.
-
-Read the GitHub repo as HTML:
-
-```sh
-github-to-canvas --read-from-github URL
-```
-
-Copy the output HTML and paste it in to the Canvas editor. This should clear up
-some larger page rendering issues, but may not fix all code snippets issues. To
-fix these, switch back to the regular Canvas WYSIWYG editor, then open a second
-tab to the GitHub repo you're converting from. Copy any HTML code snippets from
-GitHub and paste them into the Canvas editor where they should be displayed.
+To prevent HTML from being rendered, include the `--contains-html` option when
+running the GitHub to Canvas gem. This replaces `<` and `>` characters with HTML
+charset values wrapped in `span` elements. This will stop Canvas from rendering
+the HTML.
+
+If your markdown contains a mix of HTML that should and should not be rendered,
+you will need to either replace HTML that you want to be rendered with markdown
+syntax equivalents. For example, HTML you want to display as code and an `<img>`
+element you want to render as the image itself, replace the `<img>` tag with
+markdown syntax (`![alt text](url)`).
+
+The one exception is the `<iframe>` element. There is no way to easily embed
+videos in GitHub markdown without HTML, so this tag will always be allowed to
+render in Canvas, whether or not you use `--contains-html`.
+
+If you have HTML related rendering issues in Canvas that can't be fixed with
+`--contains-html`:
+
+- Go to the Canvas WYSIWYG editor for the afflicted lesson.
+- Click the HTML editor option (`</>` button in the lower right) to switch to
+  HTML.
+- Read the GitHub repo as HTML:
+
+  ```sh
+  github-to-canvas --read-from-github URL
+  ```
+
+- Copy the output HTML and paste it in to the Canvas editor. This should clear up
+some larger page rendering issues, but may not fix all code snippets issues. 
+- Switch back to the regular Canvas WYSIWYG editor
+- Open a second tab to the GitHub repo you're converting from.
+- Copy any HTML code snippets from GitHub and paste them into the Canvas editor
+  where they should be displayed.
 
 The Canvas editor will treat the pasted HTML content as code and will
 automatically replace some characters, escaping the code from the
 normal rendering process.
 
-Note that realigning after fixing this content with the gem will break the
-rendering for these lessons again. A fix is planned for this issue, but has not
-been implemented.
+Note that realigning after fixing this content may overwrite fixes.
 
 ### Multi-Line Code Snippets Render as a Single Line
 

data/bin/github-to-canvas

@@ -1,5 +1,7 @@
-require 'byebug'
 #!/usr/bin/env ruby
+
+require 'byebug'
+
 require 'optparse'
 require 'github-to-canvas'
 
@@ -77,7 +79,6 @@ OptionParser.new do |opts|
   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| 
             # byebug
-            puts type.downcase
             options[:type] = type.downcase
             abort if type == 'quiz' || type == 'discussion'
             # if type == 'page' || type == 'assignment' || type == 'discussion' || type == 'quiz' || type == 'Page' || type == 'Assignment' || type == 'Discussion' || type == 'Quiz'
@@ -107,6 +108,18 @@ OptionParser.new do |opts|
           "Adds additional Flatiron School HTML after markdown conversion") do |f|
             options[:fis] = true
           end
+  opts.on("-g", "--git-links",
+          "Adds additional GitHub after markdown conversion") do |f|
+            options[:git_links] = true
+          end
+  opts.on("--aaq", 
+          "Adds AAQ flag to HTML header appended with --fis-links") do |aaq|
+            options[:aaq] = aaq
+          end
+  opts.on("--prework", 
+          "Adds prework flag to HTML header appended with --fis-links") do |prework|
+            options[:prework] = prework
+          end
   opts.on("--forkable",
           "Used with --fis-links, adds fork button to HTML header injected into Canvas lesson") do |remote|
             options[:forkable] = true
@@ -135,10 +148,14 @@ OptionParser.new do |opts|
           "REQUIRES -f or --file Associates canvas lessons with repositories. Use query to create required YAML file") do |file|
             options[:map] = file
           end
-  opts.on("--csv COURSE", 
-          "Returns a course's lesson struction as CSV") do |course|
-            options[:csv] = course
+  opts.on("--urls-only", 
+          "Use with --map. Outputs repo URLs instead of YAML") do |urls|
+            options[:urls_only] = urls
           end
+#  opts.on("--csv COURSE", 
+#          "Returns a course's lesson struction as CSV") do |course|
+#            options[:csv] = course
+#          end
   opts.on("--read-from-canvas CANVAS_URL",
           "Retrieves an existing Canvas lesson using the provided URL") do |url|
             options[:read_from_canvas] = url
@@ -175,6 +192,19 @@ OptionParser.new do |opts|
           "Iterates over provided course YAML file and clones repos locally") do |file|
             options[:clone_from_yaml] = file
           end
+  opts.on("--contains-html", 
+          "Escapes all HTML included in source markdown by replacing '<' and '>' with HTML charset values") do |html|
+            options[:contains_html] = html
+          end
+  opts.on("--canvas-to-canvas COURSE",
+          "Copies an existing Canvas lesson into another Canvas lesson") do |canvas_to_canvas|
+            options[:canvas_to_canvas] = canvas_to_canvas
+          end
+  opts.on("--build-from-csv CSV",
+          "Build a course usin a CSV of lesson repos, names, modules, and types") do |csv_build|
+            options[:csv_build] = csv_build
+          end
+  
   
 end.parse!
 
@@ -184,12 +214,30 @@ if options[:version]
 end
 
 if options[:read_from_canvas]
-  GithubToCanvas.new(mode: 'canvas_read', filepath: options[:read_from_canvas])
+  GithubToCanvas.new(mode: 'canvas_read', 
+                    filepath: options[:read_from_canvas])
+  abort
+end
+
+if options[:canvas_to_canvas]
+  GithubToCanvas.new(mode: 'canvas_copy',
+                    filepath: options[:canvas_to_canvas],
+                    course_id: options[:course_id], 
+                    type: options[:type],
+                    id: options[:id]
+                    )
   abort
 end
 
 if options[:read_from_github]
-  GithubToCanvas.new(mode: 'github_read', filepath: options[:read_from_github])
+  GithubToCanvas.new(mode: 'github_read', 
+                    filepath: options[:read_from_github],
+                    remove_header_and_footer: !!options[:remove_header_and_footer],
+                    forkable: !!options[:forkable],
+                    fis_links: !!options[:fis],
+                    aaq: !!options[:aaq],
+                    prework: !!options[:prework],
+                    contains_html: options[:contains_html])
   abort
 end
 
@@ -199,9 +247,13 @@ if options[:create_from_github]
                       filepath: options[:create_from_github], 
                       course_id: options[:course_id], 
                       type: options[:type],
+                      name: options[:name],
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
-                      fis_links: !!options[:fis])
+                      fis_links: !!options[:fis],
+                      aaq: !!options[:aaq],
+                      prework: !!options[:prework],
+                      contains_html: options[:contains_html])
   else
     puts 'Canvas course ID and lesson type required. Example: github-to-canvas --create-from-github URL --course ID --type TYPE'
   end
@@ -218,7 +270,10 @@ if options[:align_from_github]
                       name: options[:name],
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
-                      fis_links: !!options[:fis])
+                      fis_links: !!options[:fis],
+                      aaq: !!options[:aaq],
+                      prework: !!options[:prework],
+                      contains_html: options[:contains_html])
   else
     puts 'Canvas course ID, lesson ID, and type required. Example: github-to-canvas --create-from-github URL --course COURSE_ID --id LESSON_ID --type TYPE'
   end
@@ -231,7 +286,9 @@ if options[:query]
 end
 
 if options[:map]
-  GithubToCanvas.new(mode: 'map', file_to_convert: options[:map])
+  GithubToCanvas.new(mode: 'map', 
+                      file_to_convert: options[:map],
+                      urls_only: !!options[:urls_only])
   abort
 end
 
@@ -240,12 +297,30 @@ if options[:csv]
   abort
 end
 
+if options[:csv_build]
+  GithubToCanvas.new(mode: 'csv_build', 
+                    file_to_convert: options[:csv_build],
+                    course_id: options[:course_id],
+                    fis_links: !!options[:fis], 
+                    remove_header_and_footer: !!options[:remove_header_and_footer],
+                    aaq: !!options[:aaq],
+                    forkable: !!options[:forkable],
+                    branch: options[:branch],
+                    contains_html: options[:contains_html],
+                    git_links: !!options[:git_links])
+  abort
+end
+
 if options[:build_course]
   GithubToCanvas.new(mode: 'build_course', 
                     file_to_convert: options[:build_course],
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
-                    forkable: !!options[:forkable])
+                    aaq: !!options[:aaq],
+                    prework: !!options[:prework],
+                    forkable: !!options[:forkable],
+                    contains_html: options[:contains_html],
+                    git_links: !!options[:git_links])
   abort
 end
 
@@ -256,7 +331,11 @@ if options[:add_to_course]
                       file_to_convert: options[:add_to_course],
                       fis_links: !!options[:fis], 
                       remove_header_and_footer: !!options[:remove_header_and_footer],
-                      forkable: !!options[:forkable])
+                      forkable: !!options[:forkable],
+                      aaq: !!options[:aaq],
+                      prework: !!options[:prework],
+                      contains_html: options[:contains_html],
+                      git_links: !!options[:git_links])
   else
     puts '--course required'
   end
@@ -268,7 +347,11 @@ if options[:update_course_lessons]
                     file_to_convert: options[:update_course_lessons],
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    prework: !!options[:prework],
+                    contains_html: options[:contains_html],
+                    git_links: !!options[:git_links])
   abort
 end
 
@@ -328,9 +411,13 @@ if options[:create_lesson]
                     type: options[:type], 
                     save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
+                    git_links: !!options[:git_links],
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     only_update_content: !!options[:only_content],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    prework: !!options[:prework],
+                    contains_html: options[:contains_html])
 end
 
 if options[:align]
@@ -343,8 +430,12 @@ if options[:align]
                     name: options[:name],
                     type: options[:type],
                     save_to_github: !!options[:save_to_github], 
-                    fis_links: !!options[:fis], 
+                    fis_links: !!options[:fis],
+                    git_links: !!options[:git_links], 
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     only_update_content: !!options[:only_content],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    aaq: !!options[:aaq],
+                    prework: !!options[:prework],
+                    contains_html: options[:contains_html])
 end

data/lib/github-to-canvas.rb

@@ -1,4 +1,4 @@
-require 'byebug'
+require 'csv'
 require_relative './github-to-canvas/create_canvas_lesson'
 require_relative './github-to-canvas/update_canvas_lesson'
 require_relative './github-to-canvas/canvas_dotfile'
@@ -21,14 +21,16 @@ class GithubToCanvas
     when 'query'
       CanvasInterface.get_course_info(options[:course_id], options[:id])
     when 'map'
-      CanvasInterface.map_course_info(options[:file_to_convert])
+      CanvasInterface.map_course_info(options)
     when 'csv'
       CanvasInterface.csv(options[:file_to_convert])
     when 'canvas_read'
       puts CanvasInterface.read_lesson(options[:filepath])
+    when 'canvas_copy'
+      CanvasInterface.copy_lesson(options)
     when 'github_read'
-      markdown = GithubInterface.read_remote(options[:filepath])
-      puts RepositoryConverter.convert_to_html(markdown)
+      html = RepositoryConverter.remote_file_conversion(options)
+      puts RepositoryConverter.adjust_converted_html(options, html)
     when 'create' # used with a local repo
       html = RepositoryConverter.local_file_conversion(options)
       name = RepositoryInterface.get_name(options[:filepath], html)
@@ -38,21 +40,29 @@ class GithubToCanvas
       puts "Canvas lesson created. Lesson available at #{response['html_url']}"
     when 'align' # used with a local repo
       html = RepositoryConverter.local_file_conversion(options)
-      name = RepositoryInterface.get_name(options[:filepath], html)
+      name = options[:name] ? options[:name] : RepositoryInterface.get_name(options[:filepath], html)
       html = RepositoryConverter.adjust_converted_html(options, html)
       CanvasInterface.update_all_related_lessons(options, name, html)
       
     when 'github_create'
+      if (!options[:branch])
+        options[:branch] = 'master'
+      end
       html = RepositoryConverter.remote_file_conversion(options)
-      name = RepositoryInterface.get_name(options[:filepath], html)
-      html = RepositoryConverter.adjust_converted_html(options, html)
       
+      html = RepositoryConverter.adjust_converted_html(options, html)
+      name = options[:name] ? options[:name] : RepositoryInterface.get_name(options[:filepath], html)
+      puts name
       response = CanvasInterface.create_lesson(options, name, html)
       
       puts "Canvas lesson created. Lesson available at #{response['html_url']}"
     when 'github_align'
+      if (!options[:branch])
+        options[:branch] = 'master'
+      end
       html = RepositoryConverter.remote_file_conversion(options)
       name = options[:name] ? options[:name] : RepositoryInterface.get_name(options[:filepath], html)
+      
       html = RepositoryConverter.adjust_converted_html(options, html)
       response = CanvasInterface.update_existing_lesson(options, name, html)
       puts "Canvas lesson updated. Lesson available at #{response['html_url']}"
@@ -152,6 +162,60 @@ class GithubToCanvas
         end
         }
       }
+    when 'csv_build'
+      if !options[:course_id]
+        course_info = {
+          name: "CSV Build Test",
+          course_code: "CSV-TEST"
+        }
+        created_course_info = CanvasInterface.create_course(course_info)
+        puts "Course created - #{created_course_info["id"]}"
+        puts "Make sure to add yourself as a teacher to this course before continuing, then press Enter/Return"
+        input = gets
+        options[:course_id] = created_course_info["id"]
+      else
+        puts "Adding to course #{options[:course_id]}"
+      end
+      
+      csv_data = CSV.read(options[:file_to_convert])
+      created_module_info = {
+        "id" => "",
+        "name" => ""
+      }
+      
+      csv_data.each { |lesson|
+        # lesson[0] == repo
+        # lesson[1] == name
+        # lesson[2] == module
+        # lesson[3] == type
+        # lesson[4] == yes/no contains HTML
+        module_info = {
+          name: lesson[2]
+        }
+        if created_module_info["name"] != module_info[:name]
+          created_module_info = CanvasInterface.create_module(options[:course_id], module_info)
+          puts "New module created - #{created_module_info["id"]} - #{created_module_info["name"]}"
+        end
+
+        options[:filepath] = lesson[0]
+        options[:name] = lesson[1]
+        options[:type] = lesson[3]
+        options[:branch] = "master" if !options[:branch]
+        if !options[:contains_html]
+          options[:contains_html] = (lesson[4] == "yes" || lesson[4] == "Yes") ? true : false
+        end
+        
+
+        html = RepositoryConverter.remote_file_conversion(options)
+        html = RepositoryConverter.adjust_converted_html(options, html)
+        created_lesson_info = CanvasInterface.create_lesson(options, lesson[1], html)
+        created_lesson_info["page_url"] = created_lesson_info["url"] if !created_lesson_info["page_url"]
+        created_lesson_info["id"] = created_lesson_info["page_url"] if !created_lesson_info["id"]
+        created_lesson_info["type"] = options[:type]
+        puts "Creating lesson - #{options[:name]}"
+        response = CanvasInterface.add_to_module(options[:course_id], created_module_info, created_lesson_info)
+        
+      }
     else
       puts VERSION
     end

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

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'json'
 require 'rest-client'
 require 'yaml'
@@ -47,44 +46,37 @@ class CanvasInterface
     JSON.parse(response.body)
   end
 
-  def self.create_quiz(options, quiz_data)
-    
-  end
-
   def self.add_to_module(course_id, module_info, lesson_info)
     # POST /api/v1/courses/:course_id/modules/:module_id/items
     url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/modules/#{module_info["id"]}/items"
     
-    if lesson_info["type"] == "Page"
+    if lesson_info["type"] == "Page" || lesson_info["type"] == "page"
       payload = {
-      'module_item[title]' => lesson_info["title"],
-      'module_item[type]' => lesson_info["type"],
-      'module_item[indent]' => 0,
-      'module_item[page_url]' => lesson_info["id"],
-      'module_item[completion_requirement][type]' => 'must_view'
-    }
+        'module_item[title]' => lesson_info["title"],
+        'module_item[type]' => lesson_info["type"].capitalize,
+        'module_item[indent]' => 0,
+        'module_item[page_url]' => lesson_info["id"],
+        'module_item[completion_requirement][type]' => 'must_view'
+      }
     elsif lesson_info["type"] == "Quiz"
       puts "Quiz needs to be added manually - #{lesson_info['title']} - lesson_info["
     else
       
       payload = {
         'module_item[title]' => lesson_info["title"],
-        'module_item[type]' => lesson_info["type"],
+        'module_item[type]' => lesson_info["type"].capitalize,
         'module_item[indent]' => 1,
         'module_item[content_id]' =>  lesson_info["id"],
         'module_item[completion_requirement][type]' => 'must_submit'
       }
     end
     begin
-      byebug
       response = RestClient.post(url, payload, self.headers)
     rescue
       puts "Something went wrong while adding lesson #{lesson_info["id"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Assignment"
       puts "Something went wrong while adding lesson #{lesson_info["page_url"]} to module #{module_info["id"]} in course #{course_id}" if lesson_info["type"] == "Page"
       abort
     end
-
-    
     response
     
   end
@@ -200,6 +192,7 @@ class CanvasInterface
         while !!index
           url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/modules?page=#{index}&per_page=20"
           index += 1
+          
           response = RestClient.get(url, self.headers)
           modules = JSON.parse(response.body)
           
@@ -207,7 +200,7 @@ class CanvasInterface
             course_info[:modules] = course_info[:modules] + modules
           else
             index = nil
-          end 
+          end
         end
         
         course_info[:modules] = course_info[:modules].map do |mod|
@@ -220,11 +213,12 @@ class CanvasInterface
           while !!index
             url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/modules/#{mod['id']}/items?page=#{index}&per_page=20"
             index += 1
-            response = RestClient.get(url, headers={
-              "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-            })
+            response = RestClient.get(url, self.headers)
             lessons = JSON.parse(response.body)
             lessons = lessons.map do |lesson|
+              if lesson["type"] == "ExternalUrl"
+                next
+              end
               lesson = lesson.slice("id","title","name","indent","type","html_url","page_url","url","completion_requirement", "published")
               lesson["repository"] = ""
               lesson['id'] = lesson['url'].gsub(/^(.*[\\\/])/,'')
@@ -239,7 +233,7 @@ class CanvasInterface
           end
           new_mod
         end
-
+        
         puts course_info.to_yaml
       
     rescue
@@ -248,8 +242,8 @@ class CanvasInterface
     end
   end
 
-  def self.map_course_info(file_to_convert)
-    course_info = YAML.load(File.read("#{Dir.pwd}/#{file_to_convert}"))
+  def self.map_course_info(options)
+    course_info = YAML.load(File.read("#{Dir.pwd}/#{options[:file_to_convert]}"))
     course_info[:modules] = course_info[:modules].map do |mod|
       mod[:lessons] = mod[:lessons].map do |lesson|
 
@@ -285,6 +279,7 @@ class CanvasInterface
             lesson["repository"] = repo
           else
             lesson["repository"] = "https://github.com/learn-co-curriculum/" + repo
+            puts lesson["repository"] if options[:urls_only]
           end
         end
         sleep(1)
@@ -292,7 +287,7 @@ class CanvasInterface
       end
       mod
     end
-    puts course_info.to_yaml
+    puts course_info.to_yaml if !options[:urls_only]
   end
 
   def self.csv(file_to_convert)
@@ -339,12 +334,40 @@ class CanvasInterface
       end
       mod
     end
-    byebug
     puts course_info.to_yaml
   end
 
-  
+  def self.copy_lesson(options)
+    types = ["page", "assignment", "quiz", "discussion"]
+    url = options[:filepath]
+    type = types.find {|type| url.match(type)}
+    options[:type] = type
+    if !url.include?(ENV['CANVAS_API_PATH'])
+      url = url.sub(/^.*\/\/.*?\//,"#{ENV['CANVAS_API_PATH']}/")
+    end
 
+    response = RestClient.get(url, headers={
+      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+    })
+
+    lesson_info = JSON.parse(response)
+    lesson_info = lesson_info.slice("title",
+                                    "name",
+                                    "description",
+                                    "body",
+                                    "message",
+                                    "shuffle_answers",
+                                    "allowed_attempts",
+                                    "question_count"
+                                    )
+    if options[:type] == "page"
+      self.update_existing_lesson(options, lesson_info["title"], lesson_info["body"])
+    else
+      self.update_existing_lesson(options, lesson_info["name"], lesson_info["description"])
+    end
+    
+    
+  end
 
   def self.build_payload(options, name, html)
     if options[:only_update_content]

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

@@ -61,11 +61,11 @@ class GithubInterface
     rescue
       begin
         response = RestClient.get(url_fallback)
+        return response.body
       rescue
         puts 'Error reading ' + url
       end
     end
-    
     response.body
   end
 

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

@@ -17,7 +17,7 @@ class RepositoryConverter
     GithubInterface.get_updated_repo(options[:filepath], options[:branch])
     markdown = RepositoryInterface.read_local_file(options[:filepath], options[:file_to_convert])
     raw_remote_url = self.set_raw_image_remote_url(options[:filepath])
-    
+    markdown = self.escape_existing_html(markdown) if options[:contains_html]
     markdown = self.fix_local_images(options, markdown, raw_remote_url)
     html = self.convert_to_html(markdown)
     # self.fix_local_html_links(options, html, options[:filepath])
@@ -26,15 +26,27 @@ class RepositoryConverter
   def self.remote_file_conversion(options)
     markdown = GithubInterface.read_remote(options[:filepath])
     raw_remote_url = self.set_raw_image_remote_url(options[:filepath])
+    if options[:contains_html]
+      begin
+        markdown = self.escape_existing_html(markdown)
+      rescue
+        puts "Error reading remote markdown"
+        abort
+      end
+    end
+    if (!options[:branch])
+      options[:branch] = 'master'
+    end
     markdown = self.fix_local_images(options, markdown, raw_remote_url)
     html = self.convert_to_html(markdown)
     # self.fix_local_html_links(options, html, options[:filepath])
   end
 
   def self.convert_to_html(markdown)
-    redcarpet = Redcarpet::Markdown.new(CustomRender, options={tables: true, autolink: true, fenced_code_blocks: true})
+    renderer = CustomRender.new(escape_html: true, prettify: true, hard_wrap: true)
+    redcarpet = Redcarpet::Markdown.new(CustomRender, options={tables: true, autolink: true, fenced_code_blocks: true, disable_indented_code_blocks: true})
     html = redcarpet.render(markdown)
-    self.remove_line_breaks(html)
+    # self.remove_line_breaks(html)
   end
 
   def self.adjust_converted_html(options, html)
@@ -43,12 +55,52 @@ class RepositoryConverter
       html = self.remove_header_and_footer(html)
     end
     
-    if options[:fis_links]
+    if options[:fis_links] || options[:git_links]
       html = self.add_fis_links(options, html)
     end
+
+    if options[:contains_html]
+      html = self.fix_escaped_inline_html_code(html)
+    end
+
+    html
+  end
+
+  def self.fix_escaped_inline_html_code(html)
+    
+    # stops HTML/JSX code blocks from rendering as HTML in Canvas
+    html = html.gsub("&amp;gt;</code>", "&gt;</code>")
+    html = html.gsub("&amp;gt;</code>", "&gt;</code>")
+
+    # fixes < and > code snippets
+    html = html.gsub("&amp;lt;", "&lt;")
+    html = html.gsub("&amp;gt;", "&gt;")
+
+    # # fixes blockquotes
+    # html = html.gsub(/\n<p>&gt\;(.*)\n&gt\;/) { |bq|
+    #   bq.delete_prefix!("\n<p>&gt;")
+    #   "\n<blockquote>" + bq
+    # }
+    # html = html.gsub(/\n&gt\;(.*)\n&gt\;/) { |bq|
+    #   bq.delete_prefix!("\n&gt;")
+    #   " " + bq
+    # }
+    # html = html.gsub(/\n&gt\;(.*)<\/p>/) { |bq|
+    #   bq.delete_prefix!("\n&gt\;")
+    #   bq.delete_suffix!("</p>")
+    #   " " + bq + "</blockquote>"
+    # }
+
     html
   end
 
+
+  def self.escape_existing_html(markdown)
+    markdown = markdown.gsub(/<\/(?!iframe)/, "&lt;/")
+    markdown = markdown.gsub(/<(?!iframe)/, "&lt;")
+    markdown = markdown.gsub(/(?<!iframe)>/, "&gt;")
+  end
+
   def self.remove_header_and_footer(html)
     new_html = self.remove_html_header(html)
     new_html = self.remove_footer(new_html)
@@ -56,12 +108,15 @@ class RepositoryConverter
   end
 
   def self.remove_header(readme)
-    readme.gsub!(/^# .+?\n\n/,"")
+    readme = readme.gsub(/^# .+?\n\n/,"")
     readme.gsub(/^# .+?\n/,"")
   end
 
   def self.remove_footer(readme)
     readme.gsub(/<p class='util--hide'(.+?)<\/p>/,"")
+    readme.gsub(/<p data-visibility='hidden'(.+?)<\/p>/,"")
+    readme.gsub(/<p>&lt\;p data-visibility=&#39\;hidden&#39(.+?)<\/p>/,"")
+    readme.gsub(/<p>&lt\;p class=&#39;util--hide&#39\;(.+?)<\/p>/,"")
   end
 
   def self.remove_html_header(html)
@@ -114,7 +169,7 @@ class RepositoryConverter
   end
 
   def self.adjust_local_markdown_images(readme, raw_remote_url, branch)
-    readme.gsub!(/\!\[.+\]\(.+\)/) {|image_markdown|
+    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!("(")
@@ -127,12 +182,18 @@ class RepositoryConverter
   end
 
   def self.adjust_local_html_images(readme, raw_remote_url, branch)
-    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 + '/' + branch + '/' + image_source + '"'
+    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.match(/src=(\'|\")(?=<%)/)
+        image_source = image_source.gsub(/(\'|\")/, "")
+        image_source = image_source.gsub(/src=/, '')
+        image_source = image_source.strip
+
+        begin
+          'src="' + raw_remote_url + '/' + branch + '/' + image_source + '"'
+        rescue
+          puts "Error adjust HTML images - check images in Canvas"
+        end
       else
         image_source
       end
@@ -162,12 +223,12 @@ class RepositoryConverter
   def self.add_fis_links(options, html)
     repo_info = self.get_repo_info(options[:filepath])
     html = html.sub(/<div id="git-data-element.*<header class="fis-header.*<\/header>/,'') # remove existing fis header
-    header = self.create_github_link_header(repo_info[:repo_path], options[:forkable])
-    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name])
+    header = self.create_github_link_header(repo_info[:repo_path], options)
+    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name], options[:aaq], options[:prework])
     data_element + header + html
   end
 
-  def self.create_github_link_header(repo_path, forkable)
+  def self.create_github_link_header(repo_path, options)
     # 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>"
     
@@ -175,16 +236,19 @@ class RepositoryConverter
     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>"
     
     # add link to fork (forking handled by separate Flatiron server, generation of link handled via custom Canvas JS theme file)
-    if (forkable)
-      github_fork_link = "<a class='fis-fork-link' id='fork-link' href='#' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
+
+    if (options[:forkable])
+      github_fork_link = "<a class='fis-fork-link' id='fork-link' href='#{repo_path}/fork' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
       "<header class='fis-header' style='visibility: hidden;'>#{github_fork_link}#{github_repo_link}#{github_issue_link}</header>"
+    elsif options[:git_links]
+      "<header class='fis-header'>#{github_repo_link}#{github_issue_link}</header>"
     else
       "<header class='fis-header' style='visibility: hidden;'>#{github_repo_link}#{github_issue_link}</header>"
     end
   end
 
-  def self.create_data_element(repo_org, repo_name)
-    "<div id='git-data-element' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
+  def self.create_data_element(repo_org, repo_name, aaq, prework)
+    "<div id='git-data-element' #{prework ? "data-prework='true'" : ""} #{aaq ? "data-aaq='enabled'" : ""} data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
   end
 
   

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.1.2"
+  VERSION = "0.1.8"
 end

metadata

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