tuwien_logon 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Clemens Helm
+
+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.rdoc

@@ -0,0 +1,46 @@
+= tuwien_logon
+
+This gem is an authentication solution for ruby applications being used at the Vienna University of Technology.
+
+== Note
+
+You will only be able to use this gem for authentication if you have already registered your application at the ZID. Find more information at http://www.zid.tuwien.ac.at/sts/dateninfrastruktur/authentifizierungsservice/.
+Unfortunately this page is only provided in german though.
+
+== Usage
+
+For now only retrieving user information by their oid is implemented.
+
+    user = TuwienLogon::UserInfo.find_by_oid(1234567)
+    
+The following attributes can be accessed on success:
+
+    user.oid
+    user.firstname
+    user.lastname
+    user.title
+    user.matriculation_number
+    user.institute_symbol
+    
+You can change the name of these attributes in the configuration.
+
+== Configuration
+
+You can alter the following configuration options, here their default values are shown:
+
+    Tuwien.config.user_info_url     = 'https://iu.zid.tuwien.ac.at/AuthServ.userInfo'
+    Tuwien.config.user_info_params  = [:oid, :firstname, :lastname, :title, :matriculation_number, :institute_symbol]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Clemens Helm. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tuwien_logon"
+    gem.summary = %Q{Ruby client for Vienna UT authentication service}
+    gem.description = %Q{Provides an authentication solution for ruby applications being used at the Vienna University of Technology}
+    gem.email = "clemens.helm@gmail.com"
+    gem.homepage = "http://github.com/dropswap/tuwien_logon"
+    gem.authors = ["Clemens Helm"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tuwien_logon #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tuwien_logon/configuration.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+
+module TuwienLogon
+  class Configuration
+    include Singleton
+    
+    attr_accessor :authentication_url, :user_info_url, :secret, :user_info_params
+    
+    def initialize
+      @authentication_url = 'https://iu.zid.tuwien.ac.at/AuthServ.authenticate'
+      @user_info_url = 'https://iu.zid.tuwien.ac.at/AuthServ.userInfo'
+      @secret = '123456'
+      @user_info_params = [:oid, :firstname, :lastname, :title, :matriculation_number, :institute_symbol]
+    end
+  end
+end

data/lib/tuwien_logon/user_info.rb

@@ -0,0 +1,31 @@
+module TuwienLogon
+  class UserInfo
+    attr_accessor :params, :info
+    
+    class << self
+      def find_by_oid(oid)
+        request = TuwienLogon::UserInfoRequest.new
+        request.get_user_info :oid => oid
+      end
+    end
+    
+    def initialize(params = [])
+      @params = params
+      @info = {}
+    end
+    
+    def method_missing(param, *args)
+      if param.to_s[-1] == '='
+        setter = true
+        param = param.to_s[0..-2].to_sym
+      end
+      
+      if params.include? param
+        info[param] = args[0] if setter
+        info[param]
+      else
+        super(param, args);
+      end
+    end
+  end
+end

data/lib/tuwien_logon/user_info_request.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+require 'net/https'
+require 'tuwien_logon/user_info'
+
+module TuwienLogon
+  class UserInfoRequest
+    attr_accessor :url
+    
+    def initialize(url = TuwienLogon.config.user_info_url)
+      @url = URI.parse(url)
+    end
+    
+    def split_response(response)
+      response.strip.split("\t")
+    end
+    
+    def get_user_info(params = {})
+      create_user_info(get(params))
+    end
+    
+    def create_user_info(infos = [], params = TuwienLogon.config.user_info_params)
+      infos = split_response(infos.to_s) unless infos.is_a? Array
+        
+      userdata = TuwienLogon::UserInfo.new(params)
+      TuwienLogon.config.user_info_params.each_with_index do |param, index|
+        userdata.send("#{param}=".to_sym, infos[index]) unless infos[index].nil? || infos[index].empty?
+      end
+      userdata
+    end
+    
+    def get(params = {})
+      url.query = query_string(params)
+      Net::HTTP.get_response(url).body
+    end
+    
+    def query_string(params = {})
+      params.map { |key, value| "#{key}=#{value}" }.join('&')
+    end
+  end
+end

data/lib/tuwien_logon.rb

@@ -0,0 +1,10 @@
+require 'tuwien_logon/configuration'
+require 'tuwien_logon/user_info_request'
+
+module TuwienLogon
+  class << self
+    def config
+      TuwienLogon::Configuration.instance
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tuwien_logon'
+
+class Test::Unit::TestCase
+  def setup
+    TuwienLogon.config.authentication_url = 'http://localhost:4567/AuthServ.authenticate'
+    TuwienLogon.config.user_info_url = 'http://localhost:4567/AuthServ.userInfo'
+    TuwienLogon.config.secret = '123456'
+    TuwienLogon.config.user_info_params = [:oid, :firstname, :lastname, :title, :matriculation_number, :institute_symbol]
+  end
+end

data/test/test_tuwien_logon.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestTuwienLogon < Test::Unit::TestCase
+  should "set the authentication url correctly" do
+    url = 'abc'
+    TuwienLogon.config.authentication_url = url
+    assert_equal url, TuwienLogon.config.authentication_url
+  end
+  
+  should "set the user info url correctly" do
+    url = 'abc'
+    TuwienLogon.config.user_info_url = url
+    assert_equal url, TuwienLogon.config.user_info_url
+  end
+  
+  should "set the secret correctly" do
+    url = 'abc'
+    TuwienLogon.config.secret = url
+    assert_equal url, TuwienLogon.config.secret
+  end
+end

data/test/test_user_info.rb

@@ -0,0 +1,16 @@
+require 'helper'
+require 'tuwien_logon/user_info'
+
+class TestUserInfo < Test::Unit::TestCase
+  context "A user info object" do
+    should "find correct user info" do
+      info = TuwienLogon::UserInfo.find_by_oid(1231132)
+      assert_equal '1231132', info.oid
+      assert_equal 'Ernst', info.firstname
+      assert_equal 'Orwell', info.lastname
+      assert_nil info.title
+      assert_equal '0812345', info.matriculation_number
+      assert_nil info.institute_symbol
+    end
+  end
+end

data/test/test_user_info_request.rb

@@ -0,0 +1,52 @@
+require 'helper'
+require 'tuwien_logon/user_info_request'
+
+class TestUserInfoRequest < Test::Unit::TestCase
+  context "A user info request" do
+    setup do
+      @request = TuwienLogon::UserInfoRequest.new
+      @request.url.query = 'oid=8761231'
+    end
+
+    should "parse a url correctly" do
+      assert_equal 'localhost', @request.url.host
+      assert_equal '/AuthServ.userInfo', @request.url.path
+      assert_equal 4567, @request.url.port
+      assert_equal 'http', @request.url.scheme
+      assert_equal 'oid=8761231', @request.url.query
+    end
+  
+    should "map params correctly" do
+      query = @request.query_string(:a => 'b', :c => 'd')
+      assert_equal 'a=b&c=d', query
+    end
+  
+    should "parse user info correctly" do
+      data = "124\tAlbert\tEinstein\tDr.\t0123456\tabc\n"
+      info = @request.create_user_info data, [:oid, :firstname, :lastname, :title, :matriculation_number, :institute_symbol]
+      assert_equal '124', info.oid
+      assert_equal 'Albert', info.firstname
+      assert_equal 'Einstein', info.lastname
+      assert_equal 'Dr.', info.title
+      assert_equal '0123456', info.matriculation_number
+      assert_equal 'abc', info.institute_symbol
+    end
+    
+    # for the following tests mockzid must be running at localhost:4567
+    
+    should "retrieve correct reply" do
+      reply = @request.get :oid => 8761231
+      assert_equal "8761231\tKarl\tPopper\tProf.\t\tE123\n", reply
+    end
+    
+    should "get the correct user info" do
+      info = @request.get_user_info(:oid => 1231132)
+      assert_equal '1231132', info.oid
+      assert_equal 'Ernst', info.firstname
+      assert_equal 'Orwell', info.lastname
+      assert_nil info.title
+      assert_equal '0812345', info.matriculation_number
+      assert_nil info.institute_symbol
+    end
+  end
+end

data/tuwien_logon.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tuwien_logon}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Clemens Helm"]
+  s.date = %q{2010-04-15}
+  s.description = %q{Provides an authentication solution for ruby applications being used at the Vienna University of Technology}
+  s.email = %q{clemens.helm@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tuwien_logon.rb",
+     "lib/tuwien_logon/configuration.rb",
+     "lib/tuwien_logon/user_info.rb",
+     "lib/tuwien_logon/user_info_request.rb",
+     "test/helper.rb",
+     "test/test_tuwien_logon.rb",
+     "test/test_user_info.rb",
+     "test/test_user_info_request.rb",
+     "tuwien_logon.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dropswap/tuwien_logon}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby client for Vienna UT authentication service}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_tuwien_logon.rb",
+     "test/test_user_info.rb",
+     "test/test_user_info_request.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: tuwien_logon
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Clemens Helm
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Provides an authentication solution for ruby applications being used at the Vienna University of Technology
+email: clemens.helm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tuwien_logon.rb
+- lib/tuwien_logon/configuration.rb
+- lib/tuwien_logon/user_info.rb
+- lib/tuwien_logon/user_info_request.rb
+- test/helper.rb
+- test/test_tuwien_logon.rb
+- test/test_user_info.rb
+- test/test_user_info_request.rb
+- tuwien_logon.gemspec
+has_rdoc: true
+homepage: http://github.com/dropswap/tuwien_logon
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby client for Vienna UT authentication service
+test_files: 
+- test/helper.rb
+- test/test_tuwien_logon.rb
+- test/test_user_info.rb
+- test/test_user_info_request.rb