jgrouper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bc143410b56c2bf8941c1304cbd80299b97dec6
-  data.tar.gz: 0edd86910443f5ab7fa85af5b5fb6759b0cc72a3
+  metadata.gz: 9def1caf50b60b2a1a77ab47c0878a90375e73fd
+  data.tar.gz: d506dc1c06a51c97e32d4ac80cfc9fb857da6781
 SHA512:
-  metadata.gz: adb1d29896b87a270060d69ca9b504928444d63fd0cb630951a9b37dcf30220b1c430ca492fd82346d5fd6a285a9fcebf8ca56768b00018f690031f53d557abb
-  data.tar.gz: 661aedc9bc6ed135bbb95d95130b5f5c5290472b0cbabaeb366a34af41006995254ca8b27f427e2c2560b48139c34668e8ba94c50a9f2c8cdfe8ab4f74fab975
+  metadata.gz: bdce81b2d092b14ce5e754e77533dd814c9ba5079a8a0c03cd87e14c346546e67dac986cdb441e850bd95f01069788b46f58c0c6801efb95570704569b2cc8fa
+  data.tar.gz: 4f1a97bf662d5ad4a3f5b2041469c275dd6ba98a45cab039d5ccdf32c6c6a2622895dd56e6fb61e649687e72f7dfa6314ba134db1daeca3ac458135025a7abbf

data/HISTORY.md

@@ -1,6 +1,13 @@
 JGrouper History
 ================
 
+2013-05-17 JGrouper v0.2.0
+--------------------------
+* Add "-d directory" option to "jgrouper-audit-archiver"
+* Add "-n number of days" option to "jgrouper-audit-archiver"
+* Add "-S stop date" option to "jgrouper-audit-archiver"
+
+
 2013-05-15 JGrouper v0.1.1
 --------------------------
 * Fix executables to make runnable

data/README.rdoc

@@ -2,10 +2,60 @@
 
 == Usage
 
+=== API
+
   require 'jgrouper'
+  JGrouper.home! '/path/to/your/grouper/api/installation/directory'
+
+==== Members
+
+  # Find Member by UUID
+  m = JGrouper::Member.find uuid
+
+==== Stems
+
+  # Find root stem
+  root = JGrouper::Stem.root
+
+  # Child stems
+  root.stems
+
+  # Child Groups
+  root.groups
+
+  # Find stem by name
+  stem = JGrouper::Stem.find name
+
+==== Archiver
+
+  require 'jgrouper/audit_archiver'
+
+  JGrouper::AuditArchiver.new do |archiver|
+    # Write output to this directory
+    archiver.directory     = '/some/directory'
+
+    # Archive this many days of audit log entries
+    archive.number_of_days = 5
+
+    # Omit these columns from the archive
+    archiver.skip_columns  = %w( duration_microseconds hibernate_version_number query_count )
+
+    # Do not archive from this date onward.
+    archiver.stop_date     = '2013-01-01'
+
+    # Perform archive, optionally yielding audit log entries being archived if block given
+    archiver.archive { |entry| ... audit log entry being archived ... }
+  end
+
+=== Scripts
+
+Archive Grouper audit log entries to disk:
+
+  % jgrouper-audit-archiver -h
+
+Export (some of the) Groups registry to CSV:
 
-  # Set path to your Grouper API installation
-  JGrouper.home '/path/to/your/grouper/api/installation/directory'
+  % jgrouper-exporter -h
 
 == Installation
 

data/bin/jgrouper-audit-archiver

@@ -8,18 +8,27 @@ require 'optparse'
 JGrouper::AuditArchiver.new do |archiver|
 
   opts = OptionParser.new do |opts|
-    opts.banner = "USAGE: #{ File.basename(__FILE__) } [-h] [-s col1,colN] [-v]"
+    opts.banner = "USAGE: #{ File.basename(__FILE__) } [options]"
 
+    opts.on( '-d', '--directory DIR', 'Write output to this diretory [DEFAULT: .]' ) do |directory|
+      archiver.directory = directory  
+    end   
+    opts.on( '-n', '--number DAYS', Integer, 'Archive this many days [DEFAULT: 1]' ) do |number|
+      archiver.number_of_days = number
+    end
     opts.on( '-s', '--skip COLUMNS', Array, 'Exclude these GROUPER_AUDIT_ENTRY comma-separated column names from archive [DEFAULT: none]' ) do |columns|
-      archiver.skip_columns = columns.collect { |c| c.downcase.to_sym }
+      archiver.skip_columns = columns
     end
-    opts.on( '-v', '--[no-]verbose', 'Enable verbose mode [DEFAULT: no]' ) do |verbose|
-      archiver.verbose = verbose
+    opts.on( '-S', '--stop DATE', 'So not archive entries from this date onward [DEFAULT: none]' ) do |date|
+      archiver.stop_date = date
     end
     opts.on_tail('-h', '--help', "Show this message") do
       puts opts
       exit
     end
+    opts.on_tail( '-v', '--[no-]verbose', 'Enable verbose mode [DEFAULT: no]' ) do |verbose|
+      archiver.verbose = verbose
+    end
   end.parse!
 
   # TODO DRY

data/lib/jgrouper/audit_archiver.rb

@@ -5,30 +5,46 @@ module JGrouper # :nodoc:
   #
   # = JGrouper::AuditArchiver - Archive Grouper audit log entries
   #
-  # == USAGE
+  # == Usage
   #
   #   require 'jgrouper'
   #   require 'jgrouper/audit_archiver'
   #
-  #   JGrouper::AuditArchiver.new { |archiver| archiver.archive }
+  #   JGrouper::AuditArchiver.new do |archiver|
+  #     # Write output to this directory
+  #     archiver.directory     = '/some/directory'
+  #
+  #     # Archive this many days of audit log entries
+  #     archive.number_of_days = 5
+  #
+  #     # Omit these columns from the archive
+  #     archiver.skip_columns  = %w( duration_microseconds hibernate_version_number query_count )
+  #
+  #     # Do not archive from this date onward.
+  #     archiver.stop_date     = '2013-01-01'
+  #
+  #     # Perform archive, optionally yielding audit log entries being archived if block given
+  #     archiver.archive { |entry| ... audit log entry being archived ... }
+  #   end
   #
   class AuditArchiver
 
     GROUPER_AUDIT_ENTRY = 'grouper_audit_entry' 
     GROUPER_AUDIT_TYPE  = 'grouper_audit_type'
 
-    attr_writer :directory, :skip_columns, :verbose
+    attr_writer :directory, :number_of_days, :verbose
 
     def initialize
-      @config       = {}
-      @conn         = nil
-      @directory    = Dir.pwd
-      @fh           = nil
-      @mappings     = {}
-      @skip_columns = []
-      @start, @stop = Time.at(0), Time.at(0)
-      @date         = nil
-      @verbose      = false
+      @config         = {}
+      @conn           = nil
+      @date           = nil
+      @directory      = Dir.pwd
+      @fh             = nil
+      @mappings       = {}
+      @number_of_days = 1
+      @skip_columns   = []
+      @stop_date      = nil
+      @verbose        = false
       yield self if block_given?
       self
     end
@@ -37,54 +53,70 @@ module JGrouper # :nodoc:
     # Archive oldest date from 'grouper_audit_entry' table to file.
     #
     def archive
-      entries = []
-
       log 'starting ...'
 
       connect do
         mappings do
-          start_at = time_to_microseconds @start
-          stop_at  = time_to_microseconds @stop
-
-          filehandle @directory, "grouper-audit-entries-#{ @date }.csv" do
-            log "archiving #{ @date } ..."
-
-            # TODO Extract!
-            # TODO Use prepared statement when I get JRuby, JDBC & Oracle to better cooperate on BigDecimal-ish data types
-            qry      = "SELECT * FROM #{GROUPER_AUDIT_ENTRY} WHERE created_on BETWEEN #{start_at} AND #{stop_at} ORDER BY created_on"
-            stmt     = @conn.create_statement
-            rs       = stmt.execute_query qry
-            md       = rs.meta_data
-            num_cols = md.column_count
-            while rs.next
-              entry = []
-              1.upto(num_cols) do |n|
-                k = md.column_name(n).downcase.to_sym
-                v = rs.get_object(n)
-
-                next if v.nil?
-                entry << k << v.to_s.gsub(/\n/, ', ')
-              end
+          1.upto @number_of_days do
+            @date    = oldest_entry                                   # Date of oldest entry
+            break if stop?
+
+            start_at = time_to_microseconds @date.to_time             # @date start-of-day
+            stop_at  = time_to_microseconds ( @date + 1 ).to_time - 1 # @date end-of-day
+            entries  = []
+
+            filehandle @directory, "grouper-audit-entries-#{ @date }.csv" do
+              log "archiving #{ @date } ..."
+
+              # TODO Extract!
+              # TODO Use prepared statement when I get JRuby, JDBC & Oracle to better cooperate on BigDecimal-ish data types
+              qry      = "SELECT * FROM #{GROUPER_AUDIT_ENTRY} WHERE created_on BETWEEN #{start_at} AND #{stop_at} ORDER BY created_on"
+              stmt     = @conn.create_statement
+              rs       = stmt.execute_query qry
+              md       = rs.meta_data
+              num_cols = md.column_count
+              while rs.next
+                entry = []
+                1.upto(num_cols) do |n|
+                  k = md.column_name(n).downcase.to_sym
+                  v = rs.get_object(n)
+
+                  next if v.nil?
+                  entry << k << v.to_s.gsub(/\n/, ', ')
+                end
 
-              entry = transform(entry)
-              entries << entry.each_slice(2).reject { |slice| skip? slice.first }.collect { |slice| "#{slice.first}=#{slice.last}" }
+                entry = transform(entry)
+                entries << entry.each_slice(2).reject { |slice| skip? slice.first }.collect { |slice| "#{slice.first}=#{slice.last}" }
 
-              @fh.puts CSV.generate_line( entries.last, col_sep: "\t" )
-              yield entries.last if block_given?
+                @fh.puts CSV.generate_line( entries.last, col_sep: "\t" )
+                yield entries.last if block_given?
+              end
+              rs.close
+              stmt.close
+              
+              log "archiving #{ @date } (#{entries.size} entries) - done"
             end
-            rs.close
-            stmt.close
-            
-            log "archiving #{ @date } (#{entries.size} entries) - done"
-          end
 
-          prune(entries.size, start_at, stop_at) unless entries.empty?
+            prune(entries.size, start_at, stop_at) unless entries.empty?
+          end
         end
       end
 
       log 'done'
+    end
 
-      entries
+    #
+    # Array of column names to omit from archive.
+    #
+    def skip_columns=(columns)
+      @skip_columns = columns.collect { |c| c.downcase.to_sym }
+    end
+
+    #
+    # Do not archive from this date onward.
+    #
+    def stop_date=(date)
+      @stop_date = Date.parse date
     end
 
 
@@ -121,9 +153,6 @@ module JGrouper # :nodoc:
 
           @conn  = DriverManager.get_connection @config[:url], @config[:username], @config[:password] 
           @conn.auto_commit = false
-          @date  = oldest_entry unless @date  # Date of oldest entry
-          @start = @date.to_time              # Start-of-day on @date
-          @stop  = ( @date + 1 ).to_time - 1  # End-of-day on @date
           yield self if block_given?
           @conn.close
 
@@ -262,6 +291,13 @@ module JGrouper # :nodoc:
         @skip_columns.include? name
       end
 
+      #
+      # Have we reached stop date?
+      #
+      def stop?
+        @stop_date && @date >= @stop_date
+      end
+
       #
       # Convert time to microseconds
       #

data/lib/jgrouper/version.rb

@@ -1,4 +1,4 @@
 module JGrouper
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end
 

data/lib/jgrouper.rb

@@ -10,10 +10,60 @@ require 'jgrouper/version'
 # 
 # == Usage
 #
+# === API
+#
 #   require 'jgrouper'
+#   JGrouper.home! '/path/to/your/grouper/api/installation/directory'
+#
+# ==== Members
+#
+#   # Find Member by UUID
+#   m = JGrouper::Member.find uuid
+#
+# ==== Stems
+#
+#   # Find root stem
+#   root = JGrouper::Stem.root
+#
+#   # Child stems
+#   root.stems
+#
+#   # Child Groups
+#   root.groups
+#
+#   # Find stem by name
+#   stem = JGrouper::Stem.find name
+#
+# ==== Archiver
+#
+#   require 'jgrouper/audit_archiver'
+#
+#   JGrouper::AuditArchiver.new do |archiver|
+#     # Write output to this directory
+#     archiver.directory     = '/some/directory'
+#
+#     # Archive this many days of audit log entries
+#     archive.number_of_days = 5
+#
+#     # Omit these columns from the archive
+#     archiver.skip_columns  = %w( duration_microseconds hibernate_version_number query_count )
+#
+#     # Do not archive from this date onward.
+#     archiver.stop_date     = '2013-01-01'
+#
+#     # Perform archive, optionally yielding audit log entries being archived if block given
+#     archiver.archive { |entry| ... audit log entry being archived ... }
+#   end
+#
+# === Scripts
+#
+# Archive Grouper audit log entries to disk:
+#
+#   % jgrouper-audit-archiver -h
+#
+# Export (some of the) Groups registry to CSV:
 #
-#   # Set path to your Grouper API installation
-#   JGrouper.home '/path/to/your/grouper/api/installation/directory'
+#   % jgrouper-exporter -h
 #
 # == Installation
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - blair christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler