sakai-info 0.1.0 → 0.2.0

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-19 daveadams@gmail.com
+# Last updated 2012-02-23 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,25 +11,3 @@
 
 require 'sakai-info/cli/help'
 
-module SakaiInfo
-  class CLI
-    def self.validate_config
-      return true if Configuration.configured?
-
-      begin
-        Configuration.load_config
-        return true
-      rescue NoConfigFoundException
-        STDERR.puts "ERROR: No configuration file was found at #{Configuration::DEFAULT_CONFIG_FILE}"
-        return false
-      rescue InvalidConfigException => e
-        STDERR.puts "ERROR: Configuration was invalid:"
-        e.message.each_line do |line|
-          STDERR.puts "  #{line.chomp}"
-        end
-        return false
-      end
-    end
-  end
-end
-

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

@@ -16,73 +16,83 @@ module SakaiInfo
         :default => <<EOF,
 sakai-info #{VERSION}
 
-Object commands:
-  user         Print information about a user or users
-  site         Print information about a site or sites
+  Usage: sakai-info <command> [<id>] [<options>]
 
-Misc commands:
-  validate     Validates configuration
-  help         Prints general help
-  version      Prints version
+  Object commands:
+    user         Print information about a user or users
+    site         Print information about a site or sites
 
-Type 'sakai-info help <command>' for help on a specific command.
+  Misc commands:
+    test         Tests configured database connections
+    help         Prints general help
+    version      Prints version
+
+  Options that apply to most commands:
+    -D <name>
+    --database=<name>
+        Connect to database instance <name> as defined in ~/.sakai-info instead
+        of the default (which is typically the first entry)
+
+  Type 'sakai-info help <command>' for help on a specific command.
 EOF
 
         "help" => <<EOF,
 sakai-info help
 
+  Usage: sakai-info help [<command>]
+
   Prints usage information for other sakai-info commands, or without an
   argument it prints a list of possible commands.
-
-  Usage: sakai-info help [<command>]
 EOF
 
         "version" => <<EOF,
 sakai-info version
 
-  Prints the current version of sakai-info.
-
   Usage: sakai-info version
-EOF
-
-        "validate" => <<EOF,
-sakai-info validate
 
-  Reads and validates the current configuration format. To test the actual
-  database connections, use 'sakai-info test'.
-
-  Usage: sakai-info validate
+  Prints the current version of sakai-info.
 EOF
 
         "test" => <<EOF,
 sakai-info test
 
-  [NOT YET IMPLEMENTED]
+  Usage: sakai-info test [<options>]
 
-  Reads configuration and tests connecting to each database specified, or with
-  an argument, it will test only the named instance.
-
-  Usage: sakai-info test [<instance>]
+  Reads configuration and tests connecting to each database specified, or if
+  a specific database is specified it will test only that connection.
 EOF
 
         "user" => <<EOF,
 sakai-info user
 
-  In this release, this command prints the total number of records in the
-  SAKAI_USER table. In future releases, subcommands will be available to
-  perform more tasks.
+  Usage: sakai-info user <id> [<options>]
+
+  Prints information about the user ID or EID specified. Additional options
+  may be passed to include additional information:
 
-  Usage: sakai-info user [<subcommand>]
+    --sites    Print site membership information
+    --pools    Print list of owned question pools
+    --all      Print all possible details
 EOF
 
         "site" => <<EOF,
 sakai-info site
 
-  In this release, this command prints the total number of records in the
-  SAKAI_SITE table. In future releases, subcommands will be available to
-  perform more tasks.
-
-  Usage: sakai-info site [<subcommand>]
+  Usage: sakai-info site <id> [<options>]
+
+  Prints information about the site ID specified. Additional options may be
+  passed to include additional information:
+
+    --users        Print membership information
+    --pages        Print page list with tools
+    --groups       Print group information
+    --quizzes      Print information about quizzes
+    --disk         Print disk usage
+    --assignments  Print assignment info
+    --gradebook    Print gradebook item info
+    --realm        Print site realm details
+    --forums       Print forum details
+    --all          Print all possible details
 EOF
       }
 
@@ -93,7 +103,7 @@ EOF
         else
           STDERR.puts "ERROR: help topic '#{topic}' was unrecognized"
           STDERR.puts
-          CLI.help(:default, STDERR)
+          CLI::Help.help(:default, STDERR)
           exit 1
         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-02-18 daveadams@gmail.com
+# Last updated 2012-02-24 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -39,10 +39,8 @@ module SakaiInfo
 
     def binary
       if @binary.nil?
-        DB.connect.exec("select binary_entity from #{@table_name} " +
-                        "where #{@id_column} = :id", id) do |row|
-          @binary = row[0].read
-        end
+        row = DB.connect[@table_name.to_sym].filter(@id_column.to_sym => @id).first
+        @binary = row[:binary_entity].read
       end
       @binary
     end
@@ -104,15 +102,11 @@ module SakaiInfo
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        DB.connect.exec("select resource_id, in_collection, file_path, " +
-                        "resource_uuid, file_size, context, resource_type_id " +
-                        "from content_resource " +
-                        "where resource_id=:id", id) do |row|
-          @@cache[id] = ContentResource.new(row[0], row[1], row[2], row[3], row[4].to_i, row[5], row[6])
-        end
-        if @@cache[id].nil?
+        row = DB.connect[:content_resource].filter(:resource_id => id).first
+        if row.nil?
           raise ObjectNotFoundException.new(ContentResource, id)
         end
+        @@cache[id] = ContentResource.new(row[:resource_id], row[:in_collection], row[:file_path], row[:resource_uuid], row[:file_size].to_i, row[:context], row[:resource_type_id])
       end
       @@cache[id]
     end
@@ -136,23 +130,18 @@ module SakaiInfo
 
     def self.find_by_parent(parent_id)
       resources = []
-      DB.connect.exec("select resource_id, in_collection, file_path, " +
-                      "resource_uuid, file_size, context, resource_type_id " +
-                      "from content_resource " +
-                      "where in_collection=:parent_id", parent_id) do |row|
-        @@cache[row[0]] = ContentResource.new(row[0], row[1], row[2], row[3], row[4].to_i, row[5], row[6])
+      DB.connect[:content_resource].filter(:in_collection => parent_id) do |row|
+        @@cache[row[:resource_id]] =
+          ContentResource.new(row[:resource_id], row[:in_collection], row[:file_path],
+                                row[:resource_uuid], row[:file_size].to_i, row[:context],
+                                row[:resource_type_id])
         resources << @@cache[row[0]]
       end
       resources
     end
 
     def self.count_by_parent(parent_id)
-      count = 0
-      DB.connect.exec("select count(*) from content_resource " +
-                      "where in_collection=:parent_id", parent_id) do |row|
-        count = row[0].to_i
-      end
-      count
+      DB.connect[:content_resource].filter(:in_collection => parent_id).count
     end
   end
 
@@ -172,13 +161,11 @@ module SakaiInfo
       end
 
       if @@cache[id].nil?
-        DB.connect.exec("select collection_id, in_collection from content_collection " +
-                        "where collection_id=:id", id) do |row|
-          @@cache[id] = ContentCollection.new(row[0], row[1])
-        end
-        if @@cache[id].nil?
+        row = DB.connect[:content_collection].filter(:collection_id => id).first
+        if row.nil?
           raise ObjectNotFoundException.new(ContentCollection, id)
         end
+        @@cache[id] = ContentCollection.new(row[:collection_id], row[:in_collection])
       end
       @@cache[id]
     end
@@ -194,31 +181,23 @@ module SakaiInfo
 
     def self.find_portfolio_interaction_collections
       collections = []
-      DB.connect.exec("select collection_id, in_collection from content_collection " +
-                      "where collection_id like '%/portfolio-interaction/'") do |row|
-        @@cache[row[0]] = ContentCollection.new(row[0], row[1])
-        collections << @@cache[row[0]]
+      DB.connect[:content_collection].
+        where(:collection_id.like('%/portfolio-interaction/')) do |row|
+        @@cache[row[:collection_id]] =
+          ContentCollection.new(row[:collection_id], row[:in_collection])
+        collections << @@cache[row[:collection_id]]
       end
       collections
     end
 
     def self.count_by_parent(parent_id)
-      count = 0
-      DB.connect.exec("select count(*) from content_collection " +
-                      "where in_collection=:parent_id", parent_id) do |row|
-        count = row[0].to_i
-      end
-      count
+      DB.connect[:content_collection].filter(:in_collection => parent_id).count
     end
 
     def size_on_disk
-      if @size_on_disk.nil?
-        DB.connect.exec("select sum(file_size) from content_resource " +
-                        "where resource_id like :collmatch", (@id + "%")) do |row|
-          @size_on_disk = row[0].to_i
-        end
-      end
-      @size_on_disk
+      @size_on_disk ||=
+        DB.connect[:content_resource].select(:sum.sql_function(:file_size).as(:total_size)).
+        where(:resource_id.like("#{@id}%")).first[:total_size].to_i
     end
 
     def children
@@ -278,10 +257,10 @@ module SakaiInfo
 
     def self.find_by_parent(parent_id)
       collections = []
-      DB.connect.exec("select collection_id, in_collection from content_collection " +
-                      "where in_collection = :parent_id", parent_id) do |row|
-        @@cache[row[0]] = ContentCollection.new(row[0], row[1])
-        collections << @@cache[row[0]]
+      DB.connect[:content_collection].filter(:in_collection => parent_id) do |row|
+        @@cache[row[:collection_id]] =
+          ContentCollection.new(row[:collection_id], row[:in_collection])
+        collections << @@cache[row[:collection_id]]
       end
       collections
     end

data/lib/sakai-info/database.rb

@@ -0,0 +1,114 @@
+# sakai-info/database.rb
+#   SakaiInfo::Database library
+#
+# Created 2012-02-19 daveadams@gmail.com
+# Last updated 2012-02-24 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+# DATABASE CONFIG FORMAT
+#
+# yaml file with lines of "nickname: sequel-connection-string", eg:
+#
+#   prod: oracle://user:pass@sid
+#   test: oracle://user:pass@sid/schema_name
+#   dev: mysql://user:pass@hostname/db_name
+#
+# The default connection is the first one in the file.
+# For more on Sequel connection strings, see:
+#   http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
+#
+
+# using the oci8 driver will complain if NLS_LANG is not set in the environment
+ENV["NLS_LANG"] ||= "AMERICAN_AMERICA.UTF8"
+
+module SakaiInfo
+  class InvalidConfigException < SakaiException; end
+  class ConnectionFailureException < SakaiException; end
+
+  class DB
+    DEFAULT_CONFIG_FILE = File.expand_path("~/.sakai-info")
+    @@default_database_name = nil
+    @@config = nil
+
+    def self.configure(config)
+      begin
+        if config.is_a? Hash
+          @@config = config
+        elsif config.is_a? String and File.exist?(config)
+          # try to parse as a filename first
+          if File.exist?(config)
+            @@config = YAML::load_file(config)
+          end
+        else
+          # otherwise try to parse it generically
+          @@config = YAML::load(config)
+        end
+      rescue Exception => e
+        raise InvalidConfigException.new("Unable to parse configuration: #{e}")
+      end
+    end
+
+    def self.load_config
+      if File.readable? DEFAULT_CONFIG_FILE
+        DB.configure(DEFAULT_CONFIG_FILE)
+      else
+        raise MissingConfigException.new("No config file found at #{DEFAULT_CONFIG_FILE}")
+      end
+    end
+
+    def self.databases
+      @@config
+    end
+
+    @@databases = {}
+    def self.connect(database_name = :default)
+      if @@config.nil?
+        DB.load_config
+      end
+      if @@databases[database_name].nil?
+        @@databases[database_name] =
+          Database.new(if database_name == :default
+                         if @@default_database_name.nil?
+                           @@config[@@config.keys.first]
+                         else
+                           @@config[@@default_database_name]
+                         end
+                       else
+                         @@config[database_name]
+                       end)
+      end
+      @@databases[database_name].connect
+    end
+
+    def self.default_database=(database_name)
+      @@default_database_name = database_name
+    end
+  end
+
+  class Database
+    def initialize(connection_string)
+      @connection_string = connection_string.to_s
+    end
+
+    def connect
+      if @connection and self.alive?
+        return @connection
+      end
+
+      begin
+        @connection = Sequel.connect(@connection_string)
+      rescue => e
+        @connection = nil
+        raise ConnectionFailureException.new("Could not connect: #{e}")
+      end
+    end
+
+    def alive?
+      @connection.nil? && @connection.test_connection
+    end
+  end
+end

data/lib/sakai-info/gradebook.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Gradebook library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-18 daveadams@gmail.com
+# Last updated 2012-02-24 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -24,17 +24,16 @@ module SakaiInfo
     @@cache_by_site_id = {}
     def self.find(id)
       if @@cache[id].nil?
-        version = site = name = nil
-        DB.connect.exec("select version, gradebook_uid, name " +
-                        "from gb_gradebook_t " +
-                        "where id = :id", id) do |row|
-          version = row[0].to_i
-          site = Site.find(row[1])
-          name = row[2]
-        end
-        if version.nil?
+        row = DB.connect.fetch("select version, gradebook_uid, name " +
+                               "from gb_gradebook_t " +
+                               "where id = :id", id).first
+        if row.nil?
           raise ObjectNotFoundException.new(Gradebook, id)
         end
+
+        version = row[:version].to_i
+        site = Site.find(row[:gradebook_uid])
+        name = row[:name]
         @@cache[id] = Gradebook.new(id, version, site, name)
         @@cache_by_site_id[site.id] = @@cache[id]
       end
@@ -43,18 +42,17 @@ module SakaiInfo
 
     def self.find_by_site_id(site_id)
       if @@cache_by_site_id[site_id].nil?
-        id = version = site = name = nil
-        DB.connect.exec("select id, version, name " +
-                        "from gb_gradebook_t " +
-                        "where gradebook_uid = :site_id", site_id) do |row|
-          id = row[0].to_i
-          version = row[1].to_i
-          name = row[2]
-          site = Site.find(site_id)
-        end
-        if version.nil?
+        row = DB.connect.fetch("select id, version, name " +
+                               "from gb_gradebook_t " +
+                               "where gradebook_uid = ?", site_id).first
+        if row.nil?
           raise ObjectNotFoundException.new(Gradebook, site_id)
         end
+
+        id = row[:id].to_i
+        version = row[:version].to_i
+        name = row[:name]
+        site = Site.find(site_id)
         @@cache[id] = Gradebook.new(id, version, site, name)
         @@cache_by_site_id[site_id] = @@cache[id]
       end
@@ -89,24 +87,24 @@ module SakaiInfo
     @@cache = {}
     def self.find(id)
       if @@cache[id].nil?
-        gradebook = object_type = version = name = points_possible = due_date = weight = nil
-        DB.connect.exec("select gradebook_id, object_type_id, version, " +
-                        "name, points_possible, " +
-                        "to_char(due_date, 'YYYY-MM-DD'), " +
-                        "assignment_weighting " +
-                        "from gb_gradable_object_t " +
-                        "where id = :id", id) do |row|
-          gradebook = Gradebook.find(row[0].to_i)
-          object_type = row[1].to_i
-          version = row[2].to_i
-          name = row[3]
-          points_possible = row[4].to_f
-          due_date = row[5]
-          weight = row[6].to_f
-        end
-        if version.nil?
+        row = DB.connect.fetch("select gradebook_id, object_type_id, version, " +
+                               "name, points_possible, " +
+                               "to_char(due_date, 'YYYY-MM-DD') as due, " +
+                               "assignment_weighting " +
+                               "from gb_gradable_object_t " +
+                               "where id = ?", id).first
+
+        if row.nil?
           raise ObjectNotFoundException.new(GradableObject, id)
         end
+
+        gradebook = Gradebook.find(row[:gradebook_id].to_i)
+        object_type = row[:object_type_id].to_i
+        version = row[:version].to_i
+        name = row[:name]
+        points_possible = row[:points_possible].to_f
+        due_date = row[:due]
+        weight = row[:assignment_weighting].to_f
         @@cache[id] = GradableObject.new(id, gradebook, object_type,
                                          version, name, points_possible,
                                          due_date, weight)
@@ -119,20 +117,20 @@ module SakaiInfo
       if @@cache_by_gradebook_id[gradebook_id].nil?
         objects = []
         gradebook = Gradebook.find(gradebook_id)
-        DB.connect.exec("select id, object_type_id, version, " +
-                        "name, points_possible, " +
-                        "to_char(due_date, 'YYYY-MM-DD'), " +
-                        "assignment_weighting " +
-                        "from gb_gradable_object_t " +
-                        "where gradebook_id = :gradebook_id " +
-                        "order by due_date asc", gradebook_id) do |row|
-          id = row[0].to_i
-          object_type = row[1].to_i
-          version = row[2].to_i
-          name = row[3]
-          points_possible = row[4].to_f
-          due_date = row[5]
-          weight = row[6].to_f
+        DB.connect.fetch("select id, object_type_id, version, " +
+                         "name, points_possible, " +
+                         "to_char(due_date, 'YYYY-MM-DD') as due, " +
+                         "assignment_weighting " +
+                         "from gb_gradable_object_t " +
+                         "where gradebook_id = ? " +
+                         "order by due_date asc", gradebook_id) do |row|
+          id = row[:id].to_i
+          object_type = row[:object_type_id].to_i
+          version = row[:version].to_i
+          name = row[:name]
+          points_possible = row[:points_possible].to_f
+          due_date = row[:due]
+          weight = row[:assignment_weighting].to_f
           objects << GradableObject.new(id, gradebook, object_type,
                                         version, name, points_possible,
                                         due_date, weight)