github-to-canvas 0.0.22 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30ee9448d74c258ca7d0a142e4b2fa4bfa708b227014fd3ef9cd5daf483b0da7
-  data.tar.gz: 84d2710f793fcf93beea70c5693554920b14890c0260e7d20bb28dbf1d3723c3
+  metadata.gz: eb0933e7879b19ca26982288527eb62ce59da160e7483109b9703dbe5103a4cb
+  data.tar.gz: 235afe75dcb268ef87a21e720af630c46fc3dee071e38b827ce7b925e82f022f
 SHA512:
-  metadata.gz: 75c3662d1354d1c5ed0e83ec625eed59010dc254ec9fa5663a060d7f32e58cf937ead936dabf8debd1e3f3f2d07f26747c17945b3a99fc3054244fea9be518b2
-  data.tar.gz: cbc3df60cb990b5c7fffd58b04a0a575c1ec2e4b513f68f7d080b724ee6da94726e14e4d405b77a38389ad1fe470b7c7b2fb03b8f40f00835bdbfebefe52c795
+  metadata.gz: 92ade0732354bbd82bd8b457e1ec17b192626c3fda9b39af1ea96585d75122fbd4907fae9bfdaa56d735f10ba88d4ff0291bdbbe2bcc95f4a00975cb1c017265
+  data.tar.gz: 7676ae7d369a5a98467525b8d8883bb8856771d8ac705dd3ef8a69eab53c931aeb9f342a8203027b55a8b5632a06c91fef9f098ac16e0d2754d5bfea24bead50

data/README.md

@@ -1,5 +1,10 @@
 # GitHub to Canvas Gem
 
+## Objectives
+
+1. test
+2. test 2
+
 ## Introduction
 
 The `github-to-canvas` gem is designed to enable GitHub to Canvas LMS

data/bin/github-to-canvas

@@ -19,6 +19,7 @@ OptionParser.new do |opts|
     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 --align
     github-to-canvas --align [--branch BRANCH]
     github-to-canvas --align [--branch BRANCH] [--fis-links]
@@ -30,12 +31,13 @@ OptionParser.new do |opts|
 
     Example usage:
 
-    github-to-canvas --create 154                                      -> Creates a lesson in course 154, deriving 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, deriving the type from the local repo
+    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, using the repositorie's solution branch and deriving the type from the local repo
+    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 --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, adding addition Flatiron School specific HTML
+    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
 
@@ -54,7 +56,7 @@ 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| 
-            if type == 'page' || type == 'assignment'
+            if type == 'page' || type == 'assignment' || type == 'discussion'
               options[:type] = type
             else
               puts "Invalid type. Defaulting to page"
@@ -70,13 +72,17 @@ OptionParser.new do |opts|
             options[:version] = true
           end
   opts.on("-d", "--dry-run",
-          "Runs through creation without pushing to Canvas or GitHub") do |v|
+          "Runs through creation without pushing to Canvas or GitHub") do |d|
             options[:dry] = true
           end
   opts.on("-f", "--fis-links",
-          "Adds additional Flatiron School HTML after markdown conversion") do |v|
+          "Adds additional Flatiron School HTML after markdown conversion") do |f|
             options[:fis] = true
           end
+  opts.on("-r", "--remove-header-and-footer",
+          "Removes top lesson header and any Learn.co specific footer links before converting to HTML") do |r|
+            options[:remove_header_and_footer] = true
+          end
   
 end.parse!
 
@@ -101,9 +107,25 @@ if !options[:name]
 end
 
 if options[:create]
-  GithubToCanvas.new(mode: "create", course: options[:course], filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type], dry: !!options[:dry], fis_links: !!options[:fis])
+  GithubToCanvas.new(mode: "create", 
+                    course: options[:course], 
+                    filepath: Dir.pwd, 
+                    branch: options[:branch], 
+                    name: options[:name], 
+                    type: options[:type], 
+                    dry: !!options[:dry], 
+                    fis_links: !!options[:fis], 
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 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], fis_links: !!options[:fis])
+  GithubToCanvas.new(mode: "align", 
+                    course: nil, 
+                    filepath: Dir.pwd, 
+                    branch: options[:branch], 
+                    name: options[:name], 
+                    type: options[:type], 
+                    dry: !!options[:dry], 
+                    fis_links: !!options[:fis], 
+                    remove_header_and_footer: !!options[:remove_header_and_footer])
 end

data/lib/github-to-canvas.rb

@@ -9,7 +9,16 @@ require_relative './github-to-canvas/version'
 
 class GithubToCanvas
 
-  def initialize(mode:, course:, filepath:Dir.pwd, branch:'master', name:File.basename(Dir.getwd), type:"page", dry:false, fis_links:false)
+  def initialize(mode:, 
+                course:, 
+                filepath:Dir.pwd, 
+                branch:'master', 
+                name:File.basename(Dir.getwd), 
+                type:"page", 
+                dry:false, 
+                fis_links:false,
+                remove_header_and_footer:false)
+
     if mode == 'version'
       puts VERSION
       return
@@ -17,12 +26,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)
+      CreateCanvasLesson.new(course, filepath, branch, name, type, dry, 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)
+      UpdateCanvasLesson.new(filepath, branch, name, type, dry, fis_links, remove_header_and_footer)
     end
   end
 

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

@@ -17,7 +17,11 @@ class CanvasInterface
   end
 
   def self.push_to_canvas(course_id, type, name, new_readme)
-    url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s"
+    if type == 'discussion'
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}_topics"
+    else
+      url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s"
+    end
     payload = self.build_payload(type, name, new_readme)
     begin
       RestClient.post(url, payload, headers={
@@ -46,6 +50,11 @@ class CanvasInterface
         'assignment[name]' => name,
         'assignment[description]' => new_readme
       }
+    elsif type == "discussion"
+      payload = {
+        'title' => name,
+        'message' => new_readme
+      }
     else
       payload = {
         'wiki_page[title]' => name,

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

@@ -1,18 +1,18 @@
 class CreateCanvasLesson
 
-  def initialize(course, filepath, branch, name, type, dry_run, fis_links)
+  def initialize(course, filepath, branch, name, type, dry_run, 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...'
       abort
     end
-    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links)
+    create_canvas_lesson(original_readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
   end
 
-  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links)
+  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
     if fis_links
       new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
     end

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

@@ -1,4 +1,3 @@
-require 'byebug'
 class GithubInterface
 
   def self.cd_into_and(filepath, command)
@@ -19,7 +18,7 @@ class GithubInterface
   def self.git_co_branch(filepath, branch)
     self.cd_into_and(filepath, "git checkout #{branch}")
     current_branch = self.get_current_branch(filepath)
-    
+    puts "Current branch #{current_branch.strip}"
     if !current_branch.match(branch)
       puts "#{branch} branch not found. Exiting..."
       abort

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

@@ -1,11 +1,23 @@
 require 'redcarpet'
 class RepositoryConverter
 
-  def self.convert(filepath, readme, branch)
+  def self.convert(filepath, readme, branch, remove_header_and_footer)
+    if remove_header_and_footer
+      readme = self.remove_header(readme)
+      readme = self.remove_footer(readme)
+    end
     self.fix_local_images(filepath, readme, branch)
     self.convert_to_html(filepath, readme)
   end
 
+  def self.remove_header(readme)
+    readme.gsub(/^# .+?\n\n/,"")
+  end
+
+  def self.remove_footer(readme)
+    readme.gsub(/<p (.+?)<\/p>/,"")
+  end
+
   def self.fix_local_images(filepath, readme, branch)
     raw_remote_url = self.set_raw_image_remote_url(filepath)
     self.adjust_local_markdown_images(readme, raw_remote_url, branch)
@@ -61,12 +73,14 @@ class RepositoryConverter
 
   def self.add_fis_links(filepath, readme)
     repo = self.get_repo_url(filepath)
-    github_repo_link = "<a style='text-decoration: none;' href='#{repo}' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Open GitHub Repo' src='https://curriculum-content.s3.amazonaws.com/git-logo-gray.png' alt='Link to GitHub Repo' /></a>"
-    github_issue_link = "<a style='text-decoration: none;' href='#{repo}/issues/new' target='_blank' rel='noopener'><img style='width: 40px; height: 40px; margin: 2px;' title='Create New Issue' src='https://curriculum-content.s3.amazonaws.com/flag-icon-gray.png' alt='Link to GitHub Repo Issue Form' /></a>"
-
-    html = "<p style='margin: 0; padding: 0; position: absolute; right: 5px; top: 5px; margin: 0; padding: 0;'>#{github_repo_link}#{github_issue_link}</p>"
-    
-    readme + html
+    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 = "<a id='thumbs-up' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs up!' alt='thumbs up' /></a>"
+    thumbs_down_link = "<a id='thumbs-down' data-repository='#{repo.split('/')[-1]}'><img title='Thumbs down!' alt='thumbs down' /></a>"
+    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
   end
 
 end

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

@@ -1,18 +1,18 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run, fis_links)
+  def initialize(filepath, branch, name, type, dry_run, 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...'
       abort
     end
-    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links)
+    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
   end
 
-  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links)
+  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links, remove_header_and_footer)
     GithubInterface.get_updated_repo(filepath, branch)
-    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch, remove_header_and_footer)
     if fis_links
       new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
     end

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.22"
+  VERSION = "0.0.27"
 end

metadata

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