drc_client 0.1.0

data/Manifest

@@ -0,0 +1,4 @@
+README.rdoc
+Rakefile
+lib/drc_client.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,76 @@
+= DeRose Connect Client
+
+Rails gem for interaction with DeRose Connect
+
+= Dependencies
+
+(sudo) gem install echoe
+
+(sudo) gem install rubycas-client
+
+= Installation
+
+git clone git@github.com:dwaynemac/drc_client.git
+
+cd drc_client
+
+rake manifest
+
+(sudo) rake install
+
+= Usage
+
+== Environement.rb
+
+config.gem "drc_client"
+
+DRCClient.configure(:base_url => "https://url-to-drc-server")
+
+== ApplicationController
+
+include DRCClient::HelperMethods
+
+== Filtering access
+
+Just write in your controllers (ApplicationController if filtering full application)
+
+before_filter DRCClient.filter(*options)
+
+# TODO a filter that considers both drc_logged_in? and drc_user_allowed?
+
+=== Options
+
+<tt>:gateway</tt> - if set true, DRC-connection won't be mandatory.
+
+<tt>:enable_single_sign_out</tt> - if set true, when logged out from DRC you'll be logout from the application as well. REQUIRES: config.action_controller.session_store = :active_record_store in environment and disabling forgery_protection 
+
+<tt>:user_model</tt> - name of your user model, defaults to User
+
+<tt>:drc_user_column</tt> - name of the column of your user model that identifies its DRC user, defaults to drc_user
+
+<tt>:local_user_id_column</tt> - if your user model doesn't have an :id attribute set it's id_attribute_name here.
+
+<tt>:require_local_user</tt> - set this true if you users need a local_user on top of a DRC user. (if true set :user_model) DRCClient.filter WON'T CHECK THIS, USER drc_user_allowed?
+
+<tt>:require_access_level</tt> - not implemented yet - define access level needed to access your app. (:none, :student, :teacher, :director)
+
+== OTher DRCClient Methods
+
+<tt>logout</tt> - destroys session and logs user out of DRCServer
+
+== Helpers Available with DRCClient::HelperMethods
+
+current_drc_user
+
+logged_in_drc?
+
+drc_login_url
+
+logout_drc
+
+get_local_user_id
+
+drc_user_has_local_user?
+
+
+...

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'  
+require 'rake'  
+require 'echoe'  
+   
+Echoe.new('drc_client', '0.1.0') do |p|  
+  p.description     = "Rails client for DeRoseConnect"  
+  p.url             = "http://github.com/dwaynemac/drc_client"  
+  p.author          = "Dwayne Macgowan"  
+  p.email           = "dwaynemac@gmail.com"  
+#  p.ignore_pattern  = ["tmp/*", "script/*"]  
+  p.development_dependencies = ['rubycas-client']  
+end  
+   
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }  

