github-to-canvas 0.0.46 → 0.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddda58c3ed202c82e6c0f71a80178a7fbc72e593b9357b5449ee2116d35f68cf
-  data.tar.gz: ea08df0af727814a06508291e9e2d0159f5e268ed7b54858002a74cb6529a26d
+  metadata.gz: d00d3f8b2e4a748b6d8840c365904d980f7bc6f7ad8046cc44b0f28372cad834
+  data.tar.gz: 2cf19fe82846d2cb544ba8cccacd078e08c71c7270f4ecfa1a954d894cdf6750
 SHA512:
-  metadata.gz: a62890799c51f119081bca8a26455ff46d55e9f796a3a3f783f2b39a47c16439b2ca1528eee528b54c2c8453fc865ec62e7b5526cdf925199b24a243fddc7e33
-  data.tar.gz: 980f0d8f8265f2cffa75e8f5659bbb4e7d34efaf76c4d8ff1748e9ee2357fbca3c10903ff63a5bcf9f0fc7c60c8a38a2374174c18235dfb4a70843f4350baf23
+  metadata.gz: 74598233da7a1ecfc041937a838a06e14511fbc98c65a981c8a408f997289e0c3520fa600e023bba1c3800ee84c742bb79598ca067e8ba2e0957972df390173c
+  data.tar.gz: b81aca6a1ebd575642e438a60af63a24db731728b144de5e6f7e5be2ed8c36f6c5cdc93411aa7e64e6e6e231946d0db359a51497b7417b25c40d9f4c2b36f6fb

data/bin/github-to-canvas

@@ -36,7 +36,7 @@ OptionParser.new do |opts|
     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 --fis-links                                      -> Patches existing lessons in Canvas based on the .canvas file, adds additional Flatiron School specific HTML and meta-data
     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
     github-to-canvas --info COURSE                                            -> Displays a course's lesson and assignment names    
 
@@ -104,6 +104,10 @@ OptionParser.new do |opts|
           "Displays a course's lessons and assignments") do |course|
             options[:query] = course
           end
+  opts.on("--remote",
+          "Retrieves a Canvas lesson. Requires --course and --id") do |remote|
+            options[:remote] = true
+          end
   
 end.parse!
 
@@ -115,6 +119,14 @@ if options[:query]
   GithubToCanvas.new(mode: 'query',  course: options[:query], id: options[:id])
 end
 
+if options[:remote]
+  if !options[:course] || !options[:id]
+    puts "Both --course and --id required when using --remote"
+    abort
+  end
+  GithubToCanvas.new(mode: 'remote', course: options[:course], id: options[:id])
+end
+
 if !options[:type]
   if Dir.glob("**/*/").empty?
     options[:type] = "page"

data/lib/github-to-canvas.rb

@@ -6,7 +6,6 @@ require_relative './github-to-canvas/canvas_interface'
 require_relative './github-to-canvas/canvas_dotfile'
 require_relative './github-to-canvas/version'
 
-
 class GithubToCanvas
 
   def initialize(mode:, 
@@ -30,6 +29,18 @@ class GithubToCanvas
       CanvasInterface.get_course_info(course, id)
     end
 
+    if mode == 'remote'
+      lesson_data = CanvasInterface.get_lesson_info(course, id)
+      if !lesson_data[1]
+        puts "No lesson with id #{id} was found in course #{course}."
+      else
+        pp lesson_data[0]
+        puts "\nLesson Type: #{lesson_data[1]}"
+      end
+      
+      
+    end
+
     if mode == 'create'
       puts "github-to-canvas will now create a Canvas lesson based on the current repo"
       CreateCanvasLesson.new(course, filepath, file_to_convert, branch, name, type, save_to_github, fis_links, remove_header_and_footer)

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

@@ -3,41 +3,41 @@ require 'rest-client'
 class CanvasInterface
 
   def self.get_lesson_info(course, id)
-    page_url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/pages/#{id}"
-    assignment_url = "#{ENV['CANVAS_API_PATH']}/courses/#{course}/assignments/#{id}"
+
+    lesson_types = ["quizzes", "assignments", "pages", "discussion_topics"]
+    lesson_type_urls = []
+    lesson_types.each do |type|
+      lesson_type_urls << "#{ENV['CANVAS_API_PATH']}/courses/#{course}/#{type}/#{id}"
+    end
+
     type = nil
     info = ""
+    lesson_type_urls.each do |url|
       begin
-        page_response = RestClient.get(page_url, headers={
+        response = RestClient.get(url, headers={
           "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
         })
-        if ([200, 201].include? page_response.code)
-          info = JSON.parse(page_response.body)
-          puts "A Canvas page with the ID #{id} was found in course #{course}:"
-          type = "page"
-        end
-      rescue
-      end
-
-      begin
-        assignment_response = RestClient.get(assignment_url, headers={
-          "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-        })
-        if ([200, 201].include? assignment_response.code)
-          info = JSON.parse(assignment_response.body)
-          puts "A Canvas assignment with the ID #{id} was found in course #{course}:"
-          type = "assignment"
+        if [200, 201].include? response.code
+          info = JSON.parse(response.body)
+          type = lesson_types.find {|type| url.match?("#{type}")}
+          type.delete_suffix!('zes')
+          type.delete_suffix!('s')
+          puts "\nA Canvas #{type} was found in course #{course} with the id #{id}"
+          break
         end
       rescue
       end
+    end
+    
+    
     [info, type]
   end
 
   def self.get_course_info(course, id)
     if id
-      info = self.get_lesson_info(course, id)
-      pp info[1]
-      pp info[0]
+      lesson_data = self.get_lesson_info(course, id)
+      pp lesson_data[0]
+      pp "\nLesson Type: #{lesson_data[1]}"
       return
     end
 

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

@@ -73,15 +73,24 @@ class RepositoryConverter
   end
 
   def self.add_fis_links(filepath, readme)
-    repo = self.get_repo_url(filepath)
-    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 = "<img id='thumbs-up' data-repository='#{repo.split('/')[-1]}' title='Thumbs up!' alt='thumbs up' />"
-    thumbs_down_link = "<img id='thumbs-down' data-repository='#{repo.split('/')[-1]}' title='Thumbs down!' alt='thumbs down' />"
-    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
+    repo_path = self.get_repo_url(filepath)
+    header = self.create_github_link_header(repo_path)
+    header + readme
+  end
+
+  def self.create_github_link_header(repo_path)
+    repo_name = repo_path.split('/')[-1]
+
+    # add link to fork (forking handled by separate Flatiron server, generation of link handled via custom Canvas JS theme file)
+    github_fork_link = "<a class='fis-git-link' data-repo='#{repo_name}' href='#' target='_blank' rel='noopener'><img id='fork-img' title='Fork This Assignment' alt='Fork This Assignment' /></a>"
+
+    # 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>"
+    
+    # add link to new issue form
+    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>"
+    
+    "<header class='fis-header' style='visibility: hidden;'>#{github_fork_link}#{github_issue_link}</header>"
   end
 
 end

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

@@ -1,3 +1,3 @@
 class GithubToCanvas
-  VERSION = "0.0.46"
+  VERSION = "0.0.48"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.0.46
+  version: 0.0.48
 platform: ruby
 authors:
 - maxwellbenton
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: github-to-canvas is a tool for migrating and aligning GitHub content with