sakai-info 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # sakai-info Change History #
 
+## 0.3.1 ##
+
+*Released 2012-02-29*
+
+* New objects: quiz-attempt, quiz-attempt-item, quiz-attempt-item-attachment
+* More new objects: assignment, assignment-submission
+* SakaiXMLEntity base class supports ModProps
+* New standard CL arguments: --dbrow-only and --mod-details
+* First steps towards a sqlite test infrastructure: schema creation
+* First steps towards better Sakai DB docs: graphviz file for quiz tables
+
 ## 0.3.0 ##
 
 *Released 2012-02-26*

data/README.md

@@ -10,7 +10,7 @@ tool or the libraries.
 
 ## Meta ##
 
-last updated: 2012-02-26  
+last updated: 2012-02-29  
 author: David Adams (daveadams@gmail.com)  
 github url: https://github.com/daveadams/sakai-info
 
@@ -26,7 +26,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.0.gem`.
+`sakai-info-0.3.1.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,10 +1,6 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-02-26*
-
-### 0.3.1  ###
-
-* CLI access to assignments
+*Last updated 2012-02-29*
 
 ### 0.3.2 ###
 
@@ -18,6 +14,22 @@
 
 * CLI access to forums
 
+### 0.3.5 ###
+
+* CLI access to gradebook
+
+### 0.3.6 ###
+
+* CLI access to announcements
+
+### 0.3.7 ###
+
+* CLI access to content
+
+### 0.3.8 ###
+
+* CLI access to authz (realms, roles, functions)
+
 ### 0.4 ###
 
 * Standardized abstraction for user and site to support --mod and --dbrow

data/bin/sakai-info

@@ -140,9 +140,9 @@ if flags.include? "--all"
   serials = CLI::ObjectModes[mode].all_serializations
 elsif
   flags.include? "--dbrow-only"
-  serials = [:dbrow]
+  serials = [:dbrow_only]
 else
-  serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').to_sym}
+  serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').gsub("-","_").to_sym}
 end
 begin
   puts CLI::ObjectModes[mode].find(id).to_yaml(serials)

data/lib/sakai-info.rb

@@ -73,9 +73,9 @@ end
 require 'sakai-info/database'
 
 # base objects
+require 'sakai-info/mod_props'
 require 'sakai-info/sakai_object'
 require 'sakai-info/sakai_xml_entity'
-require 'sakai-info/mod_props'
 
 # sakai object classes
 require 'sakai-info/user'

data/lib/sakai-info/assignment.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Assignment library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-02-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,46 +11,43 @@
 
 module SakaiInfo
   class Assignment < SakaiXMLEntity
-    attr_reader :site
+    attr_reader :dbrow, :site_id
 
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
         xml = ""
-        row = DB.connect[:assignment_assigment].filter(:assignment_id => id).first
+        row = DB.connect[:assignment_assignment].where(:assignment_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(Assignment, id)
         end
-        site = Site.find(row[:context])
-        REXML::Document.new(row[:xml].read).write(xml, 2)
-        @@cache[id] = Assignment.new(id, site, xml)
+        @@cache[id] = Assignment.new(row)
       end
       @@cache[id]
     end
 
     # raw data constructor
-    def initialize(id, site, xml)
-      @id = id
-      @site = site
-      @xml = xml
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:assignment_id]
+      @site_id = dbrow[:context]
+
       parse_xml
     end
 
     # set lookup
+    def self.query_by_site_id(site_id)
+      DB.connect[:assignment_assignment].where(:context => site_id)
+    end
+
     def self.find_by_site_id(site_id)
-      assignments = []
-      site = Site.find(site_id)
-      DB.connect[:assignment_assignment].filter(:context => site_id).all.each do |row|
-        id = row[:assignment_id]
-        xml = ""
-        REXML::Document.new(row[:xml].read).write(xml, 2)
-        assignments << Assignment.new(id, site, xml)
-      end
-      return assignments
+      Assignment.query_by_site_id(site_id).
+        all.collect { |row| Assignment.new(row) }
     end
 
     def self.count_by_site_id(site_id)
-      DB.connect[:assignment_assignment].filter(:context => site_id).count
+      Assignment.query_by_site_id(site_id).count
     end
 
     # getters
@@ -58,12 +55,16 @@ module SakaiInfo
       @attributes["title"]
     end
 
