sakai-info 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.4.1 ###
+
+*Released 2012-04-22*
+
+* Improved MySQL support (from not working at all to mostly working)
+* Removed properties performance hack which was inapplicable to MySQL
+* Cleaned up site default serialization
+
 ### 0.4.0 ###
 
 *Released 2012-04-21*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-04-21  
+last updated: 2012-04-22  
 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.0.gem`.
+`sakai-info-0.4.1.gem`.
 
 Cleanup built gems using:
 
@@ -48,6 +48,11 @@ gems must also be installed to support whatever database or databases you use.
 Oracle support requires the `ruby-oci8` gem, and MySQL support requires the
 `mysql` gem. Some unit tests make use of the `sqlite3` gem.
 
+## MySQL Support ##
+
+MySQL support is now working. Your MySQL server must have the setting
+`lower_case_table_names=1` or be running on a case-insensitive filesystem.
+
 ## Configuration ##
 
 To run, *sakai-info* needs to be able to connect to your Sakai database server.

data/ROADMAP.md

@@ -1,16 +1,16 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-04-21*
+*Last updated 2012-04-22*
 
-### 0.4.1 ###
+### 0.4.2 ###
 
 * CLI access to announcements
 
-### 0.4.2 ###
+### 0.4.3 ###
 
 * CLI access to gradebook
 
-### 0.4.3 ###
+### 0.4.4 ###
 
 * CLI access to authz (realms, roles, functions)
 

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-04-21 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -71,6 +71,7 @@ module SakaiInfo
   end
 end
 
+######################################################################
 # extensions to other objects
 class String
   def is_uuid?
@@ -78,6 +79,37 @@ class String
   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
+
 # baseline db connectivity
 require 'sakai-info/database'
 

data/lib/sakai-info/group.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Group library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-03-09 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -120,17 +120,9 @@ module SakaiInfo
 
     def self.find_by_group_id(group_id)
       properties = {}
-      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
-      #  This is multiple orders of magnitude faster.
-      #  But, this will break if the property value is > 4000chars and may not work
-      #  on mysql, so here's the original version:
-      # DB.connect[:sakai_site_group_property].where(:group_id => group_id).all.each do |row|
-      #   properties[row[:name]] = row[:value].read
-      # end
       DB.connect[:sakai_site_group_property].
-        select(:name, :to_char.sql_function(:value).as(:value)).
         where(:group_id => group_id).all.each do |row|
-        properties[row[:name]] = row[:value]
+        properties[row[:name]] = row[:value].read
       end
       return properties
     end

data/lib/sakai-info/page.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Page library
 #
 # Created 2012-03-08 daveadams@gmail.com
-# Last updated 2012-03-09 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -101,17 +101,9 @@ module SakaiInfo
 
     def self.find_by_page_id(page_id)
       properties = {}
-      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
-      #  This is multiple orders of magnitude faster.
-      #  But, this will break if the property value is > 4000chars and may not work
-      #  on mysql, so here's the original version:
-      # DB.connect[:sakai_site_page_property].where(:page_id => page_id).all.each do |row|
-      #   properties[row[:name]] = row[:value].read
-      # end
       DB.connect[:sakai_site_page_property].
-        select(:name, :to_char.sql_function(:value).as(:value)).
         where(:page_id => page_id).all.each do |row|
-        properties[row[:name]] = row[:value]
+        properties[row[:name]] = row[:value].read
       end
       return properties
     end

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-04-01 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -255,12 +255,15 @@ module SakaiInfo
         "gradebook_item_count" => (self.gradebook.nil? ? 0 : self.gradebook.item_count),
         "forum_count" => self.forum_count
       }
-      if result["providers"].nil? or result["providers"] == ""
+      if result["providers"].nil? or result["providers"] == "" or result["providers"] == []
         result.delete("providers")
       end
       if result["is_joinable"] == false
         result.delete("join_role")
       end
+      if result["site_properties"] == {}
+        result.delete("site_properties")
+      end
       if self.gradebook.nil?
         result.delete("gradebook_item_count")
       end
@@ -402,17 +405,9 @@ module SakaiInfo
 
     def self.find_by_site_id(site_id)
       properties = {}
-      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
-      #  This is multiple orders of magnitude faster.
-      #  But, this will break if the property value is > 4000chars and may not work
-      #  on mysql, so here's the original version:
-      # DB.connect[:sakai_site_property].where(:site_id => site_id).all.each do |row|
-      #   properties[row[:name]] = row[:value].read
-      # end
       DB.connect[:sakai_site_property].
-        select(:name, :to_char.sql_function(:value).as(:value)).
         where(:site_id => site_id).all.each do |row|
-        properties[row[:name]] = row[:value]
+        properties[row[:name]] = row[:value].read
       end
       return properties
     end

data/lib/sakai-info/tool.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Tool library
 #
 # Created 2012-03-08 daveadams@gmail.com
-# Last updated 2012-03-09 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -106,17 +106,9 @@ module SakaiInfo
 
     def self.find_by_tool_id(tool_id)
       properties = {}
-      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
-      #  This is multiple orders of magnitude faster.
-      #  But, this will break if the property value is > 4000chars and may not work
-      #  on mysql, so here's the original version:
-      # DB.connect[:sakai_site_tool_property].where(:tool_id => tool_id).all.each do |row|
-      #   properties[row[:name]] = row[:value].read
-      # end
       DB.connect[:sakai_site_tool_property].
-        select(:name, :to_char.sql_function(:value).as(:value)).
         where(:tool_id => tool_id).all.each do |row|
-        properties[row[:name]] = row[:value]
+        properties[row[:name]] = row[:value].read
       end
       return properties
     end

data/lib/sakai-info/user.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::User library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-03-09 daveadams@gmail.com
+# Last updated 2012-04-22 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -218,17 +218,9 @@ module SakaiInfo
 
     def self.find_by_user_id(user_id)
       properties = {}
-      # HACK: reading blobs via OCI8 is really slow, make the db server do it!
-      #  This is multiple orders of magnitude faster.
-      #  But, this will break if the property value is > 4000chars and may not work
-      #  on mysql, so here's the original version:
-      # DB.connect[:sakai_user_property].where(:user_id => user_id).all.each do |row|
-      #   properties[row[:name]] = row[:value].read
-      # end
       DB.connect[:sakai_user_property].
-        select(:name, :to_char.sql_function(:value).as(:value)).
         where(:user_id => user_id).all.each do |row|
-        properties[row[:name]] = row[:value]
+        properties[row[:name]] = row[:value].read
       end
       return properties
     end

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sakai-info
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - David Adams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-21 00:00:00 -05:00
+date: 2012-04-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency