kurki 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abd040581cb690dfd3754b687b345ac81834ff6d
-  data.tar.gz: bd94ac99b08ef5afa54d238e00d2db1fe81256dd
+  metadata.gz: db479d77a3a2d711264f9aefa65446bdd4ad9136
+  data.tar.gz: a04e7310befd0e261520818a21633d9187a766d1
 SHA512:
-  metadata.gz: b9925794efd6aedb7849cb04424c549ff50580069c8375a279b3c4e0ec2a5a9cd50ed450f83408415df3b9bc08a6426a7587688374db7f6975658fc64f422f07
-  data.tar.gz: 2f803a2196a3f3d0d2ee7c75af84123872e2dfc400a2e91105793246e4212171dc0c2230fdbcc5458ffe6f9c7185eef21b8cc377c495c3851e3cb766eb13adfa
+  metadata.gz: 4bc5a08affcd5280aa4b22ed5d5cd54b3ac27f345ba947d46a8026c826cd2732ad2188204b10cc8221a1dbf301f14ad2205bbce5047c74fd9ebc8f876fe03b8d
+  data.tar.gz: 7fd2b404a68472d513c4b7f6603e1302dbecd18e55aa1e7f3c95191803cb27946a638a013bc3506d1dd68a3635cbc67c9ff372aad73c3b6ae74bcc04e54532c9

data/README.md

@@ -1,4 +1,4 @@
-# Kurki [![Build Status](https://travis-ci.org/Coolnesss/kurki.svg?branch=master)](https://travis-ci.org/Coolnesss/kurki) [![Code Climate](https://codeclimate.com/github/Coolnesss/kurki/badges/gpa.svg)](https://codeclimate.com/github/Coolnesss/kurki) [![Test Coverage](https://codeclimate.com/github/Coolnesss/kurki/badges/coverage.svg)](https://codeclimate.com/github/Coolnesss/kurki/coverage)
+# Kurki [![Build Status](https://travis-ci.org/Coolnesss/kurki.svg?branch=master)](https://travis-ci.org/Coolnesss/kurki) [![Code Climate](https://codeclimate.com/github/Coolnesss/kurki/badges/gpa.svg)](https://codeclimate.com/github/Coolnesss/kurki) [![Test Coverage](https://codeclimate.com/github/Coolnesss/kurki/badges/coverage.svg)](https://codeclimate.com/github/Coolnesss/kurki/coverage) [![Gem Version](https://badge.fury.io/rb/kurki.svg)](https://badge.fury.io/rb/kurki)
 
 Helsinki University Kurki system API Rubygem.
 
@@ -13,7 +13,7 @@ And POST requests to:
 * Add students to a course
 * Add grades to students of a course
 
-Requires API token set in environment variable named KURKI_TOKEN
+Requires API token set in environment variable named KURKI_TOKEN and the API URL set in KURKI_URL.
 
 ## Installation
 
@@ -33,7 +33,15 @@ Or install it yourself as:
 
 ## Usage
 
-### GET methods
+### Command Line
+
+```bash
+$ kurki help
+```
+
+### Ruby methods
+
+#### GET methods
 
 ```ruby
 irb(main):002:0> Kurki.url = "http://localhost:1234"
@@ -57,7 +65,7 @@ irb(main):004:0> Kurki.get_students("581259.2012.K.K.1")
 => [{"arvosana"=>"3", "etunimi"=>"LASSE", "sukunimi"=>"TOIVONEN", "id"=>"012345678"}, {"arvosana"=>"5", "etunimi"=>"TERO V E", "sukunimi"=>"SANKARI", "id"=>"012435443"}]
 ```
 
-### POST methods
+#### POST methods
 
 ```ruby
 irb(main):008:0> Kurki.set_students("58131.2010.K.K.1", ["012345678"])

data/bin/kurki

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'kurki'
+require 'gli'
+require 'awesome_print'
+
+include GLI::App
+
+def print(stuff)
+  ap stuff, index: false
+end
+program_desc 'Helsinki University department of computer science Kurki command line client'
+
+#flag [:t,:tasklist], :default_value => File.join(ENV['HOME'],'.todolist')
+
+pre do |global_options,command,options,args|
+  raise "KURKI_URL or KURKI_TOKEN not set! Set them in environment variables." unless ENV["KURKI_TOKEN"] and ENV["KURKI_URL"]
+  true
+end
+
+desc 'List available courses'
+long_desc 'Lists all courses that are available for grading and manipulation on this account'
+
+command :courses do |c|
+  c.action do
+    print Kurki.get_courses
+  end
+end
+
+desc 'List students of course'
+long_desc 'Lists all students on a single course along with their grades. A valid course ID is required.'
+
+command :students do |c|
+  c.arg 'courseID'
+  c.action do |global_options,options,args|
+      help_now!('Course ID is required') if args.empty?
+      print Kurki.get_students(args.first)
+  end
+end
+
+desc 'Display information of a course'
+long_desc 'Displays course information such as its ID and start and end dates. A valid course ID is required.'
+
+command :course do |c|
+  c.arg 'courseID'
+  c.action do |global_options,options,args|
+    help_now!('Course ID is required') if args.empty?
+    print Kurki.get_course(args.first)
+  end
+end
+
+
+desc 'Set various course information, such as grades'
+
+command :set do |c|
+  c.desc 'Set grades for a course from a .csv file'
+  c.long_desc 'Use a .csv file to set grades for a course. The file should have two columns with headers, ' \
+    'the first one including the student IDs and the second the actual grades. You can specify the delimiter as the last parameter. '
+
+  c.arg 'courseID'
+  c.arg 'path'
+  c.arg 'delimiter', :optional
+
+  c.command :grades do |grades|
+    grades.action do |global_options, options, args|
+      help_now!('Course ID and path are required.') if args.size < 2
+      if (args.size == 3)
+        print Kurki.set_grades_from_csv args.first, args[1], args[2]
+      else
+        print Kurki.set_grades_from_csv args.first, args[1]
+      end
+    end
+  end
+end
+
+
+exit run(ARGV)

data/kurki.gemspec

@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "simplecov"
 
+  spec.add_runtime_dependency "gli"
   spec.add_runtime_dependency 'rest-client'
+  spec.add_runtime_dependency 'awesome_print'
+
 
 end

data/lib/kurki/version.rb

@@ -1,3 +1,3 @@
 module Kurki
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/kurki.rb

@@ -34,7 +34,7 @@ module Kurki
   end
 
   # .csv in two columns, with one header row
-  def self.set_grade_from_csv(course_id, file_path, delimiter=",")
+  def self.set_grades_from_csv(course_id, file_path, delimiter=",")
     grades = {}
     read_csv(file_path, delimiter).each do |result|
       grades[result[0]] = result[1]

data/spec/kurki_spec.rb

@@ -97,7 +97,7 @@ describe Kurki do
     end
 
     it "can POST grades from a CSV file" do
-      ans = Kurki.set_grade_from_csv("581259.2012.K.K.1", "spec/fixtures/grades.csv")
+      ans = Kurki.set_grades_from_csv("581259.2012.K.K.1", "spec/fixtures/grades.csv")
       expect(ans).to eq(
                           JSON.parse("{\"success\":[{\"id\":\"123123123\",\"arvosana\":\"3\"},
                           {\"id\":\"014475359\",\"arvosana\":\"5\"},

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kurki
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chang Rajani
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  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: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -109,10 +123,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: Support for students and teachers
 email:
 - chra@cs.helsinki.fi
-executables: []
+executables:
+- kurki
 extensions: []
 extra_rdoc_files: []
 files:
@@ -123,6 +152,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/kurki
 - kurki.gemspec
 - lib/kurki.rb
 - lib/kurki/version.rb