github-to-canvas 0.1.7.pre → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53c9c96308fae1d78f27bc68e80fee55baf2ff23d381866edfd1d114b30601ec
-  data.tar.gz: bf7570a5be4657e102659454295beb72023864ceb20562b51858fa094997b5f7
+  metadata.gz: 1ec838f45344a5baa221fdd8269eb9c1405916b8c380b9f6f5d7cd7ca01c3740
+  data.tar.gz: d03331e0767f7019ef6cbbb0b0cc7e44209184419ecf09072f96f19bbee3d21d
 SHA512:
-  metadata.gz: adbf272b0121b81582d6520bc0c3881980276ede161cb97515d1792563cb29a603c93e7bf35790db1eacc89fb471b68127dccaf24fa43f3205cd758fa53739c2
-  data.tar.gz: 45182fbe2c428468ed967650a5e42ad496af4fa8dca236b61ec52ef9aa0ace3c209ece9a52eadd46849252a7dd6f9fa7c047a5017057bb96ca5143ee3155784a
+  metadata.gz: 906786dea4252483a97dc04c5ecd4684c0ef2800e9a33e3b10a8ac4982912806e4053f18517c6b7577b2206349435f2f8aea61465da27d4c608d13d087a99579
+  data.tar.gz: c0482ac88b6f62cc022619a4045ed96392c4834ebc6e4e177e95574d4dbfaec55e8b2f40881d7b9d3d5a04a70678d33203b55886254714843f2a83c121cff0b0

data/bin/github-to-canvas

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'byebug'
 
 require 'optparse'
 require 'github-to-canvas'
@@ -78,7 +77,6 @@ OptionParser.new do |opts|
           end
   opts.on("-tTYPE", "--type TYPE", 
           "Sets the type Canvas lesson to be created (page or assignment). If no type, type decided based on repository structure") do |type| 
-            # byebug
             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'
@@ -116,6 +114,10 @@ OptionParser.new do |opts|
           "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
@@ -148,10 +150,10 @@ OptionParser.new do |opts|
           "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("--csv", 
+         "Returns a course's lesson struction as CSV") do |csv|
+           options[:csv] = csv
+         end
   opts.on("--read-from-canvas CANVAS_URL",
           "Retrieves an existing Canvas lesson using the provided URL") do |url|
             options[:read_from_canvas] = url
@@ -197,9 +199,13 @@ OptionParser.new do |opts|
             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|
+          "Build a course using a CSV of lesson repos, names, modules, and types") do |csv_build|
             options[:csv_build] = csv_build
           end
+  opts.on("--update-from-csv CSV",
+          "Update a course using a CSV of lesson repos, names, modules, types, lesson IDs, and course IDs") do |csv_align|
+            options[:csv_align] = csv_align
+          end
   
   
 end.parse!
@@ -232,6 +238,7 @@ if options[:read_from_github]
                     forkable: !!options[:forkable],
                     fis_links: !!options[:fis],
                     aaq: !!options[:aaq],
+                    prework: !!options[:prework],
                     contains_html: options[:contains_html])
   abort
 end
@@ -247,6 +254,7 @@ if options[:create_from_github]
                       forkable: !!options[:forkable],
                       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'
@@ -266,6 +274,7 @@ if options[:align_from_github]
                       forkable: !!options[:forkable],
                       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'
@@ -281,14 +290,15 @@ end
 if options[:map]
   GithubToCanvas.new(mode: 'map', 
                       file_to_convert: options[:map],
-                      urls_only: !!options[:urls_only])
+                      urls_only: !!options[:urls_only],
+                      csv: !!options[:csv])
   abort
 end
 
-if options[:csv]
-  GithubToCanvas.new(mode: 'csv', file_to_convert: options[:csv])
-  abort
-end
+# if options[:csv]
+#   GithubToCanvas.new(mode: 'csv', file_to_convert: options[:csv])
+#   abort
+# end
 
 if options[:csv_build]
   GithubToCanvas.new(mode: 'csv_build', 
@@ -304,12 +314,27 @@ if options[:csv_build]
   abort
 end
 
+if options[:csv_align]
+  GithubToCanvas.new(mode: 'csv_align', 
+                    file_to_convert: options[:csv_align],
+                    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],
+                    prework: !!options[:prework],
                     forkable: !!options[:forkable],
                     contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
@@ -325,6 +350,7 @@ if options[:add_to_course]
                       remove_header_and_footer: !!options[:remove_header_and_footer],
                       forkable: !!options[:forkable],
                       aaq: !!options[:aaq],
+                      prework: !!options[:prework],
                       contains_html: options[:contains_html],
                       git_links: !!options[:git_links])
   else
@@ -340,6 +366,7 @@ if options[:update_course_lessons]
                     remove_header_and_footer: !!options[:remove_header_and_footer],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
+                    prework: !!options[:prework],
                     contains_html: options[:contains_html],
                     git_links: !!options[:git_links])
   abort
@@ -406,6 +433,7 @@ if options[:create_lesson]
                     only_update_content: !!options[:only_content],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
+                    prework: !!options[:prework],
                     contains_html: options[:contains_html])
 end
 
@@ -425,5 +453,6 @@ if options[:align]
                     only_update_content: !!options[:only_content],
                     forkable: !!options[:forkable],
                     aaq: !!options[:aaq],
+                    prework: !!options[:prework],
                     contains_html: options[:contains_html])
 end

data/lib/github-to-canvas.rb

@@ -1,4 +1,3 @@
-require 'byebug'
 require 'csv'
 require_relative './github-to-canvas/create_canvas_lesson'
 require_relative './github-to-canvas/update_canvas_lesson'
@@ -53,7 +52,6 @@ class GithubToCanvas
       
       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)
       
@@ -217,6 +215,47 @@ class GithubToCanvas
         puts "Creating lesson - #{options[:name]}"
         response = CanvasInterface.add_to_module(options[:course_id], created_module_info, created_lesson_info)
         
+      }
+    when 'csv_align'
+      
+      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
+        # lesson[5] == lesson id
+        # lesson[6] == course id
+
+        module_info = {
+          name: lesson[2]
+        }
+
+        options[:filepath] = lesson[0]
+        options[:name] = lesson[1]
+        options[:type] = lesson[3]
+        options[:id] = lesson[5]
+        options[:course_id] = lesson[6]
+        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)
+        updated_lesson_info = CanvasInterface.update_existing_lesson(options, lesson[1], html)
+        updated_lesson_info["page_url"] = updated_lesson_info["url"] if !updated_lesson_info["page_url"]
+        updated_lesson_info["id"] = updated_lesson_info["page_url"] if !updated_lesson_info["id"]
+        updated_lesson_info["type"] = options[:type]
+        puts "Updating lesson - #{options[:name]}"
+        
       }
     else
       puts VERSION

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

@@ -1,7 +1,7 @@
-require 'byebug'
 require 'json'
 require 'rest-client'
 require 'yaml'
+# require 'byebug'
 class CanvasInterface
 
   def self.create_course(course_info)
@@ -74,8 +74,6 @@ 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
@@ -97,14 +95,16 @@ class CanvasInterface
       if options[:type] == 'page' || options[:type] == 'Page'
         response = RestClient.get(url, headers)
         lesson_info = JSON.parse(response)
+        lesson_info = lesson_info[0] if lesson_info.kind_of?(Array)
         url = url.sub(/[^\/]+$/, lesson_info["page_id"].to_s)
       end
+      
       response = RestClient.put(url, payload, headers)
-    rescue
+    rescue Exception => e
       puts "Something went wrong while pushing lesson #{options[:id]} to course #{options[:course_id]}"
       puts "Make sure you are working on lessons that are not locked"
+      raise e
       abort
-      ""
     end
     JSON.parse(response.body)
   end
@@ -114,6 +114,8 @@ class CanvasInterface
     if !options[:id]
       canvas_data = CanvasDotfile.read_canvas_data
       response = nil
