sakai-info 0.2.1 → 0.3.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+## 0.3.0 ##
+
+*Released 2012-02-26*
+
+* Support for new object types: question-pool, quiz, quiz-section, quiz-item
+* New CLI options for logging and trace-debugging
+* New object abstraction patterns allow for --dbrow and --mod options
+
 ## 0.2.1 ##
 
 *Released 2012-02-25*

data/README.md

@@ -10,7 +10,7 @@ tool or the libraries.
 
 ## Meta ##
 
-last updated: 2012-02-25  
+last updated: 2012-02-26  
 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.2.1.gem`.
+`sakai-info-0.3.0.gem`.
 
 Cleanup built gems using:
 
@@ -75,22 +75,6 @@ PATH. For usage details, run:
 
     $ sakai-info help
 
-To look up information about a user, run:
-
-    $ sakai-info user id
-
-For users, `id` can be either the user_id or the eid of the user you want
-details on.
-
-Similarly to look up information about a site, run:
-
-    $ sakai-info site id
-
-For sites, `id` is the `site_id` of the desired site.
-
-Further details are available for both object types, see the corresponding
-help pages for more information.
-
 ## Library Usage ##
 
 To use the library in your own Ruby programs, simply specify:

data/ROADMAP.md

@@ -1,10 +1,26 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-02-24*
+*Last updated 2012-02-26*
 
-### 0.3 ###
+### 0.3.1  ###
 
-* CLI access to more objects, eg quizzes, tools, assignments, and groups
+* CLI access to assignments
+
+### 0.3.2 ###
+
+* CLI access to groups
+
+### 0.3.3 ###
+
+* CLI access to pages and tools
+
+### 0.3.4 ###
+
+* CLI access to forums
+
+### 0.4 ###
+
+* Standardized abstraction for user and site to support --mod and --dbrow
 * Sqlite test infrastructure for a few basic objects
 
 ### 0.5 ###
@@ -12,6 +28,10 @@
 * Test fixtures and basic unit tests for all represented objects
 * RDoc coverage for every class
 
+### 0.6 ###
+
+* Basic OSP support
+
 ------
 
 Other things on the wishlist for future releases:
@@ -36,4 +56,5 @@ Other things on the wishlist for future releases:
 * Additional tools
   * httpd log analysis helper
   * RPC client for Sakai-monitoring servlet
+  * schema analysis and generators
 

data/bin/sakai-info

@@ -5,7 +5,7 @@
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-02-26 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -17,14 +17,17 @@ include SakaiInfo
 
 require 'sakai-info/cli'
 
-ObjectModes = {
-  "site" => Site,
-  "user" => User
-}
-
 flags = []
 args = []
 db_name = nil
+logfile = nil
+
+__trace = proc { |event, file, line, id, binding, classname|
+  if %w(call raise return).include? event
+    t = Time.now
+    printf "%s.%06d %-8s %-25s %-10s .%-10s\n", t.strftime("%H:%M:%S"), t.usec, event, File.basename(file) + ":#{line}", classname, id
+  end
+}
 
 while arg = ARGV.shift
   if arg =~ /^-/
@@ -32,6 +35,10 @@ while arg = ARGV.shift
       db_name = ARGV.shift
     elsif arg =~ /^--database=/
       db_name = arg.split("=")[1]
+    elsif arg =~ /^--log(file)?=/
+      logfile = arg.split("=")[1]
+    elsif arg == "--trace"
+      set_trace_func __trace
     else
       flags << arg
     end
@@ -99,7 +106,7 @@ when "test" then
 
 else
   # test to see if it's an accepted object mode
-  if ObjectModes.keys.include? args[0]
+  if CLI::ObjectModes.keys.include? args[0]
     mode = args.shift
     id = args.shift
 
@@ -110,6 +117,19 @@ else
   end
 end
 
+# set up a logger if specified
+logger = nil
+if not logfile.nil?
+  if logfile == "-"
+    logfile = STDOUT
+  end
+  logger = Logger.new(logfile)
+  logger.formatter = proc do |level, timestamp, progname, msg|
+    "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")} #{msg}\n"
+  end
+end
+DB.logger = logger
+
 # load database config and set instance to the instance given on the command line
 DB.load_config
 if not db_name.nil?
@@ -117,12 +137,15 @@ if not db_name.nil?
 end
 
 if flags.include? "--all"
-  serials = ObjectModes[mode].all_serializations
+  serials = CLI::ObjectModes[mode].all_serializations
+elsif
+  flags.include? "--dbrow-only"
+  serials = [:dbrow]
 else
   serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').to_sym}
 end
 begin
-  puts ObjectModes[mode].find(id).to_yaml(serials)
+  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

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-02-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -14,6 +14,7 @@ require 'json'
 require 'rexml/document'
 require 'base64'
 require 'sequel'
+require 'logger'
 
 require 'sakai-info/version'
 
@@ -74,6 +75,7 @@ require 'sakai-info/database'
 # base objects
 require 'sakai-info/sakai_object'
 require 'sakai-info/sakai_xml_entity'
+require 'sakai-info/mod_props'
 
 # sakai object classes
 require 'sakai-info/user'
@@ -85,5 +87,6 @@ require 'sakai-info/content'
 require 'sakai-info/gradebook'
 require 'sakai-info/group'
 require 'sakai-info/message'
-require 'sakai-info/samigo'
+require 'sakai-info/quiz'
+require 'sakai-info/question_pool'
 

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-23 daveadams@gmail.com
+# Last updated 2012-02-26 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,3 +11,17 @@
 
 require 'sakai-info/cli/help'
 
+module SakaiInfo
+  class CLI
+    ObjectModes = {
+      "site" => Site,
+      "user" => User,
+      "quiz" => Quiz,
+      "quiz-section" => QuizSection,
+      "quiz-item" => QuizItem,
+      "qpool" => QuestionPool,
+      "question-pool" => QuestionPool,
+    }
+  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-19 daveadams@gmail.com
+# Last updated 2012-02-26 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -19,20 +19,41 @@ sakai-info #{VERSION}
   Usage: sakai-info <command> [<id>] [<options>]
 
   Object commands:
-    user         Print information about a user or users
-    site         Print information about a site or sites
+    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
+    question-pool  Question Pool information
 
   Misc commands:
     test         Tests configured database connections
     help         Prints general help
     version      Prints version
 
-  Options that apply to most commands:
-    -D <name>
+  Options that apply globally:
     --database=<name>
         Connect to database instance <name> as defined in ~/.sakai-info instead
         of the default (which is typically the first entry)
 
+    --log=<logfile>
+        Log actual SQL statements to <logfile> as they are executed. Use "-"
+        to log to STDOUT.
+
+    --trace
+        For development troubleshooting work, this outputs an extremely verbose
+        trace log to STDOUT.
+
+  Options that work on most object types:
+    --dbrow-only
+        Print only the raw database fields for the object requested.
+
+    --mod
+        Print creation and modification users and timestamps.
+
+    --all
+        Print all possible information (other than dbrow)
+
   Type 'sakai-info help <command>' for help on a specific command.
 EOF
 
@@ -94,6 +115,73 @@ sakai-info site
     --forums       Print forum details
     --all          Print all possible details
 EOF
+
+        "quiz" => <<EOF,
+sakai-info quiz
+
+  Usage: sakai-info 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:
+
+    --sections   Print section summary list
+    --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,
+sakai-info quiz-section
+
+  Usage: sakai-info 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:
+
+    --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,
+sakai-info quiz-item
+
+  Usage: sakai-info quiz-item <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:
+
+    --mod        Print creation/modification info
+    --all        Print all possible details
+    --dbrow      Print the raw database fields
+EOF
+
+        "question-pool" => <<EOF,
+sakai-info question-pool
+
+  Usage: sakai-info qpool <id> [<options>]
+         sakai-info question-pool <id> [<options>]
+
+  Prints information about the question pool ID specified. Additional options
+  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
+    --quizzes  Print summary of quizzes that link to this pool
+    --all      Print all possible details
+EOF
+
       }
 
       def self.help(topic = :default, io = STDOUT)

data/lib/sakai-info/database.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Database library
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-02-24 daveadams@gmail.com
+# Last updated 2012-02-25 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -79,7 +79,8 @@ module SakaiInfo
                          end
                        else
                          @@config[database_name]
-                       end)
+                       end,
+                       @@logger)
       end
       @@databases[database_name].connect
     end
@@ -87,11 +88,26 @@ module SakaiInfo
     def self.default_database=(database_name)
       @@default_database_name = database_name
     end
+
+    # set global logger
+    @@logger = nil
+    def self.logger=(logger)
+      @@logger = logger
+
+      # also force it on any existing database connections
+      @@databases.each do |name, dbconn|
+        puts "updating #{name}"
+        puts dbconn.class
+        dbconn.logger = @@logger
+        puts dbconn.connect.loggers.inspect
+      end
+    end
   end
 
   class Database
-    def initialize(connection_string)
+    def initialize(connection_string, logger = nil)
       @connection_string = connection_string.to_s
+      @logger = logger
     end
 
     def connect
@@ -105,6 +121,17 @@ module SakaiInfo
         @connection = nil
         raise ConnectionFailureException.new("Could not connect: #{e}")
       end
+
+      if not @logger.nil?
+        @connection.logger = @logger
+      end
+
+      return @connection
+    end
+
+    def logger=(logger)
+      @logger = logger
+      @connection.logger = @logger
     end
 
     def alive?

data/lib/sakai-info/mod_props.rb

@@ -0,0 +1,73 @@
+# sakai-info/mod_props.rb
+#   SakaiInfo::ModProps library
+#
+# Created 2012-02-26 daveadams@gmail.com
+# Last updated 2012-02-26 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  module ModProps
+    def self.included(klass)
+      klass.class_eval {
+        # defaults based on User and Site objects
+        def get_created_at_key; :createdon; end
+        def get_created_by_key; :createdby; end
+        def get_modified_at_key; :modifiedon; end
+        def get_modified_by_key; :modifiedby; end
+
+        def self.created_at_key(newkey)
+          self.class_eval("def get_created_at_key; :#{newkey}; end")
+        end
+
+        def self.created_by_key(newkey)
+          self.class_eval("def get_created_by_key; :#{newkey}; end")
+        end
+
+        def self.modified_at_key(newkey)
+          self.class_eval("def get_modified_at_key; :#{newkey}; end")
+        end
+
+        def self.modified_by_key(newkey)
+          self.class_eval("def get_modified_by_key; :#{newkey}; end")
+        end
+
+        def created_by_id
+          @dbrow[self.get_created_by_key]
+        end
+
+        def created_by
+          User.find(self.created_by_id)
+        end
+
+        def created_at
+          @dbrow[self.get_created_at_key]
+        end
+
+        def modified_by_id
+          @dbrow[self.get_modified_by_key]
+        end
+
+        def modified_by
+          User.find(self.modified_by_id)
+        end
+
+        def modified_at
+          @dbrow[self.get_modified_at_key]
+        end
+
+        def mod_serialization
+          {
+            "created_by" => self.created_by.serialize(:summary),
+            "created_at" => self.created_at.strftime("%Y-%m-%d %H:%M:%S"),
+            "modified_by" => self.modified_by.serialize(:summary),
+            "modified_at" => self.modified_at.strftime("%Y-%m-%d %H:%M:%S")
+          }
+        end
+      }
+    end
+  end
+end