sakai-info 0.1.0

data/lib/sakai-info/db.rb

@@ -0,0 +1,19 @@
+# sakai-info/db.rb
+#   SakaiInfo::DB library
+#
+# Created 2012-02-16 daveadams@gmail.com
+# Last updated 2012-02-19 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class DB
+    def self.connect(instance_name = :default)
+      Configuration.get_instance(instance_name).connect
+    end
+  end
+end
+

data/lib/sakai-info/gradebook.rb

@@ -0,0 +1,176 @@
+# sakai-info/gradebook.rb
+#   SakaiInfo::Gradebook library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-18 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Gradebook < SakaiObject
+    attr_reader :version, :site, :name
+
+    def initialize(id, version, site, name)
+      @id = id
+      @version = version
+      @site = site
+      @name = name
+    end
+
+    @@cache = {}
+    @@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?
+          raise ObjectNotFoundException.new(Gradebook, id)
+        end
+        @@cache[id] = Gradebook.new(id, version, site, name)
+        @@cache_by_site_id[site.id] = @@cache[id]
+      end
+      @@cache[id]
+    end
+
+    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?
+          raise ObjectNotFoundException.new(Gradebook, site_id)
+        end
+        @@cache[id] = Gradebook.new(id, version, site, name)
+        @@cache_by_site_id[site_id] = @@cache[id]
+      end
+      @@cache_by_site_id[site_id]
+    end
+
+    def items
+      @items ||= GradableObject.find_by_gradebook_id(@id)
+    end
+
+    def item_count
+      items.length
+    end
+  end
+
+  class GradableObject < SakaiObject
+    attr_reader :id, :gradebook, :object_type, :version, :name
+    attr_reader :points_possible, :due_date, :weight
+
+    def initialize(id, gradebook, object_type, version, name,
+                   points_possible, due_date, weight)
+      @id = id
+      @gradebook = gradebook
+      @object_type = object_type
+      @version = version
+      @name = name
+      @points_possible = points_possible
+      @due_date = due_date
+      @weight = weight
+    end
+
+    @@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?
+          raise ObjectNotFoundException.new(GradableObject, id)
+        end
+        @@cache[id] = GradableObject.new(id, gradebook, object_type,
+                                         version, name, points_possible,
+                                         due_date, weight)
+      end
+      @@cache[id]
+    end
+
+    @@cache_by_gradebook_id = {}
+    def self.find_by_gradebook_id(gradebook_id)
+      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
+          objects << GradableObject.new(id, gradebook, object_type,
+                                        version, name, points_possible,
+                                        due_date, weight)
+
+        end
+        @@cache_by_gradebook_id[gradebook_id] = objects
+      end
+      @@cache_by_gradebook_id[gradebook_id]
+    end
+
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "name" => self.name,
+        "gradebook_id" => self.gradebook.id,
+        "object_type" => self.object_type,
+        "version" => self.version,
+        "points_possible" => self.points_possible,
+        "due_date" => self.due_date,
+        "weight" => self.weight
+      }
+      if self.due_date.nil?
+        result.delete("due_date")
+      end
+      result
+    end
+
+    def summary_serialization
+      result = {
+        "id" => self.id,
+        "name" => self.name,
+        "points_possible" => self.points_possible,
+        "due_date" => self.due_date
+      }
+      if self.due_date.nil?
+        result.delete("due_date")
+      end
+      result
+    end
+  end
+end

data/lib/sakai-info/group.rb

@@ -0,0 +1,119 @@
+# sakai-info/group.rb
+#   SakaiInfo::Group library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-17 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Group < SakaiObject
+    attr_reader :site, :title
+
+    def initialize(id, site, title)
+      @id = id
+      if site.is_a? Site
+        @site = site
+      else
+        # assume the string version is a site_id
+        @site = Site.find(site.to_s)
+      end
+      @title = title
+    end
+
+    @@cache = {}
+    def self.find(id)
+      if @@cache[id].nil?
+        site_id = title = nil
+        DB.connect.exec("select site_id, title from sakai_site_group " +
+                        "where group_id = :id", id) do |row|
+          site_id = row[0]
+          title = row[1]
+          @@cache[id] = Group.new(id, site_id, title)
+        end
+        if site_id.nil? or name.nil?
+          raise ObjectNotFoundException.new(Group, id)
+        end
+      end
+      @@cache[id]
+    end
+
+    @@cache_by_site_id = {}
+    def self.find_by_site_id(site_id)
+      if @@cache_by_site_id[site_id].nil?
+        @@cache_by_site_id[site_id] = []
+        site = Site.find(site_id)
+        DB.connect.exec("select group_id, title " +
+                        "from sakai_site_group " +
+                        "where site_id = :site_id", site_id) do |row|
+          id = row[0]
+          title = row[1]
+          @@cache[id] = Group.new(id, site, title)
+          @@cache_by_site_id[site_id] << @@cache[id]
+        end
+      end
+      @@cache_by_site_id[site_id]
+    end
+
+    def self.count_by_site_id(site_id)
+      count = 0
+      DB.connect.exec("select count(*) from sakai_site_group " +
+                      "where site_id=:site_id", site_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    def properties
+      @properties ||= GroupProperty.find_by_group_id(@id)
+    end
+
+    def realm
+      @authz_realm ||= AuthzRealm.find_by_site_id_and_group_id(@site.id, @id)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "title" => self.title,
+        "site_id" => self.site.id,
+        "members" => self.realm.user_count,
+        "properties" => self.properties
+      }
+      if result["properties"] == {}
+        result.delete("properties")
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title,
+        "members" => self.realm.user_count
+      }
+    end
+  end
+
+  class GroupProperty
+    attr_reader :name, :value
+
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+
+    def self.find_by_group_id(group_id)
+      properties = []
+      DB.connect.exec("select name, value from sakai_site_group_property " +
+                      "where group_id=:group_id", group_id) do |row|
+        properties << GroupProperty.new(row[0], row[1].read)
+      end
+      properties
+    end
+  end
+end

data/lib/sakai-info/instance.rb

@@ -0,0 +1,122 @@
+# sakai-info/instance.rb
+#   SakaiInfo::Instance library
+#
+# Created 2012-02-19 daveadams@gmail.com
+# Last updated 2012-02-19 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class ConnectionFailureException < SakaiException; end
+
+  class Instance
+    def self.create(config)
+      case config["dbtype"].downcase
+      when "oracle" then
+        OracleInstance.new(config)
+      when "mysql" then
+        MySqlInstance.new(config)
+      else
+        raise UnsupportedConfigException.new("Database type '#{config["dbtype"]}' is not supported.")
+      end
+    end
+  end
+
+  class OracleInstance
+    DEFAULT_PORT = 1521
+
+    def initialize(config)
+      # fix NLS_LANG if necessary
+      ENV["NLS_LANG"] ||= "AMERICAN_AMERICA.UTF8"
+
+      # include Oracle driver
+      require 'oci8'
+
+      @username = config["username"]
+      @password = config["password"]
+      if config["host"].nil? or config["host"] == ""
+        @service = config["service"]
+      else
+        @host = config["host"]
+        @port = config["port"].nil? ? DEFAULT_PORT : config["port"].to_i
+        @service = "//#{@host}:#{@port}/#{config["service"]}"
+      end
+
+      # close the connection upon exit
+      at_exit {
+        if @connection
+          begin
+            if @connection.methods.include? :ping
+              @connection.logoff if @connection.ping
+            else
+              @connection.logoff
+            end
+          rescue
+            # it's ok
+          end
+        end
+      }
+    end
+
+    def dbtype
+      "oracle"
+    end
+
+    def alive?
+      is_alive = false
+      begin
+        @connection.exec("select 1 from dual") do |row|
+          if row[0] == 1
+            is_alive = true
+          end
+        end
+      rescue
+        # doesn't matter what the exception is
+        @connection = nil
+        is_alive = false
+      end
+
+      is_alive
+    end
+
+    def connect
+      if @connection and self.alive?
+        return @connection
+      end
+
+      begin
+        @connection = OCI8.new(@username, @password, @service)
+      rescue => e
+        @connection = nil
+        raise ConnectionFailureException.new("Could not connect: #{e}")
+      end
+    end
+  end
+
+  class MySqlInstance
+    DEFAULT_PORT = 3306
+
+    def initialize(config)
+      @username = config["username"]
+      @password = config["password"]
+      @dbname = config["dbname"]
+      @host = config["host"]
+      @port = config["port"].nil? ? 3306 : config["port"].to_i
+    end
+
+    def dbtype
+      "mysql"
+    end
+
+    def alive?
+      false
+    end
+
+    def connect
+      raise UnsupportedConfigException.new("MySQL will be supported in a future release.")
+    end
+  end
+end

data/lib/sakai-info/message.rb

@@ -0,0 +1,122 @@
+# sakai-info/message.rb
+#   SakaiInfo::Message library
+#
+# Created 2012-02-17 daveadams@gmail.com
+# Last updated 2012-02-18 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class MessageTypeUUID
+    # TODO: verify whether these are the same in all installs
+    PRIVATE_MESSAGE = "d6404db7-7f6e-487a-00fe-baffce45d84c"
+    FORUM_POST = "7143223e-355a-4865-00dd-cee9310499e4"
+  end
+
+  class UnknownMessageTypeException < SakaiException; end
+  class GenericMessage < SakaiObject
+    def self.count_by_date_and_message_type(count_date, message_type)
+      date_str = nil
+      if count_date.is_a? Time
+        date_str = count_date.strftime("%Y-%m-%d")
+      elsif count_date.is_a? String
+        if count_date =~ /^\d\d\d\d-\d\d-\d\d$/
+          date_str = count_date
+        else
+          raise InvalidDateException
+        end
+      else
+        raise InvalidDateException
+      end
+
+      if not valid_message_type? message_type
+        raise UnknownMessageTypeException
+      end
+
+      count = 0
+      DB.connect.exec("select count(*) from mfr_message_t " +
+                      "where message_dtype = :t " +
+                      "and to_char(created,'YYYY-MM-DD') = :d",
+                      message_type, date_str) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+   private
+    def self.valid_message_type?(s)
+      s =="ME" or s =="PM"
+    end
+  end
+
+  class PrivateMessage < GenericMessage
+    def self.count_by_date(d)
+      count_by_date_and_message_type(d, "PM")
+    end
+  end
+
+  class ForumPost < GenericMessage
+    def self.count_by_date(d)
+      count_by_date_and_message_type(d, "ME")
+    end
+  end
+
+  class Forum < SakaiObject
+    attr_reader :id, :title
+
+    def initialize(id, title)
+      @id = id.to_i
+      @title = title
+    end
+
+    @@cache = {}
+
+    def self.count_by_site_id(site_id)
+      count = 0
+      DB.connect.exec("select count(*) from mfr_open_forum_t " +
+                      "where surrogatekey = (select id from mfr_area_t " +
+                      "where type_uuid = :type_uuid " +
+                      "and context_id = :site_id)",
+                      MessageTypeUUID::FORUM_POST, site_id) do |row|
+        count = row[0].to_i
+      end
+      count
+    end
+
+    @@cache_by_site_id = {}
+    def self.find_by_site_id(site_id)
+      if @@cache_by_site_id[site_id].nil?
+        @@cache_by_site_id[site_id] = []
+        DB.connect.exec("select id, title from mfr_open_forum_t " +
+                        "where surrogatekey = (select id from mfr_area_t " +
+                        "where type_uuid = :type_uuid " +
+                        "and context_id = :site_id) order by sort_index",
+                        MessageTypeUUID::FORUM_POST, site_id) do |row|
+          id = row[0].to_i.to_s
+          title = row[1]
+          @@cache[id] = Forum.new(id, title)
+          @@cache_by_site_id[site_id] << @@cache[id]
+        end
+      end
+      @@cache_by_site_id[site_id]
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "title" => self.title
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "title" => self.title
+      }
+    end
+  end
+end
+