sakai-info 0.3.4 → 0.3.5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+## 0.3.5 ##
+
+*Released 2012-04-02*
+
+* Basic Forum, ForumThread, and ForumPost support in CLI
+* Refactored Forum support in library
+* Fixed join_role serialization for Site
+
 ## 0.3.4 ##
 
 *Released 2012-03-09*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-03-09  
+last updated: 2012-04-02  
 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.4.gem`.
+`sakai-info-0.3.5.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,38 +1,35 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-03-09*
+*Last updated 2012-04-02*
 
-### 0.3.5 ###
+### 0.4.0 ###
 
-* CLI access to forums
-
-### 0.3.6 ###
-
-* CLI access to gradebook
+* CLI access to content
+* Content binary entity parsing
+* Command line tool name change to "sin"
 
-### 0.3.7 ###
+### 0.4.1 ###
 
 * CLI access to announcements
 
-### 0.3.8 ###
+### 0.4.2 ###
 
-* CLI access to content
+* CLI access to gradebook
 
-### 0.3.9 ###
+### 0.4.3 ###
 
 * CLI access to authz (realms, roles, functions)
 
-### 0.4 ###
+### 0.5.0 ###
 
 * Sqlite test infrastructure for a few basic objects
-* Command line tool name change to "sin"
 
-### 0.5 ###
+### 0.6.0 ###
 
 * Test fixtures and basic unit tests for all represented objects
 * RDoc coverage for every class
 
-### 0.6 ###
+### 0.7.0 ###
 
 * Basic OSP support
 

data/lib/sakai-info.rb

@@ -88,7 +88,8 @@ require 'sakai-info/authz'
 require 'sakai-info/content'
 require 'sakai-info/gradebook'
 require 'sakai-info/group'
-require 'sakai-info/message'
 require 'sakai-info/quiz'
 require 'sakai-info/question_pool'
+require 'sakai-info/generic_message'
+require 'sakai-info/forum'
 

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-09 daveadams@gmail.com
+# Last updated 2012-04-02 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -32,6 +32,9 @@ module SakaiInfo
       "question-pool" => QuestionPool,
       "assignment" => Assignment,
       "assignment-submission" => AssignmentSubmission,
+      "forum" => Forum,
+      "forum-thread" => ForumThread,
+      "forum-post" => ForumPost,
     }
   end
 end

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-09 daveadams@gmail.com
+# Last updated 2012-04-02 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -41,6 +41,10 @@ sakai-info #{VERSION}
     assignment-submission
                    Assignment submission information
 
+    forum          Forum information
+    forum-thread   Forum Thread information
+    forum-post     Forum Post information
+
   Misc commands:
     test         Tests configured database connections
     help         Prints general help
@@ -292,6 +296,44 @@ sakai-info assignment-submission
     --mod          Print creation/modification info
     --all          Print all possible details
 EOF
+
+        "forum" => <<EOF,
+sakai-info forum
+
+  Usage: sakai-info forum <id> [<options>]
+
+  Prints information about the forum ID specified. Additional options may be
+  passed to include additional information:
+
+    --threads    Print summary of all threads
+    --mod        Print creation/modification info
+    --all        Print all possible details
+EOF
+
+        "forum-thread" => <<EOF,
+sakai-info forum-thread
+
+  Usage: sakai-info forum-thread <id> [<options>]
+
+  Prints information about the forum thread ID specified. Additional options
+  may be passed to include additional information:
+
+    --posts      Print summary of all posts
+    --mod        Print creation/modification info
+    --all        Print all possible details
+EOF
+
+        "forum-post" => <<EOF,
+sakai-info forum-post
+
+  Usage: sakai-info forum-post <id> [<options>]
+
+  Prints information about the forum post ID specified. Additional options
+  may be passed to include additional information:
+
+    --mod        Print creation/modification info
+    --all        Print all possible details
+EOF
       }
 
       def self.help(topic = :default, io = STDOUT)

data/lib/sakai-info/forum.rb

@@ -0,0 +1,263 @@
+# sakai-info/forum.rb
+#   SakaiInfo::Forum library
+#
+# Created 2012-04-01 daveadams@gmail.com
+# Last updated 2012-04-01 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Forum < SakaiObject
+    attr_reader :id, :title, :dbrow
+
+    include ModProps
+    created_by_key :created_by
+    created_at_key :created
+    modified_by_key :modified_by
+    modified_at_key :modified
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id.to_s].nil?
+        row = DB.connect[:mfr_open_forum_t].where(:id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Forum, id)
+        end
+        @@cache[id.to_s] = Forum.new(row)
+      end
+      @@cache[id.to_s]
+    end
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:id].to_i
+      @title = dbrow[:title]
+      @area_id = dbrow[:surrogatekey]
+
+      @site_id_is_nil = false
+    end
+
+    def site_id
+      return nil if @site_id_is_nil
+
+      if @site_id.nil?
+        result = DB.connect[:mfr_area_t].
+          select(:context_id).where(:id => @area_id).first
+        if result.nil?
+          @site_id_is_nil = true
+          return nil
+        else
+          @site_id = result[:context_id]
+        end
+      end
+      @site_id
+    end
+
+    def site
+      if self.site_id.nil?
+        return nil
+      end
+
+      @site ||= Site.find(self.site_id)
+    end
+
+    def thread_count
+      @thread_count ||= ForumThread.count_by_forum_id(self.id)
+    end
+
+    def threads
+      @threads ||= ForumThread.find_by_forum_id(self.id)
+    end
+
+    def self.query_by_site_id(site_id)
+      db = DB.connect
+      db[:mfr_open_forum_t].
+        where(:surrogatekey =>
+              db[:mfr_area_t].select(:id).where(:context_id => site_id)).
+        where(:forum_dtype => "DF")
+    end
+
+    def self.count_by_site_id(site_id)
+      Forum.query_by_site_id(site_id).count
+    end
+
+    def self.find_by_site_id(site_id)
+      Forum.query_by_site_id(site_id).all.
+        collect { |row| @@cache[row[:id].to_i.to_s] = Forum.new(row) }
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "site" => self.site.serialize(:summary),
+        "thread_count" => self.thread_count,
+      }
+    end
+
+    def threads_serialization
+      {
+        "threads" => self.threads.collect { |t| t.serialize(:summary) }
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title
+      }
+    end
+
+    def self.all_serializations
+      [ :default, :threads ]
+    end
+  end
+
+  class ForumThread < GenericThread
+    attr_reader :id, :title, :dbrow
+
+    include ModProps
+    created_by_key :created_by
+    created_at_key :created
+    modified_by_key :modified_by
+    modified_at_key :modified
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id.to_s].nil?
+        row = DB.connect[:mfr_topic_t].where(:id => id, :topic_dtype => "DT").first
+        if row.nil?
+          raise ObjectNotFoundException.new(ForumThread, id)
+        end
+        @@cache[id.to_s] = ForumThread.new(row)
+      end
+      @@cache[id.to_s]
+    end
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:id].to_i
+      @title = dbrow[:title]
+    end
+
+    def post_count
+      @post_count ||= ForumPost.count_by_thread_id(self.id)
+    end
+
+    def posts
+      @posts ||= ForumPost.find_by_thread_id(self.id)
+    end
+
+    def self.query_by_forum_id(forum_id)
+      DB.connect[:mfr_topic_t].where(:of_surrogatekey => forum_id)
+    end
+
+    def self.count_by_forum_id(forum_id)
+      ForumThread.query_by_forum_id(forum_id).count
+    end
+
+    def self.find_by_forum_id(forum_id)
+      ForumThread.query_by_forum_id(forum_id).all.collect { |r| ForumThread.new(r) }
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "post_count" => self.post_count,
+      }
+    end
+
+    def posts_serialization
+      if self.post_count > 0
+        {
+          "posts" => self.posts.collect { |p| p.serialize(:summary) }
+        }
+      else
+        { }
+      end
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+      }
+    end
+
+    def self.all_serializations
+      [ :default, :posts ]
+    end
+  end
+
+  class ForumPost < GenericMessage
+    attr_reader :id, :title, :dbrow
+
+    include ModProps
+    created_by_key :created_by
+    created_at_key :created
+    modified_by_key :modified_by
+    modified_at_key :modified
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id.to_s].nil?
+        row = DB.connect[:mfr_message_t].where(:id => id, :message_dtype => "ME").first
+        if row.nil?
+          raise ObjectNotFoundException.new(ForumPost, id)
+        end
+        @@cache[id.to_s] = ForumPost.new(row)
+      end
+      @@cache[id.to_s]
+    end
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:id].to_i
+      @title = dbrow[:title]
+    end
+
+    def author
+      @author ||= User.find(@dbrow[:author])
+    end
+
+    def thread
+      @thread ||= ForumThread.find(@dbrow[:surrogatekey])
+    end
+
+    def self.query_by_thread_id(thread_id)
+      DB.connect[:mfr_message_t].where(:surrogatekey => thread_id)
+    end
+
+    def self.count_by_thread_id(thread_id)
+      ForumPost.query_by_thread_id(thread_id).count
+    end
+
+    def self.find_by_thread_id(thread_id)
+      ForumPost.query_by_thread_id(thread_id).all.collect { |r| ForumPost.new(r) }
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "author" => self.author.serialize(:summary),
+        "thread" => self.thread.serialize(:summary),
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+      }
+    end
+  end
+end
+

data/lib/sakai-info/generic_message.rb

@@ -0,0 +1,67 @@
+# sakai-info/generic_message.rb
+#   SakaiInfo::GenericMessage library
+#
+# Created 2012-04-01 daveadams@gmail.com
+# Last updated 2012-04-01 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class UnknownMessageTypeException < SakaiException; end
+  class GenericMessage < SakaiObject
+    def self.types
+      {
+        "ME" => "Forum Post",
+        "PM" => "Private Message"
+      }
+    end
+
+    def self.valid_message_type?(mt)
+      GenericMessage.types.keys.include?(mt)
+    end
+
+    def self.count_by_date_and_message_type(count_date, message_type)
+      date_str = nil
+      if count_date.is_a? Time
+        date_str = count_date.strftime("%Y-%m-%d")
+      elsif count_date.is_a? String
+        if count_date =~ /^\d\d\d\d-\d\d-\d\d$/
+          date_str = count_date
+        else
+          raise InvalidDateException
+        end
+      else
+        raise InvalidDateException
+      end
+
+      if not valid_message_type? message_type
+        raise UnknownMessageTypeException
+      end
+
+      DB.connect.fetch("select count(*) as count from mfr_message_t " +
+                       "where message_dtype = ? and " +
+                       "to_char(created,'YYYY-MM-DD') = ? ",
+                       message_type, date_str).first[:count].to_i
+    end
+  end
+
+  class GenericThread < SakaiObject
+    def self.types
+      {
+        "TO" => "Generic Thread",
+        "PT" => "Private Thread",
+        "OT" => "Open Thread",
+        "DT" => "Discussion Thread"
+      }
+    end
+
+    def self.valid_message_type?(mt)
+      GenericThread.types.keys.include?(mt)
+    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-03-09 daveadams@gmail.com
+# Last updated 2012-04-01 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -244,7 +244,7 @@ module SakaiInfo
         "site_properties" => self.properties,
         "providers" => self.realm.providers,
         "is_joinable" => self.joinable?,
-        "join_role" => (self.joinable? ? self.join_role : nil),
+        "join_role" => (self.joinable? ? self.join_role.name : nil),
         "user_count" => self.user_count,
         "group_count" => self.group_count,
         "page_count" => self.page_count,

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-09 00:00:00 -06:00
+date: 2012-04-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - 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
@@ -72,6 +73,7 @@ files:
 - lib/sakai-info/database.rb
 - lib/sakai-info/cli.rb
 - lib/sakai-info/question_pool.rb
+- lib/sakai-info/generic_message.rb
 - lib/sakai-info/message.rb
 - lib/sakai-info/content.rb
 - lib/sakai-info/page.rb