sakai-info 0.5.1 → 0.5.2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # sakai-info Change History #
 
+### 0.5.2 ###
+
+*Released 2012-10-11*
+
+* Added JSON output option for lookups
+* Proof-of-concept sin shell
+* Alias support
+
 ### 0.5.1 ###
 
 *Released 2012-10-07*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-10-07  
+last updated: 2012-10-11  
 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.5.1.gem`.
+`sakai-info-0.5.2.gem`.
 
 Cleanup built gems using:
 

data/ROADMAP.md

@@ -1,43 +1,37 @@
 # sakai-info Roadmap #
 
-*Last updated 2012-10-07*
+*Last updated 2012-10-11*
 
-### 0.5.2 ###
+### 0.5.3 ###
 
-* JSON output support
 * Ability to specify alternate config file at the command line
 * Better date formatting and proper time zone understanding
 * More query functionality
-* Proof-of-concept sin shell
-* Chat channel/message support
-* Alias support
+* OSP presentation/metaobj support
 * Add simple tests against user/site fixture data
+* More query and shell functionality
 
-### 0.5.3 ###
+### 0.5.4 ###
 
 * RDS schema creation and data loading for MySQL and Oracle testing
 * More query and shell functionality
 * Test fixture generation for quizzes
+* Chat channel/message support
+* More OSP support
 
-### 0.5.4 ###
+### 0.5.5 ###
 
 * Barebones web interface - HTML, JSON, and YAML
 * More query and shell functionality
+* Complete OSP support
 
-### 0.5.5 ###
+### 0.6.x ###
 
 * Global cache instead of per-class
 * More query, web, and shell functionality
-
-### 0.6.x ###
-
 * Test fixtures and basic unit tests for all represented objects
 * RDoc coverage for every class
-* More focus on other library usage besides ad hoc CLI/web queries
-
-### 0.7.x ###
-
-* OSP support
+* Grow support for other library usage besides ad hoc queries
 
 ------
 

data/bin/sin

@@ -5,7 +5,7 @@
 #   sakai-info library
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-05-23 daveadams@gmail.com
+# Last updated 2012-10-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -107,6 +107,9 @@ when "test" then
 when "query" then
   mode = args.shift
 
+when "shell" then
+  mode = args.shift
+
 else
   # test to see if it's an accepted lookup mode
   if CLI::LookupModes.keys.include? args[0]
@@ -151,5 +154,8 @@ when "lookup"
 when "special"
   CLI::Special.process(args, flags)
 
+when "shell"
+  CLI::Shell.process(args, flags)
+
 end
 

data/lib/sakai-info.rb

@@ -2,7 +2,7 @@
 #   Base library file
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-05-20 daveadams@gmail.com
+# Last updated 2012-10-11 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -46,4 +46,5 @@ require 'sakai-info/question_pool'
 require 'sakai-info/generic_message'
 require 'sakai-info/forum'
 require 'sakai-info/private_message'
+require 'sakai-info/alias'
 

data/lib/sakai-info/alias.rb

@@ -0,0 +1,136 @@
+# sakai-info/alias.rb
+#   SakaiInfo::Alias library
+#
+# Created 2012-10-11 daveadams@gmail.com
+# Last updated 2012-10-11 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  class Alias < SakaiObject
+    attr_reader :target, :dbrow
+
+    include ModProps
+    created_by_key :createdby
+    created_at_key :createdon
+    modified_by_key :modifiedby
+    modified_at_key :modifiedon
+
+    def self.clear_cache
+      @@cache = {}
+    end
+    clear_cache
+
+    def initialize(dbrow)
+      @dbrow = dbrow
+
+      @id = dbrow[:alias_id]
+      @target = dbrow[:target]
+    end
+
+    # target types
+    #   /mailarchive/channel/<site-id>/main
+    #   /site/<site-id>
+    #   /announcement/announcement/<site-id> -> rss feed
+    def site_id
+      if @target.nil?
+        nil
+      else
+        if @target =~ /^\/site\/(.+)$/
+          $1
+        elsif @target =~ /^\/mailarchive\/channel\/(.+)\/main$/
+          $1
+        elsif @target =~ /^\/announcement\/announcement\/(.+)$/
+          $1
+        else
+          nil
+        end
+      end
+    end
+
+    def site
+      if not self.site_id.nil?
+        @site ||= Site.find(self.site_id)
+      end
+    end
+
+    def self.find(id)
+      if @@cache[id].nil?
+        row = DB.connect[:sakai_alias].filter(:alias_id => id).first
+        if row.nil?
+          raise ObjectNotFoundException.new(Alias, id)
+        end
+        @@cache[id] = Alias.new(row)
+      end
+      @@cache[id]
+    end
+
+    def self.query_by_site_id(site_id)
+      DB.connect[:sakai_alias].where("target like ?", "%#{site_id}%")
+    end
+
+    def self.find_by_site_id(site_id)
+      Alias.query_by_site_id(site_id).all.
+        collect { |row| @@cache[row[:alias_id]] = Alias.new(row) }
+    end
+
+    def self.count_by_site_id(site_id)
+      Alias.query_by_site_id(site_id).count
+    end
+
+    def properties
+      @properties ||= AliasProperty.find_by_alias_id(self.id)
+    end
+
+    # serialization
+    def default_serialization
+      result = {
+        "id" => self.id,
+        "target" => self.target,
+        "site" => nil,
+        "properties" => self.properties,
+      }
+      if not self.site.nil?
+        result["site"] = self.site.serialize(:summary)
+      else
+        result.delete("site")
+      end
+      result
+    end
+
+    def summary_serialization
+      {
+        "id" => self.id,
+        "target" => self.target,
+      }
+    end
+
+    def self.all_serializations
+      [:default, :mod]
+    end
+  end
+
+  class AliasProperty
+    def self.get(id, property_name)
+      row = DB.connect[:sakai_alias_property].
+        filter(:alias_id => id, :name => property_name).first
+      if row.nil?
+        nil
+      else
+        row[:value].read
+      end
+    end
+
+    def self.find_by_alias_id(id)
+      properties = {}
+      DB.connect[:sakai_alias_property].
+        where(:alias_id => id).all.each do |row|
+        properties[row[:name]] = row[:value].read
+      end
+      return properties
+    end
+  end
+end

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-06-21 daveadams@gmail.com
+# Last updated 2012-10-07 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -13,6 +13,7 @@ require 'sakai-info/cli/help'
 require 'sakai-info/cli/lookup'
 require 'sakai-info/cli/query'
 require 'sakai-info/cli/special'
+require 'sakai-info/cli/shell'
 
 # it's faster to run single-threaded
 Sequel.single_threaded = true

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-10-03 daveadams@gmail.com
+# Last updated 2012-10-11 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -29,7 +29,7 @@ Sakai INfo: sin #{VERSION}
       quiz-attempt-item-attachment, question-pool, assignment,
       assignment-submission, forum, forum-thread, forum-post, content,
       announcement, announcement-channel, gradebook, gradebook-item,
-      role, function, realm, private-message
+      role, function, realm, private-message, alias
 
   QUERY MODE
     Query particular fields from certain objects given certain conditions.
@@ -470,6 +470,16 @@ sin private-message
   Prints information about the private message ID specified. Additional options
   may be passed to include additional information:
 
+    --mod        Print creation/modification info
+EOF
+        "alias" => <<EOF,
+sin alias
+
+  Usage: sin alias <id> [<options>]
+
+  Prints information about the alias ID specified. Additional options may be
+  passed to include additional information:
+
     --mod        Print creation/modification info
 EOF
         "query" => <<EOF,

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

@@ -2,7 +2,7 @@
 #   class for handling the default command line mode
 #
 # Created 2012-05-23 daveadams@gmail.com
-# Last updated 2012-06-21 daveadams@gmail.com
+# Last updated 2012-10-11 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -16,14 +16,23 @@ module SakaiInfo
         object_type = args.shift
         id = args.shift
         fields = nil
+        output = :yaml
 
+        flags_to_delete = []
         flags.each do |flag|
           if flag =~ /^--fields=(.+)$/
             fields = $1.downcase.split(',')
-            flags.delete(flag)
+            flags_to_delete << flag
+          elsif flag == "--json"
+            output = :json
+            flags_to_delete << flag
           end
         end
 
+        flags_to_delete.each do |flag|
+          flags.delete(flag)
+        end
+
         if flags.include? "--all"
           serials = CLI::LookupModes[object_type].all_serializations
         elsif flags.include? "--dbrow-only"
@@ -36,20 +45,28 @@ module SakaiInfo
         begin
           object = CLI::LookupModes[object_type].find(id)
         rescue ObjectNotFoundException => e
-          STDERR.puts "ERROR: Could not find #{object_type} with an ID of '#{id}':"
-          STDERR.puts "       #{e}"
+          STDERR.puts "ERROR: #{e}"
           exit 1
         end
 
         if fields.nil? or fields.empty?
-          puts object.to_yaml(serials)
+          if output == :json
+            puts object.to_json(serials)
+          else
+            puts object.to_yaml(serials)
+          end
+
         else
           object_hash = object.serialize(serials).delete_if{|k,v| not fields.include? k.to_s}
           if object_hash.empty?
             STDERR.puts "ERROR: no requested fields were found"
             exit 1
           end
-          puts object_hash.to_yaml
+          if output == :json
+            puts object_hash.to_json
+          else
+            puts object_hash.to_yaml
+          end
         end
       end
     end
@@ -120,6 +137,7 @@ module SakaiInfo
       "realm" => AuthzRealm,
       "private-message" => PrivateMessage,
       "pm" => PrivateMessage,
+      "alias" => Alias,
     }
   end
 end

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

@@ -2,7 +2,7 @@
 #   class for handling "query" command line mode
 #
 # Created 2012-05-23 daveadams@gmail.com
-# Last updated 2012-10-06 daveadams@gmail.com
+# Last updated 2012-10-09 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -87,6 +87,34 @@ module SakaiInfo
             puts user.to_csv(:eid, :name)
           end
 
+        elsif object_type == "quiz-attempt"
+          eid = args.shift
+          quiz_id = args.shift
+          user = nil
+          quiz = nil
+
+          begin
+            user = User.find(eid)
+            quiz = PublishedQuiz.find(quiz_id)
+          rescue ObjectNotFoundException => e
+            STDERR.puts "ERROR: #{e}"
+            exit 1
+          end
+
+          if user.nil? or quiz.nil?
+            STDERR.puts "ERROR: could not find user or quiz object"
+            exit 1
+          end
+
+          attempts = quiz.user_attempts(user.id)
+          if attempts.nil? or attempts.empty?
+            STDERR.puts "ERROR: no attempts found"
+          end
+
+          attempts.each do |att|
+            puts att.to_yaml
+          end
+
         else
           STDERR.puts "ERROR: Unrecognized object type"
           exit 1

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

@@ -0,0 +1,99 @@
+# shell.rb
+#   sin shell
+#
+# Created 2012-10-07 daveadams@gmail.com
+# Last updated 2012-10-07 daveadams@gmail.com
+#
+# https://github.com/daveadams/sakai-info
+#
+# This software is public domain.
+#
+
+module SakaiInfo
+  module CLI
+    class Shell
+      def self.process(args, flags)
+        Shell.new.run
+      end
+
+      def initialize
+        @context = nil
+        @context_history = []
+        @running = true
+      end
+
+      def context_prompt
+        if @context.nil?
+          "[-]"
+        else
+          # TODO: implement ShellContext object
+          #@context.brief_name
+          "[!]"
+        end
+      end
+
+      def prompt
+        print "sin#{context_prompt}> ";STDOUT.flush
+        gets
+      end
+
+      def run
+        while @running do
+          input = prompt
+
+          # a ctrl-D sends nil
+          if input.nil?
+            puts "exit"
+            break
+          end
+
+          argv = input.chomp.split(/ +/)
+          command = argv.shift.downcase
+          method_name = ("_shell_command_#{command}").to_sym
+
+          if Shell.method_defined? method_name
+            self.method(method_name).call(argv)
+          else
+            STDERR.puts "ERROR: unknown command '#{command}'"
+          end
+        end
+
+        # TODO: any additional cleanup here
+      end
+
+      def _shell_command_quit(argv)
+        @running = false
+      end
+
+      alias_method :_shell_command_exit, :_shell_command_quit
+
+      def _shell_command_count(argv)
+        case argv[0].downcase
+        when /^users?$/
+          puts User.count
+        when /^sites?$/
+          puts Site.count
+        else
+          STDERR.puts("ERROR: unrecognized object type")
+        end
+      end
+
+      def _shell_command_user(argv)
+        user = nil
+        begin
+          user = User.find(argv[0])
+        rescue ObjectNotFoundException => e
+          STDERR.puts "ERROR: could not find user '#{argv[0]}'"
+          STDERR.puts "       #{e}"
+          return
+        end
+
+        return if user.nil?
+
+        puts user.to_yaml(:shell)
+      end
+
+    end
+  end
+end
+

data/lib/sakai-info/quiz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Quiz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-09-29 daveadams@gmail.com
+# Last updated 2012-10-11 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -304,6 +304,10 @@ module SakaiInfo
       PublishedQuiz.query_by_site_id(site_id).select(:id).all.collect { |row| row[:id] }
     end
 
+    def user_attempts(user_id)
+      QuizAttempt.find_by_user_id_and_quiz_id(user_id, self.id)
+    end
+
     def quiz_type
       "published"
     end
@@ -784,6 +788,15 @@ module SakaiInfo
         all.collect { |row| QuizAttempt.new(row) }
     end
 
+    def self.query_by_user_id_and_quiz_id(user_id, quiz_id)
+      DB.connect[:sam_assessmentgrading_t].where(:publishedassessmentid => quiz_id, :agentid => user_id)
+    end
+
+    def self.find_by_user_id_and_quiz_id(user_id, quiz_id)
+      QuizAttempt.query_by_user_id_and_quiz_id(user_id, quiz_id).
+        all.collect { |row| QuizAttempt.new(row) }
+    end
+
     def items
       @items ||= QuizAttemptItem.find_by_attempt_id(self.id)
     end
@@ -1129,7 +1142,11 @@ module SakaiInfo
     end
 
     def timed?
-      @dbrow[:timelimit] > 0
+      if time_limit.nil?
+        false
+      else
+        time_limit > 0
+      end
     end
 
     def automatic_submission?

data/lib/sakai-info/sakai_object.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::SakaiObject
 #
 # Created 2012-02-15 daveadams@gmail.com
-# Last updated 2012-10-06 daveadams@gmail.com
+# Last updated 2012-10-08 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -62,6 +62,14 @@ module SakaiInfo
       object_type_serialization
     end
 
+    def summary_serialization
+      default_serialization
+    end
+
+    def shell_serialization
+      summary_serialization
+    end
+
     def to_yaml(*q)
       serialize(q).to_yaml
     end

data/lib/sakai-info/version.rb

@@ -1,3 +1,3 @@
 module SakaiInfo
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sakai-info
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-07 00:00:00.000000000 Z
+date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: marky_markov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
@@ -52,6 +68,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sakai-info.rb
+- lib/sakai-info/alias.rb
 - lib/sakai-info/util.rb
 - lib/sakai-info/group.rb
 - lib/sakai-info/private_message.rb
@@ -59,6 +76,7 @@ files:
 - lib/sakai-info/cli/help.rb
 - lib/sakai-info/cli/query.rb
 - lib/sakai-info/cli/special.rb
+- lib/sakai-info/cli/shell.rb
 - lib/sakai-info/cli/lookup.rb
 - lib/sakai-info/site.rb
 - lib/sakai-info/cache.rb