sakai-info 0.3.2 → 0.3.3

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # sakai-info Change History #
 
+## 0.3.3 ##
+
+*Released 2012-03-09*
+
+* Fixed performance bug connecting to the database on every query
+* Performance improvements (with possible downsides) in property lookups
+* Group supports dbrow, improved serialization
+* CLI now supports group objects
+
 ## 0.3.2 ##
 
 *Released 2012-03-08*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-03-08  
+last updated: 2012-03-09  
 author: David Adams (daveadams@gmail.com)  
 github url: https://github.com/daveadams/sakai-info
 
@@ -24,7 +24,7 @@ Use `rake` to test and build the gem:
     $ rake gem:build
 
 The resulting gem will be saved to the working directory as
-`sakai-info-0.3.2.gem`.
+`sakai-info-0.3.3.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,29 +1,28 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-03-08*
+*Last updated 2012-03-09*
 
-### 0.3.3 ###
+### 0.3.4 ###
 
-* CLI access to groups
 * User support for --mod and --dbrow
 
-### 0.3.4 ###
+### 0.3.5 ###
 
 * CLI access to forums
 
-### 0.3.5 ###
+### 0.3.6 ###
 
 * CLI access to gradebook
 
-### 0.3.6 ###
+### 0.3.7 ###
 
 * CLI access to announcements
 
-### 0.3.7 ###
+### 0.3.8 ###
 
 * CLI access to content
 
-### 0.3.8 ###
+### 0.3.9 ###
 
 * CLI access to authz (realms, roles, functions)
 

data/lib/sakai-info/cli.rb

@@ -2,7 +2,7 @@
 #  - sakai-info command line tool support
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,6 +11,9 @@
 
 require 'sakai-info/cli/help'
 
+# it's faster to run single-threaded
+Sequel.single_threaded = true
+
 module SakaiInfo
   class CLI
     ObjectModes = {
@@ -18,6 +21,7 @@ module SakaiInfo
       "page" => Page,
       "tool" => Tool,
       "user" => User,
+      "group" => Group,
       "quiz" => Quiz,
       "quiz-section" => QuizSection,
       "quiz-item" => QuizItem,

data/lib/sakai-info/cli/help.rb

@@ -2,7 +2,7 @@
 #  - sakai-info command line help
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -20,6 +20,7 @@ sakai-info #{VERSION}
 
   Object commands:
     user           User information
+    group          Group information
 
     site           Site information
     page           Site page information
@@ -116,6 +117,19 @@ sakai-info user
     --all      Print all possible details
 EOF
 
+        "group" => <<EOF,
+sakai-info group
+
+  Usage: sakai-info group <id> [<options>]
+
+  Prints information about the group ID or EID specified. Additional options
+  may be passed to include additional information:
+
+    --users    Print user membership information
+    --realm    Print corresponding realm information
+    --all      Print all possible details
+EOF
+
         "site" => <<EOF,
 sakai-info site
 

data/lib/sakai-info/database.rb

@@ -135,7 +135,7 @@ module SakaiInfo
     end
 
     def alive?
-      @connection.nil? && @connection.test_connection
+      (not @connection.nil?) && @connection.test_connection
     end
   end
 end

data/lib/sakai-info/group.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Group library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,17 +11,18 @@
 
 module SakaiInfo
   class Group < SakaiObject
-    attr_reader :site, :title
+    attr_reader :site_id, :title, :dbrow
 
-    def initialize(id, site, title)
-      @id = id
-      if site.is_a? Site
-        @site = site
-      else
-        # assume the string version is a site_id
-        @site = Site.find(site.to_s)
-      end
-      @title = title
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:group_id]
+      @site_id = dbrow[:site_id]
+      @title = dbrow[:title]
+    end
+
+    def site
+      @site ||= Site.find(@site_id)
     end
 
     @@cache = {}
@@ -31,35 +32,38 @@ module SakaiInfo
         if row.nil?
           raise ObjectNotFoundException.new(Group, id)
         end
-        @@cache[id] = Group.new(id, row[:site_id], row[:title])
+        @@cache[id] = Group.new(row)
       end
       @@cache[id]
     end
 
-    @@cache_by_site_id = {}
-    def self.find_by_site_id(site_id)
-      if @@cache_by_site_id[site_id].nil?
-        @@cache_by_site_id[site_id] = []
-        site = Site.find(site_id)
+    def self.query_by_site_id(site_id)
+      DB.connect[:sakai_site_group].where(:site_id => site_id)
+    end
 
-        DB.connect[:sakai_site_group].filter(:site_id => site_id).all.each do |row|
-          @@cache[row[:group_id]] = Group.new(row[:group_id], site, row[:title])
-          @@cache_by_site_id[site_id] << @@cache[row[:group_id]]
-        end
-      end
-      @@cache_by_site_id[site_id]
+    def self.find_by_site_id(site_id)
+      Group.query_by_site_id(site_id).all.
+        collect { |row| @@cache[row[:group_id]] = Group.new(row) }
     end
 
     def self.count_by_site_id(site_id)
-      DB.connect[:sakai_site_group].filter(:site_id => site_id).count
+      Group.query_by_site_id(site_id).count
     end
 
     def properties
-      @properties ||= GroupProperty.find_by_group_id(@id)
+      @properties ||= GroupProperty.find_by_group_id(self.id)
     end
 
     def realm
-      @authz_realm ||= AuthzRealm.find_by_site_id_and_group_id(@site.id, @id)
+      @authz_realm ||= AuthzRealm.find_by_site_id_and_group_id(self.site_id, self.id)
+    end
+
+    def providers
+      @providers ||= self.realm.providers
+    end
+
+    def users
+      @users ||= AuthzRealmMembership.find_by_realm_id(self.realm.id).collect{|arm|arm.user}
     end
 
     # serialization
@@ -67,8 +71,9 @@ module SakaiInfo
       result = {
         "id" => self.id,
         "title" => self.title,
-        "site_id" => self.site.id,
-        "members" => self.realm.user_count,
+        "site" => self.site.serialize(:summary),
+        "user_count" => self.realm.user_count,
+        "providers" => self.providers,
         "properties" => self.properties
       }
       if result["properties"] == {}
@@ -81,9 +86,25 @@ module SakaiInfo
       {
         "id" => self.id,
         "title" => self.title,
-        "members" => self.realm.user_count
+        "user_count" => self.realm.user_count
+      }
+    end
+
+    def users_serialization
+      {
+        "users" => self.users.collect { |u| u.serialize(:summary) }
       }
     end
+
+    def realm_serialization
+      {
+        "realm" => self.realm.name
+      }
+    end
+
+    def self.all_serializations
+      [:default, :users, :realm]
+    end
   end
 
   class GroupProperty
@@ -99,8 +120,17 @@ module SakaiInfo
 
     def self.find_by_group_id(group_id)
       properties = {}
-      DB.connect[:sakai_site_group_property].where(:group_id => group_id).all.each do |row|
-        properties[row[:name]] = row[:value].read
+      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
+      #  This is multiple orders of magnitude faster.
+      #  But, this will break if the property value is > 4000chars and may not work
+      #  on mysql, so here's the original version:
+      # DB.connect[:sakai_site_group_property].where(:group_id => group_id).all.each do |row|
+      #   properties[row[:name]] = row[:value].read
+      # end
+      DB.connect[:sakai_site_group_property].
+        select(:name, :to_char.sql_function(:value).as(:value)).
+        where(:group_id => group_id).all.each do |row|
+        properties[row[:name]] = row[:value]
       end
       return properties
     end

data/lib/sakai-info/page.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Page library
 #
 # Created 2012-03-08 daveadams@gmail.com
-# Last updated 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -101,8 +101,17 @@ module SakaiInfo
 
     def self.find_by_page_id(page_id)
       properties = {}
-      DB.connect[:sakai_site_page_property].where(:page_id => page_id).all.each do |row|
-        properties[row[:name]] = row[:value].read
+      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
+      #  This is multiple orders of magnitude faster.
+      #  But, this will break if the property value is > 4000chars and may not work
+      #  on mysql, so here's the original version:
+      # DB.connect[:sakai_site_page_property].where(:page_id => page_id).all.each do |row|
+      #   properties[row[:name]] = row[:value].read
+      # end
+      DB.connect[:sakai_site_page_property].
+        select(:name, :to_char.sql_function(:value).as(:value)).
+        where(:page_id => page_id).all.each do |row|
+        properties[row[:name]] = row[:value]
       end
       return properties
     end

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -402,8 +402,17 @@ module SakaiInfo
 
     def self.find_by_site_id(site_id)
       properties = {}
-      DB.connect[:sakai_site_property].where(:site_id => site_id).all.each do |row|
-        properties[row[:name]] = row[:value].read
+      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
+      #  This is multiple orders of magnitude faster.
+      #  But, this will break if the property value is > 4000chars and may not work
+      #  on mysql, so here's the original version:
+      # DB.connect[:sakai_site_property].where(:site_id => site_id).all.each do |row|
+      #   properties[row[:name]] = row[:value].read
+      # end
+      DB.connect[:sakai_site_property].
+        select(:name, :to_char.sql_function(:value).as(:value)).
+        where(:site_id => site_id).all.each do |row|
+        properties[row[:name]] = row[:value]
       end
       return properties
     end

data/lib/sakai-info/tool.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Tool library
 #
 # Created 2012-03-08 daveadams@gmail.com
-# Last updated 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -106,8 +106,17 @@ module SakaiInfo
 
     def self.find_by_tool_id(tool_id)
       properties = {}
-      DB.connect[:sakai_site_tool_property].where(:tool_id => tool_id).all.each do |row|
-        properties[row[:name]] = row[:value].read
+      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
+      #  This is multiple orders of magnitude faster.
+      #  But, this will break if the property value is > 4000chars and may not work
+      #  on mysql, so here's the original version:
+      # DB.connect[:sakai_site_tool_property].where(:tool_id => tool_id).all.each do |row|
+      #   properties[row[:name]] = row[:value].read
+      # end
+      DB.connect[:sakai_site_tool_property].
+        select(:name, :to_char.sql_function(:value).as(:value)).
+        where(:tool_id => tool_id).all.each do |row|
+        properties[row[:name]] = row[:value]
       end
       return properties
     end

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-08 00:00:00 -06:00
+date: 2012-03-09 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency