github-to-canvas 0.0.28 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d55d83e956d2f1437ef00fced0e5908ed5e5c4db1b09450a5bc993544a040f
-  data.tar.gz: 78a2d3cef6c5814d9bf18b68dd63561e5c79f4d342272229689fc03f411cae44
+  metadata.gz: b2c341073812e571a855d05baf5758d83b0bd7cbb606e451db71d7cfe2150c6c
+  data.tar.gz: 613b6db5c7f1eadbbfb35c958992b2e40cae31d7945d45749622105ab5dbcf0d
 SHA512:
-  metadata.gz: cb37cb15e34de3981106ea56343e310542a3032e9a82eb529e0d3c52d741bf396771cff2e78feeeffce5374a0602141693d673e0187d5d77dbcd0523bc43c55a
-  data.tar.gz: 5615ccc3805322be5170f508cfe4726377a12dd2d0e12690b2f7d622ae5cb43b8977f30e7229fd5523ded91645e96b67f91bc8024bcddf605da582c7e0088dca
+  metadata.gz: f1ad254f9eaba7717b17f2b0d3fe97d5ef02c02e7cde65043da8d094bb82b11b8aefae1d4d01db70573f32b4c0408008976755e2120e7bcf64a8591a6b007aed
+  data.tar.gz: 2d09b99e514ea0896bd819ed1d93835bfa43e45c020d2c1f504ddedcc9daecf2164c81bded178c56b52de3478b26d56555ea94796ec436b1b8cb4becc43ee85f

data/bin/github-to-canvas

@@ -2,7 +2,6 @@
 
 require 'optparse'
 require 'github-to-canvas'
-
 options = {}
 OptionParser.new do |opts|
   opts.banner = <<-EOBANNER
@@ -13,13 +12,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-and-footer]
+    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 +30,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-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 +62,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,11 +78,7 @@ 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
@@ -103,17 +106,23 @@ if !options[:branch]
 end
 
 if !options[:name]
-  options[:name] = File.basename(Dir.getwd)
+  if options[:file_to_convert]
+    options[:name] = options[:file_to_convert]
+  else
+    options[:name] = File.basename(Dir.getwd)
+    options[:file_to_convert] = "README.md"
+  end
 end
 
-if options[:create]
+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_and_footer: !!options[:remove_header_and_footer])
 end
@@ -121,11 +130,12 @@ end
 if options[:align]
   GithubToCanvas.new(mode: "align", 
                     course: nil, 
-                    filepath: Dir.pwd, 
-                    branch: options[:branch], 
-                    name: options[:name], 
-                    type: options[:type], 
-                    dry: !!options[:dry], 
+                    filepath: Dir.pwd,
+                    file_to_convert: options[:file_to_convert], 
+                    branch: options[:branch],
+                    name: options[:name],
+                    type: options[:type],
+                    save_to_github: !!options[:save_to_github], 
                     fis_links: !!options[:fis], 
                     remove_header_and_footer: !!options[:remove_header_and_footer])
 end

data/lib/github-to-canvas.rb

@@ -12,10 +12,11 @@ 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_and_footer:false)
 
@@ -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_and_footer)
+      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_and_footer)
+      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_interface.rb

@@ -2,17 +2,13 @@ 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)
@@ -28,6 +24,7 @@ class CanvasInterface
       })
     rescue
       puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+      abort
     end
   end
 
@@ -44,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_and_footer)
+  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_and_footer)
+    create_canvas_lesson(markdown, course, filepath, file_to_convert, 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_and_footer)
+  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_and_footer)
+    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/update_canvas_lesson.rb

@@ -1,24 +1,25 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
+  def initialize(filepath, file_to_convert, 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_and_footer)
+    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_and_footer)
+  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_and_footer)
+    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], lesson[: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.28"
+  VERSION = "0.0.33"
 end

metadata

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