+    def site
+      @site ||= Site.find(self.site_id)
+    end
+
     def submissions
-      @submissions ||= AssignmentSubmission.find_by_assignment_id(@id)
+      @submissions ||= AssignmentSubmission.find_by_assignment_id(self.id)
     end
 
     def submission_count
-      @submission_count ||= AssignmentSubmission.count_by_assignment_id(@id)
+      @submission_count ||= AssignmentSubmission.count_by_assignment_id(self.id)
     end
 
     # yaml/json serialization
@@ -72,9 +73,7 @@ module SakaiInfo
         "id" => self.id,
         "title" => self.title,
         "site" => self.site.serialize(:summary),
-        "created_by" => self.created_by.eid,
-        "created_at" => self.created_at,
-        "submissions" => self.submission_count
+        "submission_count" => self.submission_count
       }
     end
 
@@ -82,118 +81,122 @@ module SakaiInfo
       {
         "id" => self.id,
         "title" => self.title,
-        "created_by" => self.created_by.eid,
-        "submissions" => self.submission_count
+        "submission_count" => self.submission_count
+      }
+    end
+
+    def submissions_serialization
+      {
+        "submissions" => self.submissions.collect{|s|s.serialize(:assignment_summary)}
       }
     end
   end
 
   class AssignmentSubmission < SakaiXMLEntity
-    attr_reader :assignment, :submitter
+    attr_reader :dbrow, :assignment_id, :submitter_id
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:submission_id]
+      @assignment_id = dbrow[:context]
+      @submitter_id = dbrow[:submitter_id]
+      @is_submitted = (dbrow[:submitted] == "true")
+      @is_graded = (dbrow[:graded] == "true")
 
