github-to-canvas 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e9d0258dc0813b99121938b37d82311ffb922ff0ffbcf4b222640e748f8659
-  data.tar.gz: b804e8f2a65a4d733409cfd3af3d3528bb696f3b458d9a1e30225b2d6f9cc5b9
+  metadata.gz: 732a757e941548fa67c1ede523fe03575dc22e8890d87300ce8e41732a2f01e3
+  data.tar.gz: 9966442368051e67fea9e6b7ce44ebb1555c645bd61f0512feea8e9ca3486995
 SHA512:
-  metadata.gz: 91ab69410efd3b89570ca9484942fd20799a2b2d074e7bd34de95c3bbd50606a435d11ab3d127021d7c4a4f460904644c0ded04f807725b9041681ed6f4b0710
-  data.tar.gz: 1757de283f3ad403cf3c49b3b89ea842b4f05cd9a075061e601f45690d597885b8d26bee069a5976236670eeb27af9aa731c73fdd35082f179ec4d59c699ea7c
+  metadata.gz: 6f67897ee3991f5e914524e04a7b90fb0985092c106ce57b16d64cb8afa74ec1555dbd8dbd57ad0a4be780595b6c8a02af9d914d5e6a63dbc9f5fac662418285
+  data.tar.gz: 8e2793cc5b58f7ad2e0a1e2e9a4244d34172736e0d69f34940f87b0603432287ddb088876392905c36adaef4809298791a1164118e6ab8dec95a06469bb6cc24

data/README.md

@@ -1,5 +1,5 @@
 # GitHub to Canvas Gem
-
+hello
 ## Introduction
 
 The `github-to-canvas` gem is designed to enable GitHub to Canvas LMS

data/bin/github-to-canvas

@@ -17,8 +17,8 @@ OptionParser.new do |opts|
     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 --align
-    github-to-canvas --reverse-align 
     github-to-canvas --version
     
     Run these commands from inside a local GitHub repository. This gem is built for Flatiron School's internal use.
@@ -59,14 +59,14 @@ OptionParser.new do |opts|
           "Updates a canvas lesson based on the local repository's README.md") do |a|
             options[:align] = true 
           end
-  opts.on("-r", "--reverse-align",
-          "Updates a remote repository, converting the Canvas lesson body to markdown and pushing it remotely as the README.md") do |r| 
-            options[:reverse_align] = true 
-          end
   opts.on("-v", "--version",
           "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 |v|
+            options[:dry] = true
+          end
   
 end.parse!
 
@@ -89,13 +89,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])
+  GithubToCanvas.new(mode: "create", course: options[:course], filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type], dry: !!options[:dry])
 end
 
 if options[:align]
-  puts 'feature not working yet'
-end
-
-if options[:reverse_align]
-  puts 'feature not working yet'
+  GithubToCanvas.new(mode: "align", course: nil, filepath: Dir.pwd, branch: options[:branch], name: options[:name], type: options[:type], dry: !!options[:dry])
 end

data/lib/github-to-canvas.rb

@@ -1,9 +1,15 @@
-require_relative './github-to-canvas/create-canvas-lesson'
+require_relative './github-to-canvas/create_canvas_lesson'
+require_relative './github-to-canvas/update_canvas_lesson'
+require_relative './github-to-canvas/repository_converter'
+require_relative './github-to-canvas/github_interface'
+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:, course:, filepath:Dir.pwd, branch:'master', name:File.basename(Dir.getwd), type:"page")
+  def initialize(mode:, course:, filepath:Dir.pwd, branch:'master', name:File.basename(Dir.getwd), type:"page", dry:false)
     if mode == 'version'
       puts VERSION
       return
@@ -11,7 +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)
+      CreateCanvasLesson.new(course, filepath, branch, name, type, dry)
+    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)
     end
   end
 

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

@@ -0,0 +1,93 @@
+require 'yaml'
+require 'byebug'
+class CanvasDotfile
+
+  def self.update_or_create(filepath, response, course, type)
+    if File.file?(".canvas")
+      if type == "assignment"
+        canvas_data = self.update_assignment_data(response, course, type)
+      else
+        canvas_data = self.update_page_data(response, course, type)
+      end
+    else
+      if type == "assignment"
+        canvas_data = self.create_assignment_data(response, course, type)
+      else
+        canvas_data = self.create_page_data(response, course, type)
+      end
+    end
+    self.create_canvas_dotfile(filepath, canvas_data)
+  end
+
+  def self.create_canvas_dotfile(filepath, canvas_data)
+    File.write("#{filepath}/.canvas", canvas_data.to_yaml)
+  end
+
+  def self.commit_canvas_dotfile(filepath)
+    GithubInterface.git_add(filepath, '.canvas')
+    GithubInterface.git_commit(filepath, 'AUTO: add .canvas file after migration')
+  end
+
+  def self.read_canvas_data
+    if File.file?(".canvas")
+       YAML.load(File.read(".canvas"))
+    else
+      puts 'ERROR: Align functionalty requires .canvas file to be present'
+      abort
+    end
+  end
+
+  def self.update_assignment_data(response, course, type)
+    canvas_data = YAML.load(File.read(".canvas"))
+    if canvas_data[:lessons].none? { |lesson| lesson[:id] == response['id'] && lesson[:course_id] == course.to_i && lesson[:canvas_url] == response['html_url']}
+      lesson_data = {
+        id: response['id'],
+        course_id: course.to_i,
+        canvas_url: response['html_url'],
+        type: type
+      }  
+      canvas_data[:lessons] << lesson_data
+    end
+    canvas_data
+  end
+
+  def self.create_assignment_data(response, course, type)
+    {
+      lessons: [
+        {
+          id: response['id'],
+          course_id: course.to_i,
+          canvas_url: response['html_url'],
+          type: type
+        }
+      ]
+    }
+  end
+
+  def self.update_page_data(response, course, type)
+    canvas_data = YAML.load(File.read(".canvas"))
+    if canvas_data[:lessons].none? { |lesson| lesson[:page_id] == response['page_id'] && lesson[:course_id] == course.to_i && lesson[:canvas_url] == response['html_url']}
+      lesson_data = {
+        id: response['page_id'],
+        course_id: course.to_i,
+        canvas_url: response['html_url'],
+        type: type
+      }  
+      canvas_data[:lessons] << lesson_data
+    end
+    canvas_data
+  end
+
+  def self.create_page_data(response, course, type)
+    {
+      lessons: [
+        {
+          id: response['page_id'],
+          course_id: course.to_i,
+          canvas_url: response['html_url'],
+          type: type
+        }
+      ]
+    }
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'json'
+require 'rest-client'
+require 'byebug'
+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)
+    end
+  end
+
+  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']}"
+    })
+  end
+
+  def self.update_existing_lesson(course_id, page_id, type, name, new_readme, dry_run)
+    url = "#{ENV['CANVAS_API_PATH']}/courses/#{course_id}/#{type}s/#{page_id}"
+    payload = self.build_payload(type, name, new_readme)
+    RestClient.put(url, payload, headers={
+      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+    })
+  end
+
+  def self.build_payload(type, name, new_readme)
+    if type == "assignment"
+      payload = {
+        'assignment[name]' => name,
+        'assignment[description]' => new_readme
+      }
+    else
+      payload = {
+        'wiki_page[title]' => name,
+        'wiki_page[body]' => new_readme,
+        'wiki_page[editing_roles]' => "teachers" 
+      }
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+class CreateCanvasLesson
+
+  def initialize(course, filepath, branch, name, type, dry_run)
+    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)
+  end
+
+  def create_canvas_lesson(readme, course, filepath, branch, name, type, dry_run)
+    GithubInterface.get_updated_repo(filepath, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    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
+      CanvasDotfile.update_or_create(filepath, response, course, type)
+      CanvasDotfile.commit_canvas_dotfile(filepath)
+      GithubInterface.git_push(filepath, branch)
+    end
+  end
+
+end

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

@@ -0,0 +1,42 @@
+
+class GithubInterface
+
+  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}`
+  end
+
+  def self.git_co_branch(filepath, branch)
+    branch = self.cd_into_and(filepath, "git co #{branch}")
+    if branch.to_s.strip.empty?
+      puts "#{branch} branch not found. Exiting..."
+      abort
+    end
+  end
+
+  def self.git_pull(filepath, branch)
+    self.cd_into_and(filepath, "git pull origin #{branch}")
+  end
+
+  def self.git_remote(filepath)
+    self.cd_into_and(filepath, "git config --get remote.origin.url")
+  end
+
+  def self.git_add(filepath, file)
+    self.cd_into_and(filepath, "git add #{file}")
+  end
+
+  def self.git_commit(filepath, message)
+    self.cd_into_and(filepath, "git commit -m '#{message}'")
+  end
+
+  def self.git_push(filepath, branch)
+    self.cd_into_and(filepath, "git push origin #{branch}")
+  end
+end

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

@@ -0,0 +1,53 @@
+require 'redcarpet'
+
+class RepositoryConverter
+
+  def self.convert(filepath, readme, branch)
+    self.fix_local_images(filepath, readme, branch)
+    self.convert_to_html(filepath, readme)
+  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)
+    self.adjust_local_html_images(readme, raw_remote_url)
+  end
+
+  def self.set_raw_image_remote_url(filepath)
+    remote = GithubInterface.git_remote(filepath)
+    remote.gsub!("git@github.com:","https://raw.githubusercontent.com/")
+    remote.gsub!(/.git$/,"")
+    remote.strip!
+  end
+
+  def self.adjust_local_markdown_images(readme, raw_remote_url, branch)
+    readme.gsub!(/\!\[.+\]\(.+\)/) {|image|
+      if !image.match('amazonaws.com') && !image.match('https://') && !image.match('youtube')
+        image.gsub!(/\(.+\)/) { |path|
+          path.delete_prefix!("(")
+          path.delete_suffix!(")")
+          "(" + remote + "/#{branch}/" + path + ")"
+        }
+      end
+      image
+    }
+  end
+
+  def self.adjust_local_html_images(readme, raw_remote_url)
+    readme.gsub!(/src=\"[\s\S]*?" /) { |img|
+      if !image.match('amazonaws.com') && !image.match('https://') && !image.match('youtube')
+        img.gsub!(/\"/, "")
+        img.gsub!(/src=/, '')
+        img.strip!
+      end
+      'src="' + raw_remote_url + '/master/' + img + '"'
+    }
+  end
+
+  def self.convert_to_html(filepath, readme)
+    redcarpet = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options={tables: true, autolink: true, fenced_code_blocks: true})
+    # File.write("#{filepath}/README.html", redcarpet.render(readme))
+    redcarpet.render(readme)
+  end
+
+end

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

@@ -0,0 +1,24 @@
+class UpdateCanvasLesson
+
+  def initialize(filepath, branch, name, type, dry_run)
+    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)
+  end
+
+  def update_canvas_lesson(readme, filepath, branch, name, type, dry_run)
+    GithubInterface.get_updated_repo(filepath, branch)
+    new_readme = RepositoryConverter.convert(filepath, readme, branch)
+    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)
+    }
+  end
+
+  
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-to-canvas
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - maxwellbenton
@@ -80,7 +80,12 @@ files:
 - Rakefile
 - bin/github-to-canvas
 - lib/github-to-canvas.rb
-- lib/github-to-canvas/create-canvas-lesson.rb
+- lib/github-to-canvas/canvas_dotfile.rb
+- lib/github-to-canvas/canvas_interface.rb
+- lib/github-to-canvas/create_canvas_lesson.rb
+- lib/github-to-canvas/github_interface.rb
+- lib/github-to-canvas/repository_converter.rb
+- lib/github-to-canvas/update_canvas_lesson.rb
 - lib/github-to-canvas/version.rb
 homepage: https://github.com/learn-co-curriculum/github-to-canvas
 licenses:

data/lib/github-to-canvas/create-canvas-lesson.rb

@@ -1,156 +0,0 @@
-require 'redcarpet'
-require 'rest-client'
-require 'json'
-require 'yaml'
-require 'byebug'
-
-class CreateCanvasLesson
-
-  def initialize(course, filepath, branch, name, type)
-    @course = course
-    @filepath = filepath
-    @branch = branch
-    @name = name.split(/[ -]/).map(&:capitalize).join(' ')
-    @type = type
-    @renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options={tables: true, autolink: true, fenced_code_blocks: true})
-    @original_readme = File.read("#{filepath}/README.md")
-    if !@original_readme
-      puts 'README.md not found in current directory. Exiting...'
-      abort
-    end
-    create_canvas_lesson
-  end
-
-  def create_canvas_lesson
-    git_co_branch
-    git_pull
-    @raw_remote_url = set_raw_image_remote_url
-    adjust_local_markdown_images
-    adjust_local_html_images
-    @new_readme = @renderer.render(@original_readme)
-    write_to_html
-    @response = push_to_canvas
-    if @response.code != 200
-      puts "Canvas push failed. #{@response.code} status code returned "
-    end
-    @response = JSON.parse(@response.body)
-    create_canvas_dotfile
-    commit_canvas_dotfile
-    git_push
-  end
-
-  def cd_into_and(command)
-    cmd = "cd #{@filepath} && #{command}"
-    puts cmd
-    `#{cmd}`
-  end
-
-  def git_co_branch
-    cmd = "git co #{@branch}"
-    branch = cd_into_and(cmd)
-    if branch.to_s.strip.empty?
-      puts "#{b@ranch} branch not found. Exiting..."
-      abort
-    end
-  end
-
-  def git_pull
-    if @branch != 'master'
-      cmd = "git pull #{@branch}"
-    else
-      cmd =  "git pull"
-    end
-    puts "git pulling latest version of #{@branch}"
-    cd_into_and(cmd)
-  end
-
-  def git_remote
-    cmd = "git config --get remote.origin.url"
-    cd_into_and(cmd)
-  end
-
-  def git_add(file)
-    cmd = "git add #{file}"
-    puts "git adding #{file}"
-    cd_into_and(cmd)
-  end
-
-  def git_commit(message)
-    cmd = "git commit -m '#{message}'"
-    puts "git commit: '#{message}'"
-    cd_into_and(cmd)
-  end
-
-  def git_push
-    cmd = "git push"
-    puts "git pushing #{@branch}"
-    cd_into_and(cmd)
-  end
-  
-  def set_raw_image_remote_url
-    remote = git_remote
-    remote.gsub!("git@github.com:","https://raw.githubusercontent.com/")
-    remote.gsub!(/.git$/,"")
-    remote.strip!
-  end
-
-  def adjust_local_markdown_images
-    @original_readme.gsub!(/\!\[.+\]\(.+\)/) {|image|
-      if !image.match('amazonaws.com') && !image.match('https://')
-        image.gsub!(/\(.+\)/) { |path|
-          path.delete_prefix!("(")
-          path.delete_suffix!(")")
-          "(" + remote + "/#{@branch}/" + path + ")"
-        }
-      end
-      image
-    }
-  end
-
-  def adjust_local_html_images
-    @original_readme.gsub!(/src=\"[\s\S]*?" /) { |img|
-      img.gsub!(/\"/, "")
-      img.gsub!(/src=/, '')
-      img.strip!
-      'src="' + @raw_remote_url + '/master/' + img + '"'
-    }
-  end
-
-  def write_to_html
-    File.write("#{@filepath}/README.html", @new_readme)
-  end
-
-  def push_to_canvas
-    url = "#{ENV['CANVAS_API_PATH']}/courses/#{@course}/#{@type}s"
-    if @type == "assignment"
-      payload = {
-        'assignment[name]' => @name,
-        'assignment[description]' => @new_readme
-      }
-    else
-      payload = {
-        'wiki_page[title]' => @name,
-        'wiki_page[body]' => @new_readme,
-        'wiki_page[editing_roles]' => "teachers" 
-      }
-    end
-
-    RestClient.post(url, payload, headers={
-      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
-    })
-  end
-
-  def create_canvas_dotfile
-    canvas_data = {
-      page_id: @response['page_id'],
-      course_id: @course.to_i,
-      canvas_url: @response['html_url']
-    }
-    File.write("#{@filepath}/.canvas", canvas_data.to_yaml)
-  end
-
-  def commit_canvas_dotfile
-    git_add('.canvas')
-    git_commit('AUTO: add .canvas file after migration')
-  end
-end