sakai-info 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 776948130dbcdcf1e00195b4cbcd4a105f3e15c1
-  data.tar.gz: 04cea33e5e428557b899e086f136b5fb78478a6a
+  metadata.gz: c4081d75a494513f659f2e400b39b19073941efd
+  data.tar.gz: 0fec120b870358846426bf8e5f69480992e24d0a
 SHA512:
-  metadata.gz: 2f73aba7f9dd1769548f0a5b17eb7adb195900a1a0a54940115e9e4805a6327fbf6a63fe5a6080427a8b0251b4da891ae2f9c0808de1550a3cf461389916a29d
-  data.tar.gz: 1e5f042dd669ea73d1cb7f3800fe9577fdf1bb99ec45eac834ba7735567b0fa853929e4d96d9001b6363b13c203deffb1bd1e6955b26e66f5800392c8b867614
+  metadata.gz: b60724a90d944df64b7d89f7227ddaa21febb727b5e66bbddc9e2b088b46831bdccd9da8b8d7cbc91677606472f62bd4397126ddb944a30db669e48d785becde
+  data.tar.gz: 63a192c81853a701021356aca37956625c2dd45879d1dffbc3241cbe04a37c5e52ddb8928598e1f714f548ddee5ee16290b6e50da1621494ebc540d818d5075e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.5.5 ###
+
+*Released ????-??-??*
+
+* New object types: calendar and calendar-event
+* Added Site.find_all
+* Added mnemonic descriptions to quiz attempt status field
+
 ### 0.5.4 ###
 
 *Released 2013-06-28*

data/README.md

@@ -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.5.4.gem`.
+`sakai-info-0.5.5.gem`.
 
 Cleanup built gems using:
 

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-10-15 daveadams@gmail.com
+# Last updated 2013-08-29 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -37,6 +37,7 @@ require 'sakai-info/page'
 require 'sakai-info/tool'
 require 'sakai-info/announcement'
 require 'sakai-info/assignment'
+require 'sakai-info/calendar'
 require 'sakai-info/authz'
 require 'sakai-info/content'
 require 'sakai-info/gradebook'
@@ -49,4 +50,3 @@ require 'sakai-info/private_message'
 require 'sakai-info/alias'
 require 'sakai-info/metaobj'
 require 'sakai-info/wiki'
-

data/lib/sakai-info/calendar.rb

@@ -0,0 +1,263 @@
+# sakai-info/calendar.rb
+#   SakaiInfo::Calendar library
+#
+# Created 2013-08-29 daveadams@gmail.com
+# Last updated 2013-08-30 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Calendar < SakaiXMLEntity
+    attr_reader :dbrow, :next_id
+
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+      @id = dbrow[:calendar_id]
+      @next_id = dbrow[:next_id]
+
+      parse_xml
+    end
+
+    def self.find(id)
+      # if there's no slash in the id string, assume it's a site id
+      if id !~ /\//
+        id = "/calendar/calendar/#{id}/main"
+      end
+
+      if @@cache[id].nil?
+        xml = ""
+        row = DB.connect[:calendar_calendar].where(:calendar_id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Calendar, id)
+        end
+        @@cache[id] = Calendar.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.find!(id)
+      begin
+        Calendar.find(id)
+      rescue ObjectNotFoundException => e
+        if e.classname == Calendar.name
+          MissingCalendar.find(id)
+        end
+      end
+    end
+
+    # lazy properties
+    def events
+      @events ||= CalendarEvent.find_by_calendar_id(@id)
+    end
+
+    def event_count
+      @event_count ||= CalendarEvent.count_by_calendar_id(@id)
+    end
+
+    def site_id
+      @site_id ||= @id.split("/")[3]
+    end
+
+    def site
+      @site ||= Site.find(self.site_id)
+    end
+
+    def xml
+      if @xml.nil?
+        @xml = ""
+        REXML::Document.new(@dbrow[:xml].read).write(@xml, 2)
+      end
+      @xml
+    end
+
+    # serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "site" => self.site.serialize(:summary),
+        "next_id" => self.next_id,
+        "event_count" => self.event_count,
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+      }
+    end
+
+    def xml_serialization
+      {
+        "xml" => self.xml
+      }
+    end
+
+    def events_serialization
+      {
+        "events" => self.events.collect{|e|e.serialize(:summary)}
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :xml,
+       :mod,
+       :events,
+      ]
+    end
+  end
+
+  class MissingCalendar < Calendar
+    def initialize(row)
+      @dbrow = row
+
+      @id = @dbrow[:id]
+    end
+
+    def self.find(id)
+      MissingCalendar.new({:id => id})
+    end
+
+    def event_count
+      0
+    end
+
+    def events
+      []
+    end
+
+    def default_serialization
+      {
+        "status" => "No Calendar for #{self.id}",
+      }
+    end
+
+    def summary_serialization
+      {
+        "status" => "No Calendar",
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+      ]
+    end
+  end
+
+  class CalendarEvent < SakaiXMLEntity
+    attr_reader :dbrow, :calendar_id, :event_start, :event_end, :range_start, :range_end
+
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+      @id = dbrow[:event_id]
+      @calendar_id = dbrow[:calendar_id]
+      @range_start = dbrow[:range_start]
+      @range_end = dbrow[:range_end]
+
+      parse_xml
+    end
+
+    def self.find(id)
+      if @@cache[id].nil?
+        xml = ""
+        row = DB.connect[:calendar_event].where(:event_id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(CalendarEvent, id)
+        end
+        @@cache[id] = CalendarEvent.new(row)
+      end
+      @@cache[id]
+    end
+
+    def event_start
+      @event_start ||= dbrow[:event_start]
+    end
+
+    def event_end
+      @event_end ||= dbrow[:event_end]
+    end
+
+    def self.query_by_calendar_id(calendar_id)
+      DB.connect[:calendar_event].where(:calendar_id => calendar_id)
+    end
+
+    def self.count_by_calendar_id(calendar_id)
+      CalendarEvent.query_by_calendar_id(calendar_id).count
+    end
+
+    def self.find_by_calendar_id(calendar_id)
+      CalendarEvent.query_by_calendar_id(calendar_id).all.collect do |row|
+        @@cache[row[:event_id]] = CalendarEvent.new(row)
+      end
+    end
+
+    def calendar
+      @calendar ||= Calendar.find(self.calendar_id)
+    end
+
+    def display_name
+      @display_name ||= self.properties["DAV:displayname"]
+    end
+
+    def description
+      @description ||= self.properties["CHEF:description"]
+    end
+
+    def type
+      @type ||= self.properties["CHEF:calendar-type"]
+    end
+
+    # serialization
+    def default_serialization
+      {
+        "id" => self.id,
+        "calendar_id" => self.calendar_id,
+        "display_name" => self.display_name,
+        "description" => self.description,
+        "type" => self.type,
+        "event_start" => self.event_start,
+        "event_end" => self.event_end,
+      }
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "display_name" => self.display_name,
+        "type" => self.type,
+        "event_start_date" => self.event_start.strftime("%Y-%m-%d"),
+      }
+    end
+
+    def xml_serialization
+      {
+        "xml" => self.xml
+      }
+    end
+
+    def self.all_serializations
+      [
+       :default,
+       :attributes,
+       :properties,
+       :mod,
+       :xml,
+      ]
+    end
+  end
+end

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

@@ -144,7 +144,11 @@ module SakaiInfo
       "wiki" => WikiPage,
       "wiki-page-history" => WikiPageHistory,
       "wiki-history" => WikiPageHistory,
+      "cal" => Calendar,
+      "calendar" => Calendar,
+      "calendar-event" => CalendarEvent,
+      "calevent" => CalendarEvent,
+      "ce" => CalendarEvent,
     }
   end
 end
-

data/lib/sakai-info/quiz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Quiz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2013-06-28 daveadams@gmail.com
+# Last updated 2014-07-08 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -821,6 +821,21 @@ module SakaiInfo
       @is_late == 1
     end
 
+    # status definitions from samigo-api/src/java/org/sakaiproject/tool/assessment/data/ifc/grading/AssessmentGradingIfc.java
+    ATTEMPT_STATUS = {
+      "0" => "unsubmitted",
+      "1" => "submitted-ungraded",
+      "2" => "submitted-auto-graded",
+      "3" => "submitted-needs-human-attention",
+      "4" => "needs-resubmit",
+      "5" => "unsubmitted-but-graded",
+      "6" => "updated-in-progress",
+    }
+    def status
+      ATTEMPT_STATUS[@dbrow[:status].to_i.to_s] || "unknown status '#{@dbrow[:status].to_i}'"
+    end
+
+
     def default_serialization
       {
         "id" => self.id,

data/lib/sakai-info/site.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Site library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2013-06-28 daveadams@gmail.com
+# Last updated 2014-01-30 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -174,6 +174,15 @@ module SakaiInfo
       @forums ||= Forum.find_by_site_id(@id)
     end
 
+    # calendar
+    def calendar
+      @calendar ||= Calendar.find!(@id)
+    end
+
+    def calendar_event_count
+      @calendar_event_count ||= self.calendar.event_count
+    end
+
     # content properties
     def resource_storage
       resource_collection_id = "/group/#{@id}/"
@@ -229,6 +238,10 @@ module SakaiInfo
       Site.find_ids_by_property("term_eid", term_eid)
     end
 
+    def self.find_all
+      DB.connect[:sakai_site].select(:site_id).all.collect{|row| @@cache[row[:site_id]] = Site.new(row)}
+    end
+
     def self.find_all_ids
       DB.connect[:sakai_site].select(:site_id).all.collect{|r| r[:site_id]}
     end
@@ -294,7 +307,8 @@ module SakaiInfo
         "assignment_count" => self.assignment_count,
         "announcement_count" => self.announcement_count,
         "gradebook_item_count" => (self.gradebook.nil? ? 0 : self.gradebook.item_count),
-        "forum_count" => self.forum_count
+        "forum_count" => self.forum_count,
+        "calendar_event_count" => self.calendar_event_count,
       }
       if result["providers"].nil? or result["providers"] == "" or result["providers"] == []
         result.delete("providers")
@@ -425,6 +439,12 @@ module SakaiInfo
       end
     end
 
+    def calendar_events_serialization
+      {
+        "calendar_events" => self.calendar.events.collect { |e| e.serialize(:summary) }
+      }
+    end
+
     def self.all_serializations
       [
        :default,
@@ -438,6 +458,7 @@ module SakaiInfo
        :gradebook,
        :realm,
        :forums,
+       :calendar_events,
        :mod,
       ]
     end

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,57 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.12'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.9
 - !ruby/object:Gem::Dependency
   name: marky_markov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.5
 description: A command line tool and a suite of libraries for representing the objects
   and relationships defined by a Sakai CLE database.
 email: daveadams@gmail.com
@@ -60,45 +72,46 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- ROADMAP.md
+- bin/sin
 - lib/sakai-info.rb
-- lib/sakai-info/wiki.rb
-- lib/sakai-info/exceptions.rb
+- lib/sakai-info/alias.rb
+- lib/sakai-info/announcement.rb
+- lib/sakai-info/assignment.rb
 - lib/sakai-info/authz.rb
-- lib/sakai-info/forum.rb
-- lib/sakai-info/metaobj.rb
-- lib/sakai-info/version.rb
+- lib/sakai-info/cache.rb
+- lib/sakai-info/calendar.rb
 - lib/sakai-info/cli.rb
+- lib/sakai-info/cli/help.rb
+- lib/sakai-info/cli/lookup.rb
+- lib/sakai-info/cli/query.rb
+- lib/sakai-info/cli/shell.rb
+- lib/sakai-info/cli/special.rb
+- lib/sakai-info/content.rb
+- lib/sakai-info/database.rb
+- lib/sakai-info/exceptions.rb
+- lib/sakai-info/forum.rb
+- lib/sakai-info/generic_message.rb
+- lib/sakai-info/gradebook.rb
 - lib/sakai-info/group.rb
-- lib/sakai-info/quiz.rb
+- lib/sakai-info/hacks.rb
+- lib/sakai-info/metaobj.rb
 - lib/sakai-info/mod_props.rb
-- lib/sakai-info/gradebook.rb
-- lib/sakai-info/util.rb
-- lib/sakai-info/assignment.rb
+- lib/sakai-info/page.rb
 - lib/sakai-info/private_message.rb
-- lib/sakai-info/sakai_xml_entity.rb
-- lib/sakai-info/database.rb
-- lib/sakai-info/generic_message.rb
+- lib/sakai-info/question_pool.rb
+- lib/sakai-info/quiz.rb
 - lib/sakai-info/sakai_object.rb
-- lib/sakai-info/page.rb
-- lib/sakai-info/user.rb
-- lib/sakai-info/announcement.rb
+- lib/sakai-info/sakai_xml_entity.rb
 - lib/sakai-info/site.rb
-- lib/sakai-info/content.rb
-- lib/sakai-info/hacks.rb
-- lib/sakai-info/alias.rb
-- lib/sakai-info/cli/lookup.rb
-- lib/sakai-info/cli/help.rb
-- lib/sakai-info/cli/special.rb
-- lib/sakai-info/cli/query.rb
-- lib/sakai-info/cli/shell.rb
 - lib/sakai-info/tool.rb
-- lib/sakai-info/cache.rb
-- lib/sakai-info/question_pool.rb
-- bin/sin
-- README.md
-- LICENSE
-- CHANGELOG.md
-- ROADMAP.md
+- lib/sakai-info/user.rb
+- lib/sakai-info/util.rb
+- lib/sakai-info/version.rb
+- lib/sakai-info/wiki.rb
 homepage: https://github.com/daveadams/sakai-info
 licenses:
 - Public Domain
@@ -109,17 +122,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tools and library for exploring a Sakai database