sakai-info 0.4.1 → 0.4.2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # sakai-info Change History #
 
+### 0.4.2 ###
+
+*Released 2012-05-04*
+
+* Fixed issue in assignment-submission for formatting entity dates
+* Added status property to quizzes along with interpretation of the value
+* Added support for provided users to User object (submitted by Will Humphries)
+* Allowed .sakai-info file to point to another location for configuration
+
 ### 0.4.1 ###
 
 *Released 2012-04-22*

data/README.md

@@ -1,6 +1,6 @@
 # sakai-info #
 
-last updated: 2012-04-22  
+last updated: 2012-05-04  
 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.1.gem`.
+`sakai-info-0.4.2.gem`.
 
 Cleanup built gems using:
 
@@ -53,6 +53,9 @@ Oracle support requires the `ruby-oci8` gem, and MySQL support requires the
 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.
 
+I recommend you use the `mysql2` gem, which is faster than the `mysql` or
+`ruby-mysql` gems and is also much better tested.
+
 ## Configuration ##
 
 To run, *sakai-info* needs to be able to connect to your Sakai database server.
@@ -63,7 +66,23 @@ In this release, *sakai-info* expects a to find the config in a file located at
 more Sakai database connection nicknames and connection strings, for example:
 
     prod: oracle://sakai:password@SAKAIPROD
-    test: mysql://test:password@mysql.host:3307/db_name
+    test: mysql2://test:password@mysql-host/db_name
+    local: mysql2://sakai:ironchef@localhost/db_name
+
+For connections requiring options not well-supported by URI strings,
+i.e. passwords with special characters, or non-default schemas, 
+all options can be specified one their own line, eg:
+
+    lmssbx:
+      adapter: oracle
+      user: user
+      password: pas^w#?d
+      host: db_name
+      after_connect: ALTER SESSION SET CURRENT_SCHEMA=sakai
+
+Some connections may require a query be run immediately after connecting, i.e.
+to select a default schema. Sequel supports this through the after_connect
+option. To provide a query for after_connect, include it as shown above.
 
 The first connection in the list is the default connection. Other connections
 may be specified using the corresponding YAML key, which functions as a
@@ -71,6 +90,12 @@ nickname for the connection.
 
 [More information on how to specify a Sequel connection string.](http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html)
 
+As an alternative, may specify an alternate file name by putting an `@` sign
+followed by the filename to load the config from on the first line of
+the config file specified, eg:
+
+    @/etc/sakai-info/shared.conf
+
 ## Command Line Usage ##
 
 After installing the gem, the `sin` program should be found in your PATH. For
@@ -105,3 +130,9 @@ See ROADMAP.md
 This work is dedicated to the public domain. No rights are reserved. See
 LICENSE for more information.
 
+## Contributors ##
+
+The following individuals have contributed code to this project:
+
+* David Adams <daveadams@gmail.com>
+* Will Humphries <will.d.humphries@gmail.com>

data/ROADMAP.md

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

data/lib/sakai-info/assignment.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Assignment library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-29 daveadams@gmail.com
+# Last updated 2012-05-02 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -137,7 +137,7 @@ module SakaiInfo
     end
 
     def submitted_at
-      @submitted_at ||= format_entity_date(@attributes["datesubmitted"])
+      @submitted_at ||= Util.format_entity_date(@attributes["datesubmitted"])
     end
 
     def self.query_by_assignment_id(assignment_id)

data/lib/sakai-info/database.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Database library
 #
 # Created 2012-02-19 daveadams@gmail.com
-# Last updated 2012-02-25 daveadams@gmail.com
+# Last updated 2012-05-04 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -17,10 +17,31 @@
 #   test: oracle://user:pass@sid/schema_name
 #   dev: mysql://user:pass@hostname/db_name
 #
+# For connections requiring options not well-supported by URI strings,
+#   i.e. passwords with special characters, or non-default schemas,
+#   all options can be specified one their own line, eg:
+#
+#   lmssbx:
+#     adapter: oracle
+#     user: user
+#     password: pas^w#?d
+#     host: db_name
+#     after_connect: ALTER SESSION SET CURRENT_SCHEMA=sakai
+#
+# Some connections may require a query be run immediately after connecting, i.e.
+#   to select a default schema. Sequel supports this through the after_connect
+#   option. To provide a query for after_connect, include it as shown above.
+#
 # The default connection is the first one in the file.
 # For more on Sequel connection strings, see:
 #   http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html
 #
+# As an alternative, may specify an alternate file name by putting an @ sign
+# followed by the filename to load the config from on the first line of
+# the config file specified, eg:
+#
+#   @/etc/sakai-info/shared.conf
+#
 
 # using the oci8 driver will complain if NLS_LANG is not set in the environment
 ENV["NLS_LANG"] ||= "AMERICAN_AMERICA.UTF8"
@@ -40,8 +61,35 @@ module SakaiInfo
           @@config = config
         elsif config.is_a? String and File.exist?(config)
           # try to parse as a filename first
+          # first check to see if it points to a different config file
+          File.open(config) do |f|
+            first_line = f.readlines[0].chomp
+            if first_line =~ /^@(.+)$/
+              # use the rest of the line as an alternate filename
+              config = $1
+            end
+          end
           if File.exist?(config)
             @@config = YAML::load_file(config)
+            # loop through each connection, symbolicize keys in options hashes
+            @@config.each do |name,connect_info|
+              if connect_info.is_a?(Hash)
+                conn = {}
+                connect_info.each do |option,value|
+                  osym=option.to_sym
+                  # If a query is needed after connection, store it in a procedure
+                  # See: http://sequel.rubyforge.org/rdoc/files/doc/release_notes/3_11_0_txt.html
+                  if option=="after_connect"
+                    conn[osym]=proc{|c| c.exec(value)}
+                  else
+                    conn[osym]=value
+                  end
+                end
+                @@config[name]=conn
+              end
+            end
+          else
+            raise "No such file '#{config}'"
           end
         else
           # otherwise try to parse it generically
@@ -105,8 +153,8 @@ module SakaiInfo
   end
 
   class Database
-    def initialize(connection_string, logger = nil)
-      @connection_string = connection_string.to_s
+    def initialize(connect_info, logger = nil)
+      @connect_info=connect_info
       @logger = logger
     end
 
@@ -116,7 +164,7 @@ module SakaiInfo
       end
 
       begin
-        @connection = Sequel.connect(@connection_string)
+        @connection = Sequel.connect(@connect_info)
       rescue => e
         @connection = nil
         raise ConnectionFailureException.new("Could not connect: #{e}")

data/lib/sakai-info/quiz.rb

@@ -2,7 +2,7 @@
 #   SakaiInfo::Quiz library
 #
 # Created 2012-02-17 daveadams@gmail.com
-# Last updated 2012-02-28 daveadams@gmail.com
+# Last updated 2012-05-03 daveadams@gmail.com
 #
 # https://github.com/daveadams/sakai-info
 #
@@ -93,6 +93,21 @@ module SakaiInfo
       nil
     end
 
+    # possible statuses
+    INACTIVE = 0
+    ACTIVE = 1
+    DELETED = 2 # aka 'DEAD' in the Scholar source
+    RETRACTED_FOR_EDITING = 3
+    def status
+      case @dbrow[:status].to_i
+      when INACTIVE then "inactive"
+      when ACTIVE then "active"
+      when DELETED then "deleted"
+      when RETRACTED_FOR_EDITING then "retracted for editing"
+      else "unknown status '#{@dbrow[:status].to_i}'"
+      end
+    end
+
     def section_count
       @section_count ||= QuizSection.count_by_quiz_id(@id)
     end
@@ -106,6 +121,7 @@ module SakaiInfo
         "id" => self.id,
         "title" => self.title,
         "site" => nil,
+        "status" => self.status,
         "type" => self.quiz_type,
         "section_count" => self.section_count,
         "attempt_count" => nil
@@ -126,6 +142,7 @@ module SakaiInfo
         "id" => self.id,
         "title" => self.title,
         "site_id" => nil,
+        "status" => self.status,
         "type" => self.quiz_type
       }
       if not self.site.nil?
@@ -137,7 +154,8 @@ module SakaiInfo
     def site_summary_serialization
       {
         "id" => self.id,
-        "title" => self.title
+        "title" => self.title,
+        "status" => self.status,
       }
     end
 

data/lib/sakai-info/user.rb

@@ -30,9 +30,12 @@ module SakaiInfo
 
         row = DB.connect[:sakai_user].where(:user_id => user_id).first
         if row.nil?
-          raise ObjectNotFoundException.new(User, id)
+          #Has sakai_user_id_map record, but not sakai_user record. Provided account!
+          #raise ObjectNotFoundException.new(User, id)
+          @@cache[eid] = @@cache[user_id] = User.new(user_id,'Provided')
+        else
+          @@cache[eid] = @@cache[user_id] = User.new(row)
         end
-        @@cache[eid] = @@cache[user_id] = User.new(row)
       end
       @@cache[id]
     end
@@ -59,14 +62,24 @@ module SakaiInfo
       end
     end
 
-    def initialize(dbrow)
-      @dbrow = dbrow
-
-      @id = dbrow[:user_id]
-      @eid = User.get_eid(@id)
-      @email = dbrow[:email]
-      @name = ((dbrow[:first_name] || "") + " " + (dbrow[:last_name] || "")).strip
-      @type = dbrow[:type]
+    def initialize(*args)
+      case args.size
+      when 1
+        dbrow = args[0]
+        @dbrow = dbrow 
+        @id = dbrow[:user_id]
+        @eid = User.get_eid(@id)
+        @email = dbrow[:email]
+        @name = ((dbrow[:first_name] || "") + " " + (dbrow[:last_name] || "")).strip
+        @type = dbrow[:type]
+      when 2
+        user_id, placeholder_string = args
+        @id = user_id
+        @eid=User.get_eid(@id)
+        @email = @name = @type = placeholder_string
+      else
+        raise ArgumentError, "This method takes 1-2 arguments"
+      end
     end
 
     def properties

data/lib/sakai-info/version.rb

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

metadata

@@ -1,60 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sakai-info
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - David Adams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-22 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sequel
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: A command line tool and a suite of libraries for representing the objects and relationships defined by a Sakai CLE database.
+  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
-executables: 
+executables:
 - sin
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/sakai-info.rb
 - lib/sakai-info/group.rb
 - lib/sakai-info/tool.rb
@@ -83,39 +79,29 @@ files:
 - LICENSE
 - CHANGELOG.md
 - ROADMAP.md
-has_rdoc: true
 homepage: https://github.com/daveadams/sakai-info
-licenses: 
+licenses:
 - Public Domain
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Tools and library for exploring a Sakai database
 test_files: []
-