-    def initialize(id, assignment, xml, submitter, submitted, graded)
-      @id = id
-      @assignment = assignment
-      @xml = xml
-      @submitter = submitter
-      @submitted = submitted
-      @graded = graded
       parse_xml
     end
 
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        assignment = submitter = submitted_at = submitted = graded = nil
-        xml = ""
-        row = DB.connect[:assignment_submission].filter(:submission_id => id).first
+        row = DB.connect[:assignment_submission].where(:submission_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(AssignmentSubmission, id)
         end
 
-        assignment = Assignment.find(row[:context])
-        REXML::Document.new(row[:xml].read).write(xml, 2)
-        submitter = User.find(row[:submitter_id])
-        submitted = (row[:submitted] == "true")
-        graded = (row[:graded] == "true")
-
-        @@cache[id] = AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
+        @@cache[id] = AssignmentSubmission.new(row)
       end
       @@cache[id]
     end
 
+    def submitter
+      @submitter ||= User.find(self.submitter_id)
+    end
+
+    def assignment
+      @assignment ||= Assignment.find(self.assignment_id)
+    end
+
     def submitted?
-      ( created_by.eid == @submitter.eid && @submitted ) || false
+      ( self.created_by_id == self.submitter_id && @is_submitted ) || false
     end
 
     def graded?
-      @graded || false
+      @is_graded || false
     end
 
     def submitted_at
       @submitted_at ||= format_entity_date(@attributes["datesubmitted"])
     end
 
+    def self.query_by_assignment_id(assignment_id)
+      DB.connect[:assignment_submission].where(:context => assignment_id)
+    end
+
     def self.find_by_assignment_id(assignment_id)
-      submissions = []
-      assignment = Assignment.find(assignment_id)
-      DB.connect[:assignment_submission].filter(:context => assignment_id).all.each do |row|
-        id = row[:submission_id]
-        xml = ""
-        REXML::Document.new(row[:xml].read).write(xml, 2)
-        submitter = User.find(row[:submitter_id])
-        submitted = (row[:submitted] == "true")
-        graded = (row[:graded] == "true")
-        submissions << AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
-      end
-      return submissions
+      AssignmentSubmission.query_by_assignment_id(assignment_id).
+        all.collect { |row| AssignmentSubmission.new(row) }
     end
 
     def self.count_by_assignment_id(assignment_id)
-      DB.connect[:assignment_submission].filter(:context => assignment_id).count
+      AssignmentSubmission.query_by_assignment_id(assignment_id).count
+    end
+
+    def self.query_by_user_id(user_id)
+      DB.connect[:assignment_submission].where(:submitter_id => user_id)
     end
 
     def self.find_by_user_id(user_id)
-      submissions = []
-      submitter = User.find(user_id)
-      DB.connect[:assignment_submission].filter(:submitter_id => user_id).all.each do |row|
-        id = row[:submission_id]
-        assignment = Assignment.find(row[:context])
-        xml = ""
-        REXML::Document.new(row[:xml].read).write(xml, 2)
-        submitted = (row[:submitted] == "true")
-        graded = (row[:graded] == "true")
-        submissions << AssignmentSubmission.new(id, assignment, xml, submitter, submitted, graded)
-      end
-      return submissions
+      AssignmentSubmission.query_by_user_id(user_id).
+        all.collect { |row| AssignmentSubmission.new(row) }
     end
 
     def self.count_by_user_id(user_id)
-      DB.connect[:assignment_submission].filter(:submitter_id => user_id).count
+      AssignmentSubmission.query_by_user_id(user_id).count
     end
 
     # yaml/json serialization
     def default_serialization
-      {
+      result = {
         "id" => self.id,
         "assignment" => self.assignment.serialize(:summary),
         "submitter" => self.submitter.serialize(:summary),
-        "submitted" => self.submitted?,
+        "is_submitted" => self.submitted?,
         "submitted_at" => self.submitted_at,
-        "graded" => self.graded?,
-        "created_by" => self.created_by.eid,
-        "created_at" => self.created_at,
-        "modified_by" => self.modified_by.eid,
-        "modified_at" => self.modified_at
+        "is_graded" => self.graded?,
       }
+      if not self.submitted?
+        result.delete("submitted_at")
+        result.delete("is_graded")
+      end
+      result
     end
 
     def summary_serialization
       {
         "id" => self.id,
-        "assignment_id" => self.assignment.id,
-        "submitter" => self.submitter.eid,
-        "submitted" => self.submitted?
+        "assignment_id" => self.assignment_id,
+        "submitter" => User.get_eid(self.submitter_id),
+        "is_submitted" => self.submitted?
+      }
+    end
+
+    def assignment_summary_serialization
+      {
+        "id" => self.id,
+        "submitter" => User.get_eid(self.submitter_id),
+        "is_submitted" => self.submitted?
       }
     end
   end
@@ -211,7 +214,7 @@ module SakaiInfo
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        row = DB.connect[:assignment_content].filter(:content_id => id).first
+        row = DB.connect[:assignment_content].where(:content_id => id).first
         if row.nil?
           raise ObjectNotFoundException.new(AssignmentContent, id)
         end
@@ -224,7 +227,7 @@ module SakaiInfo
 
     def self.find_by_user_id(user_id)
       contents = []
-      DB.connect[:assignment_content].filter(:context => user_id).all.each do |row|
+      DB.connect[:assignment_content].where(:context => user_id).all.each do |row|
         id = row[:content_id]
         context = row[:context]
         xml = ""
@@ -235,7 +238,7 @@ module SakaiInfo
     end
 
     def self.count_by_user_id(user_id)
-      DB.connect[:assignment_content].filter(:context => user_id).count
+      DB.connect[:assignment_content].where(:context => user_id).count
     end
 
     # getters

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-26 daveadams@gmail.com
+# Last updated 2012-02-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -19,8 +19,13 @@ module SakaiInfo
       "quiz" => Quiz,
       "quiz-section" => QuizSection,
       "quiz-item" => QuizItem,
+      "quiz-attempt" => QuizAttempt,
+      "quiz-attempt-item" => QuizAttemptItem,
+      "quiz-attempt-item-attachment" => QuizAttemptItemAttachment,
       "qpool" => QuestionPool,
       "question-pool" => QuestionPool,
+      "assignment" => Assignment,
+      "assignment-submission" => AssignmentSubmission,
     }
   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-02-26 daveadams@gmail.com
+# Last updated 2012-02-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -21,11 +21,22 @@ sakai-info #{VERSION}
   Object commands:
     user           User information
     site           Site information
+
     quiz           Quiz aka Assessment information, pending or published
     quiz-section   Quiz section information, pending or published
     quiz-item      Quiz item information, pending or published
+    quiz-attempt   Quiz attempt information
+    quiz-attempt-item
+                   Information on attempted quiz items
+    quiz-attempt-item-attachment
+                   Information on file attachments to attempted quiz items
+
     question-pool  Question Pool information
 
+    assignment     Assignment information
+    assignment-submission
+                   Assignment submission information
+
   Misc commands:
     test         Tests configured database connections
     help         Prints general help
@@ -45,11 +56,17 @@ sakai-info #{VERSION}
         trace log to STDOUT.
 
   Options that work on most object types:
+    --dbrow
+        Print the raw database fields in addition to the usual summary.
+
     --dbrow-only
         Print only the raw database fields for the object requested.
 
     --mod
-        Print creation and modification users and timestamps.
+        Print creation and modification user EIDs and timestamps.
+
+    --mod-details
+        Print creation and modification user details and timestamps.
 
     --all
         Print all possible information (other than dbrow)
@@ -126,13 +143,12 @@ sakai-info quiz
   include additional information:
 
     --sections   Print section summary list
+    --attempts   Print summary of user quiz attempts
     --mod        Print creation/modification info
     --all        Print all possible details
-    --dbrow      Print the raw database fields
 
   Not yet implemented:
     --items      Print summary of items on the quiz
-    --attempts   Print summary of user quiz attempts (for published quizzes)
 EOF
 
         "quiz-section" => <<EOF,
@@ -147,7 +163,6 @@ sakai-info quiz-section
     --items      Print summary of items in the section
     --mod        Print creation/modification info
     --all        Print all possible details
-    --dbrow      Print the raw database fields
 EOF
 
         "quiz-item" => <<EOF,
@@ -161,7 +176,6 @@ sakai-info quiz-item
 
     --mod        Print creation/modification info
     --all        Print all possible details
-    --dbrow      Print the raw database fields
 EOF
 
         "question-pool" => <<EOF,
@@ -174,7 +188,6 @@ sakai-info question-pool
   may be passed to include additional information:
 
     --mod      Print creation/modification info
-    --dbrow    Print the raw database fields
 
   Not yet implemented:
     --items    Print summary of items in the pool
@@ -182,6 +195,69 @@ sakai-info question-pool
     --all      Print all possible details
 EOF
 
+        "quiz-attempt" => <<EOF,
+sakai-info quiz-attempt
+
+  Usage: sakai-info quiz-attempt <id> [<options>]
+
+  Prints information about the quiz attempt ID specified. Additional options
+  may be passed to include additional information:
+
+    --items      Print list of attempted items
+    --all        Print all possible details
+EOF
+
+
+        "quiz-attempt-item" => <<EOF,
+sakai-info quiz-attempt-item
+
+  Usage: sakai-info quiz-attempt-item <id> [<options>]
+
+  Prints information about the quiz attempt item ID specified. Additional
+  options may be passed to include additional information:
+
+    --attachments  Print a list of file attachments, if any
+    --all          Print all possible details
+EOF
+
+        "quiz-attempt-item-attachment" => <<EOF,
+sakai-info quiz-attempt-item-attachment
+
+  Usage: sakai-info quiz-attempt-item-attachment <id> [<options>]
+
+  Prints information about the quiz attempt item attachment ID specified.
+  Additional options may be passed to include additional information:
+
+    --mod        Print creation/modification info
+    --all        Print all possible details
+EOF
+
+        "assignment" => <<EOF,
+sakai-info assignment
+
+  Usage: sakai-info assignment <id> [<options>]
+
+  Prints information about the assignment ID specified. Additional options
+  may be passed to include additional information:
+
+    --submissions  Print summary of all submissions
+    --xml          Print the raw XML
+    --mod          Print creation/modification info
+    --all          Print all possible details
+EOF
+
+        "assignment-submission" => <<EOF,
+sakai-info assignment-submission
+
+  Usage: sakai-info assignment-submission <id> [<options>]
+
+  Prints information about the assignment submission ID specified. Additional
+  options may be passed to include additional information:
+
+    --xml          Print the raw XML
+    --mod          Print creation/modification info
+    --all          Print all possible details
+EOF
       }
 
       def self.help(topic = :default, io = STDOUT)

data/lib/sakai-info/mod_props.rb

@@ -61,10 +61,19 @@ module SakaiInfo
 
         def mod_serialization
           {
+            "created_at" => self.created_at,
+            "created_by" => User.get_eid(self.created_by_id),
+            "modified_at" => self.modified_at,
+            "modified_by" => User.get_eid(self.modified_by_id),
+          }
+        end
+
+        def mod_details_serialization
+          {
+            "created_at" => self.created_at,
             "created_by" => self.created_by.serialize(:summary),
-            "created_at" => self.created_at.strftime("%Y-%m-%d %H:%M:%S"),
+            "modified_at" => self.modified_at,
             "modified_by" => self.modified_by.serialize(:summary),
-            "modified_at" => self.modified_at.strftime("%Y-%m-%d %H:%M:%S")
           }
         end
       }

data/lib/sakai-info/quiz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Quiz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-26 daveadams@gmail.com
+# Last updated 2012-02-28 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -107,11 +107,17 @@ module SakaiInfo
         "title" => self.title,
         "site" => nil,
         "type" => self.quiz_type,
-        "section_count" => self.section_count
+        "section_count" => self.section_count,
+        "attempt_count" => nil
       }
       if not self.site.nil?
         result["site"] = self.site.serialize(:summary)
       end
+      if self.respond_to? :attempt_count
+        result["attempt_count"] = self.attempt_count
+      else
+        result.delete("attempt_count")
+      end
       result
     end
 
@@ -140,6 +146,10 @@ module SakaiInfo
         "sections" => self.sections.collect{|s|s.serialize(:quiz_summary)}
       }
     end
+
+    def self.all_serializations
+      [:default, :sections]
+    end
   end
 
   class PendingQuiz < Quiz
@@ -223,6 +233,24 @@ module SakaiInfo
     def quiz_type
       "published"
     end
+
+    def attempt_count
+      @attempt_count ||= QuizAttempt.count_by_quiz_id(self.id)
+    end
+
+    def attempts
+      @attempts ||= QuizAttempt.find_by_quiz_id(self.id)
+    end
+
+    def attempts_serialization
+      {
+        "attempts" => self.attempts.collect { |a| a.serialize(:quiz_summary) }
+      }
+    end
+
+    def self.all_serializations
+      [:default, :sections, :attempts]
+    end
   end
 
   class QuizSection < SakaiObject
@@ -256,7 +284,7 @@ module SakaiInfo
           begin
             @@cache[id] = PublishedQuizSection.find(id)
           rescue ObjectNotFoundException
-            raise ObjectNotFoundException(QuizSection, id)
+            raise ObjectNotFoundException.new(QuizSection, id)
           end
         end
       end
@@ -347,7 +375,7 @@ module SakaiInfo
       if @@cache[id].nil?
         row = DB.connect[:sam_section_t].where(:sectionid => id).first
         if row.nil?
-          raise ObjectNotFoundException(PendingQuizSection, id)
+          raise ObjectNotFoundException.new(PendingQuizSection, id)
         end
 
         @@cache[id] = PendingQuizSection.new(row)
@@ -367,7 +395,7 @@ module SakaiInfo
       if @@cache[id].nil?
         row = DB.connect[:sam_publishedsection_t].where(:sectionid => id).first
         if row.nil?
-          raise ObjectNotFoundException(PublishedQuizSection, id)
+          raise ObjectNotFoundException.new(PublishedQuizSection, id)
         end
 
         @@cache[id] = PublishedQuizSection.new(row)
@@ -409,7 +437,7 @@ module SakaiInfo
           begin
             @@cache[id] = PublishedQuizItem.find(id)
           rescue ObjectNotFoundException
-            raise ObjectNotFoundException(QuizItem, id)
+            raise ObjectNotFoundException.new(QuizItem, id)
           end
         end
       end
@@ -500,7 +528,7 @@ module SakaiInfo
       if @@cache[id].nil?
         row = DB.connect[:sam_item_t].where(:itemid => id).first
         if row.nil?
-          raise ObjectNotFoundException(PendingQuizItem, id)
+          raise ObjectNotFoundException.new(PendingQuizItem, id)
         end
 
         @@cache[id] = PendingQuizItem.new(row)
@@ -520,7 +548,7 @@ module SakaiInfo
       if @@cache[id].nil?
         row = DB.connect[:sam_publisheditem_t].where(:itemid => id).first
         if row.nil?
-          raise ObjectNotFoundException(PublishedQuizItem, id)
+          raise ObjectNotFoundException.new(PublishedQuizItem, id)
         end
 
         @@cache[id] = PublishedQuizItem.new(row)
@@ -532,4 +560,295 @@ module SakaiInfo
       "published"
     end
   end
+
+  # class QuizItemAttachment < SakaiObject
+  # end
+
+  # class PendingQuizItemAttachment < QuizItemAttachment
+  # end
+
+  # class PublishedQuizItemAttachment < QuizItemAttachment
+  # end
+
+  class QuizAttempt < SakaiObject
+    attr_reader :dbrow, :submitted_at, :total_auto_score, :status, :attempted_at
+    attr_reader :time_elapsed, :comments, :user_id, :quiz_id
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:assessmentgradingid]
+      @submitted_at = dbrow[:submitteddate]
+      @user_id = dbrow[:agentid]
+      @quiz_id = dbrow[:publishedassessmentid]
+      @total_auto_score = dbrow[:totalautoscore]
+      @status = dbrow[:status]
+      @attempted_at = dbrow[:attempted_at]
+      @time_elapsed = dbrow[:timeelapsed]
+      @is_auto_submitted = dbrow[:is_auto_submitted]
+      @is_late = dbrow[:islate]
+      @comments = dbrow[:comments]
+    end
+
+    @@cache = {}
+    def self.find(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        row = DB.connect[:sam_assessmentgrading_t].where(:assessmentgradingid => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(QuizAttempt, id)
+        end
+
+        @@cache[id] = QuizAttempt.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.query_by_quiz_id(quiz_id)
+      DB.connect[:sam_assessmentgrading_t].where(:publishedassessmentid => quiz_id)
+    end
+
+    def self.count_by_quiz_id(quiz_id)
+      QuizAttempt.query_by_quiz_id(quiz_id).count
+    end
+
+    def self.find_by_quiz_id(quiz_id)
+      QuizAttempt.query_by_quiz_id(quiz_id).
+        all.collect { |row| QuizAttempt.new(row) }
+    end
+
+    def items
+      @items ||= QuizAttemptItem.find_by_attempt_id(self.id)
+    end
+
+    def item_count
+      @item_count ||= QuizAttemptItem.count_by_attempt_id(self.id)
+    end
+
+    def user
+      @user ||= User.find(@user_id)
+    end
+
+    def quiz
+      @quiz ||= PublishedQuiz.find(@quiz_id)
+    end
+
+    def auto_submitted?
+      @is_auto_submitted == 1
+    end
+
+    def late?
+      @is_late == 1
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "user" => self.user.serialize(:summary),
+        "quiz" => self.quiz.serialize(:summary),
+        "item_count" => self.item_count,
+        "submitted_at" => self.submitted_at,
+        "is_auto_submitted" => self.auto_submitted?,
+        "is_late" => self.late?,
+        "status" => self.status,
+        "total_auto_score" => self.total_auto_score
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "eid" => User.get_eid(self.user_id),
+        "quiz_id" => self.quiz_id,
+        "status" => self.status
+      }
+    end
+
+    def quiz_summary_serialization
+      {
+        "id" => self.id,
+        "eid" => User.get_eid(self.user_id),
+        "status" => self.status
+      }
+    end
+
+    def items_serialization
+      {
+        "items" => self.items.collect { |i| i.serialize(:attempt_summary) }
+      }
+    end
+
+    def self.all_serializations
+      [:default, :items]
+    end
+  end
+
+  class QuizAttemptItem < SakaiObject
+    attr_reader :dbrow, :submitted_at, :answer, :user_id, :item_id, :attempt_id
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:itemgradingid]
+      @submitted_at = dbrow[:submitteddate]
+      @user_id = dbrow[:agentid]
+      @attempt_id = dbrow[:assessmentgradingid]
+      @item_id = dbrow[:publisheditemid]
+      @answer = dbrow[:answertext]
+    end
+
+    def user
+      @user ||= User.find(@user_id)
+    end
+
+    def attempt
+      @attempt ||= QuizAttempt.find(@attempt_id)
+    end
+
+    def item
+      @item ||= PublishedQuizItem.find(@item_id)
+    end
+
+    @@cache = {}
+    def self.find(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        row = DB.connect[:sam_itemgrading_t].where(:itemgradingid => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(QuizAttemptItem, id)
+        end
+
+        @@cache[id] = QuizAttemptItem.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.query_by_attempt_id(attempt_id)
+      DB.connect[:sam_itemgrading_t].where(:assessmentgradingid => attempt_id)
+    end
+
+    def self.count_by_attempt_id(attempt_id)
+      QuizAttemptItem.query_by_attempt_id(attempt_id).count
+    end
+
+    def self.find_by_attempt_id(attempt_id)
+      QuizAttemptItem.query_by_attempt_id(attempt_id).
+        all.collect { |row| QuizAttemptItem.new(row) }
+    end
+
+    def attachments
+      @attachments ||=
+        QuizAttemptItemAttachment.find_by_quiz_attempt_item_id(self.id)
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "user" => self.user.serialize(:summary),
+        "attempt" => self.attempt.serialize(:summary),
+        "item" => self.item.serialize(:summary),
+        "answer" => self.answer,
+        "attachment_count" => self.attachments.length
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "eid" => User.get_eid(self.user_id),
+        "attempt_id" => self.attempt_id,
+        "item_id" => self.item_id
+      }
+    end
+
+    def attempt_summary_serialization
+      {
+        "id" => self.id,
+        "item_id" => self.item_id
+      }
+    end
+
+    def attachments_serialization
+      {
+        "attachments" => self.attachments.collect{|a|a.serialize(:attempt_item_summary)}
+      }
+    end
+
+    def self.all_serializations
+      [:default, :attachments]
+    end
+  end
+
+  class QuizAttemptItemAttachment < SakaiObject
+    attr_reader :dbrow, :status, :filepath, :filename, :filesize, :mimetype
+    attr_reader :description, :quiz_attempt_item_id
+
+    include ModProps
+    created_by_key :createdby
+    created_at_key :createddate
+    modified_by_key :lastmodifiedby
+    modified_at_key :lastmodifieddate
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:mediaid]
+      @quiz_attempt_item_id = dbrow[:itemgradingid]
+      @status = dbrow[:status]
+      @filepath = dbrow[:location]
+      @filename = dbrow[:filename]
+      @filesize = dbrow[:filesize]
+      @mimetype = dbrow[:mimetype]
+      @description = dbrow[:description]
+    end
+
+    def quiz_attempt_item
+      @quiz_attempt_item ||= QuizAttemptItem.find(@quiz_attempt_item_id)
+    end
+
+    def self.find_by_quiz_attempt_item_id(quiz_attempt_item_id)
+      DB.connect[:sam_media_t].where(:itemgradingid => quiz_attempt_item_id).
+        all.collect { |row| QuizAttemptItemAttachment.new(row) }
+    end
+
+    @@cache = {}
+    def self.find(id)
+      id = id.to_s
+      if @@cache[id].nil?
+        row = DB.connect[:sam_media_t].where(:mediaid => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(QuizAttemptItemAttachment, id)
+        end
+
+        @@cache[id] = QuizAttemptItemAttachment.new(row)
+      end
+      @@cache[id]
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "filename" => self.filename,
+        "mimetype" => self.mimetype,
+        "filesize" => self.filesize,
+        "status" => self.status,
+        "quiz_attempt_item" => self.quiz_attempt_item.serialize(:summary)
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "filename" => self.filename,
+        "quiz_attempt_item_id" => self.quiz_attempt_item_id
+      }
+    end
+
+    def attempt_item_summary_serialization
+      {
+        "id" => self.id,
+        "filename" => self.filename
+      }
+    end
+  end
 end

data/lib/sakai-info/sakai_object.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::SakaiObject
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-26 daveadams@gmail.com
+# Last updated 2012-02-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -50,6 +50,14 @@ module SakaiInfo
       end
     end
 
+    def dbrow_only_serialization
+      if not self.dbrow_serialization["dbrow"].nil?
+        self.dbrow_serialization["dbrow"]
+      else
+        {}
+      end
+    end
+
     def default_serialization
       object_type_serialization
     end

data/lib/sakai-info/sakai_xml_entity.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::SakaiXMLEntity
 #
 # Created 2012-02-16 daveadams@gmail.com
-# Last updated 2012-02-18 daveadams@gmail.com
+# Last updated 2012-02-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -39,12 +39,22 @@ module SakaiInfo
   class SakaiXMLEntity < SakaiObject
     attr_reader :xml, :xmldoc, :attributes, :properties
 
-    private
+    include ModProps
+    created_by_key :_xml_entity_created_by
+    created_at_key :_xml_entity_created_at
+    modified_by_key :_xml_entity_modified_by
+    modified_at_key :_xml_entity_modified_at
+
     # this method parses the universal XML field for all entities
     # down to two collections: attributes (XML attributes defined in the
     # top-level tag) and properties (<property> tags inside the top-level
     # tag). Properties are generally base64 encoded
     def parse_xml
+      if @xml.nil?
+        @xml = ""
+        REXML::Document.new(@dbrow[:xml].read).write(@xml, 2)
+      end
+
       @xmldoc = REXML::Document.new(@xml)
       @attributes = {}
       @xmldoc.root.attributes.keys.each do |att_name|
@@ -60,67 +70,62 @@ module SakaiInfo
         if prop_encoding == "BASE64"
           prop_value = Base64.decode64(prop_value)
         else
-          raise UnrecognizedPropertyEncodingException(prop_name, prop_encoding, prop_value)
+          raise UnrecognizedPropertyEncodingException.new(prop_name, prop_encoding, prop_value)
         end
         @properties[prop_name] = prop_value
       end
-    end
-
-    def format_entity_date(raw)
-      raw.gsub(/^(....)(..)(..)(..)(..)(..).*$/, '\1-\2-\3 \4:\5:\6')
-    end
-
-    public
-    # standard property for all entities
-    def created_by
-      @created_by ||= User.find(@properties["CHEF:creator"])
-    end
-
-    # standard property for all entities
-    def modified_by
-      @modified_by ||= User.find(@properties["CHEF:modifiedby"])
-    end
-
-    # standard property for all entities
-    def created_at
-      format_entity_date(@properties["DAV:creationdate"])
-    end
 
-    # standard property for all entities
-    def modified_at
-      format_entity_date(@properties["DAV:getlastmodified"])
+      @dbrow[:_xml_entity_created_by] = @properties["CHEF:creator"]
+      @dbrow[:_xml_entity_modified_by] = @properties["CHEF:modifiedby"]
+      @dbrow[:_xml_entity_created_at] = format_entity_date(@properties["DAV:creationdate"])
+      @dbrow[:_xml_entity_modified_at] = format_entity_date(@properties["DAV:getlastmodified"])
     end
 
-    # by default, serialize all the common properties
-    def default_serialization
-      {
-        "id" => self.id,
-        "created_by" => self.created_by,
-        "created_at" => self.created_at,
-        "modified_by" => self.modified_by,
-        "modified_at" => self.modified_at
-      }
+    def format_entity_date(raw)
+      if raw =~ /^(....)(..)(..)(..)(..)(..).*$/
+        # I believe these are usually in UTC
+        Time.utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i).getlocal
+      end
     end
 
     # serialize all attributes
     def attributes_serialization
       {
-        "attributes" => @attributes
+        "attributes" => self.attributes
       }
     end
 
     # serialize all properties
     def properties_serialization
       {
-        "properties" => @properties
+        "properties" => self.properties
       }
     end
 
     # xml dump serialization option
     def xml_serialization
       {
-        "xml" => xml
+        "xml" => self.xml
+      }
+    end
+
+    # tweak the dbrow out since we hacked dbrow for other purposes
+    # and since the xml field doesn't display typically
+    def dbrow_serialization
+      dbrow = super["dbrow"]
+      dbrow[:xml] = self.xml
+      dbrow.delete(:_xml_entity_created_by)
+      dbrow.delete(:_xml_entity_created_at)
+      dbrow.delete(:_xml_entity_modified_by)
+      dbrow.delete(:_xml_entity_modified_at)
+
+      {
+        "dbrow" => dbrow
       }
     end
+
+    def self.all_serializations
+      [ :default, :attributes, :properties, :xml ]
+    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-26 daveadams@gmail.com
+# Last updated 2012-02-28 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -273,7 +273,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
       }
@@ -445,7 +445,7 @@ module SakaiInfo
       if @@cache[id].nil?
         row = DB.connect[:sakai_site_page].where(:page_id => id).first
         if row.nil?
-          raise ObjectNotFoundException(Page, id)
+          raise ObjectNotFoundException.new(Page, id)
         end
 
         site = Site.find(row[:site_id])

data/lib/sakai-info/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-26 00:00:00 -06:00
+date: 2012-02-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency