kobra_client 0.0.3 → 0.0.4

data/README.MD

@@ -1,4 +1,48 @@
-KOBRA Client
+KOBRA Ruby Client [![Tested with Travis-CI](https://secure.travis-ci.org/LinTek/kobra_client.png)](http://travis-ci.org/#!/LinTek/kobra_client)
 ============
 
-Simple client for KOBRA.
+Simple client for KOBRA.
+
+## Requirments
+
+* Ruby 1.9.2: kobra_client is only tested with Ruby 1.9.2, no garantees for other versions of Ruby.
+
+## Install
+
+Install via RubyGems
+
+    gem install kobra_client
+
+## Source
+
+The source for kobra_client is available on Github:
+
+    https://github.com/LinTek/kobra_client
+
+### Development
+
+kobra_client uses rspec and webmock for testing, do a `bundle install` for all the development requirements.
+
+## Usage
+
+kobra_client is a client to the KOBRA service at LiU (Linköpings Universitet).
+A KOBRA account is needed to use this client.
+
+### Initiate and authenticate
+
+Get the username and API-key from your KOBRA account and use to authenticate the client.
+
+    require 'kobra/client'
+    kobra = Kobra::Client.new(:username => 'jage', :api_key => 'a9b8c7')
+    # => #<Kobra::Client:0x00000101175898 @base_url="https://jage:a9b8c7@kobra.ks.liu.se/">
+
+When we have the `kobra` instance, we can use the API.
+
+### Lookup a LiU student
+
+    kobra.get_student(:liu_id => 'johdoXXX')
+    => {:blocked=>nil, :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"}
+
+## Copyright
+
+Copyright (c) 2011 Johan Eckerström. See LICENSE for details.

data/lib/kobra/client.rb

@@ -13,7 +13,7 @@ module Kobra
     # 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]}/"
+      @base_url = "https://#{settings[:username]}:#{settings[:api_key]}@#{settings[:domain]}/"
     end
 
     # get_student(:liu_id => 'johec890')

data/spec/kobra_client_spec.rb

@@ -4,7 +4,7 @@ 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").
+      stub_request(:post, "https://john:a9b8c7@kobra.ks.liu.se/students/api.json").
         with(:body => "email=johdoXXX%40student.liu.se").
         to_return(fixture('student_found.txt'))
 
@@ -23,7 +23,7 @@ describe Kobra::Client do
     end
 
     it 'fails to obtain student information by email' do
-      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+      stub_request(:post, "https://john:a9b8c7@kobra.ks.liu.se/students/api.json").
         with(:body => "email=johdoXXX%40student.liu.se").
         to_return(fixture('student_not_found.txt'))
 
@@ -32,7 +32,7 @@ describe Kobra::Client do
     end
 
     it 'fails to authorize' do
-      stub_request(:post, "http://john:wrong@kobra.ks.liu.se/students/api.json").
+      stub_request(:post, "https://john:wrong@kobra.ks.liu.se/students/api.json").
         with(:body => "email=johdoXXX%40student.liu.se").
         to_return(fixture('auth_failure.txt'))
 
@@ -41,7 +41,7 @@ describe Kobra::Client do
     end
 
     it 'gets garbage' do
-      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+      stub_request(:post, "https://john:a9b8c7@kobra.ks.liu.se/students/api.json").
         with(:body => "email=johdoXXX%40student.liu.se").
         to_return(fixture('garbage.txt'))
 
@@ -50,7 +50,7 @@ describe Kobra::Client do
     end
 
     it 'gets server error' do
-      stub_request(:post, "http://john:a9b8c7@kobra.ks.liu.se/students/api.json").
+      stub_request(:post, "https://john:a9b8c7@kobra.ks.liu.se/students/api.json").
         with(:body => "email=johdoXXX%40student.liu.se").
         to_return(fixture('server_error.txt'))
 

metadata

@@ -2,7 +2,7 @@
 name: kobra_client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Johan Eckerstroem
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-21 00:00:00 +02:00
-default_executable: 
+date: 2011-09-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json_pure
@@ -86,8 +85,7 @@ files:
 - spec/kobra_client_spec.rb
 - spec/spec_helper.rb
 - README.MD
-has_rdoc: true
-homepage: http://kobra.ks.liu.se/
+homepage: https://kobra.ks.liu.se/
 licenses: []
 
 post_install_message: 
@@ -110,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Client library for KOBRA.