github-to-canvas 0.0.17 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c34f751012912f2dab63047ccb3d988f7f2c072f72ef10fe197a11b65ef3ce4
-  data.tar.gz: 8a8c5c2b21ff81708fb56d75154e1d286f2a6f4ec76f58b42b862b90dde26982
+  metadata.gz: 30ee9448d74c258ca7d0a142e4b2fa4bfa708b227014fd3ef9cd5daf483b0da7
+  data.tar.gz: 84d2710f793fcf93beea70c5693554920b14890c0260e7d20bb28dbf1d3723c3
 SHA512:
-  metadata.gz: 39e7585eb2b1f01dd30dda410abaad6b6440c377d573535e1bec44e9950136c46e89016a4d62449ae6c466956bff7ec78097e62576165cbbec007041dce6f767
-  data.tar.gz: 327074a131b23b3ec67b7f21fe782894674eee079009eb637af9758e0992d30eeaf0093d86a931280ce968da2e6194bcfcb7ded701c68c9b25cd8860f83845e2
+  metadata.gz: 75c3662d1354d1c5ed0e83ec625eed59010dc254ec9fa5663a060d7f32e58cf937ead936dabf8debd1e3f3f2d07f26747c17945b3a99fc3054244fea9be518b2
+  data.tar.gz: cbc3df60cb990b5c7fffd58b04a0a575c1ec2e4b513f68f7d080b724ee6da94726e14e4d405b77a38389ad1fe470b7c7b2fb03b8f40f00835bdbfebefe52c795

data/bin/github-to-canvas

@@ -18,8 +18,12 @@ OptionParser.new do |opts|
     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 --align
+    github-to-canvas --align [--branch BRANCH]
+    github-to-canvas --align [--branch BRANCH] [--fis-links]
     github-to-canvas --version
+
     
     Run these commands from inside a local GitHub repository. This gem is built for Flatiron School's internal use.
     Some default behaviors assume this, like the default Canvas API path.
@@ -30,7 +34,9 @@ OptionParser.new do |opts|
     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 --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 --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
+
   EOBANNER
 
   opts.on("-cCOURSE", "--create COURSE", 
@@ -67,6 +73,10 @@ OptionParser.new do |opts|
           "Runs through creation without pushing to Canvas or GitHub") do |v|
             options[:dry] = true
           end
+  opts.on("-f", "--fis-links",
+          "Adds additional Flatiron School HTML after markdown conversion") do |v|
+            options[:fis] = true
+          end
   
 end.parse!
 
@@ -74,10 +84,12 @@ if options[:version]
   GithubToCanvas.new(mode: 'version',  course: nil)
 end
 
-if Dir.glob("**/*/").empty?
-  options[:type] = "page"
-else
-  options[:type] = "assignment"
+if !options[:type]
+  if Dir.glob("**/*/").empty?
+    options[:type] = "page"
+  else
+    options[:type] = "assignment"
+  end
 end
 
 if !options[:branch]
@@ -89,9 +101,9 @@ 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])
+  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])
 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])
+  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])
 end

data/lib/github-to-canvas.rb

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

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

@@ -19,18 +19,25 @@ class CanvasInterface
   def self.push_to_canvas(course_id, type, name, new_readme)
     url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s"
     payload = self.build_payload(type, name, new_readme)
-
-    RestClient.post(url, payload, headers={
-      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-    })
+    begin
+      RestClient.post(url, payload, headers={
+        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+      })
+    rescue
+      puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+    end
   end
 
   def self.update_existing_lesson(course_id, id, type, name, new_readme, dry_run)
     url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s/#{id}"
     payload = self.build_payload(type, name, new_readme)
-    RestClient.put(url, payload, headers={
-      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-    })
+    begin
+      RestClient.put(url, payload, headers={
+        "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+      })
+    rescue
+      puts "Something went wrong while pushing lesson #{id} to course #{course_id}"
+    end
   end
 
   def self.build_payload(type, name, new_readme)

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

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

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

@@ -1,20 +1,26 @@
-
+require 'byebug'
 class GithubInterface
 
+  def self.cd_into_and(filepath, command)
+    cmd = "cd #{filepath} && #{command}"
+    puts cmd
+    `#{cmd}`
+  end
+
   def self.get_updated_repo(filepath, branch)
    self.git_co_branch(filepath, branch)
    self.git_pull(filepath, branch)
   end
 
-  def self.cd_into_and(filepath, command)
-    cmd = "cd #{filepath} && #{command}"
-    puts cmd
-    `#{cmd}`
+  def self.get_current_branch(filepath)
+    self.cd_into_and(filepath, "git rev-parse --abbrev-ref HEAD")
   end
 
   def self.git_co_branch(filepath, branch)
-    branch = self.cd_into_and(filepath, "git checkout #{branch}")
-    if branch.to_s.strip.empty?
+    self.cd_into_and(filepath, "git checkout #{branch}")
+    current_branch = self.get_current_branch(filepath)
+    
+    if !current_branch.match(branch)
       puts "#{branch} branch not found. Exiting..."
       abort
     end

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

@@ -1,5 +1,4 @@
 require 'redcarpet'
-
 class RepositoryConverter
 
   def self.convert(filepath, readme, branch)
@@ -16,6 +15,14 @@ class RepositoryConverter
   def self.set_raw_image_remote_url(filepath)
     remote = GithubInterface.git_remote(filepath)
     remote.gsub!("git@github.com:","https://raw.githubusercontent.com/")
+    remote.gsub!("https://github.com/","https://raw.githubusercontent.com/")
+    remote.gsub!(/.git$/,"")
+    remote.strip!
+  end
+
+  def self.get_repo_url(filepath)
+    remote = GithubInterface.git_remote(filepath)
+    remote.gsub!("git@github.com:","https://github.com/")
     remote.gsub!(/.git$/,"")
     remote.strip!
   end
@@ -52,4 +59,14 @@ class RepositoryConverter
     redcarpet.render(readme)
   end
 
+  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
+  end
+
 end

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

@@ -1,18 +1,21 @@
 class UpdateCanvasLesson
 
-  def initialize(filepath, branch, name, type, dry_run)
+  def initialize(filepath, branch, name, type, dry_run, fis_links)
     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)
+    update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links)
   end
 
-  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run)
+  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run, fis_links)
     GithubInterface.get_updated_repo(filepath, branch)
     new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    if fis_links
+      new_readme = RepositoryConverter.add_fis_links(filepath, new_readme)
+    end
     canvas_data = CanvasDotfile.read_canvas_data
     canvas_data[:lessons].each { |lesson|
       CanvasInterface.update_existing_lesson(lesson[:course_id], lesson[:id], type, name, new_readme, dry_run)

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

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

metadata

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