claw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a01d7797a095f7f3e01bc18ea036b5cabf7ba5740faa8d2314829c1eebf93554
+  data.tar.gz: 7f69f0503747146d07cdf3de5b4e0db7e9504374bb21d7cb51936ee4cd8ea77e
+SHA512:
+  metadata.gz: cf936c9d8dc51000a74ffe42ac530363a44f9d77e1422e46ef101611a4d796c681c6d04b64f6beb415344c433eec70a35c73ebd8a5b6af45bc8bd690ba71f17d
+  data.tar.gz: 3d4230a9e246a26357fc746a322cb898aea194996fd47ed9d18c9e4785fbae4eaf2a951353c569d1f961bf2fbb8fc90a27bfb048e88249ecca2ba366d5afeb45

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in claw.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    claw (0.1.0)
+      highlight
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    highlight (2.0.0)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  claw!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Neil Johari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Claw
+
+Welcome to Claw, a CLI for UofM teaching staff to help students more effectively.
+
+Claw downloads a student's latest [Autograder](https://autograder.io) submission locally and then prompts the instructor to run all AG tests locally along with the option to sync to CAEN.
+
+## Installation
+
+Run `gem install claw` in your command line.
+
+## Usage
+
+### Obtaining a Token
+
+> Log in to autograder.io in Chrome and open up the developer tools from the Chrome menu (View->Developer->Developer Tools on a Mac).
+> Click on a course link.
+> In the developer console, click on a request (e.g. my_roles/ or projects/). Under Request Headers, there is an Authorization entry that looks like "Token ".
+> Copy the hex string and save it to the file .agtoken in your home directory.
+> -- <cite>[autograder-contrib](https://github.com/eecs-autograder/autograder-contrib)</cite>
+
+### Setting Up a Solution Repository
+
+1. Clone a solution repository (like `eecs280staff/<solution repo>`) locally via `git clone`
+2. Ensure the solution repo Makefile has an `autograde` target (all EECS280 project repos do)
+3. Optionally add a `sync` target to the Makefile. This target should sync _the
+   entire_ solution repo to CAEN. An example target would be:
+
+```
+# Copy files to CAEN Linux
+sync :
+	rsync \
+  -rtv \
+  --delete \
+  --exclude '.git*' \
+  --filter=':- .gitignore' \
+  ./ \
+	<your uniqname here>@login.engin.umich.edu:ia-280-p3
+```
+
+### Running Claw
+
+In a solution repo, run `claw <project id> <student uniqname>`.
+
+You can determine the project id by navigating to the project on `autograder.io` and looking at the URL.
+For instance, in Fall 2020, EECS280's Euchre project was available at [https://autograder.io/web/project/721](https://autograder.io/web/project/721) which means the project id was `721`.
+
+This will download a json file containing all groups of students who have submitted to the Autograder (including those working alone) and then download the given student's latest solution into a directory `./<uniqname>/`.
+Subsequent runs will reuse the previously downloaded json file; you should delete this file periodically to keep your list of students up to date.
+
+Claw will then prompt to run all private autograder tests from the repo. It assumes the Makefile has an `autograde` target, and will dump the output to a file called `autograder.io`.
+
+Finally, Claw will prompt the user whether to upload to CAEN. It assumes the Makefile has a `sync` target.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neiljohari/claw.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "claw"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/claw.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/claw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "claw"
+  spec.version       = Claw::VERSION
+  spec.authors       = ["Neil Johari"]
+  spec.email         = ["neil@johari.tech"]
+
+  spec.summary       = %q{A tool for staff to quickly download student AG submissions}
+  spec.homepage      = "https://eecs280staff.github.io/eecs280.org/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/neiljohari/claw/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ['claw']
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'highlight'
+  spec.add_runtime_dependency 'httparty'
+end

data/exe/claw

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require 'claw'
+require 'fileutils'
+require 'English'
+require 'highline/import'
+
+def last_submission(submissions)
+  if submissions.empty?
+    warn 'No submissions for user'
+    exit
+  end
+  submissions[0].slice('pk', 'submitted_filenames')
+end
+
+if ARGV.length != 2
+  warn 'Usage: claw <project_id> <uniqname>'
+  exit
+end
+
+token_file_path = File.join(ENV['HOME'], '.agtoken')
+unless File.exist? token_file_path
+  warn %{
+    Log in to autograder.io in Chrome and open up the developer tools from the Chrome menu (View->Developer->Developer Tools on a Mac)
+
+    Click on a course link. In the developer console, click on a request (e.g. my_roles/ or projects/).
+
+    Under Request Headers, there is an Authorization entry that looks like "Token".
+
+    Copy the hex string and save it to the file .agtoken in your home directory.
+  }
+  exit
+end
+
+token = File.read(token_file_path)
+ag = Claw::Autograder.new(token)
+
+groupid = ag.get_group_id_from_uniqname(ARGV[0], "#{ARGV[1]}@umich.edu")
+unless groupid
+  warn %{
+    Group for student not found! Double check their uniqname.
+
+    It is also possible this person registered their group after Claw cached the groups in the json file.
+    Try deleting the json file and rerunning the command.
+  }
+  exit
+end
+
+ag.download_files(ARGV[1], last_submission(ag.submissions(groupid)))
+
+# Run tests
+if HighLine.agree('Run tests? [Y/N]')
+  # Update SOL=? in the Makefile
+  mkfile_path = File.join(Dir.pwd, 'Makefile')
+
+  unless File.exist? mkfile_path
+    warn 'Could not find Makefile. You should run this from within a project repo (such as eecs280staff/p3-euchre for example)'
+    exit
+  end
+
+  mklines = File.readlines(mkfile_path)
+  mklines[1] = "SOL ?= #{ARGV[1]}" << $INPUT_RECORD_SEPARATOR
+  File.open(mkfile_path, 'w') { |f| f.write(mklines.join) }
+
+  `make autograde > autograder.txt`
+  puts 'The student autograder output has been dumped to autograder.txt'
+end
+
+# Sync to CAEN
+if HighLine.agree('Upload to CAEN? [Y/N]')
+  `make sync`
+end

data/lib/claw.rb

@@ -0,0 +1,6 @@
+require 'claw/version'
+require 'claw/autograder'
+
+module Claw
+  class Error < StandardError; end
+end

data/lib/claw/autograder.rb

@@ -0,0 +1,64 @@
+require 'json'
+require 'httparty'
+
+module Claw
+  # Autograder HTTParty Client Wrapper
+  class Autograder
+    include HTTParty
+    base_uri 'autograder.io'
+
+    def initialize(token, query = {})
+      @options = {
+        headers: {
+          'Accept' => 'application/json, text/plain, */*',
+          'Authorization' => "Token #{token}",
+          'Cookie' => "token=#{token}"
+        },
+        query: query,
+        verify: false
+      }
+    end
+
+    def download_groups(projectid)
+      puts 'Downloading groups json file (this could take a while)...'
+      File.open(File.join(Dir.pwd, "project_#{projectid}_groups.json"), 'w') do |f|
+        f.write(self.class.get("/api/projects/#{projectid}/groups/", @options))
+      end
+    end
+
+    def get_group_id_from_uniqname(projectid, name)
+      puts 'Searching for user group id...'
+      download_groups(projectid) unless File.exist? "project_#{projectid}_groups.json"
+
+      groups_json = JSON.parse(File.read(File.join(Dir.pwd, "project_#{projectid}_groups.json")))
+
+      groups_json.each do |group|
+        return group['pk'] if group['member_names'].include?(name)
+      end
+
+      nil
+    end
+
+    def submissions(groupid)
+      puts 'Fetching group submissions...'
+      self.class.get("/api/groups/#{groupid}/submissions/", @options)
+    end
+
+    def download_files(dirname, submission)
+      puts 'Downloading submission files...'
+      FileUtils.mkdir_p(File.join(Dir.pwd, dirname))
+
+      submission['submitted_filenames'].each do |filename|
+        opt_merge = {
+          query: {
+            'filename' => filename
+          }
+        }
+
+        File.open(File.join(Dir.pwd, dirname, filename), 'w') do |f|
+          f.write(self.class.get("/api/submissions/#{submission['pk']}/file/", @options.merge(opt_merge)))
+        end
+      end
+    end
+  end
+end

data/lib/claw/version.rb

@@ -0,0 +1,3 @@
+module Claw
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: claw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil Johari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highlight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- neil@johari.tech
+executables:
+- claw
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- claw.gemspec
+- exe/claw
+- lib/claw.rb
+- lib/claw/autograder.rb
+- lib/claw/version.rb
+homepage: https://eecs280staff.github.io/eecs280.org/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://eecs280staff.github.io/eecs280.org/
+  source_code_uri: https://github.com/neiljohari/claw/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A tool for staff to quickly download student AG submissions
+test_files: []