+      puts canvas_data
+      puts options
       canvas_data[:lessons] = canvas_data[:lessons].map { |lesson|
         response = self.update_existing_lesson(lesson, name, html)
         options[:id] = lesson[:id]
@@ -240,7 +242,6 @@ class CanvasInterface
         puts course_info.to_yaml
       
     rescue
-      byebug
       puts "Something went wrong while getting info about course #{course}"
       abort
     end
@@ -283,8 +284,9 @@ class CanvasInterface
             lesson["repository"] = repo
           else
             lesson["repository"] = "https://github.com/learn-co-curriculum/" + repo
-            puts lesson["repository"] if options[:urls_only]
           end
+          puts lesson["repository"] if options[:urls_only]
+          puts "#{lesson["repository"]}, #{lesson["title"]}, #{mod[:name]}, #{lesson["type"].downcase}, , #{lesson["id"]}, #{course_info[:id]}" if options[:csv]
         end
         sleep(1)
         lesson
@@ -338,7 +340,6 @@ class CanvasInterface
       end
       mod
     end
-    byebug
     puts course_info.to_yaml
   end
 

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

@@ -1,5 +1,5 @@
 require 'redcarpet'
-
+# require 'byebug'
 class CustomRender < Redcarpet::Render::HTML
   def block_code(code, lang)
     "<pre>" \
@@ -14,7 +14,7 @@ end
 
 class RepositoryConverter
   def self.local_file_conversion(options)
-    GithubInterface.get_updated_repo(options[:filepath], options[:branch])
+    # 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]
@@ -46,7 +46,8 @@ class RepositoryConverter
     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)
+    puts "Markdown converted to HTML"
+    self.remove_line_breaks(html)
   end
 
   def self.adjust_converted_html(options, html)
@@ -69,12 +70,15 @@ class RepositoryConverter
   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>")
+    # 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;")
+
+    # html = html.gsub(/<pre><code>(.*?)<\/code><\/pre>/) { |string|
+    #   byebug
+    # }
+    # html = html.gsub("&amp;gt;", "&gt;")
 
     # # fixes blockquotes
     # html = html.gsub(/\n<p>&gt\;(.*)\n&gt\;/) { |bq|
@@ -96,9 +100,13 @@ class RepositoryConverter
 
 
   def self.escape_existing_html(markdown)
-    markdown = markdown.gsub(/<\/(?!iframe)/, "&lt;/")
-    markdown = markdown.gsub(/<(?!iframe)/, "&lt;")
-    markdown = markdown.gsub(/(?<!iframe)>/, "&gt;")
+    # markdown = markdown.gsub(/<\/(?!iframe)/, "&lt;/")
+    # markdown = markdown.gsub(/<(?!iframe)/, "&lt;")
+    # markdown = markdown.gsub(/(?<!iframe)>/, "&gt;")
+    # byebug
+    # markdown = markdown.gsub(/```(.*?)```/) {|s|
+    #   byebug
+    # }
   end
 
   def self.remove_header_and_footer(html)
@@ -192,7 +200,7 @@ class RepositoryConverter
         begin
           'src="' + raw_remote_url + '/' + branch + '/' + image_source + '"'
         rescue
-          byebug
+          puts "Error adjust HTML images - check images in Canvas"
         end
       else
         image_source
@@ -224,7 +232,7 @@ class RepositoryConverter
     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)
-    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name], options[:aaq])
+    data_element = self.create_data_element(repo_info[:repo_org], repo_info[:repo_name], options[:aaq], options[:prework])
     data_element + header + html
   end
 
@@ -247,12 +255,8 @@ class RepositoryConverter
     end
   end
 
-  def self.create_data_element(repo_org, repo_name, aaq)
-    if (aaq)
-      "<div id='git-data-element' data-aaq='enabled' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
-    else
-      "<div id='git-data-element' data-org='#{repo_org}' data-repo='#{repo_name}'></div>"
-    end
+  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.7"
+  VERSION = "0.1.12"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.1.7.pre
+  version: 0.1.12
 platform: ruby
 authors:
 - maxwellbenton
@@ -104,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: