kobra_client 0.0.1

data/README.MD

@@ -0,0 +1,4 @@
+KOBRA Client
+============
+
+Simple client for KOBRA.

data/lib/kobra/client.rb

@@ -0,0 +1,46 @@
+require 'json/pure'
+require 'open-uri'
+require 'rest_client'
+
+module Kobra
+  class Client
+
+    class BadResponse < RuntimeError; end
+    class NotFound < RuntimeError; end
+    class AuthError < RuntimeError; end
+    class ServerError < RuntimeError; end
+
+    # Kobra::Client.new(:domain => "kobra.ks.liu.se", :username => "john", :api_key => "a3h93hu393")
+    def initialize(settings = {})
+      settings[:domain] ||= 'kobra.ks.liu.se'
+      @base_url = "http://#{settings[:username]}:#{settings[:api_key]}@#{settings[:domain]}/"
+    end
+
+    # get_student(:liu_id => 'johec890')
+    # Parameters: liu_id, email, personal_number, rfid_number, barcode_number
+    def get_student(parameters)
+      json_post('students/api.json', parameters)
+    end
+
+    private
+
+    # Posts to path with parameters, returns JSON with symbols
+    def json_post(path, parameters = {})
+      # Make sure parameters is a Hash
+      parameters = {}.merge(parameters)
+      url = @base_url + path
+
+      response = RestClient.post(url, parameters)
+
+      JSON.parse(response.body, :symbolize_names => true)
+    rescue JSON::ParserError
+      raise BadResponse, "Can't parse JSON"
+    rescue RestClient::ResourceNotFound
+      raise NotFound, "Resource not found"
+    rescue RestClient::Unauthorized
+      raise AuthError, "Authentification failed"
+    rescue RestClient::InternalServerError
+      raise ServerError, "Server error"
+    end
+  end
+end

data/spec/fixtures/auth_failure.txt

@@ -0,0 +1,12 @@
+HTTP/1.1 401 Unauthorized
+Date: Wed, 15 Jun 2011 14:24:56 GMT
+Status: 401 Unauthorized
+WWW-Authenticate: Basic realm="Application"
+Content-Type: text/html; charset=utf-8
+Cache-Control: no-cache
+X-UA-Compatible: IE=Edge,chrome=1
+X-Runtime: 0.005396
+Via: 1.1 kobra.ks.liu.se
+Transfer-Encoding: chunked
+
+HTTP Basic: Access denied.

data/spec/fixtures/garbage.txt

@@ -0,0 +1,10 @@
+HTTP/1.1 200 OK
+Date: Wed, 15 Jun 2011 09:57:52 GMT
+Status: 200 OK
+Content-Type: application/json; charset=utf-8
+ETag: "115ea511d19e8f40b9fbbb47b5a2bc0f"
+Cache-Control: max-age=0, private, must-revalidate
+Via: 1.1 kobra.ks.liu.se
+Transfer-Encoding: chunked
+
+ocked":null,"last_name":"DOE","email":"johdoXXX@student.liu.se","first_name":"JOHN","personal_number":"887711-0011","rfid_number":"9999999999","barcode_number":"888888888888888","union":"LinTek","liu_id:"johdoXXX"}

data/spec/fixtures/server_error.txt

@@ -0,0 +1,8 @@
+HTTP/1.1 500 Internal Server Error 
+Server: nginx/0.8.53
+Date: Wed, 15 Jun 2011 14:38:47 GMT
+Content-Type: text/html
+Connection: keep-alive
+Keep-Alive: timeout=20
+Content-Length: 27213
+

data/spec/fixtures/student_found.txt

@@ -0,0 +1,10 @@
+HTTP/1.1 200 OK
+Date: Wed, 15 Jun 2011 09:57:52 GMT
+Status: 200 OK
+Content-Type: application/json; charset=utf-8
+ETag: "115ea511d19e8f40b9fbbb47b5a2bc0f"
+Cache-Control: max-age=0, private, must-revalidate
+Via: 1.1 kobra.ks.liu.se
+Transfer-Encoding: chunked
+
+{"blocked":null,"last_name":"DOE","email":"johdoXXX@student.liu.se","first_name":"JOHN","personal_number":"887711-0011","rfid_number":"9999999999","barcode_number":"888888888888888","union":"LinTek","liu_id":"johdoXXX"}