data/drc_client.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{drc_client}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dwayne Macgowan"]
+  s.date = %q{2010-09-07}
+  s.description = %q{Rails client for DeRoseConnect}
+  s.email = %q{dwaynemac@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/drc_client.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/drc_client.rb", "Manifest", "drc_client.gemspec"]
+  s.homepage = %q{http://github.com/dwaynemac/drc_client}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Drc_client", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{drc_client}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails client for DeRoseConnect}
+
+  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<rubycas-client>, [">= 0"])
+    else
+      s.add_dependency(%q<rubycas-client>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rubycas-client>, [">= 0"])
+  end
+end

data/lib/drc_client.rb

@@ -0,0 +1,125 @@
+# DeRose Connect Client (DRCClient) requires rubycas-client
+require 'casclient'
+require 'casclient/frameworks/rails/filter'
+require 'i18n'
+
+module DRCClient
+
+  # These are initialized when you call configure
+  @@drc_config = {
+    :base_url => nil,
+    :enable_single_sign_out => nil,
+    :user_model => nil,
+    :drc_user_column => nil,
+    :local_user_id_column => nil,
+    :require_local_user => nil,
+    :require_access_level => nil # none, student, teacher, director, federation_president
+  }
+
+  def self.filter(opts={})
+    gateway = opts.delete(:gateway)
+    if gateway
+      CASClient::Frameworks::Rails::GatewayFilter
+    else
+      CASClient::Frameworks::Rails::Filter
+    end
+  end
+
+  def self.configure(configuration)
+    @@drc_config[:base_url] = configuration.delete(:base_url)
+    @@drc_config[:enable_single_sign_out] = configuration.delete(:enable_single_sign_out) || false
+    @@drc_config[:user_model] = configuration.delete(:user_model)
+    @@drc_config[:drc_user_column] = configuration.delete(:drc_user_column) || :drc_user
+    @@drc_config[:require_local_user] = configuration.delete(:require_local_user)
+    @@drc_config[:require_access_level] = configuration.delete(:require_access_level)
+    @@drc_config[:local_user_id_column] = configuration.delete(:local_user_id_column) || :id
+
+    configuration.merge!({:cas_base_url => @@drc_config[:base_url],
+                          :enable_single_sign_out => @@drc_config[:enable_single_sign_out]})
+    CASClient::Frameworks::Rails::Filter.configure(configuration)
+  end
+
+  def self.logout(controller,service=nil)
+    CASClient::Frameworks::Rails::Filter.logout(controller,service)
+  end
+
+  def self.config
+    return @@drc_config
+  end
+
+  def self.mock_login(username)
+    CASClient::Frameworks::Rails::Filter.fake(username)
+  end
+  
+  module HelperMethods
+
+    def self.included(base)
+      base.send :helper_method, :logged_in_drc?, :cas_is_pama_allowed?, :current_drc_user,
+                :drc_user_has_local_user?, :login_with_drc, :drc_logout_url, :drc_login_url,
+                :drc_top_bar, :clear_local_drc_session
+    end
+
+    def current_drc_user
+      return session[:cas_user]
+    end
+
+    def clear_local_drc_session
+      session[:cas_user] = nil
+    end
+
+    # check if session has DRC credentials
+    def logged_in_drc?
+      return !current_drc_user.blank?
+    end
+
+    # checks if DRC credentials have access to local application
+    def allowed_drc_user?
+      return false if !logged_in_drc?
+      allowed = true # by default having a drc_user is enough
+      allowed &&= drc_user_has_local_user? if DRCClient.config[:require_local_user]
+      allowed &&= true if DRCClient.config[:require_access_level] # TODO
+      return allowed
+    end
+
+    # finds local user that matches logged in DRC user
+    # return user's id or nil if none found
+    def get_local_user_id
+      return nil if DRCClient.config[:user_model].nil?
+      return nil unless logged_in_drc?
+      user = DRCClient.config[:user_model].find(:first,
+                                              :select => DRCClient.config[:local_user_id_column],
+                                              :conditions => { DRCClient.config[:drc_user_column] => current_drc_user})
+      if user
+        return user[DRCClient.config[:local_user_id_column].to_sym]
+      else
+        return nil
+      end
+    end
+
+    # checks if drc_user matches any local application user.
+    def drc_user_has_local_user?
+      return !get_local_user_id.nil?
+    end
+
+    # returns login url to DRC server.
+    def drc_login_url
+      return CASClient::Frameworks::Rails::Filter.login_url(self)
+    end
+    
+    def drc_logout_url
+      return DRCClient.config[:base_url]+"/logout" # TODO strip posible / at end of base_url
+    end
+
+    # helper for rendering top_bar
+    def drc_top_bar(local_logout_url=nil)
+      logout_href = (local_logout_url.nil?)? drc_logout_url : local_logout_url
+      ret = "<div style='width: 100%; height: 12px; top: 0; border-bottom: 1px solid grey; margin-bottom: 5px; padding-bottom: 5px; vertical-align: middle; font-size: 12px;'>"
+      ret << "<div style='text-align: left; float: left;'>DRC-Bar. (TODO: list available apps here)</div>"
+      ret << "<div style='text-align: right; float: right;'><strong>#{current_drc_user}</strong> | "
+      ret << "<a href='#{logout_href}'>#{I18n.t('logout', :default => "logout").capitalize}</a></div>"
+      ret << "</div>"
+      return ret
+    end
+
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: drc_client
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dwayne Macgowan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-07 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubycas-client
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rails client for DeRoseConnect
+email: dwaynemac@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/drc_client.rb
+files: 
+- README.rdoc
+- Rakefile
+- lib/drc_client.rb
+- Manifest
+- drc_client.gemspec
+has_rdoc: true
+homepage: http://github.com/dwaynemac/drc_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Drc_client
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: drc_client
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails client for DeRoseConnect
+test_files: []
+