sakai-info 0.1.0

data/lib/sakai-info/user.rb

@@ -0,0 +1,220 @@
+# sakai-info/user.rb
+#   SakaiInfo::User library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-17 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class User < SakaiObject
+    attr_reader :eid, :name, :type
+    attr_reader :created_by, :created_at, :modified_by, :modified_at
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        user_id = eid = nil
+        DB.connect.exec("select user_id, eid from sakai_user_id_map " +
+                        "where user_id=:user_id or eid=:eid", id, id) do |row|
+          user_id = row[0]
+          eid = row[1]
+        end
+        if user_id.nil? or eid.nil?
+          raise ObjectNotFoundException.new(User, id)
+        end
+
+        DB.connect.exec("select first_name, last_name, type, " +
+                        "to_char(createdon,'YYYY-MM-DD HH24:MI:SS'), " +
+                        "to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS') " +
+                        "from sakai_user where user_id=:userid", user_id) do |row|
+          first_name, last_name, type, created_at, modified_at = *row
+          first_name ||= ""
+          last_name ||= ""
+          @@cache[eid] =
+            @@cache[user_id] =
+            User.new(user_id, eid, (first_name+' '+last_name), type, created_at, modified_at)
+        end
+      end
+      @@cache[id]
+    end
+
+    def initialize(id, eid, name, type, created_at, modified_at)
+      @id = id
+      @eid = eid
+      @name = name
+      @type = type
+      @created_at = created_at
+      @modified_at = modified_at
+      @properties = nil
+    end
+
+    def properties
+      @properties ||= UserProperty.find_by_user_id(@id)
+    end
+
+    def workspace
+      @workspace ||= Site.find("~" + @id)
+    end
+
+    def question_pools
+      @question_pools ||= QuestionPool.find_by_user_id(@id)
+    end
+
+    def question_pool_count
+      if @question_pools.nil?
+        QuestionPool.count_by_user_id(@id)
+      else
+        @question_pools.length
+      end
+    end
+
+    def assignment_submissions
+      @assignment_submissions ||= AssignmentSubmission.find_by_user_id(@id)
+    end
+
+    def assignment_submission_count
+      @assignment_submission_count ||= AssignmentSubmission.count_by_user_id(@id)
+    end
+
+    def assignment_contents
+      @assignment_contents ||= AssignmentContent.find_by_user_id(@id)
+    end
+
+    def assignment_content_count
+      @assignment_content_count ||= AssignmentContent.count_by_user_id(@id)
+    end
+
+    def membership
+      @membership ||= SiteMembership.find_by_user_id(@id)
+    end
+
+    def site_count
+      if @membership.nil?
+        Site.count_by_user_id(@id)
+      else
+        @membership.length
+      end
+    end
+
+    def preferences_xml
+      if @preferences_xml.nil?
+        db = DB.connect
+        @preferences_xml = ""
+        db.exec("select xml from sakai_preferences " +
+                "where preferences_id=:userid", @user_id) do |row|
+          REXML::Document.new(row[0].read).write(@preferences_xml, 2)
+        end
+      end
+      @preferences_xml
+    end
+
+    # finders/counters
+    @@total_user_count = nil
+    def self.count
+      if @@total_user_count.nil?
+        @@total_user_count = 0
+        DB.connect.exec("select count(*) from sakai_user") do |row|
+          @@total_user_count = row[0].to_i
+        end
+      end
+      @@total_user_count
+    end
+
+    def self.count_by_realm_id_and_role_id(realm_id, role_id)
+      count = 0
+      DB.connect.exec("select count(*) from sakai_realm_rl_gr " +
+                      "where realm_key = :realm_id " +
+                      "and role_key = :role_id", realm_id, role_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def self.find_by_realm_id_and_role_id(realm_id, role_id)
+      users = []
+      DB.connect.exec("select first_name, last_name, type, " +
+                      "to_char(createdon,'YYYY-MM-DD HH24:MI:SS'), " +
+                      "to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS') " +
+                      "from sakai_user where user_id in " +
+                      "(select user_id from sakai_realm_rl_gr " +
+                      "where realm_key = :realm_id " +
+                      "and role_key = :role_id)", realm_id, role_id) do |row|
+        first_name, last_name, type, created_at, modified_at = *row
+        first_name ||= ""
+        last_name ||= ""
+        @@cache[eid] =
+          @@cache[user_id] =
+          User.new(user_id, eid, (first_name+' '+last_name), type, created_at, modified_at)
+        users << @@cache[eid]
+      end
+      users
+    end
+
+    # yaml/json serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+        "eid" => self.eid,
+        "type" => self.type,
+        "created_at" => self.created_at,
+        "user_properties" => UserProperty.find_by_user_id(self.id),
+        "site_count" => self.site_count,
+        "question_pool_count" => self.question_pool_count
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "eid" => self.eid,
+        "name" => self.name,
+        "type" => self.type
+      }
+    end
+
+    def membership_serialization
+      {
+        "sites" => self.membership.collect { |sm| sm.serialize(:user_summary) }
+      }
+    end
+
+    def question_pools_serialization
+      if self.question_pool_count > 0
+        {
+          "question_pools" => self.question_pools.collect { |qp| qp.serialize(:user_summary) }
+        }
+      else
+        {}
+      end
+    end
+  end
+
+  class UserProperty
+    def self.get(user_id, property_name)
+      db = DB.connect
+      value = nil
+      db.exec("select value from sakai_user_property " +
+              "where user_id=:user_id and name=:name", user_id, property_name) do |row|
+        value = row[0].read
+      end
+      return value
+    end
+
+    def self.find_by_user_id(user_id)
+      db = DB.connect
+      properties = {}
+      db.exec("select name, value from sakai_user_property " +
+              "where user_id=:user_id", user_id) do |row|
+        name = row[0]
+        value = row[1].read
+        properties[name] = value
+      end
+      return properties
+    end
+  end
+end

data/lib/sakai-info/version.rb

@@ -0,0 +1,3 @@
+module SakaiInfo
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: sakai-info
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-19 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: A command line tool and a suite of libraries for representing the objects and relationships defined by a Sakai CLE database.
+email: daveadams@gmail.com
+executables: 
+- sakai-info
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sakai-info.rb
+- lib/sakai-info/group.rb
+- lib/sakai-info/samigo.rb
+- lib/sakai-info/cli/help.rb
+- lib/sakai-info/site.rb
+- lib/sakai-info/assignment.rb
+- lib/sakai-info/authz.rb
+- lib/sakai-info/gradebook.rb
+- lib/sakai-info/sakai_object.rb
+- lib/sakai-info/user.rb
+- lib/sakai-info/version.rb
+- lib/sakai-info/announcement.rb
+- lib/sakai-info/cli.rb
+- lib/sakai-info/instance.rb
+- lib/sakai-info/configuration.rb
+- lib/sakai-info/message.rb
+- lib/sakai-info/content.rb
+- lib/sakai-info/db.rb
+- lib/sakai-info/sakai_xml_entity.rb
+- bin/sakai-info
+- README.md
+- LICENSE
+- CHANGELOG.md
+- ROADMAP.md
+has_rdoc: true
+homepage: https://github.com/daveadams/sakai-info
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tools and library for exploring a Sakai database
+test_files: []
+