github-to-canvas 0.1.5 → 0.1.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18946099c8b4fd23e1c2230f71fac458f932079fd22ada5297732358fec4d0e
-  data.tar.gz: '092e1b7854f2b4c4026f0713599d423d8eac6431ae16e4f9372c1a00ebb9775c'
+  metadata.gz: 53c9c96308fae1d78f27bc68e80fee55baf2ff23d381866edfd1d114b30601ec
+  data.tar.gz: bf7570a5be4657e102659454295beb72023864ceb20562b51858fa094997b5f7
 SHA512:
-  metadata.gz: d11be9f366fc3a457a671669a57802d6a1a8cc8ff3b0a7e9fa3ee10b4b8b91334cbaa336d39c1e3057c41e787619716d76df3e8523d918393cbb1b6fa9737549
-  data.tar.gz: 85d91f81000c82d55cb45e02f31c9aa3b2e241c785cb58366f5fbef99b72c7ce76e7e9d70f101cedb7f54c5082b2061926e0453cd8a162227cdba78f96c54e71
+  metadata.gz: adbf272b0121b81582d6520bc0c3881980276ede161cb97515d1792563cb29a603c93e7bf35790db1eacc89fb471b68127dccaf24fa43f3205cd758fa53739c2
+  data.tar.gz: 45182fbe2c428468ed967650a5e42ad496af4fa8dca236b61ec52ef9aa0ace3c209ece9a52eadd46849252a7dd6f9fa7c047a5017057bb96ca5143ee3155784a

data/bin/github-to-canvas

@@ -108,6 +108,10 @@ 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
@@ -188,6 +192,15 @@ OptionParser.new do |opts|
           "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!
 
@@ -202,6 +215,16 @@ if 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],
@@ -267,13 +290,29 @@ 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],
                     aaq: !!options[:aaq],
-                    forkable: !!options[:forkable])
+                    forkable: !!options[:forkable],
+                    contains_html: options[:contains_html],
+                    git_links: !!options[:git_links])
   abort
 end
 
@@ -286,7 +325,8 @@ if options[:add_to_course]
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
                       aaq: !!options[:aaq],
-                      contains_html: options[:contains_html])
+                      contains_html: options[:contains_html],
+                      git_links: !!options[:git_links])
   else
     puts '--course required'
   end
@@ -300,7 +340,8 @@ if options[:update_course_lessons]
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
-                    contains_html: options[:contains_html])
+                    contains_html: options[:contains_html],
+                    git_links: !!options[:git_links])
   abort
 end
 
@@ -360,6 +401,7 @@ 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],
@@ -377,7 +419,8 @@ 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],

data/lib/github-to-canvas.rb

@@ -1,4 +1,5 @@
 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'
@@ -26,6 +27,8 @@ class GithubToCanvas
       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'
       html = RepositoryConverter.remote_file_conversion(options)
       puts RepositoryConverter.adjust_converted_html(options, html)
@@ -43,16 +46,25 @@ class GithubToCanvas
       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 = options[:name] ? 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)
+      byebug
+      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 +164,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

@@ -51,21 +51,21 @@ class CanvasInterface
     # 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'
@@ -74,6 +74,8 @@ class CanvasInterface
     begin
       response = RestClient.post(url, payload, self.headers)
     rescue
+      byebug
+
       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
@@ -340,8 +342,37 @@ class CanvasInterface
     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

@@ -66,8 +66,7 @@ class GithubInterface
         puts 'Error reading ' + url
       end
     end
-    
-    
+    response.body
   end
 
   def self.save_to_github(filepath, branch)

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

@@ -27,9 +27,15 @@ class RepositoryConverter
     markdown = GithubInterface.read_remote(options[:filepath])
     raw_remote_url = self.set_raw_image_remote_url(options[:filepath])
     if options[:contains_html]
-      puts "Contains HTML"
-      puts options[:contains_html]
-      markdown = self.escape_existing_html(markdown)
+      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)
@@ -37,9 +43,10 @@ class RepositoryConverter
   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)
@@ -48,7 +55,7 @@ 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
 
@@ -60,8 +67,31 @@ class RepositoryConverter
   end
 
   def self.fix_escaped_inline_html_code(html)
-    html = html.gsub("<code>&amp;lt;", "<code>&lt;")
+    
+    # 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
 
 
@@ -84,6 +114,9 @@ class RepositoryConverter
 
   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)
@@ -155,7 +188,12 @@ class RepositoryConverter
         image_source = image_source.gsub(/(\'|\")/, "")
         image_source = image_source.gsub(/src=/, '')
         image_source = image_source.strip
-        'src="' + raw_remote_url + '/' + branch + '/' + image_source + '"'
+
+        begin
+          'src="' + raw_remote_url + '/' + branch + '/' + image_source + '"'
+        rescue
+          byebug
+        end
       else
         image_source
       end
@@ -185,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])
+    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])
     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>"
     
@@ -198,9 +236,12 @@ 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

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7.pre
 platform: ruby
 authors:
 - maxwellbenton
@@ -104,11 +104,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 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