sakai-info 0.3.1 → 0.3.2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # sakai-info Change History #
 
+## 0.3.2 ##
+
+*Released 2012-03-08*
+
+* Site supports dbrow and ModProps, added published? method
+* Page supports dbrow, improved serialization methods
+* Tool supports dbrow, improved serialization methods
+* CLI now supports page and tool objects
+
 ## 0.3.1 ##
 
 *Released 2012-02-29*

data/README.md

@@ -1,5 +1,9 @@
 # sakai-info #
 
+last updated: 2012-03-08  
+author: David Adams (daveadams@gmail.com)  
+github url: https://github.com/daveadams/sakai-info
+
 *sakai-info* is a command line tool and a suite of Ruby libraries which enable
 the exploration of a Sakai database without the intermediation of a Java VM or
 any official Sakai code.
@@ -8,12 +12,6 @@ Because the primary goal of this tool is to assist in information gathering
 and troubleshooting, no capability to change the database is included in the
 tool or the libraries.
 
-## Meta ##
-
-last updated: 2012-02-29  
-author: David Adams (daveadams@gmail.com)  
-github url: https://github.com/daveadams/sakai-info
-
 ## Testing ##
 
 Tests are defined in ./test using Test::Unit. The default `rake` action is to
@@ -26,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.1.gem`.
+`sakai-info-0.3.2.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,14 +1,11 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-02-29*
-
-### 0.3.2 ###
-
-* CLI access to groups
+*Last updated 2012-03-08*
 
 ### 0.3.3 ###
 
-* CLI access to pages and tools
+* CLI access to groups
+* User support for --mod and --dbrow
 
 ### 0.3.4 ###
 
@@ -32,8 +29,8 @@
 
 ### 0.4 ###
 
-* Standardized abstraction for user and site to support --mod and --dbrow
 * Sqlite test infrastructure for a few basic objects
+* Command line tool name change to "sin"
 
 ### 0.5 ###
 

data/lib/sakai-info.rb

@@ -80,6 +80,8 @@ require 'sakai-info/sakai_xml_entity'
 # sakai object classes
 require 'sakai-info/user'
 require 'sakai-info/site'
+require 'sakai-info/page'
+require 'sakai-info/tool'
 require 'sakai-info/announcement'
 require 'sakai-info/assignment'
 require 'sakai-info/authz'

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-02-29 daveadams@gmail.com
+# Last updated 2012-03-08 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -15,6 +15,8 @@ module SakaiInfo
   class CLI
     ObjectModes = {
       "site" => Site,
+      "page" => Page,
+      "tool" => Tool,
       "user" => User,
       "quiz" => Quiz,
       "quiz-section" => QuizSection,

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-02-29 daveadams@gmail.com
+# Last updated 2012-03-08 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -20,7 +20,10 @@ sakai-info #{VERSION}
 
   Object commands:
     user           User information
+
     site           Site information
+    page           Site page information
+    tool           Page tool information
 
     quiz           Quiz aka Assessment information, pending or published
     quiz-section   Quiz section information, pending or published
@@ -130,9 +133,26 @@ sakai-info site
     --gradebook    Print gradebook item info
     --realm        Print site realm details
     --forums       Print forum details
+    --mod          Print creation/modification info
     --all          Print all possible details
 EOF
 
+        "page" => <<EOF,
+sakai-info page
+
+  Usage: sakai-info page <id> [<options>]
+
+  Prints information about the page ID specified, including tools.
+EOF
+
+        "tool" => <<EOF,
+sakai-info tool
+
+  Usage: sakai-info tool <id> [<options>]
+
+  Prints information about the tool ID specified.
+EOF
+
         "quiz" => <<EOF,
 sakai-info quiz
 

data/lib/sakai-info/page.rb

@@ -0,0 +1,111 @@
+# sakai-info/page.rb
+#   SakaiInfo::Page library
+#
+# Created 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-08 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Page < SakaiObject
+    attr_reader :title, :order, :layout, :site_id, :dbrow
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:sakai_site_page].where(:page_id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Page, id)
+        end
+
+        @@cache[id] = Page.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.query_by_site_id(site_id)
+      DB.connect[:sakai_site_page].where(:site_id => site_id)
+    end
+
+    def self.count_by_site_id(site_id)
+      Page.query_by_site_id(site_id).count
+    end
+
+    def self.find_by_site_id(site_id)
+      Page.query_by_site_id(site_id).order(:site_order).all.
+        collect { |row| @@cache[row[:page_id]] = Page.new(row) }
+    end
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:page_id]
+      @title = dbrow[:title]
+      @order = dbrow[:site_order].to_i
+      @layout = dbrow[:layout]
+      @site_id = dbrow[:site_id]
+    end
+
+    def site
+      @site ||= Site.find(@site_id)
+    end
+
+    def properties
+      @properties ||= PageProperty.find_by_page_id(@id)
+    end
+
+    def tools
+      @tools ||= Tool.find_by_page_id(@id)
+    end
+
+    # serialization
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "site_id" => self.site_id
+      }
+    end
+
+    def site_summary_serialization
+      result = summary_serialization
+      result.delete("site_id")
+      result["order"] = self.order
+      result["tools"] = self.tools.collect { |tool| tool.serialize(:summary) }
+      if not self.properties.nil? and self.properties != {}
+        result["properties"] = self.properties
+      end
+      result
+    end
+
+    def default_serialization
+      result = site_summary_serialization
+      result["site"] = self.site.serialize(:summary)
+      result
+    end
+  end
+
+  class PageProperty
+    def self.get(page_id, property_name)
+      row = DB.connect[:sakai_site_page_property].
+        filter(:page_id => page_id, :name => property_name).first
+      if row.nil?
+        nil
+      else
+        row[:value].read
+      end
+    end
+
+    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
+      end
+      return properties
+    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-02-28 daveadams@gmail.com
+# Last updated 2012-03-08 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,49 +11,44 @@
 
 module SakaiInfo
   class Site < SakaiObject
-    attr_reader :title, :type
-    attr_reader :created_at, :modified_at
+    attr_reader :title, :type, :dbrow
+
+    include ModProps
+    created_by_key :createdby
+    created_at_key :createdon
+    modified_by_key :modifiedby
+    modified_at_key :modifiedon
 
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        db = DB.connect
-        row = db.fetch("select site_id, title, type, " +
-                       "createdby,  modifiedby, " +
-                       "to_char(createdon,'YYYY-MM-DD HH24:MI:SS') as created_at, " +
-                       "to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS') as modified_at, " +
-                       "joinable, join_role " +
-                       "from sakai_site where site_id=?", id).first
+        row = DB.connect[:sakai_site].where(:site_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(Site, id)
         end
 
-        joinable = false
-        if row[:joinable].to_i == 1
-          joinable = true
-        end
-
-        @@cache[id] = Site.new(id, row[:title], row[:type], row[:createdby],
-                               row[:created_at], row[:modifiedby], row[:modified_at],
-                               joinable, row[:join_role])
+        @@cache[id] = Site.new(row)
       end
       @@cache[id]
     end
 
-    def initialize(id, title, type, created_by_user_id, created_at, modified_by_user_id, modified_at, joinable, join_role)
-      @id = id
-      @title = title
-      @type = type
-      @created_by_user_id = created_by_user_id
-      @created_at = created_at
-      @modified_by_user_id = modified_by_user_id
-      @modified_at = modified_at
-      @joinable = joinable
-      @join_role_string = join_role.to_s
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:site_id]
+      @title = dbrow[:title]
+      @type = dbrow[:type]
+      @is_joinable = (dbrow[:joinable].to_i == 1)
+      @is_published = (dbrow[:published].to_i == 1)
+      @join_role_string = dbrow[:join_role].to_s
     end
 
     def joinable?
-      @joinable
+      @is_joinable
+    end
+
+    def published?
+      @is_published
     end
 
     def join_role
@@ -76,14 +71,6 @@ module SakaiInfo
       @assignments ||= Assignment.find_by_site_id(@id)
     end
 
-    def created_by
-      @created_by ||= User.find(@created_by_user_id)
-    end
-
-    def modified_by
-      @modified_by ||= User.find(@modified_by_user_id)
-    end
-
     def user_count
       @user_count ||=
         DB.connect[:sakai_site_user].filter(:site_id => @id).count
@@ -201,10 +188,6 @@ module SakaiInfo
       DB.connect[:sakai_site_user].where(:user_id => user_id).count
     end
 
-    def self.count_by_type(type)
-      DB.connect[:sakai_site].where(:type => type).count
-    end
-
     def self.count_by_property(name, value)
       DB.connect[:sakai_site_property].
         where(:name => name, :to_char.sql_function(:value) => value).count
@@ -237,35 +220,30 @@ module SakaiInfo
         where(:type => type).all.collect{|r| r[:site_id]}
     end
 
+    # by_type queries
+    def self.query_by_type(type)
+      DB.connect[:sakai_site].where(:type => type)
+    end
+
+    def self.count_by_type(type)
+      Site.query_by_type(type).count
+    end
+
     def self.find_by_type(type)
-      sites = []
-      DB.connect.fetch("select site_id, title, type, " +
-                       "createdby, modifiedby, " +
-                       "to_char(createdon,'YYYY-MM-DD HH24:MI:SS') as created_at, " +
-                       "to_char(modifiedon,'YYYY-MM-DD HH24:MI:SS') as modified_at, " +
-                       "joinable, join_role " +
-                       "from sakai_site where type = ?", type) do |row|
-        joinable = false
-        if joinable_n.to_i == 1
-          joinable = true
-        end
-        @@cache[row[:site_id]] = Site.new(row[:site_id], row[:title], row[:type], row[:createdby], row[:created_at], row[:modifiedby], row[:modified_at], joinable, row[:join_role])
-        sites << @@cache[row[:site_id]]
-      end
-      sites
+      Site.query_by_type(type).all.collect{|row| @@cache[row[:site_id]] = Site.new(row)}
     end
 
+    ############################################################
     # serialization methods
     def default_serialization
       result = {
         "id" => self.id,
         "title" => self.title,
         "type" => self.type,
-        "created_at" => self.created_at,
-        "created_by" => self.created_by.serialize(:summary),
+        "is_published" => self.published?,
         "site_properties" => self.properties,
         "providers" => self.realm.providers,
-        "joinable" => self.joinable?,
+        "is_joinable" => self.joinable?,
         "join_role" => (self.joinable? ? self.join_role : nil),
         "user_count" => self.user_count,
         "group_count" => self.group_count,
@@ -280,7 +258,7 @@ module SakaiInfo
       if result["providers"].nil? or result["providers"] == ""
         result.delete("providers")
       end
-      if result["joinable"] == false
+      if result["is_joinable"] == false
         result.delete("join_role")
       end
       if self.gradebook.nil?
@@ -294,7 +272,7 @@ module SakaiInfo
         "id" => self.id,
         "title" => self.title,
         "type" => self.type,
-        "created_by" => self.created_by.eid
+        "created_by" => self.created_by_id
       }
     end
 
@@ -306,7 +284,7 @@ module SakaiInfo
 
     def pages_serialization
       {
-        "pages" => self.pages.collect { |pg| pg.serialize(:summary) }
+        "pages" => self.pages.collect { |pg| pg.serialize(:site_summary) }
       }
     end
 
@@ -437,189 +415,6 @@ module SakaiInfo
     end
   end
 
-  class Page < SakaiObject
-    attr_reader :title, :order, :layout, :site
-
-    @@cache = {}
-    def self.find(id)
-      if @@cache[id].nil?
-        row = DB.connect[:sakai_site_page].where(:page_id => id).first
-        if row.nil?
-          raise ObjectNotFoundException.new(Page, id)
-        end
-
-        site = Site.find(row[:site_id])
-        @@cache[id] = Page.new(id, row[:title], row[:order].to_i, row[:layout], site)
-      end
-      @@cache[id]
-    end
-
-    def self.find_by_site_id(site_id)
-      results = []
-      site = Site.find(site_id)
-      DB.connect[:sakai_site_page].
-        where(:site_id => site_id).order(:site_order).all.each do |row|
-        @@cache[row[:page_id]] =
-          Page.new(row[:page_id], row[:title], row[:site_order].to_i,
-                   row[:layout], site)
-        results << @@cache[row[:page_id]]
-      end
-      results
-    end
-
-    def initialize(id, title, order, layout, site)
-      @id = id
-      @title = title
-      @order = order
-      @layout = layout
-      @site = site
-    end
-
-    def properties
-      @properties ||= PageProperty.find_by_page_id(@id)
-    end
-
-    def tools
-      @tools ||= Tool.find_by_page_id(@id)
-    end
-
-    # serialization
-    def default_serialization
-      {
-        "id" => self.id,
-        "title" => self.title,
-        "order" => self.order,
-        "tools" => self.tools.collect { |tool| tool.serialize(:summary) },
-        "properties" => self.properties,
-        "site_id" => self.site.id
-      }.delete_if do |k,v|
-        k == "properties" && v == {}
-      end
-    end
-
-    def summary_serialization
-      default_serialization.delete_if do |k,v|
-        k == "site_id"
-      end
-    end
-  end
-
-  class PageProperty
-    def self.get(page_id, property_name)
-      row = DB.connect[:sakai_site_page_property].
-        filter(:page_id => page_id, :name => property_name).first
-      if row.nil?
-        nil
-      else
-        row[:value].read
-      end
-    end
-
-    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
-      end
-      return properties
-    end
-  end
-
-  class Tool < SakaiObject
-    attr_reader :title, :registration, :order, :layout, :page, :site
-
-    @@cache = {}
-    def self.find(id)
-      if @@cache[id].nil?
-        row = DB.connect[:sakai_site_tool].where(:tool_id => id).first
-        if row.nil?
-          raise ObjectNotFoundException.new(Tool, id)
-        end
-
-        page = Page.find(row[:page_id])
-        @@cache[id] =
-          Tool.new(id, row[:title], row[:registration], row[:page_order].to_i,
-                   row[:layout_hints], page)
-      end
-      @@cache[id]
-    end
-
-    def self.find_by_page_id(page_id)
-      results = []
-      page = Page.find(page_id)
-      DB.connect[:sakai_site_tool].
-        where(:page_id => page_id).order(:page_order).all.each do |row|
-        @@cache[row[:tool_id]] =
-          Tool.new(row[:tool_id], row[:title], row[:registration], row[:page_order].to_i,
-                   row[:layout_hints], page)
-        results << @@cache[row[:tool_id]]
-      end
-      results
-    end
-
-    def initialize(id, title, registration, order, layout, page)
-      @id = id
-      @title = title
-      @registration = registration
-      @order = order
-      @layout = layout
-      @page = page
-      @site = page.site
-    end
-
-    def properties
-      @properties ||= ToolProperty.find_by_tool_id(@id)
-    end
-
-    # serialization
-    def default_serialization
-      result = {
-        "id" => self.id,
-        "registration" => self.registration,
-        "title" => self.title,
-        "site" => self.site.serialize(:summary),
-        "page_id" => self.page.id,
-        "order" => self.order,
-        "layout" => self.layout,
-        "properties" => self.properties
-      }
-      if result["properties"] == {}
-        result.delete("properties")
-      end
-      if result["layout"].nil?
-        result.delete("layout")
-      end
-      result
-    end
-
-    def summary_serialization
-      {
-        "id" => self.id,
-        "registration" => self.registration,
-        "title" => self.title
-      }
-    end
-  end
-
-  class ToolProperty
-    def self.get(tool_id, property_name)
-      row = DB.connect[:sakai_site_tool_property].
-        filter(:tool_id => tool_id, :name => property_name).first
-      if row.nil?
-        nil
-      else
-        row[:value].read
-      end
-    end
-
-    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
-      end
-      return properties
-    end
-  end
-
   class SiteMembership < SakaiObject
     attr_reader :site, :user, :role
 

data/lib/sakai-info/tool.rb

@@ -0,0 +1,116 @@
+# sakai-info/tool.rb
+#   SakaiInfo::Tool library
+#
+# Created 2012-03-08 daveadams@gmail.com
+# Last updated 2012-03-08 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Tool < SakaiObject
+    attr_reader :title, :registration, :order, :layout, :page_id, :site_id, :dbrow
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:sakai_site_tool].where(:tool_id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Tool, id)
+        end
+
+        @@cache[id] = Tool.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.query_by_page_id(page_id)
+      DB.connect[:sakai_site_tool].where(:page_id => page_id)
+    end
+
+    def self.count_by_page_id(page_id)
+      Tool.query_by_page_id(page_id).count
+    end
+
+    def self.find_by_page_id(page_id)
+      Tool.query_by_page_id(page_id).order(:page_order).all.
+        collect { |row| @@cache[row[:tool_id]] = Tool.new(row) }
+    end
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:tool_id]
+      @title = dbrow[:title]
+      @registration = dbrow[:registration]
+      @order = dbrow[:page_order].to_i
+      @layout = dbrow[:layout_hints]
+      @page_id = dbrow[:page_id]
+      @site_id = dbrow[:site_id]
+    end
+
+    def page
+      @page ||= Page.find(@page_id)
+    end
+
+    def site
+      @site ||= Site.find(@site_id)
+    end
+
+    def properties
+      @properties ||= ToolProperty.find_by_tool_id(@id)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "registration" => self.registration,
+        "title" => self.title,
+        "site" => self.site.serialize(:summary),
+        "page_id" => self.page_id,
+        "order" => self.order,
+        "layout" => self.layout,
+        "properties" => self.properties
+      }
+      if result["properties"] == {}
+        result.delete("properties")
+      end
+      if result["layout"].nil?
+        result.delete("layout")
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "registration" => self.registration,
+        "title" => self.title
+      }
+    end
+  end
+
+  class ToolProperty
+    def self.get(tool_id, property_name)
+      row = DB.connect[:sakai_site_tool_property].
+        filter(:tool_id => tool_id, :name => property_name).first
+      if row.nil?
+        nil
+      else
+        row[:value].read
+      end
+    end
+
+    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
+      end
+      return properties
+    end
+  end
+end
+

data/lib/sakai-info/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-29 00:00:00 -06:00
+date: 2012-03-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ extra_rdoc_files: []
 files: 
 - lib/sakai-info.rb
 - lib/sakai-info/group.rb
+- lib/sakai-info/tool.rb
 - lib/sakai-info/cli/help.rb
 - lib/sakai-info/site.rb
 - lib/sakai-info/assignment.rb
@@ -73,6 +74,7 @@ files:
 - lib/sakai-info/question_pool.rb
 - lib/sakai-info/message.rb
 - lib/sakai-info/content.rb
+- lib/sakai-info/page.rb
 - lib/sakai-info/sakai_xml_entity.rb
 - bin/sakai-info
 - README.md