kurki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a30102744bcc5b5daec6421831454dcaf80aa731
+  data.tar.gz: ce94b77b00a206fcd274da51ae924f473644194c
+SHA512:
+  metadata.gz: b6049b9b6ec060cc7ea59cddb97c1b7a0821ce2fb84a514a817561daf718ba40d5c7d32999328b63f46e2ca9e7e02eb51393cc03b0ad679b96aadd2226b714ed
+  data.tar.gz: 9d8750a54d873198e62699391f0ccbeb70b3e1c2befa1e325553b006d47709eb8576c64c7df1ac5104eec482c329f082c3504a2928f11c53829992a810bef6f2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kurki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Chang
+
+MIT License
+
+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,49 @@
+# Kurki
+
+Helsinki University Kurki system API Rubygem.
+
+Currently supports GET requests to:
+
+* Fetch all courses
+* Fetch a single course based on ID
+* Fetch all students of a single course
+
+Requires API token set in environment variable named KURKI_TOKEN
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kurki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kurki
+
+## Usage
+
+```ruby
+Kurki.get_courses
+```
+
+```ruby
+Kurki.get_course(id)
+```
+
+```ruby
+Kurki.get_students(course_id)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/kurki.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kurki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kurki"
+  spec.version       = Kurki::VERSION
+  spec.authors       = ["Chang Rajani"]
+  spec.email         = ["chra@cs.helsinki.fi"]
+  spec.summary       = %q{Helsinki University Kurki system API}
+  spec.description   = %q{Support for students and teachers}
+  spec.homepage      = "http://kurki.cs.helsinki.fi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_runtime_dependency 'rest-client'
+
+end

data/lib/kurki/version.rb

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

data/lib/kurki.rb

@@ -0,0 +1,35 @@
+require "kurki/version"
+require 'rest-client'
+
+module Kurki
+  @@url = "http://svm-23.cs.helsinki.fi:4567/"
+
+  def self.url=(url)
+    @@url = url
+    @@url += "/" if (url[-1, 1] != '/')
+  end
+
+  def self.url
+    @@url
+  end
+
+  def self.get_courses
+    get(url + "courses")
+  end
+
+  def self.get_students(course_id)
+    get(url + "courses/#{course_id}/students")
+  end
+
+  def self.get_course(id)
+    # First because API returns array with one element
+    get(url + "courses/#{id}").first
+  end
+
+  private
+
+    def self.get(address, params = {})
+      params[:authorization] = ENV["KURKI_TOKEN"]
+      JSON.parse(RestClient.get(address, { params: params, accept: :json, content_type: :json }))
+    end
+end

data/spec/fixtures/course.json

@@ -0,0 +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"}]

data/spec/fixtures/courses.json

@@ -0,0 +1 @@
+[{"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"}]

data/spec/fixtures/students.json

@@ -0,0 +1 @@
+[{"arvosana":"3","etunimi":"LAURA M A","sukunimi":"PESOLA","id":"123456789"},{"arvosana":"5","etunimi":"TERO V E","sukunimi":"NURMILUOTO","id":"123456789"},{"arvosana":"5","etunimi":"KENNY S","sukunimi":"HEINONEN","id":"123456789"},{"arvosana":"5","etunimi":"JUHO P","sukunimi":"KALLIO","id":"123456789"},{"arvosana":"5","etunimi":"JULIUS E","sukunimi":"RAIHA","id":"123456789"},{"arvosana":"5","etunimi":"EETU V V","sukunimi":"KOMSI","id":"123456789"},{"arvosana":"4","etunimi":"JARL-ERIK","sukunimi":"MALMSTROM","id":"123456789"},{"arvosana":"1","etunimi":"HENRI V P","sukunimi":"KARHU","id":"123456789"},{"arvosana":"1","etunimi":"PESSI J","sukunimi":"MOILANEN","id":"123456789"},{"arvosana":"3","etunimi":"HANNA M","sukunimi":"HIRVONEN","id":"123456789"},{"arvosana":"5","etunimi":"J KASPER","sukunimi":"HIRVIKOSKI","id":"123456789"},{"arvosana":"5","etunimi":"LAURI K J","sukunimi":"SAVOLAINEN","id":"123456789"},{"arvosana":"5","etunimi":"SAMI V","sukunimi":"KOSKINEN","id":"123456789"},{"arvosana":"2","etunimi":"NIKO E J","sukunimi":"ERONEN","id":"123456789"},{"arvosana":null,"etunimi":"MIKKO K","sukunimi":"LEHTINEN","id":"123456789"},{"arvosana":"3","etunimi":"HENRI K","sukunimi":"YLIKOTILA","id":"123456789"},{"arvosana":"5","etunimi":"HEIKKI J","sukunimi":"HOLOPAINEN","id":"123456789"},{"arvosana":"3","etunimi":"KAVAN","sukunimi":"SOLEIMANBEIGI","id":"123456789"},{"arvosana":null,"etunimi":"ANNA E","sukunimi":"HIETANEN","id":"123456789"},{"arvosana":"4","etunimi":"TONI O A","sukunimi":"KONNILA","id":"123456789"},{"arvosana":"4","etunimi":"MATHIAS A","sukunimi":"KEUS","id":"123456789"},{"arvosana":"2","etunimi":"JOONAS K","sukunimi":"MAGNUSSON","id":"123456789"},{"arvosana":"4","etunimi":"TUUKKA S","sukunimi":"YLONEN","id":"123456789"},{"arvosana":"1","etunimi":"MATTI T","sukunimi":"TAHVANAINEN","id":"123456789"},{"arvosana":"3","etunimi":"JUHO-E A","sukunimi":"GAVERT","id":"123456789"},{"arvosana":"1","etunimi":"VILLE P","sukunimi":"KUKKOLA","id":"123456789"},{"arvosana":"4","etunimi":"TOMMI T","sukunimi":"JALKANEN","id":"123456789"},{"arvosana":"4","etunimi":"OLLI-PEKKA","sukunimi":"HARKONSALO","id":"123456789"},{"arvosana":"2","etunimi":"VALTTER H J","sukunimi":"TAIPALE","id":"123456789"},{"arvosana":null,"etunimi":"AKI J","sukunimi":"KESULAHTI","id":"123456789"},{"arvosana":"4","etunimi":"ANTTI J","sukunimi":"MYYRA","id":"123456789"},{"arvosana":"5","etunimi":"PAUL H A","sukunimi":"SAIKKO","id":"123456789"},{"arvosana":"2","etunimi":"JESSE H","sukunimi":"SIPOLA","id":"123456789"},{"arvosana":null,"etunimi":"EKI H","sukunimi":"YLIKOSKI","id":"123456789"},{"arvosana":"3","etunimi":"JARI M J","sukunimi":"KOSKINEN","id":"123456789"},{"arvosana":null,"etunimi":"JASSE M A","sukunimi":"WISTRAND","id":"123456789"},{"arvosana":"3","etunimi":"CAROLINA J E","sukunimi":"LINDQVIST","id":"123456789"},{"arvosana":"4","etunimi":"EMMI M","sukunimi":"OTAVA","id":"123456789"},{"arvosana":"5","etunimi":"TITTI M K","sukunimi":"MALMIVIRTA","id":"123456789"},{"arvosana":"3","etunimi":"HERKKO J","sukunimi":"VIROLAINEN","id":"123456789"},{"arvosana":"4","etunimi":"TOMI M","sukunimi":"SIMSIO","id":"123456789"},{"arvosana":"4","etunimi":"TOMI S","sukunimi":"HILTUNEN","id":"123456789"},{"arvosana":"4","etunimi":"ERNO A","sukunimi":"HOPEARUOHO","id":"123456789"},{"arvosana":"3","etunimi":"LAURI M","sukunimi":"PULKKINEN","id":"123456789"},{"arvosana":"2","etunimi":"TIMO O","sukunimi":"PITKANEN","id":"123456789"},{"arvosana":"2","etunimi":"TARU K","sukunimi":"AIROLA","id":"123456789"},{"arvosana":"4","etunimi":"MARKUS K","sukunimi":"KOSKI","id":"123456789"},{"arvosana":"1","etunimi":"MIKKO K","sukunimi":"KOHO","id":"123456789"},{"arvosana":"3","etunimi":"KARI K","sukunimi":"KORPINEN","id":"123456789"},{"arvosana":"5","etunimi":"OLLI O","sukunimi":"RISSANEN","id":"123456789"},{"arvosana":"4","etunimi":"DARIA","sukunimi":"ANTONOVA","id":"123456789"},{"arvosana":"2","etunimi":"ATTE E","sukunimi":"AALTONEN","id":"123456789"},{"arvosana":"5","etunimi":"JUKKA T","sukunimi":"KOSKELIN","id":"123456789"},{"arvosana":"2","etunimi":"HANNU S","sukunimi":"PAIVEROINEN","id":"123456789"},{"arvosana":"1","etunimi":"ANNI K","sukunimi":"HAUTALA","id":"123456789"},{"arvosana":"5","etunimi":"TERO A","sukunimi":"HUOMO","id":"123456789"},{"arvosana":"4","etunimi":"ANIS","sukunimi":"MOUBARIK","id":"123456789"},{"arvosana":"4","etunimi":"IRINA M A","sukunimi":"MAKIPAJA","id":"123456789"},{"arvosana":"1","etunimi":"VILLE P","sukunimi":"SIIVOLA","id":"123456789"},{"arvosana":"1","etunimi":"TOPI J","sukunimi":"SARKKINEN","id":"123456789"},{"arvosana":"1","etunimi":"NIKO K","sukunimi":"LAITINEN","id":"123456789"},{"arvosana":"2","etunimi":"PANU P","sukunimi":"KLEMOLA","id":"123456789"},{"arvosana":"3","etunimi":"SAMIR P","sukunimi":"PUUSKA","id":"123456789"},{"arvosana":"5","etunimi":"TONY E J","sukunimi":"KOVANEN","id":"123456789"},{"arvosana":"5","etunimi":"EEVA A","sukunimi":"TERKKI","id":"123456789"},{"arvosana":"3","etunimi":"MIKKO K A","sukunimi":"NYLEN","id":"123456789"},{"arvosana":"3","etunimi":"XUEGANG","sukunimi":"CHAI","id":"123456789"},{"arvosana":null,"etunimi":"SAMPO T","sukunimi":"LAURILA","id":"123456789"},{"arvosana":null,"etunimi":"KALLE M K","sukunimi":"ALANEN","id":"123456789"},{"arvosana":null,"etunimi":"KARL H M","sukunimi":"KARLBERG","id":"123456789"},{"arvosana":"4","etunimi":"SAMU H A","sukunimi":"VUORINEN","id":"123456789"},{"arvosana":null,"etunimi":"ALEKSI J","sukunimi":"MAJANDER","id":"123456789"},{"arvosana":"5","etunimi":"JOOSA A S","sukunimi":"KURVINEN","id":"123456789"},{"arvosana":"0","etunimi":"RUBEN K O","sukunimi":"LAGUS","id":"123456789"},{"arvosana":"5","etunimi":"OTTO H","sukunimi":"WALLENIUS","id":"123456789"},{"arvosana":"0","etunimi":"VILLE T","sukunimi":"KNUUTTILA","id":"123456789"},{"arvosana":"3","etunimi":"JUKKA-PEKKA","sukunimi":"SALO","id":"123456789"},{"arvosana":"5","etunimi":"HANNA K","sukunimi":"ARPIAINEN","id":"123456789"},{"arvosana":"4","etunimi":"ILKKA A","sukunimi":"HAKKARAINEN","id":"123456789"},{"arvosana":"3","etunimi":"NIKO A","sukunimi":"AHONEN","id":"123456789"},{"arvosana":"5","etunimi":"ANNI M","sukunimi":"TUULINEN","id":"123456789"},{"arvosana":"3","etunimi":"LAURA M A","sukunimi":"PESOLA","id":"123456789"},{"arvosana":"5","etunimi":"JULIUS E","sukunimi":"RAIHA","id":"123456789"},{"arvosana":"5","etunimi":"EETU V V","sukunimi":"KOMSI","id":"123456789"},{"arvosana":"3","etunimi":"LAURA M A","sukunimi":"PESOLA","id":"123456789"},{"arvosana":"5","etunimi":"JULIUS E","sukunimi":"RAIHA","id":"123456789"},{"arvosana":"5","etunimi":"EETU V V","sukunimi":"KOMSI","id":"123456789"},{"arvosana":"3","etunimi":"LAURA M A","sukunimi":"PESOLA","id":"123456789"},{"arvosana":"5","etunimi":"JULIUS E","sukunimi":"RAIHA","id":"123456789"},{"arvosana":null,"etunimi":"SAMPO KUISMA ILARI","sukunimi":"LUUKKAINEN","id":"123456789"},{"arvosana":"1","etunimi":"ARTO O","sukunimi":"VIHAVAINEN","id":"123456789"},{"arvosana":"1","etunimi":"MATTI","sukunimi":"LUUKKAINEN","id":"123456789"},{"arvosana":null,"etunimi":"TUUKKA S","sukunimi":"NORRI","id":"123456789"}]

data/spec/kurki_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Kurki do
+
+  before :each do
+
+    Kurki.url = "http://example.com"
+    ENV["KURKI_TOKEN"] = "fake"
+
+    stub_request(:get, /.*courses.*/).
+      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/courses.json"), :headers => {})
+
+    stub_request(:get, /.*courses\/581259.2012.K.K.1/).
+      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/course.json"), :headers => {})
+
+    stub_request(:get, /.*courses\/581259.2012.K.K.1\/students.*/).
+      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
+
+  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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'webmock/rspec'
+
+Bundler.setup
+
+require 'kurki' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: kurki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chang Rajani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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
+    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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kurki.gemspec
+- lib/kurki.rb
+- lib/kurki/version.rb
+- spec/fixtures/course.json
+- spec/fixtures/courses.json
+- spec/fixtures/students.json
+- spec/kurki_spec.rb
+- spec/spec_helper.rb
+homepage: http://kurki.cs.helsinki.fi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Helsinki University Kurki system API
+test_files:
+- spec/fixtures/course.json
+- spec/fixtures/courses.json
+- spec/fixtures/students.json
+- spec/kurki_spec.rb
+- spec/spec_helper.rb