sakai-info 0.4.3 → 0.4.4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.4.4 ###
+
+*Released 2012-05-12*
+
+* Standardized gradebook and gradebook-item APIs
+* Renamed GradableObject class to GradebookItem
+* CLI access to gradebook and gradebook-item objects
+
 ### 0.4.3 ###
 
 *Released 2012-05-10*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-05-10  
+last updated: 2012-05-12  
 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.3.gem`.
+`sakai-info-0.4.4.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,10 +1,6 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-05-10*
-
-### 0.4.4 ###
-
-* CLI access to gradebook
+*Last updated 2012-05-12*
 
 ### 0.4.5 ###
 
@@ -13,6 +9,8 @@
 ### 0.5.0 ###
 
 * Sqlite test infrastructure for a few basic objects
+* Deeper query functionality and field specification
+* Simple web query interface - HTML, JSON, and YAML
 
 ### 0.6.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-05-10 daveadams@gmail.com
+# Last updated 2012-05-12 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -38,6 +38,8 @@ module SakaiInfo
       "content" => Content,
       "announcement" => Announcement,
       "announcement-channel" => AnnouncementChannel,
+      "gradebook" => Gradebook,
+      "gradebook-item" => GradebookItem,
     }
   end
 end

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

@@ -2,7 +2,7 @@
 #  - sin command line help
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-12 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -21,7 +21,7 @@ sin #{VERSION}
     user, group, site, page, tool, quiz, quiz-section, quiz-item, quiz-attempt,
     quiz-attempt-item, quiz-attempt-item-attachment, question-pool, assignment,
     assignment-submission, forum, forum-thread, forum-post, content,
-    announcement, announcement-channel
+    announcement, announcement-channel, gradebook, gradebook-item
 
   Misc commands:
     test             Tests configured database connections
@@ -99,7 +99,6 @@ sin user
 
     --sites    Print site membership information
     --pools    Print list of owned question pools
-    --all      Print all possible details
 EOF
 
         "group" => <<EOF,
@@ -112,7 +111,6 @@ sin group
 
     --users    Print user membership information
     --realm    Print corresponding realm information
-    --all      Print all possible details
 EOF
 
         "site" => <<EOF,
@@ -133,7 +131,6 @@ sin site
     --realm        Print site realm details
     --forums       Print forum details
     --mod          Print creation/modification info
-    --all          Print all possible details
 EOF
 
         "page" => <<EOF,
@@ -164,7 +161,6 @@ sin quiz
     --sections   Print section summary list
     --attempts   Print summary of user quiz attempts
     --mod        Print creation/modification info
-    --all        Print all possible details
 
   Not yet implemented:
     --items      Print summary of items on the quiz
@@ -181,7 +177,6 @@ sin quiz-section
 
     --items      Print summary of items in the section
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "quiz-item" => <<EOF,
@@ -194,7 +189,6 @@ sin quiz-item
   passed to include additional information:
 
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "question-pool" => <<EOF,
@@ -211,7 +205,6 @@ sin question-pool
   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
 
         "quiz-attempt" => <<EOF,
@@ -223,7 +216,6 @@ sin quiz-attempt
   may be passed to include additional information:
 
     --items      Print list of attempted items
-    --all        Print all possible details
 EOF
 
 
@@ -236,7 +228,6 @@ sin quiz-attempt-item
   options may be passed to include additional information:
 
     --attachments  Print a list of file attachments, if any
-    --all          Print all possible details
 EOF
 
         "quiz-attempt-item-attachment" => <<EOF,
@@ -248,7 +239,6 @@ sin quiz-attempt-item-attachment
   Additional options may be passed to include additional information:
 
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "assignment" => <<EOF,
@@ -262,7 +252,6 @@ sin assignment
     --submissions  Print summary of all submissions
     --xml          Print the raw XML
     --mod          Print creation/modification info
-    --all          Print all possible details
 EOF
 
         "assignment-submission" => <<EOF,
@@ -275,7 +264,6 @@ sin assignment-submission
 
     --xml          Print the raw XML
     --mod          Print creation/modification info
-    --all          Print all possible details
 EOF
 
         "forum" => <<EOF,
@@ -288,7 +276,6 @@ sin forum
 
     --threads    Print summary of all threads
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "forum-thread" => <<EOF,
@@ -301,7 +288,6 @@ sin forum-thread
 
     --posts      Print summary of all posts
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "forum-post" => <<EOF,
@@ -313,7 +299,6 @@ sin forum-post
   may be passed to include additional information:
 
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
 
         "content" => <<EOF,
@@ -327,7 +312,6 @@ sin content
     --properties Print all properties
     --children   Recursively print collection children
     --mod        Print creation/modification info
-    --all        Print all possible details
 EOF
         "announcement" => <<EOF,
 sin announcement
@@ -338,10 +322,9 @@ sin announcement
   be passed to include additional information:
 
     --xml        Print raw XML content
-    --all        Print all possible details
 EOF
         "announcement-channel" => <<EOF,
-sin content
+sin announcement-channel
 
   Usage: sin announcement-channel <id> [<options>]
 
@@ -350,7 +333,23 @@ sin content
 
     --announcements  Print a summary of all announcements in this channel
     --xml            Print raw XML content
-    --all            Print all possible details
+EOF
+        "gradebook" => <<EOF,
+sin gradebook
+
+  Usage: sin gradebook <id> [<options>]
+
+  Prints information about the gradebook ID specified. Additional options may
+  be passed to include additional information:
+
+    --items    Print all gradebook items
+EOF
+        "gradebook-item" => <<EOF,
+sin gradebook-item
+
+  Usage: sin gradebook-item <id> [<options>]
+
+  Prints information about the gradebook item ID specified.
 EOF
       }
 

data/lib/sakai-info/gradebook.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Gradebook library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-12 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -11,150 +11,151 @@
 
 module SakaiInfo
   class Gradebook < SakaiObject
-    attr_reader :version, :site, :name
+    attr_reader :version, :site_id, :name
 
     def self.clear_cache
       @@cache = {}
-      @@cache_by_site_id = {}
     end
     clear_cache
 
-    def initialize(id, version, site, name)
-      @id = id
-      @version = version
-      @site = site
-      @name = name
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:id].to_i
+      @version = @dbrow[:version].to_i
+      @site_id = @dbrow[:gradebook_uid]
+      @name = @dbrow[:name]
     end
 
     def self.find(id)
       if @@cache[id].nil?
-        row = DB.connect.fetch("select version, gradebook_uid, name " +
-                               "from gb_gradebook_t " +
-                               "where id = :id", id).first
+        row = DB.connect[:gb_gradebook_t].where(: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]
+        @@cache[id] = Gradebook.new(row)
       end
       @@cache[id]
     end
 
-    def self.find_by_site_id(site_id)
-      if @@cache_by_site_id[site_id].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
+    def site
+      @site ||= Site.find(self.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
-      @@cache_by_site_id[site_id]
+    def self.query_by_site_id(site_id)
+      DB.connect[:gb_gradebook_t].where(:gradebook_uid => site_id)
+    end
+
+    def self.count_by_site_id(site_id)
+      Gradebook.query_by_site_id(site_id).count
+    end
+
+    def self.find_by_site_id(site_id)
+      Gradebook.query_by_site_id(site_id).all.collect { |row| Gradebook.new(row) }
     end
 
     def items
-      @items ||= GradableObject.find_by_gradebook_id(@id)
+      @items ||= GradebookItem.find_by_gradebook_id(self.id)
     end
 
     def item_count
-      items.length
+      @item_count ||= GradebookItem.count_by_gradebook_id(self.id)
+    end
+
+    def default_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+        "site" => self.site.serialize(:summary),
+        "version" => self.version,
+        "item_count" => self.item_count,
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "name" => self.name,
+        "site_id" => self.site_id,
+        "item_count" => self.item_count,
+      }
+    end
+
+    def site_summary_serialization
+      {
+        "id" => self.id,
+      }
+    end
+
+    def items_serialization
+      {
+        "items" => self.items.collect { |item| item.serialize(:summary) }
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :items
+      ]
     end
   end
 
-  class GradableObject < SakaiObject
-    attr_reader :id, :gradebook, :object_type, :version, :name
-    attr_reader :points_possible, :due_date, :weight
+  class GradebookItem < SakaiObject
+    attr_reader :gradebook_id, :object_type_id, :version, :name, :points_possible, :due_date, :weight
 
     def self.clear_cache
       @@cache = {}
-      @@cache_by_gradebook_id = {}
     end
     clear_cache
 
-    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
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = @dbrow[:id]
+      @gradebook_id = @dbrow[:gradebook_id].to_i
+      @object_type_id = @dbrow[:object_type_id].to_i
+      @version = @dbrow[:version].to_i
+      @name = @dbrow[:name]
+      @points_possible = @dbrow[:points_possible].to_f
+      @due_date = @dbrow[:due_date]
+      @weight = @dbrow[:assignment_weighting].to_f
     end
 
     def self.find(id)
       if @@cache[id].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
-
+        row = DB.connect[:gb_gradable_object_t].where(:id => id).first
         if row.nil?
-          raise ObjectNotFoundException.new(GradableObject, id)
+          raise ObjectNotFoundException.new(GradebookItem, 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)
+        @@cache[id] = GradebookItem.new(row)
       end
       @@cache[id]
     end
 
-    def self.find_by_gradebook_id(gradebook_id)
-      if @@cache_by_gradebook_id[gradebook_id].nil?
-        objects = []
-        gradebook = Gradebook.find(gradebook_id)
-        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)
+    def gradebook
+      @gradebook = Gradebook.find(self.gradebook_id)
+    end
 
-        end
-        @@cache_by_gradebook_id[gradebook_id] = objects
-      end
-      @@cache_by_gradebook_id[gradebook_id]
+    def self.query_by_gradebook_id(gradebook_id)
+      DB.connect[:gb_gradable_object_t].where(:gradebook_id => gradebook_id)
+    end
+
+    def self.count_by_gradebook_id(gradebook_id)
+      GradebookItem.query_by_gradebook_id(gradebook_id).count
+    end
+
+    def self.find_by_gradebook_id(gradebook_id)
+      GradebookItem.query_by_gradebook_id(gradebook_id).all.collect { |row| GradebookItem.new(row) }
     end
 
     def default_serialization
       result = {
         "id" => self.id,
         "name" => self.name,
-        "gradebook_id" => self.gradebook.id,
-        "object_type" => self.object_type,
+        "gradebook_id" => self.gradebook_id,
+        "object_type_id" => self.object_type_id,
         "version" => self.version,
         "points_possible" => self.points_possible,
         "due_date" => self.due_date,

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-05-10 daveadams@gmail.com
+# Last updated 2012-05-12 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -135,10 +135,7 @@ module SakaiInfo
 
     # gradebook properties
     def gradebook
-      @gradebook ||= Gradebook.find_by_site_id(@id)
-    rescue ObjectNotFoundException
-      # not all sites have a gradebook, don't panic
-      nil
+      @gradebook ||= Gradebook.find_by_site_id(@id).first
     end
 
     # forum properties
@@ -363,9 +360,9 @@ module SakaiInfo
     end
 
     def gradebook_serialization
-      if self.gradebook and self.gradebook.item_count > 0
+      if self.gradebook
         {
-          "gradebook_items" => self.gradebook.items.collect { |item| item.serialize(:summary) }
+          "gradebook" => self.gradebook.serialize(:site_summary, :items)
         }
       else
         {}

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel