sakai-info 0.4.4 → 0.4.5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.4.5 ###
+
+*Released 2012-05-14*
+
+* CLI support for authz roles, realms, and functions
+* Bugfix: fix syntax error using ContentCollection.find! on missing collections
+* Bugfix: gracefully handle missing AnnouncementChannel for Site serializations
+
 ### 0.4.4 ###
 
 *Released 2012-05-12*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-05-12  
+last updated: 2012-05-14  
 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.4.4.gem`.
+`sakai-info-0.4.5.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,23 +1,20 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-05-12*
+*Last updated 2012-05-14*
 
-### 0.4.5 ###
-
-* CLI access to authz (realms, roles, functions)
-
-### 0.5.0 ###
+### 0.5.x ###
 
 * Sqlite test infrastructure for a few basic objects
 * Deeper query functionality and field specification
 * Simple web query interface - HTML, JSON, and YAML
+* Global cache instead of per-class
 
-### 0.6.0 ###
+### 0.6.x ###
 
 * Test fixtures and basic unit tests for all represented objects
 * RDoc coverage for every class
 
-### 0.7.0 ###
+### 0.7.x ###
 
 * OSP support
 

data/lib/sakai-info/authz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Authz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-14 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -18,9 +18,11 @@ module SakaiInfo
     end
     clear_cache
 
-    def initialize(id, name)
-      @id = id
-      @name = name
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:role_key].to_i
+      @name = @dbrow[:role_name]
     end
 
     def to_s
@@ -30,13 +32,12 @@ module SakaiInfo
     def self.find_by_id(id)
       id = id.to_s
       if @@cache[id].nil?
-        row = DB.connect.fetch("select role_name from sakai_realm_role " +
-                               "where role_key = ?", id.to_i).first
+        row = DB.connect[:sakai_realm_role].where(:role_key => id.to_i).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzRole, id)
         end
-        @@cache[id] = AuthzRole.new(id, row[:role_name])
-        @@cache[name] = @@cache[id]
+        @@cache[id] = AuthzRole.new(row)
+        @@cache[@@cache[id].name] = @@cache[id]
       end
       @@cache[id]
     end
@@ -46,14 +47,12 @@ module SakaiInfo
         raise ObjectNotFoundException.new(AuthzRole, "")
       end
       if @@cache[name].nil?
-        row = DB.connect.fetch("select role_key from sakai_realm_role " +
-                               "where role_name = ?", name).first
+        row = DB.connect[:sakai_realm_role].where(:role_name => name).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzRole, name)
         end
-        id = row[:role_key].to_i.to_s
-        @@cache[name] = AuthzRole.new(id, name)
-        @@cache[id] = @@cache[name]
+        @@cache[name] = AuthzRole.new(row)
+        @@cache[@@cache[name].id] = @@cache[name]
       end
       @@cache[name]
     end
@@ -73,18 +72,26 @@ module SakaiInfo
       role
     end
 
+    def self.query_by_realm_id_and_function_id(realm_id, function_id)
+      DB.connect[:sakai_realm_role].
+        where(:role_key => DB.connect[:sakai_realm_rl_fn].select(:role_key).
+              where(:realm_key => realm_id, :function_key => function_id))
+    end
+
+    def self.count_by_realm_id_and_function_id(realm_id, function_id)
+      AuthzRole.query_by_realm_id_and_function_id(realm_id, function_id).count
+    end
+
     def self.find_by_realm_id_and_function_id(realm_id, function_id)
-      roles = []
-      DB.connect.fetch("select role_key, role_name from " +
-                       "sakai_realm_role where role_key in " +
-                       "(select role_key from sakai_realm_rl_fn " +
-                       "where realm_key=? and function_key=?) " +
-                       "order by role_name", realm_id, function_id) do |row|
-        role_id = row[:role_key].to_i.to_s
-        role_name = row[:role_name]
-        roles << AuthzRole.new(role_id, role_name)
-      end
-      roles
+      AuthzRole.query_by_realm_id_and_function_id(realm_id, function_id).
+        order(:role_name).all.collect { |row| AuthzRole.new(row) }
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+      }
     end
   end
 
@@ -96,9 +103,11 @@ module SakaiInfo
     end
     clear_cache
 
-    def initialize(id, name)
-      @id = id
-      @name = name
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:function_key].to_i
+      @name = @dbrow[:function_name]
     end
 
     def to_s
@@ -108,28 +117,27 @@ module SakaiInfo
     def self.find_by_id(id)
       id = id.to_s
       if @@cache[id].nil?
-        row = DB.connect.fetch("select function_name from sakai_realm_function " +
-                               "where function_key = ?", id.to_i).first
+        row = DB.connect[:sakai_realm_function].where(:function_key => id.to_i).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzFunction, id)
         end
-        @@cache[id] = AuthzFunction.new(id, row[:function_name])
-        @@cache[row[:function_name]] = @@cache[id]
+        @@cache[id] = AuthzFunction.new(row)
+        @@cache[@@cache[id].name] = @@cache[id]
       end
       @@cache[id]
     end
 
     def self.find_by_name(name)
+      if name.nil?
+        raise ObjectNotFoundException.new(AuthzFunction, "")
+      end
       if @@cache[name].nil?
-        id = nil
-        row = DB.connect.fetch("select function_key from sakai_realm_function " +
-                               "where function_name = ?", name).first
+        row = DB.connect[:sakai_realm_function].where(:function_name => name).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzFunction, name)
         end
-        id = row[:function_key].to_i.to_s
-        @@cache[name] = AuthzFunction.new(id, name)
-        @@cache[id] = @@cache[name]
+        @@cache[name] = AuthzFunction.new(row)
+        @@cache[@@cache[name].id] = @@cache[name]
       end
       @@cache[name]
     end
@@ -149,47 +157,62 @@ module SakaiInfo
       function
     end
 
+    def self.query_by_realm_id_and_role_id(realm_id, role_id)
+      DB.connect[:sakai_realm_function].
+        where(:function_key => DB.connect[:sakai_realm_rl_fn].select(:function_key).
+              where(:realm_key => realm_id, :role_key => role_id))
+    end
+
     def self.count_by_realm_id_and_role_id(realm_id, role_id)
-      DB.connect[:sakai_realm_rl_fn].
-        filter(:realm_key => realm_id, :role_key => role_id).count
+      AuthzFunction.query_by_realm_id_and_role_id(realm_id, role_id).count
     end
 
     def self.find_by_realm_id_and_role_id(realm_id, role_id)
-      functions = []
-      DB.connect.fetch("select function_key, function_name from " +
-                       "sakai_realm_function where function_key in " +
-                       "(select function_key from sakai_realm_rl_fn " +
-                       "where realm_key=? and role_key=?) " +
-                       "order by function_name", realm_id, role_id) do |row|
-        function_id = row[:function_key].to_i.to_s
-        function_name = row[:function_name]
-        functions << AuthzFunction.new(function_id, function_name)
-      end
-      functions
+      AuthzFunction.query_by_realm_id_and_role_id(realm_id, role_id).
+        order(:function_name).all.collect { |row| AuthzFunction.new(row) }
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+      }
     end
   end
 
   class AuthzRealm < SakaiObject
     attr_reader :name, :providers, :maintain_role
 
+    include ModProps
+    created_at_key :createdon
+    created_by_key :createdby
+    modified_at_key :modifiedon
+    modified_by_key :modifiedby
+
     def self.clear_cache
       @@cache = {}
     end
     clear_cache
 
-    def initialize(id, name, providers, maintain_role)
-      @id = id
-      @name = name
-      if providers.nil?
+    def initialize(row)
+      @dbrow = row
+
+      @id = @dbrow[:realm_key].to_i
+      @name = @dbrow[:realm_id]
+      if @dbrow[:provider_id].nil?
         @providers = nil
       else
-        @providers = providers.split("+")
+        @providers = @dbrow[:provider_id].split("+")
+      end
+      if @dbrow[:maintain_role].nil? or @dbrow[:maintain_role] == ""
+        @maintain_role = nil
+      else
+        @maintain_role = AuthzRole.find_by_id(@dbrow[:maintain_role])
       end
-      @maintain_role = maintain_role
     end
 
     def realm_roles
-      @realm_roles ||= AuthzRealmRole.find_by_realm_id(@id)
+      @realm_roles ||= AuthzRealmRole.find_by_realm_id(self.id)
     end
 
     def to_s
@@ -197,56 +220,34 @@ module SakaiInfo
     end
 
     def user_count
-      @user_count ||= AuthzRealmMembership.count_by_realm_id(@id)
+      @user_count ||= AuthzRealmMembership.count_by_realm_id(self.id)
     end
 
-    def membership
-      @membership ||= AuthzRealmMembership.find_by_realm_id(@id)
+    def users
+      @users ||= AuthzRealmMembership.find_by_realm_id(self.id)
     end
 
     def self.find_by_id(id)
       id = id.to_s
       if @@cache[id].nil?
-        row = DB.connect.fetch("select realm_id, provider_id, maintain_role " +
-                               "from sakai_realm " +
-                               "where realm_key = ?", id.to_i).first
+        row = DB.connect[:sakai_realm].where(:realm_key => id.to_i).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzRealm, id)
         end
-
-        name = row[:realm_id]
-        providers = row[:provider_id]
-        maintain_role = nil
-        if row[:maintain_role].nil? or row[:maintain_role] == ""
-          maintain_role = nil
-        else
-          maintain_role = AuthzRole.find_by_id(row[:maintain_role].to_i)
-        end
-        @@cache[id] = AuthzRealm.new(id, name, providers, maintain_role)
-        @@cache[name] = @@cache[id]
+        @@cache[id] = AuthzRealm.new(row)
+        @@cache[@@cache[id].name] = @@cache[id]
       end
       @@cache[id]
     end
 
     def self.find_by_name(name)
       if @@cache[name].nil?
-        row = DB.connect.fetch("select realm_key, provider_id, maintain_role " +
-                               "from sakai_realm " +
-                               "where realm_id = ?", name).first
+        row = DB.connect[:sakai_realm].where(:realm_id => name).first
         if row.nil?
           raise ObjectNotFoundException.new(AuthzRealm, name)
         end
-
-        id = row[:realm_key].to_i.to_s
-        providers = row[:provider_id]
-        maintain_role = nil
-        if row[:maintain_role].nil? or row[:maintain_role] == ""
-          maintain_role = nil
-        else
-          maintain_role = AuthzRole.find_by_id(row[:maintain_role].to_i)
-        end
-        @@cache[name] = AuthzRealm.new(id, name, providers, maintain_role)
-        @@cache[id] = @@cache[name]
+        @@cache[name] = AuthzRealm.new(row)
+        @@cache[@@cache[name].id] = @@cache[name]
       end
       @@cache[name]
     end
@@ -273,6 +274,49 @@ module SakaiInfo
     def self.find_by_site_id_and_group_id(site_id, group_id)
       AuthzRealm.find_by_name("/site/#{site_id}/group/#{group_id}")
     end
+
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "name" => self.name,
+        "user_count" => self.user_count,
+      }
+      if not self.providers.nil?
+        result["providers"] = self.providers
+      end
+      if not self.maintain_role.nil?
+        result["maintain_role"] = self.maintain_role.name
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+      }
+    end
+
+    def roles_serialization
+      {
+        "roles" => self.realm_roles.collect { |rr| rr.serialize(:realm_summary) }
+      }
+    end
+
+    def users_serialization
+      {
+        "users" => self.users.collect { |u| u.serialize(:realm_summary) }
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :mod,
+       :roles,
+       :users,
+      ]
+    end
   end
 
   class AuthzRealmRole < SakaiObject
@@ -284,19 +328,23 @@ module SakaiInfo
     end
 
     def function_count
-      @function_count ||= AuthzFunction.count_by_realm_id_and_role_id(@realm.id, @role.id)
+      @function_count ||=
+        AuthzFunction.count_by_realm_id_and_role_id(self.realm.id, self.role.id)
     end
 
     def functions
-      @functions ||= AuthzFunction.find_by_realm_id_and_role_id(@realm.id, @role.id)
+      @functions ||=
+        AuthzFunction.find_by_realm_id_and_role_id(self.realm.id, self.role.id)
     end
 
     def user_count
-      @user_count ||= User.count_by_realm_id_and_role_id(@realm.id, @role.id)
+      @user_count ||=
+        User.count_by_realm_id_and_role_id(self.realm.id, self.role.id)
     end
 
     def users
-      @users ||= User.find_by_realm_id_and_role_id(@realm.id, @role.id)
+      @users ||=
+        User.find_by_realm_id_and_role_id(self.realm.id, self.role.id)
     end
 
     def self.find_by_realm_id(realm_id)
@@ -319,15 +367,22 @@ module SakaiInfo
         "realm_name" => self.realm.name,
         "role_name" => self.role.name,
         "user_count" => self.user_count,
-        "function_count" => self.function_count
+        "function_count" => self.function_count,
       }
     end
 
     def summary_serialization
       {
-        "role_name" => self.role.name,
+        "realm" => self.realm.name,
+        "role" => self.role.name,
+      }
+    end
+
+    def realm_summary_serialization
+      {
+        "role" => self.role.name,
         "user_count" => self.user_count,
-        "function_count" => self.function_count
+        "function_count" => self.function_count,
       }
     end
   end
@@ -354,7 +409,7 @@ module SakaiInfo
     end
 
     def self.count_by_realm_id(realm_id)
-      DB.connect[:sakai_realm_rl_gr].filter(:realm_key => realm_id).count
+      DB.connect[:sakai_realm_rl_gr].where(:realm_key => realm_id).count
     end
 
     def self.find_by_user_id(user_id)
@@ -369,5 +424,28 @@ module SakaiInfo
       end
       results
     end
+
+    def default_serialization
+      {
+        "realm" => self.realm.serialize(:summary),
+        "user" => self.user.serialize(:summary),
+        "role" => self.role.serialize(:summary),
+      }
+    end
+
+    def summary_serialization
+      {
+        "realm" => self.realm.name,
+        "user" => self.user.eid,
+        "role" => self.role.name,
+      }
+    end
+
+    def realm_summary_serialization
+      {
+        "user" => self.user.eid,
+        "role" => self.role.name,
+      }
+    end
   end
 end

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-05-12 daveadams@gmail.com
+# Last updated 2012-05-14 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -40,6 +40,9 @@ module SakaiInfo
       "announcement-channel" => AnnouncementChannel,
       "gradebook" => Gradebook,
       "gradebook-item" => GradebookItem,
+      "role" => AuthzRole,
+      "function" => AuthzFunction,
+      "realm" => AuthzRealm,
     }
   end
 end

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

@@ -2,7 +2,7 @@
 #  - sin command line help
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-05-12 daveadams@gmail.com
+# Last updated 2012-05-14 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -14,14 +14,15 @@ module SakaiInfo
     class Help
       STRINGS = {
         :default => <<EOF,
-sin #{VERSION}
+Sakai Info: sin #{VERSION}
   Usage: sin <command> [<id>] [<options>]
 
   Object commands:
     user, group, site, page, tool, quiz, quiz-section, quiz-item, quiz-attempt,
     quiz-attempt-item, quiz-attempt-item-attachment, question-pool, assignment,
     assignment-submission, forum, forum-thread, forum-post, content,
-    announcement, announcement-channel, gradebook, gradebook-item
+    announcement, announcement-channel, gradebook, gradebook-item, role,
+    function, realm
 
   Misc commands:
     test             Tests configured database connections
@@ -32,7 +33,7 @@ sin #{VERSION}
 EOF
 
         "options" => <<EOF,
-sin #{VERSION}
+Sakai Info: sin #{VERSION}
   Options that apply globally:
     --database=<name>
         Connect to database instance <name> as defined in ~/.sakai-info instead
@@ -121,16 +122,17 @@ sin site
   Prints information about the site ID specified. Additional options may be
   passed to include additional information:
 
-    --users        Print membership information
-    --pages        Print page list with tools
-    --groups       Print group information
-    --quizzes      Print information about quizzes
-    --disk         Print disk usage
-    --assignments  Print assignment info
-    --gradebook    Print gradebook item info
-    --realm        Print site realm details
-    --forums       Print forum details
-    --mod          Print creation/modification info
+    --users         Print membership information
+    --pages         Print page list with tools
+    --groups        Print group information
+    --quizzes       Print information about quizzes
+    --disk          Print disk usage
+    --assignments   Print assignment info
+    --announcements Print announcement info
+    --gradebook     Print gradebook item info
+    --realm         Print site realm details
+    --forums        Print forum details
+    --mod           Print creation/modification info
 EOF
 
         "page" => <<EOF,
@@ -350,6 +352,32 @@ sin gradebook-item
   Usage: sin gradebook-item <id> [<options>]
 
   Prints information about the gradebook item ID specified.
+EOF
+        "role" => <<EOF,
+sin role
+
+  Usage: sin role <id> [<options>]
+
+  Prints information about the authz role ID specified.
+EOF
+        "function" => <<EOF,
+sin function
+
+  Usage: sin function <id> [<options>]
+
+  Prints information about the authz function ID specified.
+EOF
+        "realm" => <<EOF,
+sin realm
+
+  Usage: sin realm <id> [<options>]
+
+  Prints information about the authz realm ID specified. Additional options may
+  be passed to include additional information:
+
+    --roles      List roles associated with this realm
+    --users      List users in this realm
+    --mod        Print creation/modification info
 EOF
       }
 

data/lib/sakai-info/content.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Content library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-14 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -361,8 +361,12 @@ module SakaiInfo
     end
     clear_cache
 
+    def initialize(id)
+      @id = id
+    end
+
     def self.find(id)
-      @@cache[id] ||= MissingContentCollection.new(id, nil)
+      @@cache[id] ||= MissingContentCollection.new(id)
     end
 
     def size_on_disk

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-12 daveadams@gmail.com
+# Last updated 2012-05-14 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -108,12 +108,28 @@ module SakaiInfo
     end
 
     # announcement properties
+    def announcement_channel
+      if @announcement_channel.nil?
+        begin
+          @announcement_channel = AnnouncementChannel.find_by_site_id(self.id)
+        rescue ObjectNotFoundException
+          @announcement_channel = -1
+          return nil
+        end
+      elsif @announcement_channel == -1
+        return nil
+      end
+      @announcement_channel
+    end
+
     def announcements
-      @announcements ||= AnnouncementChannel.find_by_site_id(@id).announcements
+      return nil if self.announcement_channel.nil?
+      @announcements ||= self.announcement_channel.announcements
     end
 
     def announcement_count
-      @announcement_count ||= AnnouncementChannel.find_by_site_id(@id).announcement_count
+      return 0 if self.announcement_channel.nil?
+      @announcement_count ||= self.announcement_channel.announcement_count
     end
 
     # samigo quiz properties
@@ -252,7 +268,7 @@ module SakaiInfo
         "pending_quiz_count" => self.pending_quiz_count,
         "published_quiz_count" => self.published_quiz_count,
         "assignment_count" => self.assignment_count,
-#        "announcement_count" => self.announcement_count,
+        "announcement_count" => self.announcement_count,
         "gradebook_item_count" => (self.gradebook.nil? ? 0 : self.gradebook.item_count),
         "forum_count" => self.forum_count
       }
@@ -387,8 +403,18 @@ module SakaiInfo
 
     def self.all_serializations
       [
-       :default, :users, :pages, :groups, :quizzes, :disk, :assignments,
-       :announcements, :gradebook, :realm, :forums
+       :default,
+       :users,
+       :pages,
+       :groups,
+       :quizzes,
+       :disk,
+       :assignments,
+       :announcements,
+       :gradebook,
+       :realm,
+       :forums,
+       :mod,
       ]
     end
   end

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-12 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel