sakai-info 0.5.2 → 0.5.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60994547f55899b550d5e48c72db77c09c1bbd89
+  data.tar.gz: d661b8730e48e2804dbf1f582a845cf93784ace4
+SHA512:
+  metadata.gz: 94d914c3ef6409b3f5ae018ddf4da9b79fb4eab75a51719834c2d06fde19670544c08a57910df55d2fc9ea96359912ad39572af33ac1a72e077d0a6f15c91135
+  data.tar.gz: f7bb94184d106cce1c804f454c5dba6fa6b2276f86746293d53e05e49043b4deb4dfe677c009aafb21cbe883c0ce37c23b0690a20d223da1ce2969346222e8a0

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # sakai-info Change History #
 
+### 0.5.3 ###
+
+*Released 2013-06-28*
+
+* Unit test cleanup, refactor, and migration to MiniTest
+* Added simple tests against user/site fixture data
+* Refactored and simplified rake tasks for initializing test database
+* Added ability to specify alternate config file at the command line
+* New method to find ContentResource by UUID
+* Metaobj and Wiki support
+* More graceful fails when Users, Sites, and AuthzRealms are not found
+* Fixed Sequel 4.0 sql_or -> or support
+
 ### 0.5.2 ###
 
 *Released 2012-10-11*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-10-11  
+last updated: 2013-06-28  
 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.5.2.gem`.
+`sakai-info-0.5.3.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -4,11 +4,10 @@
 
 ### 0.5.3 ###
 
-* Ability to specify alternate config file at the command line
+* Add ability to specify Sequel connect string on command line
 * Better date formatting and proper time zone understanding
 * More query functionality
 * OSP presentation/metaobj support
-* Add simple tests against user/site fixture data
 * More query and shell functionality
 
 ### 0.5.4 ###

data/bin/sin

@@ -5,7 +5,7 @@
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-10-09 daveadams@gmail.com
+# Last updated 2012-10-13 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -39,6 +39,10 @@ while arg = ARGV.shift
       logfile = arg.split("=")[1]
     elsif arg == "--trace"
       set_trace_func __trace
+    elsif arg == "-c"
+      DB.config_file = ARGV.shift
+    elsif arg =~ /^--config(-?file)?=/
+      DB.config_file = arg.split("=")[1]
     else
       flags << arg
     end
@@ -140,8 +144,13 @@ DB.logger = logger
 
 # load database config and set instance to the instance given on the command line
 DB.load_config
-if not db_name.nil?
-  DB.default_database = db_name
+begin
+  if not db_name.nil?
+    DB.default_database = db_name
+  end
+rescue MissingConfigException => e
+  STDERR.puts "ERROR: database '#{db_name}' is not configured in #{DB.config_file}"
+  exit 1
 end
 
 case mode

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-10-11 daveadams@gmail.com
+# Last updated 2012-10-15 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -47,4 +47,6 @@ require 'sakai-info/generic_message'
 require 'sakai-info/forum'
 require 'sakai-info/private_message'
 require 'sakai-info/alias'
+require 'sakai-info/metaobj'
+require 'sakai-info/wiki'
 

data/lib/sakai-info/authz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Authz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-14 daveadams@gmail.com
+# Last updated 2012-10-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -267,6 +267,18 @@ module SakaiInfo
       realm
     end
 
+    def self.find!(id_or_name)
+      begin
+        realm = AuthzRealm.find(id_or_name)
+      rescue ObjectNotFoundException => e
+        if e.classname == AuthzRealm.name
+          realm = MissingAuthzRealm.find(id_or_name)
+        end
+      end
+      realm
+    end
+
+
     def self.find_by_site_id(site_id)
       AuthzRealm.find_by_name("/site/#{site_id}")
     end
@@ -319,6 +331,54 @@ module SakaiInfo
     end
   end
 
+  class MissingAuthzRealm < AuthzRealm
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(id)
+      @dbrow = {}
+
+      @dbrow = {}
+
+      @id = id
+      @name = id
+      @providers = nil
+      @maintain_role = nil
+    end
+
+    def self.find(id)
+      @@cache[id] ||= MissingAuthzRealm.new(id)
+    end
+
+    def realm_roles
+      []
+    end
+
+    def users
+      []
+    end
+
+    def default_serialization
+      {
+        "id" => "MISSING REALM: #{self.id}",
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => "MISSING REALM: #{self.id}",
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+      ]
+    end
+  end
+
   class AuthzRealmRole < SakaiObject
     attr_reader :realm, :role
 

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-10-11 daveadams@gmail.com
+# Last updated 2012-10-31 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -29,7 +29,8 @@ Sakai INfo: sin #{VERSION}
       quiz-attempt-item-attachment, question-pool, assignment,
       assignment-submission, forum, forum-thread, forum-post, content,
       announcement, announcement-channel, gradebook, gradebook-item,
-      role, function, realm, private-message, alias
+      role, function, realm, private-message, alias, metaobj,
+      wiki-page, wiki-page-history
 
   QUERY MODE
     Query particular fields from certain objects given certain conditions.
@@ -481,6 +482,41 @@ sin alias
   passed to include additional information:
 
     --mod        Print creation/modification info
+EOF
+        "metaobj" => <<EOF,
+sin metaobj
+
+  Usage: sin metaobj <id> [<options>]
+
+  Prints information about the metaobj/form ID specified. Additional options
+  may be passed to include additional information:
+
+    --instructions  Include form instruction text
+    --schemadata    Include schemadata field
+    --mod           Print creation/modification info
+EOF
+        "wiki-page" => <<EOF,
+sin wiki-page
+
+  Usage: sin wiki-page <id> [<options>]
+
+  Prints information about the wiki page ID specified. Additional options may
+  be passed to include additional information:
+
+    --content       Include content of the wiki page itself
+    --permissions   Break out permissions individually
+    --history       Summarize revision history
+EOF
+        "wiki-page-history" => <<EOF,
+sin wiki-page-history
+
+  Usage: sin wiki-page-history <id> [<options>]
+
+  Prints information about the wiki page history ID specified. Additional
+  options may be passed to include additional information:
+
+    --content       Include content of the wiki page itself
+    --permissions   Break out permissions individually
 EOF
         "query" => <<EOF,
 sin query

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

@@ -2,7 +2,7 @@
 #   class for handling the default command line mode
 #
 # Created 2012-05-23 daveadams@gmail.com
-# Last updated 2012-10-11 daveadams@gmail.com
+# Last updated 2012-10-31 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -138,6 +138,12 @@ module SakaiInfo
       "private-message" => PrivateMessage,
       "pm" => PrivateMessage,
       "alias" => Alias,
+      "metaobj" => Metaobj,
+      "form" => Metaobj,
+      "wiki-page" => WikiPage,
+      "wiki" => WikiPage,
+      "wiki-page-history" => WikiPageHistory,
+      "wiki-history" => WikiPageHistory,
     }
   end
 end

data/lib/sakai-info/content.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Content library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-10-04 daveadams@gmail.com
+# Last updated 2012-10-19 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -157,6 +157,7 @@ module SakaiInfo
 
     def self.clear_cache
       @@cache = {}
+      @@uuid_cache = {}
     end
     clear_cache
 
@@ -182,10 +183,23 @@ module SakaiInfo
           raise ObjectNotFoundException.new(ContentResource, id)
         end
         @@cache[id] = ContentResource.new(row)
+        @@uuid_cache[row[:uuid]] = @@cache[id]
       end
       @@cache[id]
     end
 
+    def self.find_by_uuid(uuid)
+      if @@uuid_cache[uuid].nil?
+        row = DB.connect[:content_resource].where(:resource_uuid => uuid).first
+        if row.nil?
+          raise ObjectNotFoundException.new(ContentResource, uuid)
+        end
+        @@uuid_cache[uuid] = ContentResource.new(row)
+        @@cache[row[:resource_id]] = @@uuid_cache[uuid]
+      end
+      @@uuid_cache[uuid]
+    end
+
     def size_on_disk
       @file_size
     end

data/lib/sakai-info/database.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Database library
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-05-04 daveadams@gmail.com
+# Last updated 2012-10-13 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -48,12 +48,22 @@ ENV["NLS_LANG"] ||= "AMERICAN_AMERICA.UTF8"
 
 module SakaiInfo
   class InvalidConfigException < SakaiException; end
+  class MissingConfigException < SakaiException; end
   class ConnectionFailureException < SakaiException; end
 
   class DB
     DEFAULT_CONFIG_FILE = File.expand_path("~/.sakai-info")
     @@default_database_name = nil
     @@config = nil
+    @@config_file = DEFAULT_CONFIG_FILE
+
+    def self.config_file=(newfile)
+      @@config_file = newfile
+    end
+
+    def self.config_file
+      @@config_file
+    end
 
     def self.configure(config)
       begin
@@ -100,11 +110,11 @@ module SakaiInfo
       end
     end
 
-    def self.load_config
-      if File.readable? DEFAULT_CONFIG_FILE
-        DB.configure(DEFAULT_CONFIG_FILE)
+    def self.load_config(config_file = DB.config_file)
+      if File.readable? config_file
+        DB.configure(config_file)
       else
-        raise MissingConfigException.new("No config file found at #{DEFAULT_CONFIG_FILE}")
+        raise MissingConfigException.new("No config file found at #{config_file}")
       end
     end
 
@@ -135,6 +145,9 @@ module SakaiInfo
 
     def self.default_database=(database_name)
       @@default_database_name = database_name
+      # spin it up so that we throw a missing config exception if it's invalid
+      DB.connect(@@default_database_name)
+      @@default_database_name
     end
 
     # set global logger
@@ -154,7 +167,10 @@ module SakaiInfo
 
   class Database
     def initialize(connect_info, logger = nil)
-      @connect_info=connect_info
+      if connect_info.nil?
+        raise MissingConfigException.new("No configuration was provided")
+      end
+      @connect_info = connect_info
       @logger = logger
     end
 

data/lib/sakai-info/exceptions.rb

@@ -2,7 +2,7 @@
 #   Special exception definitions
 #
 # Created 2012-05-20 daveadams@gmail.com
-# Last updated 2012-05-20 daveadams@gmail.com
+# Last updated 2012-10-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -16,11 +16,15 @@ module SakaiInfo
 
   # exception to be raised when an object of a certain type cannot be found
   class ObjectNotFoundException < SakaiException
-    def initialize(classname, identifier)
-      @classname = classname
+    def initialize(missing_class, identifier)
+      @missing_class = missing_class
       @identifier = identifier
 
-      super("Could not find a #{@classname} object for '#{@identifier}'")
+      super("Could not find a #{@missing_class.name} object for '#{@identifier}'")
+    end
+
+    def classname
+      @missing_class.name
     end
   end
 end

data/lib/sakai-info/metaobj.rb

@@ -0,0 +1,197 @@
+# sakai-info/metaobj.rb
+#   SakaiInfo::Metaobj library (OSP form support)
+#
+# Created 2012-10-15 daveadams@gmail.com
+# Last updated 2012-10-23 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Metaobj < SakaiObject
+    attr_reader :dbrow, :description, :external_type, :schema_hash
+
+    include ModProps
+    created_by_key :owner
+    created_at_key :created
+    modified_by_key :owner
+    modified_at_key :modified
+
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:id]
+      @description = dbrow[:description]
+      @external_type = dbrow[:externaltype]
+      @schema_hash = dbrow[:schema_hash]
+    end
+
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:metaobj_form_def].filter(:id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Metaobj, id)
+        end
+        @@cache[id] = Metaobj.new(row)
+      end
+      @@cache[id]
+    end
+
+    def owner
+      @owner ||= User.find(@dbrow[:owner])
+    end
+
+    def system_only?
+      @dbrow[:systemonly] == 1
+    end
+
+    def site
+      if @dbrow[:siteid]
+        begin
+          @site ||= Site.find(@dbrow[:siteid])
+        rescue ObjectNotFoundException
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    def site_state
+      case @dbrow[:sitestate]
+      when 0
+        "unpublished"
+      when 2
+        "published"
+      else
+        @dbrow[:sitestate]
+      end
+    end
+
+    def published?
+      self.site_state == "published"
+    end
+
+    def global_state
+      case @dbrow[:globalstate]
+      when 0
+        "unpublished"
+      when 1
+        "pending approval"
+      when 2
+        "published"
+      else
+        @dbrow[:globalstate]
+      end
+    end
+
+    def globally_published?
+      self.global_state == "published"
+    end
+
+    def pending_approval?
+      self.global_state == "pending approval"
+    end
+
+    def alternate_create_xslt
+      if @dbrow[:alternatecreatexslt].nil?
+        nil
+      else
+        @@alternate_create_xslt ||= ContentResource.find_by_uuid(@dbrow[:alternatecreatexslt])
+      end
+    end
+
+    def alternate_view_xslt
+      if @dbrow[:alternateviewxslt].nil?
+        nil
+      else
+        @@alternate_view_xslt ||= ContentResource.find_by_uuid(@dbrow[:alternateviewxslt])
+      end
+    end
+
+    def instructions
+      if @dbrow[:instructions].nil?
+        nil
+      else
+        @instructions ||= @dbrow[:instruction].read
+      end
+    end
+
+    def schemadata
+      @schemadata ||= @dbrow[:schemadata].read.force_encoding(Encoding::UTF_8)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "description" => self.description,
+        "owner" => self.owner.serialize(:summary),
+        "site" => nil,
+        "system_only" => self.system_only?,
+        "published" => self.published?,
+        "globally_published" => self.globally_published?,
+        "pending_approval" => self.pending_approval?,
+        "external_type" => self.external_type,
+        "alternate_create_xslt" => nil,
+        "alternate_view_xslt" => nil,
+        "schema_hash" => self.schema_hash,
+      }
+      if self.site.nil?
+        result.delete("site")
+      else
+        result["site"] = self.site.serialize(:summary)
+      end
+      if not self.pending_approval?
+        result.delete("pending_approval")
+      end
+      if self.alternate_create_xslt.nil?
+        result.delete("alternate_create_xslt")
+      else
+        result["alternate_create_xslt"] = self.alternate_create_xslt.serialize(:summary)
+      end
+      if self.alternate_view_xslt.nil?
+        result.delete("alternate_view_xslt")
+      else
+        result["alternate_view_xslt"] = self.alternate_view_xslt.serialize(:summary)
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "description" => self.description,
+        "owner" => self.owner.eid,
+      }
+    end
+
+    def instructions_serialization
+      {
+        "instructions" => self.instructions,
+      }
+    end
+
+    def schemadata_serialization
+      {
+        "schemadata" => self.schemadata,
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :mod,
+       :instructions,
+       :schemadata,
+      ]
+    end
+  end
+end

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-10-06 daveadams@gmail.com
+# Last updated 2012-10-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -36,6 +36,17 @@ module SakaiInfo
       @@cache[id]
     end
 
+    def self.find!(id)
+      begin
+        site = Site.find(id)
+      rescue ObjectNotFoundException => e
+        if e.classname == Site.name
+          site = MissingSite.find(id)
+        end
+      end
+      site
+    end
+
     def initialize(dbrow)
       @dbrow = dbrow
 
@@ -432,6 +443,41 @@ module SakaiInfo
     end
   end
 
+  class MissingSite < Site
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(id)
+      @dbrow = {}
+
+      @id = id
+    end
+
+    def self.find(id)
+      @@cache[id] ||= MissingSite.new(id)
+    end
+
+    def default_serialization
+      {
+        "id" => "MISSING SITE: #{self.id}",
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => "MISSING SITE: #{self.id}",
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+      ]
+    end
+  end
+
   class SiteProperty
     def self.get(site_id, property_name)
       row = DB.connect[:sakai_site_property].

data/lib/sakai-info/user.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::User library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-10-06 daveadams@gmail.com
+# Last updated 2012-10-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -45,9 +45,19 @@ module SakaiInfo
       @@cache[id]
     end
 
+    def self.find!(id)
+      begin
+        user = User.find(id)
+      rescue ObjectNotFoundException => e
+        if e.classname == User.name
+          user = MissingUser.find(id)
+        end
+      end
+    end
+
     def self.get_ids(id)
       @@id_cache[id] ||=
-        DB.connect[:sakai_user_id_map].where({:user_id => id, :eid => id}.sql_or).first
+        DB.connect[:sakai_user_id_map].where(:user_id => id).or(:eid => id).first
     end
 
     def self.get_eid(id)
@@ -240,6 +250,42 @@ module SakaiInfo
     end
   end
 
+  class MissingUser < User
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(id)
+      @dbrow = {}
+
+      @id = id
+      @eid = id
+    end
+
+    def self.find(id)
+      @@cache[id] ||= MissingUser.new(id)
+    end
+
+    def default_serialization
+      {
+        "id" => "MISSING USER: #{self.id}",
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => "MISSING USER: #{self.id}",
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+      ]
+    end
+  end
+
   class UserProperty
     def self.get(user_id, property_name)
       row = DB.connect[:sakai_user_property].

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/lib/sakai-info/wiki.rb

@@ -0,0 +1,288 @@
+# sakai-info/wiki.rb
+#   SakaiInfo::Wiki library
+#
+# Created 2012-10-23 daveadams@gmail.com
+# Last updated 2012-10-31 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class WikiPage < SakaiObject
+    attr_reader :dbrow
+
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:id]
+    end
+
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:rwikiobject].filter(:id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(WikiPage, id)
+        end
+        @@cache[id] = WikiPage.new(row)
+      end
+      @@cache[id]
+    end
+
+    def last_updated
+      @dbrow[:version]
+    end
+
+    def revision
+      @dbrow[:revision]
+    end
+
+    def owner
+      @owner ||= User.find!(@dbrow[:owner])
+    end
+
+    def last_updated_by
+      @updated_by ||= User.find!(@dbrow[:userid])
+    end
+
+    def realm
+      if not self.realm_name.nil?
+        @realm ||= AuthzRealm.find!(self.realm_name)
+      end
+    end
+
+    def realm_name
+      @dbrow[:realm]
+    end
+
+    def site_id
+      @site_id ||= if not self.realm_name.nil?
+                     if self.realm_name =~ /^\/site\/([^\/]+)/
+                       $1
+                     else
+                       nil
+                     end
+                   else
+                     nil
+                   end
+    end
+
+    def site
+      @site ||= if not self.site_id.nil?
+                  Site.find!(self.site_id)
+                else
+                  nil
+                end
+    end
+
+    def page_name
+      @page_name ||= if not self.realm_name.nil?
+                       if @dbrow[:name] =~ /^#{self.realm_name}\/(.+)$/
+                         $1
+                       else
+                         @dbrow[:name]
+                       end
+                     end
+    end
+
+    def owner_readable?
+      @dbrow[:ownerread] == 1
+    end
+
+    def owner_writable?
+      @dbrow[:ownerwrite] == 1
+    end
+
+    def owner_admin?
+      @dbrow[:owneradmin] == 1
+    end
+
+    def group_readable?
+      @dbrow[:groupread] == 1
+    end
+
+    def group_writable?
+      @dbrow[:groupwrite] == 1
+    end
+
+    def group_admin?
+      @dbrow[:groupadmin] == 1
+    end
+
+    def public_readable?
+      @dbrow[:publicread] == 1
+    end
+
+    def public_writable?
+      @dbrow[:publicwrite] == 1
+    end
+
+    def permission_string
+      (self.owner_readable? ? "r" : "-") +
+        (self.owner_writable? ? "w" : "-") +
+        (self.owner_admin? ? "A" : "-") +
+        (self.group_readable? ? "r" : "-") +
+        (self.group_writable? ? "w" : "-") +
+        (self.group_admin? ? "A" : "-") +
+        (self.public_readable? ? "r" : "-") +
+        (self.public_writable? ? "w" : "-") +
+        "-"
+    end
+
+    def content
+      @content ||= DB.connect[:rwikicurrentcontent].where(:rwikiid => self.id).first[:content].read
+    end
+
+    def history
+      @history ||= WikiPageHistory.find_by_wiki_page_id(self.id)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "page_name" => self.page_name,
+        "realm" => self.realm.serialize(:summary),
+        "owner" => self.owner.eid,
+        "last_updated_by" => self.last_updated_by.eid,
+        "last_updated" => self.last_updated,
+        "site" => self.site.serialize(:summary),
+        "permissions" => self.permission_string,
+        "revision" => self.revision,
+      }
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+        "owner" => self.owner.eid,
+        "site_id" => self.site_id,
+      }
+    end
+
+    def history_summary_serialization
+      {
+        "id" => self.id,
+        "last_updated" => self.last_updated,
+        "last_updated_by" => self.last_updated_by.eid,
+      }
+    end
+
+    def permissions_serialization
+      {
+        "permissions" => {
+          "owner" => {
+            "read" => self.owner_readable?,
+            "write" => self.owner_writable?,
+            "admin" => self.owner_admin?,
+          },
+          "group" => {
+            "read" => self.group_readable?,
+            "write" => self.group_writable?,
+            "admin" => self.group_admin?,
+          },
+          "public" => {
+            "read" => self.public_readable?,
+            "write" => self.public_writable?,
+          }
+        }
+      }
+    end
+
+    def history_serialization
+      result = {
+        "history" => self.history.collect { |r| r.serialize(:history) },
+      }
+      if result["history"] == []
+        result = {}
+      end
+      result
+    end
+
+    def content_serialization
+      {
+        "content" => self.content,
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :permissions,
+       :content,
+       :history,
+      ]
+    end
+  end
+
+  class WikiPageHistory < WikiPage
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:rwikihistory].filter(:id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(WikiPageHistory, id)
+        end
+        @@cache[id] = WikiPageHistory.new(row)
+      end
+      @@cache[id]
+    end
+
+    def content
+      @content ||= DB.connect[:rwikihistorycontent].where(:rwikiid => self.id).first[:content].read
+    end
+
+    def wiki_page_id
+      @dbrow[:rwikiobjectid]
+    end
+
+    def wiki_page
+      @wiki_page ||= WikiPage.find(self.wiki_page_id)
+    end
+
+    def self.find_by_wiki_page_id(id)
+      results = []
+      DB.connect[:rwikihistory].filter(:rwikiobjectid => id).
+        order(:revision).all.collect do |row|
+        @@cache[row[:id]] = WikiPageHistory.new(row)
+        results << @@cache[row[:id]]
+      end
+      results
+    end
+
+    def default_serialization
+      result = super
+      result["current_version"] = self.wiki_page.serialize(:history_summary)
+      result
+    end
+
+    def history_serialization
+      {
+        "id" => self.id,
+        "revision" => self.revision,
+        "last_updated" => self.last_updated,
+        "last_updated_by" => self.last_updated_by.eid,
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :permissions,
+       :content,
+      ]
+    end
+  end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.5.2
-  prerelease: 
+  version: 0.5.3
 platform: ruby
 authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: marky_markov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A command line tool and a suite of libraries for representing the objects
@@ -68,37 +61,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sakai-info.rb
-- lib/sakai-info/alias.rb
-- lib/sakai-info/util.rb
-- lib/sakai-info/group.rb
-- lib/sakai-info/private_message.rb
-- lib/sakai-info/tool.rb
-- lib/sakai-info/cli/help.rb
-- lib/sakai-info/cli/query.rb
-- lib/sakai-info/cli/special.rb
-- lib/sakai-info/cli/shell.rb
-- lib/sakai-info/cli/lookup.rb
-- lib/sakai-info/site.rb
-- lib/sakai-info/cache.rb
+- lib/sakai-info/wiki.rb
 - lib/sakai-info/exceptions.rb
-- lib/sakai-info/assignment.rb
 - lib/sakai-info/authz.rb
-- lib/sakai-info/gradebook.rb
-- lib/sakai-info/mod_props.rb
 - lib/sakai-info/forum.rb
-- lib/sakai-info/sakai_object.rb
-- lib/sakai-info/quiz.rb
-- lib/sakai-info/user.rb
-- lib/sakai-info/hacks.rb
+- lib/sakai-info/metaobj.rb
 - lib/sakai-info/version.rb
-- lib/sakai-info/announcement.rb
-- lib/sakai-info/database.rb
 - lib/sakai-info/cli.rb
-- lib/sakai-info/question_pool.rb
+- lib/sakai-info/group.rb
+- lib/sakai-info/quiz.rb
+- lib/sakai-info/mod_props.rb
+- lib/sakai-info/gradebook.rb
+- lib/sakai-info/util.rb
+- lib/sakai-info/assignment.rb
+- lib/sakai-info/private_message.rb
+- lib/sakai-info/sakai_xml_entity.rb
+- lib/sakai-info/database.rb
 - lib/sakai-info/generic_message.rb
-- lib/sakai-info/content.rb
+- lib/sakai-info/sakai_object.rb
 - lib/sakai-info/page.rb
-- lib/sakai-info/sakai_xml_entity.rb
+- lib/sakai-info/user.rb
+- lib/sakai-info/announcement.rb
+- lib/sakai-info/site.rb
+- lib/sakai-info/content.rb
+- lib/sakai-info/hacks.rb
+- lib/sakai-info/alias.rb
+- lib/sakai-info/cli/lookup.rb
+- lib/sakai-info/cli/help.rb
+- lib/sakai-info/cli/special.rb
+- lib/sakai-info/cli/query.rb
+- lib/sakai-info/cli/shell.rb
+- lib/sakai-info/tool.rb
+- lib/sakai-info/cache.rb
+- lib/sakai-info/question_pool.rb
 - bin/sin
 - README.md
 - LICENSE
@@ -107,26 +102,25 @@ files:
 homepage: https://github.com/daveadams/sakai-info
 licenses:
 - Public Domain
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Tools and library for exploring a Sakai database
 test_files: []