canvas-workflow 0.5.0

data/lib/canvas/workflow/cli/push.rb

@@ -0,0 +1,55 @@
+module Canvas
+  module Workflow
+    module CLI
+      class Push < Thor
+        desc "push", "Push changes in Canvas Workflow project since last successful Travis build"
+        def push
+          # upload files
+          # FIXME This assumes a unix-like environment which uses backslash as
+          #   file separator.
+          Dir.glob('files/**/*', File::FNM_DOTMATCH).select do |file|
+            push?(file) && (Travis.created?(file) || Travis.modified?(file))
+          end.each do |file|
+            puts "=> uploading #{file}"
+
+            content = {
+              'name' => File.basename(file),
+              'size' => File.size(file),
+              'parent_folder_path' => File.dirname(file).sub('files', '')
+            }
+
+            Workflow.client.upload_file(course, file, content)
+          end
+
+          # upload assignments
+          # FIXME this only compacts one level
+          Dir.glob('assignments/*.md').select do |md_file|
+            push?(md_file) && Travis.created?(md_file)
+          end.each do |md_file|
+            content = YAML.load_file(md_file)
+
+            puts "=> creating #{content['title']}"
+
+            Workflow.client.create_assignment(course, content['title'])
+          end
+        end
+
+        default_task :push
+
+        private
+
+        def course
+          @course ||= Workflow.config['course']
+        end
+
+        def push?(file)
+          !File.directory?(file) &&
+            (!Workflow.excluded?(file) || Workflow.included?(file))
+        end
+      end
+
+      desc("push", "Push changes in Canvas Workflow project since last successful Travis build")
+      subcommand "push", Push
+    end
+  end
+end

data/lib/canvas/workflow/client.rb

@@ -0,0 +1,13 @@
+require 'pandarus' # canvas lms api
+
+module Canvas
+  module Workflow
+    class Client < Pandarus::Client
+      def initialize(config)
+        token  = ENV['CANVAS_API_TOKEN']
+        prefix = config['prefix'] + '/api'
+        super(prefix: prefix, token: token)
+      end
+    end
+  end
+end

data/lib/canvas/workflow/pandarus.rb

@@ -0,0 +1,88 @@
+require 'pandarus'    # canvas lms api
+require 'rest-client' # multi-part send
+
+# monkey-patch incorrect/incomplete implementations
+module Pandarus
+  class V1
+    # incomplete: added additional parameter path
+    def resolve_path_courses(course_id, path, opts={})
+      query_param_keys = [
+      ]
+
+      form_param_keys = [
+      ]
+
+      # verify existence of params
+      raise "course_id is required" if course_id.nil?
+      raise "path is required" if path.nil?
+      # set default values and merge with input
+      options = underscored_merge_opts(opts,
+        :course_id => course_id,
+        :path => path
+      )
+
+      # resource path
+      path = path_replace("/v1/courses/{course_id}/folders/by_path/{path}/",
+        :course_id => course_id, :path => path)
+      headers = nil
+      form_params = select_params(options, form_param_keys)
+      query_params = select_query_params(options, query_param_keys)
+
+      RemoteCollection.new(connection, Folder, path, query_params)
+    end
+
+    # incomplete: added additional parameter file
+    def upload_file(course_id, file, opts={})
+      query_param_keys = [
+      ]
+
+      form_param_keys = [
+        :name,
+        :size,
+        :content_type,
+        :parent_folder_id,
+        :parent_folder_path,
+        :on_duplicate
+      ]
+
+      # verify existence of params
+      raise "course_id is required" if course_id.nil?
+      raise "file is required" if file.nil?
+      # set default values and merge with input
+      options = underscored_merge_opts(opts,
+        :course_id => course_id
+      )
+
+      # resource path
+      path = path_replace("/v1/courses/{course_id}/files",
+        :course_id => course_id)
+      headers = nil
+      form_params = select_params(options, form_param_keys)
+      query_params = select_query_params(options, query_param_keys)
+
+      # initiate file upload
+      response = mixed_request(:post, path, query_params, form_params, headers)
+
+      # add file to form data
+      response['upload_params']['file'] = ::File.new(file, "rb")
+
+      # complete file upload using rest-client api and the response to the
+      # original request
+      RestClient.post(response['upload_url'], response['upload_params'])
+    end
+
+  protected
+    # incorrect: fixes instructure/pandarus#28
+    def dot_flatten_recur(hash)
+      hash.map do |k1, v1|
+        if v1.is_a?(Hash)
+          dot_flatten_recur(v1).map do |k2, v2|
+            ["#{k1}.#{k2}", v2]
+          end
+        else
+          [[k1, v1]]
+        end
+      end.flatten(1)
+    end
+  end
+end

data/lib/canvas/workflow/tags.rb

@@ -0,0 +1,10 @@
+require 'jekyll' # jekyll & liquid
+
+module Canvas
+  module Workflow
+    module Tags
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/tags/*.rb'].each { |file| require file }

data/lib/canvas/workflow/tags/assignment.rb

@@ -0,0 +1,28 @@
+module Canvas
+  module Workflow
+    module Tags
+      class AssignmentTag < Liquid::Tag
+        def initialize(tag_name, text, tokens)
+          super
+        end
+
+        def render(context)
+          config = context.registers[:site].config['canvas']
+          title  = context.environments.first['page']['title']
+          course = config['course']
+          client = Canvas::Workflow::Client.new(config)
+
+          assignments = client.list_assignments(course, :search_term => title).to_a
+
+          raise ArgumentError.new("Assignment does not exist") if assignments.empty?
+
+          # return the first, which /should/ be the shortest length string, so
+          # first lexicographically
+          assignments.first[:id]
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('assignment', Canvas::Workflow::Tags::AssignmentTag)

data/lib/canvas/workflow/tags/file.rb

@@ -0,0 +1,35 @@
+module Canvas
+  module Workflow
+    module Tags
+      class FileTag < Liquid::Tag
+        def initialize(tag_name, text, tokens)
+          super
+          @path = text.strip
+        end
+
+        def render(context)
+          config  = context.registers[:site].config['canvas']
+          course  = config['course']
+          client  = Canvas::Workflow::Client.new(config)
+
+          dir     = File.dirname(@path)
+          file    = File.basename(@path)
+          folders = client.resolve_path_courses(course, dir).to_a
+
+          raise ArgumentError.new("Path does not exist") if folders.empty?
+
+          folder  = folders.last
+          files   = client.list_files_folders(folder[:id], :search_term => file).to_a
+
+          raise ArgumentError.new("File does not exist") if files.empty?
+
+          # return the first, which /should/ be the shortest length string, so
+          # first lexicographically
+          files.first[:url]
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('file', Canvas::Workflow::Tags::FileTag)

data/lib/canvas/workflow/tags/gist.rb

@@ -0,0 +1,20 @@
+module Canvas
+  module Workflow
+    module Tags
+      class GistTag < Liquid::Tag
+        def initialize(tag_name, text, tokens)
+          raise ArgumentError.new("Cannot have empty gist") if text.empty?
+
+          super
+          @gist = text.strip
+        end
+
+        def render(context)
+          "<p><iframe style=\"width: 100%; height: 400px;\" title=\"GitHub gist\" src=\"https://www.edu-apps.org/tools/github/github_summary_gist.html\##{@gist}\" width=\"100%\" height=\"400\" allowfullscreen=\"allowfullscreen\" webkitallowfullscreen=\"webkitallowfullscreen\" mozallowfullscreen=\"mozallowfullscreen\"></iframe></p>"
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('gist', Canvas::Workflow::Tags::GistTag)

data/lib/canvas/workflow/tags/icon.rb

@@ -0,0 +1,20 @@
+module Canvas
+  module Workflow
+    module Tags
+      class IconTag < Liquid::Tag
+        def initialize(tag_name, text, tokens)
+          raise ArgumentError.new("Cannot have empty icon") if text.empty?
+
+          super
+          @icon = text.strip
+        end
+
+        def render(context)
+          "<i class=\"icon-#{@icon}\"></i>"
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('icon', Canvas::Workflow::Tags::IconTag)

data/lib/canvas/workflow/travis.rb

@@ -0,0 +1,112 @@
+require 'travis' # travis-ci api
+
+module Canvas
+  module Workflow
+    module Travis
+      # Has +file+ been removed since the last successful build?
+      #
+      # @!macro [new] undefined
+      #   @note Behavior is undefined if the reason that there is no previous
+      #     successful build is because it was struck from the git history. If
+      #     this is the case, then there is no reliable way to determine which
+      #     files have been changed without brute-force checking every file
+      #     against the Canvas site.
+      # @internal In the current logic, no files will be reported as having
+      #   been removed.
+      #
+      # @param file [String] a file name
+      # @return [Boolean] true if the file has been removed since the last
+      #   successful build.
+      #
+      # @bug The orignal paths of those files that have been renamed will not
+      #   be identified as having been removed.
+      # @internal This is due to --diff-filter=D only returning those files
+      #   that have been deleted. --diff-filter=DR is incorrect because R
+      #   lists the new paths. It is unclear at this time how to get the
+      #   original paths of such files.
+      # @bug This will not recursively identify empty directories.
+      def self.removed?(file)
+        if commit_sha.nil?
+          # no files have been removed, since there is no previous successful
+          # build on this branch
+        else
+          # get the list of files that have been deleted since the last passed
+          # commit
+          @removed ||= `git diff --diff-filter=D --name-only #{commit_sha}`
+          exit($?.exitstatus) if $?.exitstatus != 0
+        end
+
+        # check if the param file has been removed
+        @removed.include?(file)
+      end
+
+      # Has +file+ been created since the last successful build?
+      #
+      # @!macro undefined
+      # @internal In the current logic, all files will be reported as having
+      #   been created.
+      #
+      # @param file [String] a file name
+      # @return [Boolean] true if the file has been created since the last
+      #   successful build.
+      def self.created?(file)
+        if commit_sha.nil?
+          # get the list of all files on this branch being tracked by git
+          @created ||= `git ls-tree -r #{branch} --name-only`
+        else
+          # get the list of files that have been created since the last passed
+          # commit
+          @created ||= `git diff --diff-filter=AR --name-only #{commit_sha}`
+        end
+        exit($?.exitstatus) if $?.exitstatus != 0
+
+        # check if the param file has been created
+        @created.include?(file)
+      end
+
+      # Has +file+ been modified since the last successful build?
+      #
+      # @!macro undefined
+      # @internal In the current logic, all files will be reported as having
+      #   been modified.
+      #
+      # @param file [String] a file name
+      # @return [Boolean] true if the file has been modified since the last
+      #   successful build.
+      def self.modified?(file)
+        if commit_sha.nil?
+          # get the list of all files on this branch being tracked by git
+          @modified ||= `git ls-tree -r #{branch} --name-only`
+        else
+          # get the list of files that have been modified since the last
+          # passed commit
+          @modified ||= `git diff --diff-filter=M --name-only #{commit_sha}`
+        end
+        exit($?.exitstatus) if $?.exitstatus != 0
+
+        # check if the param file has been modified
+        @modified.include?(file)
+      end
+
+      private
+
+      def self.branch
+        @branch ||= ENV['TRAVIS_BRANCH']
+      end
+
+      def self.commit_sha
+        return @commit_sha unless @commit_sha.nil?
+
+        # get the builds for the travis repo
+        repo   = ENV['TRAVIS_REPO_SLUG']
+        travis = ::Travis::Repository.find(repo)
+
+        # search the builds for last succesful build
+        builds = travis.each_build.select do |build|
+          build.branch_info.eql?(self.branch) && build.passed?
+        end
+        @commit_sha = builds.first.commit.short_sha unless builds.empty?
+      end
+    end
+  end
+end

data/lib/canvas/workflow/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Canvas
+  module Workflow
+    VERSION = "0.5.0".freeze
+  end
+end

data/spec/assignment_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+# [ ] test with incorrect authorization [error]
+# [X]      with non-existing course [error]
+# [X]      for non-existing assignment [error]
+# [X]      for existing assignment [pass]
+
+describe Canvas::Workflow::Tags::AssignmentTag do
+  let(:doc) { doc_with_content(content) }
+  let(:prefix) { doc.site.config['canvas']['prefix'] }
+  let(:course) { doc.site.config['canvas']['course'] }
+  let(:content) { "{% assignment %}" }
+  let(:output) do
+    doc.data['title'] = "#{title}"
+    doc.content = content
+    doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+  end
+
+  before :each do
+    stub_request(:get, url).to_return(:status => status, :body => fixture(fix), :headers => { "Content-Type" => "application/json; charset=utf-8" })
+  end
+  let(:url) { "#{prefix}/api/v1/courses/#{course}/assignments?search_term=#{title}" }
+
+  context "with existing assignment" do
+    let(:status)  { 200 }
+    let(:fix)     { "assignment" }
+    let(:title)   { "some assignment" }
+
+    it "produces the correct id" do
+      expect(output).to eq("<p>4</p>\n");
+    end
+  end
+
+  context "with non-existing component" do
+    context "course does not exist" do
+      let(:output) do
+        doc.data['title'] = "#{title}"
+        doc.site.config['canvas']['course'] = course
+        doc.content = content
+        doc.output  = Jekyll::Renderer.new(doc.site, doc).run
+      end
+
+      let(:course) { "0123456789" }
+      let(:status) { 404 }
+      let(:fix)    { "doesnotexist" }
+      let(:title)  { "some assignment" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(Footrest::HttpError::NotFound)
+      end
+    end
+
+    context "assignment does not exist" do
+      let(:status) { 404 }
+      let(:fix)    { "doesnotexist" }
+      let(:title)  { "invalid assignment" }
+
+      it "raises an error" do
+        expect(-> { output }).to raise_error(Footrest::HttpError::NotFound)
+      end
+    end
+  end
+end