data/spec/fixtures/student_not_found.txt

@@ -0,0 +1,10 @@
+HTTP/1.1 404 Not Found
+Date: Wed, 15 Jun 2011 14:25:31 GMT
+Status: 404 Not Found
+Content-Type: text/html; charset=utf-8
+Cache-Control: no-cache
+X-UA-Compatible: IE=Edge,chrome=1
+X-Runtime: 0.051747
+Via: 1.1 kobra.ks.liu.se
+Transfer-Encoding: chunked
+

data/spec/kobra_client_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'kobra/client'
+
+describe Kobra::Client do
+  describe '#get_student' do
+    it 'obtains student information by email' do
+      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+        with(:body => "email=johdoXXX%40student.liu.se").
+        to_return(fixture('student_found.txt'))
+
+      kobra = Kobra::Client.new(:username => 'john', :api_key => 'a9b8c7')
+      student = kobra.get_student(:email => 'johdoXXX@student.liu.se')
+
+      student[:email].should           == 'johdoXXX@student.liu.se'
+      student[:liu_id].should          == 'johdoXXX'
+      student[:rfid_number].should     == '9999999999'
+      student[:first_name].should      == 'JOHN'
+      student[:last_name].should       == 'DOE'
+      student[:blocked].should         == nil
+      student[:barcode_number].should  == '888888888888888'
+      student[:union].should           == 'LinTek'
+      student[:personal_number].should == '887711-0011'
+    end
+
+    it 'fails to obtain student information by email' do
+      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+        with(:body => "email=johdoXXX%40student.liu.se").
+        to_return(fixture('student_not_found.txt'))
+
+      kobra = Kobra::Client.new(:username => 'john', :api_key => 'a9b8c7')
+      expect { kobra.get_student(:email => 'johdoXXX@student.liu.se') }.to raise_error Kobra::Client::NotFound
+    end
+
+    it 'fails to authorize' do
+      stub_request(:post, "http://john:wrong@kobra.ks.liu.se/students/api.json").
+        with(:body => "email=johdoXXX%40student.liu.se").
+        to_return(fixture('auth_failure.txt'))
+
+      kobra = Kobra::Client.new(:username => 'john', :api_key => 'wrong')
+      expect { kobra.get_student(:email => 'johdoXXX@student.liu.se') }.to raise_error Kobra::Client::AuthError
+    end
+
+    it 'gets garbage' do
+      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+        with(:body => "email=johdoXXX%40student.liu.se").
+        to_return(fixture('garbage.txt'))
+
+      kobra = Kobra::Client.new(:username => 'john', :api_key => 'a9b8c7')
+      expect { kobra.get_student(:email => 'johdoXXX@student.liu.se') }.to raise_error Kobra::Client::BadResponse
+    end
+
+    it 'gets server error' do
+      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+        with(:body => "email=johdoXXX%40student.liu.se").
+        to_return(fixture('server_error.txt'))
+
+      kobra = Kobra::Client.new(:username => 'john', :api_key => 'a9b8c7')
+      expect { kobra.get_student(:email => 'johdoXXX@student.liu.se') }.to raise_error Kobra::Client::ServerError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'webmock/rspec'
+
+def fixture_path
+  File.expand_path(File.join('..', 'fixtures'), __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, file))
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: kobra_client
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Johan Eckerstroem
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Used for access to KOBRA, API-account needed
+email: johan@duh.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.MD
+files: 
+- lib/kobra/client.rb
+- spec/fixtures/auth_failure.txt
+- spec/fixtures/garbage.txt
+- spec/fixtures/server_error.txt
+- spec/fixtures/student_found.txt
+- spec/fixtures/student_not_found.txt
+- spec/kobra_client_spec.rb
+- spec/spec_helper.rb
+- README.MD
+has_rdoc: true
+homepage: http://kobra.ks.liu.se/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Client library for KOBRA.
+test_files: []
+