sakai-info 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,12 +1,18 @@
-sakai-info Change History
-=========================
+# sakai-info Change History #
 
-0.0.0
------
+## 0.2.0 ##
 
-*Released 2012-02-??*
+*Released 2012-02-24*
+
+* Sequel now used as the database driver, enabling MySQL and Sqlite support
+* Simplified configuration file format
+* CLI tool now provides details on user and site objects
+
+## 0.1.0 ##
+
+*Released 2012-02-19*
 
 * Initial release
 * Oracle-only support
-* Limited CLI functionality
+* Extremely limited CLI functionality
 

data/README.md

@@ -1,5 +1,4 @@
-sakai-info
-==========
+# sakai-info #
 
 *sakai-info* is a command line tool and a suite of Ruby libraries which enable
 the exploration of a Sakai database without the intermediation of a Java VM or
@@ -9,34 +8,31 @@ Because the primary goal of this tool is to assist in information gathering
 and troubleshooting, no capability to change the database is included in the
 tool or the libraries.
 
-Meta
-----
-last updated: 2012-02-19  
-author: David Adams (daveadams@gmail.com)  
+## Meta ##
+
+last updated: 2012-02-24
+author: David Adams (daveadams@gmail.com)
 github url: https://github.com/daveadams/sakai-info
 
-Testing
--------
+## Testing ##
 
 Tests are defined in ./test using Test::Unit. The default `rake` action is to
 run all tests.
 
