sakai-info 0.4.6 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # sakai-info Change History #
 
+### 0.5.0 ###
+
+*Released 2012-06-21*
+
+* Added --full-children and --all options for content
+* Refactored rake tasks into one directory
+* Added a barebones proof-of-concept-only query mode
+* Removed quiz, quiz-section, and quiz-item types due to ID overlap risk
+* Added new special modes to intercept calls for these removed object types
+* Added published-quiz and pending-quiz types
+* Added published-quiz-section and pending-quiz-section types
+* Added published-quiz-item and pending-quiz-item types
+* Added --texts record listing to published-quiz-item and pending-quiz-item
+* Added --items record listing to quiz
+* Better summaries for items in quiz-sections and quizzes
+* Added a number of command line object type shortcuts
+* Added random test fixture generation for user objects
+
 ### 0.4.6 ###
 
 *Released 2012-05-19*

data/LICENSE

@@ -6,3 +6,8 @@ domain. This applies worldwide.
 I grant any entity the right to use this work for any purpose, without
 any conditions, unless such conditions are required by law.
 
+If you require a fuller legal statement, please refer to the Creative
+Commons Zero license:
+
+http://creativecommons.org/publicdomain/zero/1.0/
+

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-05-19  
+last updated: 2012-06-21  
 author: David Adams (daveadams@gmail.com)  
 github url: https://github.com/daveadams/sakai-info
 
@@ -24,7 +24,7 @@ Use `rake` to test and build the gem:
     $ rake gem:build
 
 The resulting gem will be saved to the working directory as
-`sakai-info-0.4.6.gem`.
+`sakai-info-0.5.0.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,18 +1,43 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-05-14*
+*Last updated 2012-06-21*
 
-### 0.5.x ###
+### 0.5.1 ###
+
+* Test fixture generation for sites
+* Text fixture loading into sqlite for sites and users
+* Field restrictions for lookups
+* Simple queries by name/title for user/site
+* More details for quizzes including access control data
+
+### 0.5.2 ###
+
+* Test fixture generation for quizzes
+* Better date formatting all around
+* More query functionality
+* Proof-of-concept sin shell
+* Chat channel/message support
+
+### 0.5.3 ###
+
+* RDS schema creation and data loading for MySQL and Oracle testing
+* More query and shell functionality
+
+### 0.5.4 ###
+
+* Barebones web interface - HTML, JSON, and YAML
+* More query and shell functionality
+
+### 0.5.5 ###
 
-* Sqlite test infrastructure for a few basic objects
-* Deeper query functionality and field specification
-* Simple web query interface - HTML, JSON, and YAML
 * Global cache instead of per-class
+* More query, web, and shell functionality
 
 ### 0.6.x ###
 
 * Test fixtures and basic unit tests for all represented objects
 * RDoc coverage for every class
+* More focus on other library usage besides ad hoc CLI/web queries
 
 ### 0.7.x ###
 

data/bin/sin

@@ -5,7 +5,7 @@
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-04-02 daveadams@gmail.com
+# Last updated 2012-05-23 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -104,11 +104,16 @@ when "test" then
     exit
   end
 
+when "query" then
+  mode = args.shift
+
 else
-  # test to see if it's an accepted object mode
-  if CLI::ObjectModes.keys.include? args[0]
-    mode = args.shift
-    id = args.shift
+  # test to see if it's an accepted lookup mode
+  if CLI::LookupModes.keys.include? args[0]
+    mode = "lookup"
+
+  elsif CLI::SpecialModes.keys.include? args[0]
+    mode = "special"
 
   else
     STDERR.puts "ERROR: Command '#{args[0]}' was not recognized."
@@ -136,18 +141,15 @@ if not db_name.nil?
   DB.default_database = db_name
 end
 
-if flags.include? "--all"
-  serials = CLI::ObjectModes[mode].all_serializations
-elsif
-  flags.include? "--dbrow-only"
-  serials = [:dbrow_only]
-else
-  serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').gsub("-","_").to_sym}
-end
-begin
-  puts CLI::ObjectModes[mode].find(id).to_yaml(serials)
-rescue ObjectNotFoundException
-  STDERR.puts "ERROR: Could not find #{mode} with an ID of '#{id}'"
-  exit 1
+case mode
+when "query"
+  CLI::Query.process(args, flags)
+
+when "lookup"
+  CLI::Lookup.process(args, flags)
+
+when "special"
+  CLI::Special.process(args, flags)
+
 end
 

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -17,109 +17,10 @@ require 'sequel'
 require 'logger'
 
 require 'sakai-info/version'
-
-module SakaiInfo
-  # base exception class for distinguishing SakaiInfo exceptions
-  # from Ruby exceptions
-  class SakaiException < Exception; end
-
-  # exception to be raised when an object of a certain type cannot be found
-  class ObjectNotFoundException < SakaiException
-    def initialize(classname, identifier)
-      @classname = classname
-      @identifier = identifier
-
-      super("Could not find a #{@classname} object for '#{@identifier}'")
-    end
-  end
-
-  class Util
-    # misc support functions
-    FILESIZE_LABELS = ["bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
-    def self.format_filesize(i_size)
-      size = i_size.to_f
-      negative = false
-
-      if size < 0
-        negative = true
-        size = -size
-      end
-
-      label = 0
-      (FILESIZE_LABELS.size - 1).times do
-        if size >= 1024.0
-          size = size / 1024.0
-          label += 1
-        end
-      end
-
-      if size >= 100.0 or label == 0
-        "#{negative ? "-" : ""}#{size.to_i.to_s} #{FILESIZE_LABELS[label]}"
-      else
-        "#{negative ? "-" : ""}#{sprintf("%.1f", size)} #{FILESIZE_LABELS[label]}"
-      end
-    end
-
-    def self.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
-      else
-        raw
-      end
-    end
-  end
-
-  # cache control
-  class Cache
-    def self.clear_all
-      SakaiObject.descendants.select { |klass|
-        klass.methods.include? :clear_cache
-      }.each { |klass|
-        klass.clear_cache
-      }
-    end
-  end
-end
-
-######################################################################
-# extensions to other objects
-class String
-  def is_uuid?
-    self =~ /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
-  end
-end
-
-# terrible hack to work around mysql case issues
-# essentially, if the hash key asked for is a symbol and its value is
-# nil, then try again with the uppercased version of the symbol
-# this might cause problems in weird cases with other hashes, this is
-# definitely not a sustainable fix.
-# TODO: patch Sequel for case-insensitive/-fixed identifiers
-class Hash
-  alias :original_brackets :[]
-
-  def [](key)
-    if not (value = original_brackets(key)).nil?
-      return value
-    else
-      if key.is_a? Symbol
-        return original_brackets(key.to_s.upcase.to_sym)
-      else
-        return nil
-      end
-    end
-  end
-end
-
-# alias .to_s on Blob class to match OCI8 blob class's read method
-module Sequel
-  module SQL
-    class Blob
-      alias :read :to_s
-    end
-  end
-end
+require 'sakai-info/exceptions'
+require 'sakai-info/hacks'
+require 'sakai-info/util'
+require 'sakai-info/cache'
 
 # baseline db connectivity
 require 'sakai-info/database'

data/lib/sakai-info/cache.rb

@@ -0,0 +1,23 @@
+# cache.rb
+#   Cache control
+#
+# Created 2012-05-20 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  # cache control
+  class Cache
+    def self.clear_all
+      SakaiObject.descendants.select { |klass|
+        klass.methods.include? :clear_cache
+      }.each { |klass|
+        klass.clear_cache
+      }
+    end
+  end
+end

data/lib/sakai-info/cli.rb

@@ -2,7 +2,7 @@
 #  - sakai-info command line tool support
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-05-14 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -10,40 +10,10 @@
 #
 
 require 'sakai-info/cli/help'
+require 'sakai-info/cli/lookup'
+require 'sakai-info/cli/query'
+require 'sakai-info/cli/special'
 
 # it's faster to run single-threaded
 Sequel.single_threaded = true
 
-module SakaiInfo
-  class CLI
-    ObjectModes = {
-      "site" => Site,
-      "page" => Page,
-      "tool" => Tool,
-      "user" => User,
-      "group" => Group,
-      "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,
-      "forum" => Forum,
-      "forum-thread" => ForumThread,
-      "forum-post" => ForumPost,
-      "content" => Content,
-      "announcement" => Announcement,
-      "announcement-channel" => AnnouncementChannel,
-      "gradebook" => Gradebook,
-      "gradebook-item" => GradebookItem,
-      "role" => AuthzRole,
-      "function" => AuthzFunction,
-      "realm" => AuthzRealm,
-    }
-  end
-end
-

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

@@ -2,7 +2,7 @@
 #  - sin command line help
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-05-14 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -10,26 +10,42 @@
 #
 
 module SakaiInfo
-  class CLI
+  module CLI
     class Help
       STRINGS = {
         :default => <<EOF,
-Sakai Info: sin #{VERSION}
-  Usage: sin <command> [<id>] [<options>]
+Sakai INfo: sin #{VERSION}
+
+  LOOKUP MODE
+    Lookup details about a particular object and its child objects.
+
+    Usage: sin <object-type> [<id>] [<options>]
+
+    Supported object types:
+      user, group, site, page, tool, pending-quiz, published-quiz,
+      pending-quiz-section, published-quiz-section, pending-quiz-item,
+      published-quiz-item, quiz-attempt, quiz-attempt-item,
+      quiz-attempt-item-attachment, question-pool, assignment,
+      assignment-submission, forum, forum-thread, forum-post, content,
+      announcement, announcement-channel, gradebook, gradebook-item,
+      role, function, realm
+
+  QUERY MODE
+    Query particular fields from certain objects given certain conditions.
+
+    Usage: sin query <object-type> [<options>]
 
-  Object commands:
-    user, group, site, page, tool, quiz, quiz-section, quiz-item, quiz-attempt,
-    quiz-attempt-item, quiz-attempt-item-attachment, question-pool, assignment,
-    assignment-submission, forum, forum-thread, forum-post, content,
-    announcement, announcement-channel, gradebook, gradebook-item, role,
-    function, realm
+    Use "sin help query" for more details.
 
-  Misc commands:
-    test             Tests configured database connections
-    help             Prints general help
-    version          Prints version
-    help <command>   Prints help about a particular command
-    help options     Prints help about additional options
+  OTHER COMMANDS
+    Usage: sin <command>
+
+    Available commands:
+      test             Tests configured database connections
+      help             Prints general help
+      version          Prints version
+      help <command>   Prints help about a particular command
+      help options     Prints help about additional options
 EOF
 
         "options" => <<EOF,
@@ -151,45 +167,78 @@ sin tool
   Prints information about the tool ID specified.
 EOF
 
-        "quiz" => <<EOF,
-sin quiz
+        "pending-quiz" => <<EOF,
+sin pending-quiz
 
-  Usage: sin quiz <id> [<options>]
+  Usage: sin pending-quiz <id> [<options>]
 
-  Prints information about the quiz ID specified. The quiz ID may represent
-  a pending quiz or a published quiz. Additional options may be passed to
-  include additional information:
+  Prints information about the pending quiz ID specified. Additional options
+  may be passed to include additional information:
 
     --sections   Print section summary list
-    --attempts   Print summary of user quiz attempts
+    --items      Print summary of items on the quiz
     --mod        Print creation/modification info
+EOF
 
-  Not yet implemented:
+        "published-quiz" => <<EOF,
+sin published-quiz
+
+  Usage: sin published-quiz <id> [<options>]
+
+  Prints information about the published quiz ID specified. Additional options
+  may be passed to include additional information:
+
+    --sections   Print section summary list
     --items      Print summary of items on the quiz
+    --attempts   Print summary of user quiz attempts
+    --mod        Print creation/modification info
 EOF
 
-        "quiz-section" => <<EOF,
-sin quiz-section
+        "pending-quiz-section" => <<EOF,
+sin pending-quiz-section
 
-  Usage: sin quiz-section <id> [<options>]
+  Usage: sin pending-quiz-section <id> [<options>]
 
-  Prints information about the quiz section ID specified. The ID may represent
-  a pending quiz section or a published quiz section. Additional options may be
-  passed to include additional information:
+  Prints information about the pending quiz section ID specified. Additional
+  options may be passed to include additional information:
 
     --items      Print summary of items in the section
     --mod        Print creation/modification info
 EOF
 
-        "quiz-item" => <<EOF,
-sin quiz-item
+        "published-quiz-section" => <<EOF,
+sin published-quiz-section
 
-  Usage: sin quiz-item <id> [<options>]
+  Usage: sin published-quiz-section <id> [<options>]
 
-  Prints information about the quiz item ID specified. The ID may represent
-  a pending quiz item or a published quiz item. Additional options may be
-  passed to include additional information:
+  Prints information about the published quiz section ID specified. Additional
+  options may be passed to include additional information:
 
+    --items      Print summary of items in the section
+    --mod        Print creation/modification info
+EOF
+
+        "pending-quiz-item" => <<EOF,
+sin pending-quiz-item
+
+  Usage: sin pending-quiz-item <id> [<options>]
+
+  Prints information about the pending quiz item ID specified. Additional
+  options may be passed to include additional information:
+
+    --texts      List associated pending-quiz-item-text records
+    --mod        Print creation/modification info
+EOF
+
+        "published-quiz-item" => <<EOF,
+sin published-quiz-item
+
+  Usage: sin published-quiz-item <id> [<options>]
+
+  Prints information about the published quiz item ID specified. Additional
+  options may be passed to include additional information:
+
+    --texts      List associated quiz-item-text records
     --mod        Print creation/modification info
 EOF
 
@@ -311,9 +360,10 @@ sin content
   Prints information about the content resource or collection ID specified.
   Additional options may be passed to include additional information:
 
-    --properties Print all properties
-    --children   Recursively print collection children
-    --mod        Print creation/modification info
+    --properties    Print all properties
+    --children      Recursively print collection children
+    --full-children Print children with full IDs and file paths
+    --mod           Print creation/modification info
 EOF
         "announcement" => <<EOF,
 sin announcement
@@ -378,6 +428,13 @@ sin realm
     --roles      List roles associated with this realm
     --users      List users in this realm
     --mod        Print creation/modification info
+EOF
+        "query" => <<EOF,
+sin query
+
+  Usage: sin query <object-type> [<options>]
+
+  Query mode is only being tested at present.
 EOF
       }
 

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

@@ -0,0 +1,96 @@
+# lookup.rb
+#   class for handling the default command line mode
+#
+# Created 2012-05-23 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  module CLI
+    class Lookup
+      def self.process(args, flags)
+        object_type = args.shift
+        id = args.shift
+
+        if flags.include? "--all"
+          serials = CLI::LookupModes[object_type].all_serializations
+        elsif
+          flags.include? "--dbrow-only"
+          serials = [:dbrow_only]
+        else
+          serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').gsub("-","_").to_sym}
+        end
+        begin
+          puts CLI::LookupModes[object_type].find(id).to_yaml(serials)
+        rescue ObjectNotFoundException
+          STDERR.puts "ERROR: Could not find #{object_type} with an ID of '#{id}'"
+          exit 1
+        end
+      end
+    end
+
+    LookupModes = {
+      "site" => Site,
+      "page" => Page,
+      "tool" => Tool,
+      "user" => User,
+      "group" => Group,
+      "pq" => PublishedQuiz,
+      "pubquiz" => PublishedQuiz,
+      "published-quiz" => PublishedQuiz,
+      "nq" => PendingQuiz,
+      "penquiz" => PendingQuiz,
+      "pending-quiz" => PendingQuiz,
+      "pqs" => PublishedQuizSection,
+      "pubqs" => PublishedQuizSection,
+      "published-quiz-section" => PublishedQuizSection,
+      "nqs" => PendingQuizSection,
+      "penqs" => PendingQuizSection,
+      "pending-quiz-section" => PendingQuizSection,
+      "pqi" => PublishedQuizItem,
+      "pubqi" => PublishedQuizItem,
+      "published-quiz-item" => PublishedQuizItem,
+      "nqi" => PendingQuizItem,
+      "penqi" => PendingQuizItem,
+      "pending-quiz-item" => PendingQuizItem,
+      "qa" => QuizAttempt,
+      "quiz-attempt" => QuizAttempt,
+      "qai" => QuizAttemptItem,
+      "quiz-attempt-item" => QuizAttemptItem,
+      "qaia" => QuizAttemptItemAttachment,
+      "quiz-attempt-item-attachment" => QuizAttemptItemAttachment,
+      "qp" => QuestionPool,
+      "qpool" => QuestionPool,
+      "question-pool" => QuestionPool,
+      "a" => Assignment,
+      "assignment" => Assignment,
+      "as" => AssignmentSubmission,
+      "asub" => AssignmentSubmission,
+      "assignment-submission" => AssignmentSubmission,
+      "forum" => Forum,
+      "ft" => ForumThread,
+      "forum-thread" => ForumThread,
+      "fp" => ForumPost,
+      "forum-post" => ForumPost,
+      "content" => Content,
+      "ann" => Announcement,
+      "announcement" => Announcement,
+      "annchan" => AnnouncementChannel,
+      "announcement-channel" => AnnouncementChannel,
+      "gb" => Gradebook,
+      "gradebook" => Gradebook,
+      "gbi" => GradebookItem,
+      "gradebook-item" => GradebookItem,
+      "role" => AuthzRole,
+      "fn" => AuthzFunction,
+      "func" => AuthzFunction,
+      "function" => AuthzFunction,
+      "realm" => AuthzRealm,
+    }
+  end
+end
+

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

@@ -0,0 +1,58 @@
+# query.rb
+#   class for handling "query" command line mode
+#
+# Created 2012-05-23 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  module CLI
+    class Query
+      def self.process(args, flags)
+        # TODO: expand query functionality from proof of concept
+        object_type = args.shift
+        fields = []
+        site_id = nil
+
+        if object_type == "quiz"
+          flags.each do |flag|
+            case flag
+            when /^--fields=/
+              fields = flag.split("=")[1].split(",")
+            when /^--site=/
+              site_id = flag.split("=")[1]
+            else
+              STDERR.puts "ERROR: Unrecognized query flag"
+              exit 1
+            end
+          end
+
+          if site_id.nil?
+            STDERR.puts "ERROR: No site ID was provided"
+            exit 1
+          end
+
+          puts PublishedQuiz.find_ids_by_site_id(site_id)
+
+        elsif object_type == "userid" or object_type == "user_id" or object_type == "uid"
+          id = args.shift
+          begin
+            user = User.find(id)
+            puts user.id
+          rescue ObjectNotFoundException => e
+            STDERR.puts "ERROR: #{e}"
+            exit 1
+          end
+
+        else
+          STDERR.puts "ERROR: Unrecognized object type"
+          exit 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# special.rb
+#   class for handling the special command line modes
+#
+# Created 2012-06-21 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain. See LICENSE.
+#
+
+module SakaiInfo
+  module CLI
+    class Special
+      def self.process(args, flags)
+        mode = args.shift
+
+        STDERR.puts "WARNING:"
+        STDERR.puts "  Looking up items of type '#{mode}' can return ambiguous results."
+        STDERR.puts "  Please use #{SpecialModes[mode]} types instead."
+        exit 1
+      end
+    end
+
+    SpecialModes = {
+      "quiz" => "'published-quiz' or 'pending-quiz'",
+      "quiz-section" => "'published-quiz-section' or 'pending-quiz-section'",
+      "quiz-item" => "'published-quiz-item' or 'pending-quiz-item'",
+    }
+  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-05-14 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -140,6 +140,16 @@ module SakaiInfo
       self.binary_entity
       self.original_mod_details_serialization
     end
+
+    def self.all_serializations
+      [
+       :default,
+       :children,
+       :realm,
+       :properties,
+       :mod
+      ]
+    end
   end
 
   class ContentResource < Content
@@ -218,6 +228,14 @@ module SakaiInfo
         "size" => self.size_on_disk,
       }
     end
+
+    def detailed_summary_serialization
+      {
+        "id" => self.id,
+        "size" => self.size_on_disk,
+        "file_path" => self.file_path,
+      }
+    end
   end
 
   class ContentCollection < Content
@@ -319,6 +337,13 @@ module SakaiInfo
       }
     end
 
+    def detailed_summary_serialization
+      {
+        "id" => self.id,
+        "size_on_disk" => self.size_on_disk,
+      }
+    end
+
     def children_serialization
       result = {
         "collections" => self.children["collections"].collect { |cc|
@@ -337,6 +362,24 @@ module SakaiInfo
       result
     end
 
+    def full_children_serialization
+      result = {
+        "collections" => self.children["collections"].collect { |cc|
+          cc.serialize(:detailed_summary, :full_children)
+        },
+        "resources" => self.children["resources"].collect { |cr|
+          cr.serialize(:detailed_summary)
+        }
+      }
+      if result["collections"] == []
+        result.delete("collections")
+      end
+      if result["resources"] == []
+        result.delete("resources")
+      end
+      result
+    end
+
     def self.query_by_parent(parent_id)
       DB.connect[:content_collection].where(:in_collection => parent_id)
     end

data/lib/sakai-info/exceptions.rb

@@ -0,0 +1,27 @@
+# exceptions.rb
+#   Special exception definitions
+#
+# Created 2012-05-20 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  # base exception class for distinguishing SakaiInfo exceptions
+  # from Ruby exceptions
+  class SakaiException < Exception; end
+
+  # exception to be raised when an object of a certain type cannot be found
+  class ObjectNotFoundException < SakaiException
+    def initialize(classname, identifier)
+      @classname = classname
+      @identifier = identifier
+
+      super("Could not find a #{@classname} object for '#{@identifier}'")
+    end
+  end
+end
+

data/lib/sakai-info/hacks.rb

@@ -0,0 +1,49 @@
+# hacks.rb
+#   Hacks necessary to work around problems in external libraries
+#
+# Created 2012-05-20 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+######################################################################
+# extensions to other objects
+class String
+  def is_uuid?
+    self =~ /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+  end
+end
+
+# terrible hack to work around mysql case issues
+# essentially, if the hash key asked for is a symbol and its value is
+# nil, then try again with the uppercased version of the symbol
+# this might cause problems in weird cases with other hashes, this is
+# definitely not a sustainable fix.
+# TODO: patch Sequel for case-insensitive/-fixed identifiers
+class Hash
+  alias :original_brackets :[]
+
+  def [](key)
+    if not (value = original_brackets(key)).nil?
+      return value
+    else
+      if key.is_a? Symbol
+        return original_brackets(key.to_s.upcase.to_sym)
+      else
+        return nil
+      end
+    end
+  end
+end
+
+# alias .to_s on Blob class to match OCI8 blob class's read method
+module Sequel
+  module SQL
+    class Blob
+      alias :read :to_s
+    end
+  end
+end

data/lib/sakai-info/quiz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Quiz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-06-21 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -113,11 +113,19 @@ module SakaiInfo
     end
 
     def section_count
-      @section_count ||= QuizSection.count_by_quiz_id(@id)
+      @section_count ||= self.section_class.count_by_quiz_id(@id)
     end
 
     def sections
-      @sections ||= QuizSection.find_by_quiz_id(@id)
+      @sections ||= self.section_class.find_by_quiz_id(@id)
+    end
+
+    def item_count
+      @item_count ||= self.item_class.count_by_quiz_id(self.id)
+    end
+
+    def items
+      @items ||= self.item_class.find_by_quiz_id(self.id)
     end
 
     def default_serialization
@@ -128,6 +136,7 @@ module SakaiInfo
         "status" => self.status,
         "type" => self.quiz_type,
         "section_count" => self.section_count,
+        "item_count" => self.item_count,
         "attempt_count" => nil
       }
       if not self.site.nil?
@@ -169,8 +178,18 @@ module SakaiInfo
       }
     end
 
+    def items_serialization
+      {
+        "items" => self.items.collect { |i| i.serialize(:quiz_summary) }
+      }
+    end
+
     def self.all_serializations
-      [:default, :sections]
+      [
+       :default,
+       :sections,
+       :items,
+      ]
     end
   end
 
@@ -202,21 +221,30 @@ module SakaiInfo
     end
 
     def self.find_by_site_id(site_id)
-      results = []
-      PendingQuiz.query_by_site_id(site_id).all.each do |row|
+      PendingQuiz.query_by_site_id(site_id).all.collect do |row|
         @@cache[row[:id]] = PendingQuiz.new(row, site_id)
-        results << @@cache[row[:id]]
       end
-      results
     end
 
     def self.count_by_site_id(site_id)
       PendingQuiz.query_by_site_id(site_id).count
     end
 
+    def self.find_ids_by_site_id(site_id)
+      PendingQuiz.query_by_site_id(site_id).select(:id).all.collect { |row| row[:id] }
+    end
+
     def quiz_type
       "pending"
     end
+
+    def section_class
+      PendingQuizSection
+    end
+
+    def item_class
+      PendingQuizItem
+    end
   end
 
   class PublishedQuiz < Quiz
@@ -248,22 +276,31 @@ module SakaiInfo
     end
 
     def self.find_by_site_id(site_id)
-      results = []
-      PublishedQuiz.query_by_site_id(site_id).all.each do |row|
+      PublishedQuiz.query_by_site_id(site_id).all.collect do |row|
         @@cache[row[:id]] = PublishedQuiz.new(row, site_id)
-        results << @@cache[row[:id]]
       end
-      results
     end
 
     def self.count_by_site_id(site_id)
       PublishedQuiz.query_by_site_id(site_id).count
     end
 
+    def self.find_ids_by_site_id(site_id)
+      PublishedQuiz.query_by_site_id(site_id).select(:id).all.collect { |row| row[:id] }
+    end
+
     def quiz_type
       "published"
     end
 
+    def section_class
+      PublishedQuizSection
+    end
+
+    def item_class
+      PublishedQuizItem
+    end
+
     def attempt_count
       @attempt_count ||= QuizAttempt.count_by_quiz_id(self.id)
     end
@@ -279,7 +316,12 @@ module SakaiInfo
     end
 
     def self.all_serializations
-      [:default, :sections, :attempts]
+      [
+       :default,
+       :sections,
+       :items,
+       :attempts,
+      ]
     end
   end
 
@@ -335,12 +377,7 @@ module SakaiInfo
     end
 
     def self.find_by_quiz_id(quiz_id)
-      section_class = if Quiz.find(quiz_id).quiz_type == "pending"
-                        PendingQuizSection
-                      else
-                        PublishedQuizSection
-                      end
-
+      section_class = Quiz.find(quiz_id).section_class
       QuizSection.query_by_quiz_id(quiz_id).all.collect do |row|
         section_class.new(row)
       end
@@ -355,11 +392,11 @@ module SakaiInfo
     end
 
     def item_count
-      @item_count ||= QuizItem.count_by_section_id(@id)
+      @item_count ||= QuizItem.count_by_section_id(self.id)
     end
 
     def items
-      @items ||= QuizItem.find_by_section_id(@id)
+      @items ||= QuizItem.find_by_section_id(self.id)
     end
 
     def default_serialization
@@ -393,7 +430,7 @@ module SakaiInfo
 
     def items_serialization
       {
-        "items" => self.items.collect{|i|i.serialize(:summary)}
+        "items" => self.items.collect{|i|i.serialize(:section_summary)}
       }
     end
 
@@ -534,15 +571,35 @@ module SakaiInfo
 
     def self.find_by_quiz_id(quiz_id)
       item_class = QuizItem.class_for_type(Quiz.find(quiz_id).quiz_type)
-      QuizItem.query_by_quiz_id(quiz_id).all.collect do |row|
+      QuizItem.query_by_quiz_id(quiz_id).order(:sequence).all.collect do |row|
         item_class.new(row)
-      end
+      end.sort { |a,b| if a.section.sequence == b.section.sequence
+                         a.sequence <=> b.sequence
+                       else
+                         a.section.sequence <=> b.section.sequence
+                       end }
     end
 
     def item_type
       nil
     end
 
+    def itemtext_table
+      nil
+    end
+
+    def texts
+      if self.itemtext_table.nil?
+        return []
+      end
+
+      DB.connect[self.itemtext_table].
+        select(:text).
+        where(:itemid => self.id).
+        order(:sequence).all.
+        collect { |row| row[:text].read }
+    end
+
     def default_serialization
       {
         "id" => self.id,
@@ -562,8 +619,33 @@ module SakaiInfo
       }
     end
 
+    def quiz_summary_serialization
+      {
+        "id" => self.id,
+        "section" => self.section.sequence,
+        "sequence" => self.sequence,
+      }
+    end
+
+    def section_summary_serialization
+      {
+        "id" => self.id,
+        "sequence" => self.sequence,
+      }
+    end
+
+    def texts_serialization
+      {
+        "texts" => self.texts
+      }
+    end
+
     def self.all_serializations
-      [:default, :mod]
+      [
+       :default,
+       :mod,
+       :texts
+      ]
     end
   end
 
@@ -589,6 +671,10 @@ module SakaiInfo
     def item_type
       "pending"
     end
+
+    def itemtext_table
+      :sam_itemtext_t
+    end
   end
 
   class PublishedQuizItem < QuizItem
@@ -613,6 +699,10 @@ module SakaiInfo
     def item_type
       "published"
     end
+
+    def itemtext_table
+      :sam_publisheditemtext_t
+    end
   end
 
   # class QuizItemAttachment < SakaiObject

data/lib/sakai-info/util.rb

@@ -0,0 +1,50 @@
+# util.rb
+#   Utility methods
+#
+# Created 2012-05-20 daveadams@gmail.com
+# Last updated 2012-05-20 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Util
+    # misc support functions
+    FILESIZE_LABELS = ["bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
+    def self.format_filesize(i_size)
+      size = i_size.to_f
+      negative = false
+
+      if size < 0
+        negative = true
+        size = -size
+      end
+
+      label = 0
+      (FILESIZE_LABELS.size - 1).times do
+        if size >= 1024.0
+          size = size / 1024.0
+          label += 1
+        end
+      end
+
+      if size >= 100.0 or label == 0
+        "#{negative ? "-" : ""}#{size.to_i.to_s} #{FILESIZE_LABELS[label]}"
+      else
+        "#{negative ? "-" : ""}#{sprintf("%.1f", size)} #{FILESIZE_LABELS[label]}"
+      end
+    end
+
+    def self.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
+      else
+        raw
+      end
+    end
+  end
+end
+

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -52,10 +52,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sakai-info.rb
+- lib/sakai-info/util.rb
 - lib/sakai-info/group.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/lookup.rb
 - lib/sakai-info/site.rb
+- lib/sakai-info/cache.rb
+- lib/sakai-info/exceptions.rb
 - lib/sakai-info/assignment.rb
 - lib/sakai-info/authz.rb
 - lib/sakai-info/gradebook.rb
@@ -64,6 +70,7 @@ files:
 - lib/sakai-info/sakai_object.rb
 - lib/sakai-info/quiz.rb
 - lib/sakai-info/user.rb
+- lib/sakai-info/hacks.rb
 - lib/sakai-info/version.rb
 - lib/sakai-info/announcement.rb
 - lib/sakai-info/database.rb