kurki 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a30102744bcc5b5daec6421831454dcaf80aa731
-  data.tar.gz: ce94b77b00a206fcd274da51ae924f473644194c
+  metadata.gz: ead63983b995b93ce4704249d06579fe9fe03df3
+  data.tar.gz: 63c6cae4d423d7fe15a1887b1f1ee1c28f031739
 SHA512:
-  metadata.gz: b6049b9b6ec060cc7ea59cddb97c1b7a0821ce2fb84a514a817561daf718ba40d5c7d32999328b63f46e2ca9e7e02eb51393cc03b0ad679b96aadd2226b714ed
-  data.tar.gz: 9d8750a54d873198e62699391f0ccbeb70b3e1c2befa1e325553b006d47709eb8576c64c7df1ac5104eec482c329f082c3504a2928f11c53829992a810bef6f2
+  metadata.gz: 0670108ce07b761db746ecd550bc383b58acc90e4c6985925fc68e00823250bcf61c674be9e754cf624bc4cfefcc66983104721eca89824ef9b61a769f3d49b0
+  data.tar.gz: f3598f0e3b4c3a8d944c865e28163cc7fdaa0df1a80e37c6c8d09dfdbf444a3a73e66c58820ec720e482ee60d2410ec732119c105194cc8f3742568dbfb1993a

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - "2.2.0"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/README.md

@@ -1,4 +1,4 @@
-# Kurki
+# 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)
 
 Helsinki University Kurki system API Rubygem.
 
@@ -8,6 +8,11 @@ Currently supports GET requests to:
 * Fetch a single course based on ID
 * Fetch all students of a single course
 
+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
 
 ## Installation
@@ -28,21 +33,45 @@ Or install it yourself as:
 
 ## Usage
 
+### GET methods
+
 ```ruby
-Kurki.get_courses
+irb(main):002:0> Kurki.url = "http://localhost:1234"
+=> "http://localhost:1234"
+irb(main):003:0> Kurki.url
+=> "http://localhost:1234/"
 ```
 
 ```ruby
-Kurki.get_course(id)
+irb(main):002:0> Kurki.get_courses
+=> [{"kurssikoodi"=>"581259", "lukuvuosi"=>2012, "lukukausi"=>"K", "tyyppi"=>"K", "tila"=>"J", "kurssi_nro"=>1, "nimi"=>"Ohjelmistotuotanto", "alkamis_pvm"=>"2012-03-12 00:00:00 +0300", "paattymis_pvm"=>"2016-04-30 00:00:00 +0300", "url"=>"localhost:1234/courses/581259.2012.K.K.1"}, {"kurssikoodi"=>"58131", "lukuvuosi"=>2010, "lukukausi"=>"K", "tyyppi"=>"K", "tila"=>"J", "kurssi_nro"=>1, "nimi"=>"Tietorakenteet", "alkamis_pvm"=>"2010-01-19 00:00:00 +0300", "paattymis_pvm"=>"2016-04-30 00:00:00 +0300", "url"=>"localhost:1234/courses/58131.2010.K.K.1"}, {"kurssikoodi"=>"58131", "lukuvuosi"=>2011, "lukukausi"=>"K", "tyyppi"=>"K", "tila"=>"J", "kurssi_nro"=>1, "nimi"=>"Tietorakenteet", "alkamis_pvm"=>"2011-01-17 00:00:00 +0300", "paattymis_pvm"=>"2016-04-30 00:00:00 +0300", "url"=>"localhost:1234/courses/58131.2011.K.K.1"}]
+```
+
+```ruby
+irb(main):003:0> Kurki.get_course("581259.2012.K.K.1")
+=> {"kurssikoodi"=>"581259", "lukuvuosi"=>2012, "lukukausi"=>"K", "tyyppi"=>"K", "kurssi_nro"=>1, "alkamis_pvm"=>"2012-03-12 00:00:00 +0300", "paattymis_pvm"=>"2016-04-30 00:00:00 +0300", "omistaja"=>"LUUKKAINEN_M"}
+```
+
+```ruby
+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
+
+```ruby
+irb(main):008:0> Kurki.set_students("58131.2010.K.K.1", ["012345678"])
+=>  {"success"=>[{"id"=>"012345678"}], "error"=>[]}
 ```
 
 ```ruby
-Kurki.get_students(course_id)
+irb(main):006:0> Kurki.set_grades("58131.2011.K.K.1", {"013595141" => "5"})
+=> {"success"=>[{"id"=>"013595141", "arvosana"=>"5"}], "error"=>[]}
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/kurki/fork )
+1. Fork it ( https://github.com/coolnesss/kurki/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/kurki.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "codeclimate-test-reporter"
+
   spec.add_runtime_dependency 'rest-client'
 
 end

data/lib/kurki/version.rb

@@ -1,3 +1,3 @@
 module Kurki
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/kurki.rb

@@ -26,10 +26,40 @@ module Kurki
     get(url + "courses/#{id}").first
   end
 
+  # Student_ids in form ["12345678", "12345678"]
+  def self.set_students(course_id, student_ids)
+    post(@@url + "courses/#{course_id}/students", parse_students(student_ids))
+  end
+
+  # Grades in form {"01234567": "3", "01243483": "4"}
+  def self.set_grades(course_id, grades)
+    post(@@url + "courses/#{course_id}/students", parse_grades(grades))
+  end
+
   private
 
+    def self.parse_students(student_ids)
+      parse(student_ids, lambda { |x| {"id": x} })
+    end
+
+    def self.parse_grades(grades)
+      parse(grades, lambda {|x,y| { "id": x, "arvosana": y } })
+    end
+
+    def self.parse(items, exp)
+      json = {}
+      json["students"] = items.map(&exp)
+      json
+    end
+
+    def self.post(address, data, params = {})
+      return unless data
+      params[:authorization] = ENV["KURKI_TOKEN"]
+      JSON.parse(RestClient.post address, data.to_json, params: params, content_type: :json, accept: :json)
+    end
+
     def self.get(address, params = {})
       params[:authorization] = ENV["KURKI_TOKEN"]
-      JSON.parse(RestClient.get(address, { params: params, accept: :json, content_type: :json }))
+      JSON.parse(RestClient.get address, { params: params, accept: :json, content_type: :json })
     end
 end

data/spec/kurki_spec.rb

@@ -19,35 +19,81 @@ describe Kurki do
       with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
         to_return(:status => 200, :body => IO.read("spec/fixtures/students.json"), :headers => {})
 
-  end
+    stub_request(:post, /.*581259.2012.K.K.1\/students.*/).
+         with(:body => "{\"students\":[{\"id\":\"012345678\"},{\"id\":\"01293492\"}]}",
+              :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Length'=>'51', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+                to_return(:status => 200, :body => "{\"success\":[{\"id\":\"012345678\"},{\"id\":\"01293492\"}],\"error\":[]}", :headers => {})
 
-  it "allows setting of url" do
-    Kurki.url = "test/"
-    expect(Kurki.url).to eq("test/")
-  end
+    stub_request(:post, /.*581259.2012.K.K.1\/students.*/).
+         with(:body => "{\"students\":[{\"id\":\"012345678\",\"arvosana\":\"4\"}]}",
+              :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Length'=>'48', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+                to_return(:status => 200, :body => "{\"success\":[{\"id\":\"012345678\",\"arvosana\":\"4\"}],\"error\":[]}", :headers => {})
 
-  it "setting an url without a backslash adds it" do
-    Kurki.url = "test"
-    expect(Kurki.url).to eq("test/")
   end
 
-  it "default url works" do
-    expect(Kurki.url).not_to be_nil
-  end
+  describe "GET" do
 
-  it 'can GET the curses index' do
-    courses = Kurki.get_courses
-    expect(courses.first["kurssikoodi"]).to eq("581259")
-    expect(courses.last["kurssikoodi"]).to eq("58131")
-  end
+    it "allows setting of url" do
+      Kurki.url = "test/"
+      expect(Kurki.url).to eq("test/")
+    end
+
+    it "setting an url without a backslash adds it" do
+      Kurki.url = "test"
+      expect(Kurki.url).to eq("test/")
+    end
+
+    it "default url works" do
+      expect(Kurki.url).not_to be_nil
+    end
+
+    it 'can GET the curses index' do
+      courses = Kurki.get_courses
+      expect(courses.first["kurssikoodi"]).to eq("581259")
+      expect(courses.last["kurssikoodi"]).to eq("58131")
+    end
+
+    it 'can GET the a single course by id' do
+      course = Kurki.get_course("581259.2012.K.K.1")
+      expect(course["kurssikoodi"]).to eq("581259")
+    end
+
+    it 'can get GET students of a course' do
+      students = Kurki.get_students("581259.2012.K.K.1")
+      expect(students.first["arvosana"]).to eq("3")
+    end
 
-  it 'can GET the a single course by id' do
-    course = Kurki.get_course("581259.2012.K.K.1")
-    expect(course["kurssikoodi"]).to eq("581259")
   end
 
-  it 'can get GET students of a course' do
-    students = Kurki.get_students("581259.2012.K.K.1")
-    expect(students.first["arvosana"]).to eq("3")
+  describe "POST" do
+
+    it "can parse student array correctly" do
+      hash = Kurki.parse_students(["01293492","18239123","812383172"])
+      expect(hash).to have_key("students")
+      expect(hash["students"].size).to eq(3)
+      expect(hash["students"].first).to eq({"id": "01293492"})
+    end
+
+    it "can parse grades array correctly" do
+      hash = Kurki.parse_grades({"01293492" => "3","18239123" => "4","812383172" => "1"})
+      expect(hash).to have_key("students")
+      expect(hash["students"].size).to eq 3
+      expect(hash["students"].is_a? Array)
+      expect(hash["students"].first).to eq({id:"01293492", "arvosana": "3"})
+    end
+
+    it "can POST students to a course" do
+      students = ["012345678", "01293492"]
+      ans = Kurki.set_students("581259.2012.K.K.1", students)
+      expect(ans).to eq(
+        JSON.parse("{\"success\":[{\"id\":\"012345678\"},{\"id\":\"01293492\"}],\"error\":[]}"))
+    end
+
+    it "can POST grades to a course" do
+      grades = {"012345678" => "4"}
+      ans = Kurki.set_grades("581259.2012.K.K.1", grades)
+      expect(ans).to eq(
+        JSON.parse("{\"success\":[{\"id\":\"012345678\",\"arvosana\":\"4\"}],\"error\":[]}"))
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 require 'webmock/rspec'
-
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 Bundler.setup
 
 require 'kurki' # and any other gems you need

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kurki
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Chang Rajani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
@@ -89,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md