-Building
---------
+## Building ##
 
 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.1.0.gem`.
+`sakai-info-0.2.0.gem`.
 
 Cleanup built gems using:
 
     $ rake clean
 
-Installing
-----------
+## Installing ##
 
 Install the *sakai-info* gem locally with:
 
@@ -46,78 +42,56 @@ Uninstall with:
 
     $ rake gem:uninstall
 
-Supported Databases
--------------------
-
-For this release, only Oracle databases are supported. MySQL support is planned
-as soon as possible. Support for SQLite or some other lightweight database may
-be implemented for unit testing purposes.
-
-System Requirements
--------------------
+## Database Connectivity ##
 
-For Oracle support, the `ruby-oci8` gem is required.
+[Sequel](http://sequel.rubyforge.org) is used for database connectivity. Driver
+gems must also be installed to support whatever database or databases you use.
 
-So far, testing has occurred using Ruby 1.9.1p376 and Ruby 1.9.2p290, with
-version 2.0.6 of the `ruby-oci8` gem, on Ubuntu 10.04, against Oracle 11g
-R2 versions 11.2.0.1 and 11.2.0.3, using the Oracle Instant Client version
-11.2.0.3.
+Oracle support requires the `ruby-oci8` gem, and MySQL support requires the
+`mysql` gem. Some unit tests make use of the `sqlite3` gem.
 
-Configuration
--------------
+## Configuration ##
 
 To run, *sakai-info* needs to be able to connect to your Sakai database server.
 It is possible to specify multiple instances to choose from at runtime.
 
 In this release, *sakai-info* expects a to find the config in a file located at
 `$HOME/.sakai-info`. The file must be in YAML format and can contain one or
-more Sakai database connection definitions. To define a single database
-connection, specify the file like this:
-
-    dbtype: oracle
-    username: sakai
-    password: <password>
-    service: SAKAIPROD
-    host: oracle.db
-    port: 1521
-
-The `port` value is optional, with a default of 1521. If your Oracle setup uses
-a `tnsnames.ora` file, then both `host` and `port` can be excluded, and
-`service` will be used to find the corresponding `tnsnames.ora` entry.
-
-Multiple instances may be specified by using the following format:
-
-    default: production
-    instances:
-      production:
-        dbtype: oracle
-        username: sakai
-        password: <password>
-        service: SAKAIPROD
-        host: oracle.db
-        port: 1521
-     test:
-       dbtype: oracle
-       username: sakai
-       password: <password>
-       service: SAKAITEST
-
-The `default` key identifies which of the connections under `instances` you
-wish to be used in the absence of any explicit specification. Other instances
-will be referenced by the corresponding YAML key (eg, `production` and `test`
-in the example above).
-
-Command Line Usage
-------------------
+more Sakai database connection nicknames and connection strings, for example:
+
+    prod: oracle://sakai:password@SAKAIPROD
+    test: mysql://test:password@mysql.host:3307/db_name
+
+The first connection in the list is the default connection. Other connections
+may be specified using the corresponding YAML key, which functions as a
+nickname for the connection.
+
+[More information on how to specify a Sequel connection string.](http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html)
+
+## Command Line Usage ##
 
 After installing the gem, the `sakai-info` program should be found in your
-PATH. For this release, very limited functionality is included. For usage
-details, run:
+PATH. For usage details, run:
 
     $ sakai-info help
 
-Library Usage
--------------
+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:
 
@@ -131,18 +105,16 @@ program.
 Full RDoc documentation for each class is not available in this release, but is
 planned for a future release.
 
-Change History
---------------
+## Change History ##
 
 See CHANGELOG.md
 
-Future Plans
-------------
+## Future Plans ##
 
 See ROADMAP.md
 
-License
--------
+## License ##
+
 This work is dedicated to the public domain. No rights are reserved. See
 LICENSE for more information.
 

data/ROADMAP.md

@@ -1,14 +1,18 @@
-sakai-info Roadmap
-==================
+# sakai-info Roadmap #
 
-*Last updated 2012-02-18 by daveadams@gmail.com*
+*Last updated 2012-02-24*
 
-The most important things to get to after the initial release are:
+### 0.3 ###
 
-* MySQL support
-* Command-line access to all object types, properties, and relationships
-  understood by the library.
-* Full RDoc documentation of the library classes, properties, and methods
+* CLI access to more objects, eg quizzes, tools, assignments, and groups
+* Sqlite test infrastructure for a few basic objects
+
+### 0.5 ###
+
+* Test fixtures and basic unit tests for all represented objects
+* RDoc coverage for every class
+
+------
 
 Other things on the wishlist for future releases:
 
@@ -25,13 +29,11 @@ Other things on the wishlist for future releases:
 * Generalized reporting capabilities
   * Storage utilization per-site
   * Session and event statistics
-  * Metrics on various elements, eg:
-    * Typical quiz duration
-    * Quiz/assignment completion rates
-    * Forum post rates, post length
-    * etc
-
-The ultimate dream:
-
-* A web interface for searching and exploring the database
+* Metrics on various elements
+  * Typical quiz duration
+  * Quiz/assignment completion rates
+  * Forum post rates, post length
+* Additional tools
+  * httpd log analysis helper
+  * RPC client for Sakai-monitoring servlet
 

data/bin/sakai-info

@@ -5,7 +5,7 @@
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-19 daveadams@gmail.com
+# Last updated 2012-02-24 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -17,63 +17,114 @@ include SakaiInfo
 
 require 'sakai-info/cli'
 
-ObjectModes = %w(site user)
+ObjectModes = {
+  "site" => Site,
+  "user" => User
+}
 
-if ARGV.length > 0
-  case ARGV[0]
+flags = []
+args = []
+db_name = nil
 
-  when "help" then
-    if ARGV.length > 1
-      CLI::Help.help ARGV[1]
+while arg = ARGV.shift
+  if arg =~ /^-/
+    if arg == "-D"
+      db_name = ARGV.shift
+    elsif arg =~ /^--database=/
+      db_name = arg.split("=")[1]
     else
-      CLI::Help.help
+      flags << arg
     end
-    exit
+  else
+    args << arg
+  end
+end
 
-  when "version" then
-    puts VERSION
-    exit
+if args.length < 1
+  STDERR.puts "ERROR: No command was given."
+  STDERR.puts "Run '#{File.basename($0)} help' for a list of commands."
+  exit 1
+end
 
-  when "validate" then
-    if CLI.validate_config
-      puts "Configuration OK"
-      exit
-    else
-      exit 1
-    end
+case args[0]
+when "help" then
+  if not args[1].nil?
+    CLI::Help.help args[1]
+  else
+    CLI::Help.help
+  end
+  exit
 
-  when "test" then
-    STDERR.puts "PENDING: test mode unimplemented"
-    exit 1
+when "version" then
+  puts VERSION
+  exit
 
+when "test" then
+  DB.load_config
+  success = 0
+  failure = 0
+  dbs = nil
+
+  if db_name.nil?
+    dbs = DB.databases
   else
-    # test to see if it's an accepted object mode
-    if ObjectModes.include? ARGV[0]
-      mode = ARGV[0]
-      ARGV.shift
-      # continue on
+    dbs = { db_name => DB.databases[db_name] }
+  end
 
-    else
-      STDERR.puts "ERROR: Command '#{ARGV[0]}' was not recognized."
-      STDERR.puts "Run 'sakai-info help' for a list of commands."
-      exit 1
+  dbs.each do |nickname, connection_string|
+    begin
+      print "Trying #{nickname}... "; STDOUT.flush
+      db = Sequel.connect(connection_string)
+      if db.test_connection
+        puts "OK"
+        success += 1
+      else
+        puts "FAIL"
+        failure += 1
+      end
+    rescue => e
+      puts "FAIL"
+      puts "  #{e}"
+      failure += 1
     end
   end
-else
-  STDERR.puts "ERROR: No command was given."
-  STDERR.puts "Run 'sakai-info help' for a list of commands."
-  exit 1
-end
 
-exit 1 if not CLI.validate_config
+  if failure > 0
+    puts "WARNING: Some connections failed"
+    exit 1
+  else
+    puts "OK: All connection tests succeeded"
+    exit
+  end
 
-if mode == "user"
-  print "Total users: "; STDOUT.flush
-  puts User.count
+else
+  # test to see if it's an accepted object mode
+  if ObjectModes.keys.include? args[0]
+    mode = args.shift
+    id = args.shift
 
-elsif mode == "site"
-  print "Total sites: "; STDOUT.flush
-  puts Site.count
+  else
+    STDERR.puts "ERROR: Command '#{args[0]}' was not recognized."
+    STDERR.puts "Run '#{File.basename($0)} help' for a list of commands."
+    exit 1
+  end
+end
+
+# load database config and set instance to the instance given on the command line
+DB.load_config
+if not db_name.nil?
+  DB.default_database = db_name
+end
 
+if flags.include? "--all"
+  serials = ObjectModes[mode].all_serializations
+else
+  serials = [:default] + flags.collect{|flag|flag.gsub(/^--/,'').to_sym}
+end
+begin
+  puts ObjectModes[mode].find(id).to_yaml(serials)
+rescue ObjectNotFoundException
+  STDERR.puts "ERROR: Could not find #{mode} with an ID of '#{id}'"
+  exit 1
 end
 

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-02-19 daveadams@gmail.com
+# Last updated 2012-02-24 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -13,6 +13,7 @@ require 'yaml'
 require 'json'
 require 'rexml/document'
 require 'base64'
+require 'sequel'
 
 require 'sakai-info/version'
 
@@ -30,6 +31,34 @@ module SakaiInfo
       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
+  end
 end
 
 # extensions to other objects
@@ -39,10 +68,8 @@ class String
   end
 end
 
-# baseline config and connectivity
-require 'sakai-info/instance'
-require 'sakai-info/db'
-require 'sakai-info/configuration'
+# baseline db connectivity
+require 'sakai-info/database'
 
 # base objects
 require 'sakai-info/sakai_object'