jgrouper 0.4.2 → 0.5.0

data/HISTORY.md

@@ -1,46 +1,62 @@
 JGrouper History
 ================
 
+2013-08-15 JGrouper v0.5.0
+--------------------------
+* Add `JGrouper.start_root_session()`
+* Add `JGrouper::Field`
+* Add `JGrouper::Group#to_hash()`
+* Add `JGrouper::Group#to_hash()`
+* Add `JGrouper::GroupType`
+* Add `JGrouper::Source`
+* Add `JGrouper::Stem#root?()`
+* Add `JGrouper::Stem#to_yaml()`
+* Add `JGrouper::Stem#to_yaml()`
+* Add `JGrouper::Subject#to_hash()`
+* Add `JGrouper::Subject#to_yaml()`
+* Update `JGrouper::Export` and `bin/jgrouper-export` to export to YAML
+
+
 2013-07-18 JGrouper v0.4.2
 --------------------------
-* Fix "JGrouper::AuditArchiver" end-of-day calculation
+* Fix `JGrouper::AuditArchiver` end-of-day calculation
 
 
 2013-07-18 JGrouper v0.4.1
 --------------------------
-* Update "JGrouper::AuditArchiver" to detect re-archive attempts and increment date
-* Update "JGrouper::AuditArchiver" earliest entry detection (again)
+* Update `JGrouper::AuditArchiver` to detect re-archive attempts and increment date
+* Update `JGrouper::AuditArchiver` earliest entry detection (again)
 
 
 2013-07-05 JGrouper v0.4.0
 --------------------------
-* Add "--batch-size NUMBER" to "jgrouper-audit-archiver"
+* Add `--batch-size NUMBER` to `jgrouper-audit-archiver`
 * Add more code examples
-* Update "JGrouper::AuditArchiver" to append to output files
-* Update "JGrouper::AuditArchiver" to lock output file
-* Update "JGrouper::AuditArchiver" to prune from database in batches to better support large datasets
-* Update "JGrouper::AuditArchiver" earliest entry detection
+* Update `JGrouper::AuditArchiver` to append to output files
+* Update `JGrouper::AuditArchiver` to lock output file
+* Update `JGrouper::AuditArchiver` to prune from database in batches to better support large datasets
+* Update `JGrouper::AuditArchiver` earliest entry detection
 
 
 2013-06-27 JGrouper v0.3.0
 --------------------------
-* Add "bin/jgrouper-grant"
-* Add *JGrouper::Group.find()*
-* Add *JGrouper::Group.grant()*
-* Add *JGrouper::Privilege*
-* Add *JGrouper::Stem.grant()*
-* Add *JGrouper::Subject*
-* Improve *JGrouper::Stem.find()* error handling
-* Fix various *to_s* bugs
-* Fix *JGrouper::Member.find()* error handling
-* Fix *JGrouper::Stem.stems()*
+* Add `bin/jgrouper-grant`
+* Add `JGrouper::Group.find()`
+* Add `JGrouper::Group.grant()`
+* Add `JGrouper::Privilege`
+* Add `JGrouper::Stem.grant()`
+* Add `JGrouper::Subject`
+* Improve `JGrouper::Stem.find()` error handling
+* Fix various `to_s` bugs
+* Fix `JGrouper::Member.find()` error handling
+* Fix `JGrouper::Stem.stems()`
 
 
 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"
+* 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
@@ -52,65 +68,65 @@ JGrouper History
 --------------------------
 Starting over with a more clear design in mind.
 
-* Add "bin/jgrouper-audit-archiver"
-* Add "bin/jgrouper-export"
-* Add "JGrouper.home!()"
-* Add "JGrouper::AuditArchiver"
-* Add "JGrouper::Exporter"
-* Add "JGrouper::Group"
-* Add "JGrouper::Member"
-* Add "JGrouper::Member.find()"
-* Add "JGrouper::Stem"
-* Add "JGrouper::Stem.find()"
-* Add "JGrouper::Stem#groups()"
-* Add "JGrouper::Stem.root()"
-* Add "JGrouper::Stem#stems()"
+* Add `bin/jgrouper-audit-archiver`
+* Add `bin/jgrouper-export`
+* Add `JGrouper.home!()`
+* Add `JGrouper::AuditArchiver`
+* Add `JGrouper::Exporter`
+* Add `JGrouper::Group`
+* Add `JGrouper::Member`
+* Add `JGrouper::Member.find()`
+* Add `JGrouper::Stem`
+* Add `JGrouper::Stem.find()`
+* Add `JGrouper::Stem#groups()`
+* Add `JGrouper::Stem.root()`
+* Add `JGrouper::Stem#stems()`
 
 
 2012-11-20 JGrouper v0.0.5
 --------------------------
-* Add *JGrouper::Group#add_type*
-* Add *JGrouper::Group#delete_type*
-* Add *JGrouper::Group#method_missing*
-* Add *JGrouper::Group#types*
-* Add *JGrouper::GroupType#method_missing*
-* Add *JGrouper::Stem#method_missing*
-* Add *JGrouper::Subject#method_missing*
-* Fix *JGrouper::Group* tests
+* Add `JGrouper::Group#add_type`
+* Add `JGrouper::Group#delete_type`
+* Add `JGrouper::Group#method_missing`
+* Add `JGrouper::Group#types`
+* Add `JGrouper::GroupType#method_missing`
+* Add `JGrouper::Stem#method_missing`
+* Add `JGrouper::Subject#method_missing`
+* Fix `JGrouper::Group` tests
 
 
 2012-10-04 JGrouper v0.0.4
 --------------------------
-* Add *JGrouper::Group*
-* Add *JGrouper::Group.find*
-* Add *JGrouper::Group* support to *JGrouper::Shell*
-* Extracted *JGrouper::Shell* to its own gem
+* Add `JGrouper::Group`
+* Add `JGrouper::Group.find`
+* Add `JGrouper::Group` support to `JGrouper::Shell`
+* Extracted `JGrouper::Shell` to its own gem
 
 
 2012-08-17 JGrouper v0.0.3
 --------------------------
-* Add *JGrouper::Shell*
-* Add *bin/jgrouper* interactive shell
-* Rename *JGrouper::Stem#root_stem* to *JGrouper::Stem#root*
-* Rename *JGrouper::Subject#root_subject* to *JGrouper::Subject#root*
-* Add *JGrouper::GroupType.delete(name)*
-* Add *JGrouper::Stem.create( name, display_name = nil )*
-* Add *JGrouper::Stem#add_stem( name, display_name = nil )*
-* Add *JGrouper::Stem.find(name)*
-* Add *JGrouper::Subject::TestCase*
-* Add *JGrouper::GroupType::TestCase*
-* Add *JGrouper::Stem::TestCase*
+* Add `JGrouper::Shell`
+* Add `bin/jgrouper` interactive shell
+* Rename `JGrouper::Stem#root_stem` to `JGrouper::Stem#root`
+* Rename `JGrouper::Subject#root_subject` to `JGrouper::Subject#root`
+* Add `JGrouper::GroupType.delete(name)`
+* Add `JGrouper::Stem.create( name, display_name = nil )`
+* Add `JGrouper::Stem#add_stem( name, display_name = nil )`
+* Add `JGrouper::Stem.find(name)`
+* Add `JGrouper::Subject::TestCase`
+* Add `JGrouper::GroupType::TestCase`
+* Add `JGrouper::Stem::TestCase`
 
 
 2012-08-10 JGrouper v0.0.2
 --------------------------
-* Add *JGrouper::GroupType*
-* Add *JGrouper::Stem#to_json*
-* Add *JGrouper::Subject#to_json*
+* Add `JGrouper::GroupType`
+* Add `JGrouper::Stem#to_json`
+* Add `JGrouper::Subject#to_json`
 
 
 2012-08-10 JGrouper v0.0.1
 --------------------------
-* Add *JGrouper::Stem.root_stem*
-* Add *JGrouper::Subject.root_subject*
+* Add `JGrouper::Stem.root_stem`
+* Add `JGrouper::Subject.root_subject`
 

data/README.rdoc

@@ -71,15 +71,24 @@
     archiver.archive { |entry| ... audit log entry being archived ... }
   end
 
+=== Exporter
+
+  require 'jgrouper'
+  require 'jgrouper/exporter'
+
+  JGrouper::Exporter do |exporter|
+    exporter.export 'stem:to:export', lambda { |_| puts _.to_yaml }
+  end
+
 === Scripts
 
 Archive Grouper audit log entries to disk:
 
   % jgrouper-audit-archiver -h
 
-Export (some of the) Groups registry to CSV:
+Export Groups registry to YAML:
 
-  % jgrouper-exporter -h
+  % jgrouper-export -h
 
 Grant privileges:
 

data/bin/jgrouper-export

@@ -3,19 +3,26 @@
 require 'jgrouper'
 require 'jgrouper/exporter'
 require 'optparse'
+require 'thread'
+require 'yaml'
 
 
 JGrouper::Exporter.new do |exporter|
 
+  directory = Dir.pwd
+
   opts = OptionParser.new do |opts|
     opts.banner = "USAGE: #{ File.basename(__FILE__) } [-h]"
 
+    opts.on( '-d', '--directory DIR', 'Write output to this directory [DEFAULT: .]' ) do |value|
+      directory = value
+    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|
-      exporter.verbose = verbose
+    opts.on_tail( '-v', '--[no-]verbose', 'Enable verbose mode [DEFAULT: no]' ) do |value|
+      exporter.verbose = value
     end
   end.parse!
 
@@ -27,7 +34,41 @@ JGrouper::Exporter.new do |exporter|
     exit 1
   end
 
-  exporter.export ARGV.shift
+  raise "ERROR: directory does not exist - #{directory}" unless File.directory?(directory)
+
+  done  = false
+  queue = Queue.new
+
+  Thread.abort_on_exception = true
+  consumer = Thread.new do
+    JGrouper.start_root_session
+
+    # TODO GzipWriter?
+    fn = File.join directory, 'jgrouper-export.yaml'
+    File.open( fn, 'w' ) do |fh|
+      fh.flock File::LOCK_EX
+
+      loop do
+        while queue.size > 0
+          value = queue.pop
+          fh.puts value.to_yaml
+        end
+        if done && queue.empty?
+          break
+        end
+        sleep 0.1
+      end
+
+      fh.flock File::LOCK_UN
+    end
+  end
+  producer = Thread.new do
+    exporter.export base: ARGV.shift, block: lambda { |_| queue << _ ; sleep 0.1 if queue.size > 100 }
+    done = true
+    Thread.stop
+  end
+  consumer.join
+
 end
 
 # vim: syntax=ruby

data/lib/jgrouper/exporter.rb

@@ -1,8 +1,7 @@
-require 'csv'
 
 module JGrouper # :nodoc:
   #
-  # = JGrouper::Exporter - Export (some of the) Groups registry to CSV
+  # = JGrouper::Exporter - Export Groups registry.
   #
   # == USAGE
   #
@@ -10,7 +9,7 @@ module JGrouper # :nodoc:
   #   require 'jgrouper/exporter'
   #
   #   JGrouper::Exporter do |exporter|
-  #     exporter.export 'stem:to:export'
+  #     exporter.export 'stem:to:export', lambda { |_| puts _.to_yaml }
   #   end
   #
   class Exporter
@@ -18,55 +17,55 @@ module JGrouper # :nodoc:
     attr_writer :verbose
 
     def initialize
-      @directory    = Dir.pwd
-      @fh           = nil
-      @verbose      = false
+      @verbose   = false
       yield self if block_given?
       self
     end
 
     #
-    # Export (some of the) Groups registry to CSV.
+    # Export Groups registry.
     #
-    def export( base = nil )
-      entries = []
-
-      filehandle @directory, "jgrouper-export.csv" do
-        stem = base.nil? ? Stem.root : Stem.find(base)
-        raise "ERROR: stem not found" if stem.nil?
-        log "exporting stem=#{stem.name} ..."
-
-        raise "NOT IMPLEMENTED - exporting child stems" if stem.stems.size > 0
+    def export(params)
+      stem = params[:base] ? Stem.find( params[:base] ) : Stem.root
+      raise "ERROR: stem not found"        if     stem.nil?
+      raise "ERROR: :block not specified"  unless params[:block]
+      raise "ERROR: :block is not a block" unless params[:block].kind_of?(Proc)
+
+      # TODO Multiple readers?
+      txt = stem.root? ? 'root stem' : "stem #{stem.name}"
+      log "exporting #{txt} ..."
+      if stem.root? # TODO Configurable?
+        export_group_types params[:block]
+        export_sources     params[:block]
+      end
+      export_stem stem, params[:block]
+      log "exporting #{txt} - done"
 
-        groups = stem.groups do |child|
-          g  =  %w( display_extension extension name ).collect { |k| child.send(k) }
-          g  << CSV.generate_line( child.members.collect { |m| "#{ m.subject_source_id }|#{ m.subject_type_id }|#{ m.subject_id }" } ).chomp
+    end
 
-          entries << CSV.generate_line(g)
-          @fh.puts entries.last
-          yield entries.last if block_given?
-        end
+    # Export group types.
+    def export_group_types(p)
+      log 'exporting group types ...'
+      p.call JGrouper::GroupType
+    end
 
-        log "exporting stem=#{stem.name} - done"
-      end
+    # Export subject sources.
+    def export_sources(p)
+      log 'exporting subject sources ...'
+      p.call JGrouper::Source
+    end
 
-      entries
+    # Export stem and childen.
+    def export_stem( stem, p )
+      log "exporting stem #{stem.name} ..."
+      p.call stem
+      stem.groups { |child| p.call child          }
+      stem.stems  { |child| export_stem(child, p) }
     end
 
 
     private
 
-      #
-      # Open filehandle for writing or raise exception if a) directory does not exist or b) file does exist.
-      # TODO DRY
-      #
-      def filehandle(directory, file)
-        raise "ERROR: directory does not exist - #{directory}" unless File.directory?(directory)
-        fn = File.join directory, file
-        raise "ERROR: file already exists - #{fn}" if File.exists?(fn)
-        File.open(fn, 'w') { |fh| @fh = fh ; yield self ; @fh = nil }
-      end
-
       # TODO Use Logger...
       # TODO DRY
       def log(msg)

data/lib/jgrouper/field.rb

@@ -0,0 +1,54 @@
+
+module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::Field - Grouper Group Field
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
+  #
+  #   TODO
+  #
+  class Field
+
+    def initialize( obj = nil )
+      @obj = obj
+      yield self if block_given?
+      self
+    end
+
+    #
+    # For passing methods on to Grouper Field object.
+    #
+    def method_missing(meth, *args, &block)
+      super if @obj.nil?
+      begin
+        block.call @obj.send(meth, *args) if block
+        @obj.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
+    def to_hash
+      {
+        'kind'      =>  'field',
+        'name'      =>  @obj.get_name,
+        'uuid'      =>  @obj.get_uuid,
+        'nullable'  =>  @obj.get_is_nullable,
+        'required'  =>  @obj.get_required,
+        'privilege' =>  {
+          'read'      =>  @obj.get_read_privilege,
+          'write'     =>  @obj.get_write_privilege
+        }
+      }
+    end
+
+    def to_yaml
+      to_hash.to_yaml
+    end
+
+  end
+end
+

data/lib/jgrouper/group.rb

@@ -1,4 +1,3 @@
-require 'csv'
 
 module JGrouper # :nodoc:
 
@@ -24,7 +23,7 @@ module JGrouper # :nodoc:
     #
     def self.find(name)
       begin
-        obj = JGroupFinder.find_by_name GrouperSession.start_root_session, name, false
+        obj = JGroupFinder.find_by_name JGrouper.start_root_session, name, false
       rescue => e
         warn "JGrouper::Group.find(#{name}) => #{e}"
       end
@@ -51,11 +50,85 @@ module JGrouper # :nodoc:
       end
     end
 
+    def to_hash
+      begin
+        mod_subj = JGrouper::Subject.new( @obj.get_modify_subject )
+      rescue edu.internet2.middleware.subject.SubjectNotFoundException
+        mod_subj = nil
+      end
+
+      hash = {
+        'kind'              =>  'group',
+        'uuid'              =>  @obj.get_uuid,
+        'name'              =>  @obj.get_name,
+        'display_name'      =>  @obj.get_display_name,
+        'extension'         =>  @obj.get_extension,
+        'display_extension' =>  @obj.get_display_extension,
+        'description'       =>  @obj.get_description,
+        'parent'            =>  {
+          'name'              =>  @obj.get_parent_stem_name,
+          'uuid'              =>  @obj.get_parent_uuid,
+        },
+        'create'            =>  {
+          'subject'           =>  JGrouper::Subject.new( @obj.get_create_subject ).to_hash,
+          'time'              =>  Time.at( @obj.get_create_time_long / 1000 ).to_datetime.rfc3339
+        }
+      }
+
+      begin
+        mod_subj = JGrouper::Subject.new( @obj.get_modify_subject )
+        hash['modify'] = {
+          'subject'     =>  mod_subj ? mod_subj.to_hash : nil,
+          'time'        =>  Time.at( @obj.get_modify_time_long / 1000 ).to_datetime.rfc3339
+        }
+      rescue
+      end
+
+      # TODO Ugly
+      unless  @obj.get_admins.empty?  &&
+              @obj.get_optins.empty?  &&
+              @obj.get_optouts.empty? &&
+              @obj.get_readers.empty? &&
+              @obj.get_updaters.empty &&
+              @obj.get_viewers.empty?
+        hash['privileges'] = {}
+        hash['privileges']['admin']  = @obj.get_admins.collect   { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_admins.empty?
+        hash['privileges']['optin']  = @obj.get_optins.collect   { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_optins.empty?
+        hash['privileges']['optout'] = @obj.get_optouts.collect  { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_optouts.empty?
+        hash['privileges']['read']   = @obj.get_readers.collect  { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_readers.empty?
+        hash['privileges']['update'] = @obj.get_updaters.collect { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_updaters.empty?
+        hash['privileges']['view']   = @obj.get_viewers.collect  { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_viewers.empty?
+      end
+
+      hash['types']           = @obj.get_removable_types.collect { |_| { 'name' => _.get_name, 'uuid' => _.get_uuid } } unless @obj.get_removable_types.empty?
+      hash['attributes']      = @obj.get_attributes_map(false).inject({}) { |h, (k,v)| h[k] = v.get_value ; h }         unless @obj.get_attributes_map(false).empty?
+      hash['alternate_names'] = @obj.get_alternate_names.collect { |_| _ }                                              unless @obj.get_alternate_names.empty?
+
+      hash['role'] = 'role' if 'role' == @obj.get_type_of_group.to_string
+
+      composite = @obj.get_composite(false)
+      if composite
+        hash['composite'] = {
+          'type'  =>  composite.get_type.get_name,
+          'left'  =>  { 'name' => composite.get_left_group.get_name,  'uuid' => composite.get_left_group.get_uuid  },
+          'right' =>  { 'name' => composite.get_right_group.get_name, 'uuid' => composite.get_right_group.get_uuid }
+        }
+      else
+        hash['members'] = @obj.get_immediate_members.collect { |_| JGrouper::Subject.new( _.get_subject ).to_hash } unless @obj.get_immediate_members.empty?
+      end
+
+      hash
+    end
+
     def to_s
       return nil if @obj.nil?
       %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
     end
 
+    def to_yaml
+      to_hash.to_yaml
+    end
+
   end
 end
 

data/lib/jgrouper/group_type.rb

@@ -0,0 +1,87 @@
+
+module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::GroupType - Grouper Group Type
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
+  #
+  #   TODO
+  #
+  class GroupType
+
+    def initialize( obj = nil )
+      @obj = obj
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Find all group types.
+    #
+    def self.all
+      JGroupTypeFinder.find_all.collect { |_| self.new _ }
+    end
+
+    #
+    # Find group type by name.  Returns +JGrouper::GroupType+ or +nil+.
+    #
+    def self.find(name)
+      begin
+        obj = JGroupTypeFinder.find name, false
+      rescue => e
+        warn "JGrouper::GroupType.find(#{name}) => #{e}"
+      end
+      return nil if obj.nil?
+      group_type = self.new obj
+      yield group_type if block_given?
+      group_type 
+    end
+
+    #
+    # For passing methods on to Grouper GroupType object.
+    #
+    def method_missing(meth, *args, &block)
+      super if @obj.nil?
+      begin
+        block.call @obj.send(meth, *args) if block
+        @obj.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
+    def to_hash
+      hash = {
+        'kind'        =>  'group_type',
+        'name'        =>  @obj.get_name,
+        'uuid'        =>  @obj.get_uuid,
+        'assignable'  =>  @obj.get_is_assignable,
+        'internal'    =>  @obj.get_is_internal,
+        'create'      =>  {
+          'uuid'        => @obj.get_creator_uuid,
+          'time'        => Time.at( @obj.get_create_time / 1000 ).to_datetime.rfc3339
+        }
+      }
+      unless @obj.get_fields.empty?
+        hash['fields'] = @obj.get_fields.collect { |_| JGrouper::Field.new(_).to_hash }
+      end
+      hash
+    end
+
+    def self.to_yaml
+      {
+        'kind'        => 'group_types',
+        'group_types' => all.collect { |_| self.new(_).to_hash } 
+      }.to_yaml
+    end
+
+    def to_yaml
+      to_hash.to_yaml
+    end
+
+  end
+end
+

data/lib/jgrouper/member.rb

@@ -23,7 +23,7 @@ module JGrouper # :nodoc:
     #
     def self.find(uuid)
       begin
-        m = MemberFinder.find_by_uuid GrouperSession.start_root_session, uuid, false
+        m = MemberFinder.find_by_uuid JGrouper.start_root_session, uuid, false
       rescue => e
         warn "JGrouper::Member.find(#{uuid}) => #{e}"
       end

data/lib/jgrouper/source.rb

@@ -0,0 +1,63 @@
+
+module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::Source - Grouper Subject Source
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
+  #
+  #   TODO
+  #
+  class Source
+
+    def initialize( obj = nil )
+      @obj = obj
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Find all subject sources.
+    #
+    def self.all
+      JSourceManager.get_instance.get_sources.collect { |_| self.new _ }
+    end
+
+    #
+    # For passing methods on to Grouper Source object.
+    #
+    def method_missing(meth, *args, &block)
+      super if @obj.nil?
+      begin
+        block.call @obj.send(meth, *args) if block
+        @obj.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
+    def to_hash
+      {
+        'kind'        =>  'source',
+        'id'          =>  @obj.get_id,
+        'name'        =>  @obj.get_name,
+        'init_params' =>  @obj.get_init_params.inject({}) { |h, (k,v)| h[k] = v ; h }
+      }
+    end
+
+    def self.to_yaml
+      {
+        'kind'    => 'sources',
+        'sources' => all.collect { |_| self.new(_).to_hash }
+      }.to_yaml
+    end
+
+    def to_yaml
+      to_hash.to_yaml
+    end
+
+  end
+end
+

data/lib/jgrouper/stem.rb

@@ -24,7 +24,7 @@ module JGrouper # :nodoc:
     #
     def self.find(name)
       begin
-        obj = StemFinder.find_by_name GrouperSession.start_root_session, name, false
+        obj = StemFinder.find_by_name JGrouper.start_root_session, name, false
       rescue => e
         warn "JGrouper::Group.find(#{name}) => #{e}"
       end
@@ -66,13 +66,20 @@ module JGrouper # :nodoc:
     # Find Grouper root stem.  Returns +JGrouper::Stem+ or +nil+.
     #
     def self.root
-      obj = StemFinder.find_root_stem GrouperSession.start_root_session
+      obj = StemFinder.find_root_stem JGrouper.start_root_session
       return nil if obj.nil?
       stem = self.new obj
       yield stem if block_given?
       stem
     end
 
+    #
+    # Is this the root stem?
+    #
+    def root?
+      name.empty?
+    end
+
     #
     # Yield child stems.
     #
@@ -84,11 +91,55 @@ module JGrouper # :nodoc:
       end
     end
 
+    def to_hash
+      hash = {
+        'kind'              =>  'stem',
+        'uuid'              =>  @obj.get_uuid,
+        'name'              =>  @obj.get_name,
+        'display_name'      =>  @obj.get_display_name,
+        'extension'         =>  @obj.get_extension,
+        'display_extension' =>  @obj.get_display_extension
+      }
+
+      hash['description'] = @obj.get_description unless @obj.get_description.empty?
+
+      hash['create'] = {
+          'subject'   =>  JGrouper::Subject.new( @obj.get_create_subject ).to_hash,
+          'time'      =>  Time.at( @obj.get_create_time_long / 1000 ).to_datetime.rfc3339
+      }
+
+      begin
+        mod_subj = JGrouper::Subject.new( @obj.get_modify_subject )
+        hash['modify'] = {
+          'subject'     =>  mod_subj ? mod_subj.to_hash : nil,
+          'time'        =>  Time.at( @obj.get_modify_time_long / 1000 ).to_datetime.rfc3339
+        }
+      rescue
+      end
+
+      unless @obj.get_creators.empty? && @obj.get_stemmers.empty?
+        hash['privileges'] = {}
+        hash['privileges']['create'] = @obj.get_creators.collect { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_creators.empty?
+        hash['privileges']['stem']   = @obj.get_stemmers.collect { |_| JGrouper::Subject.new(_).to_hash } unless @obj.get_stemmers.empty?
+      end
+
+      hash['stems']  = @obj.child_stems.collect  { |_| { 'name' => _.get_name, 'uuid' => _.get_uuid } } unless @obj.child_stems.empty?
+      hash['groups'] = @obj.child_groups.collect { |_| { 'name' => _.get_name, 'uuid' => _.get_uuid } } unless @obj.child_groups.empty?
+
+      hash['parent'] = { 'name' => @obj.get_parent_stem.get_name, 'uuid' => @obj.get_parent_uuid } unless root?
+
+      hash
+    end
+
     def to_s
       return nil if @obj.nil?
       %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
     end
 
+    def to_yaml
+      to_hash.to_yaml
+    end
+
   end
 end
 

data/lib/jgrouper/subject.rb

@@ -48,11 +48,24 @@ module JGrouper # :nodoc:
 
     def to_grouper; @obj; end
 
+    def to_hash
+      {
+        'kind'    => 'subject',
+        'id'      => @obj.get_id,
+        'source'  => @obj.get_source_id,
+        'type'    => @obj.get_type_name
+      }
+    end
+
     def to_s
       return nil if @obj.nil?
       %w( id type_name source_id name ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
     end
 
+    def to_yaml
+      to_hash.to_yaml
+    end
+
   end
 end
 

data/lib/jgrouper/version.rb

@@ -1,4 +1,4 @@
 module JGrouper
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end
 

data/lib/jgrouper.rb

@@ -1,8 +1,11 @@
 require 'java'
 
+require 'jgrouper/field'
 require 'jgrouper/group'
+require 'jgrouper/group_type'
 require 'jgrouper/member'
 require 'jgrouper/privilege'
+require 'jgrouper/source'
 require 'jgrouper/stem'
 require 'jgrouper/subject'
 require 'jgrouper/version'
@@ -81,15 +84,24 @@ require 'jgrouper/version'
 #     archiver.archive { |entry| ... audit log entry being archived ... }
 #   end
 #
+# === Exporter
+#
+#   require 'jgrouper'
+#   require 'jgrouper/exporter'
+#
+#   JGrouper::Exporter do |exporter|
+#     exporter.export 'stem:to:export', lambda { |_| puts _.to_yaml }
+#   end
+#
 # === Scripts
 #
 # Archive Grouper audit log entries to disk:
 #
 #   % jgrouper-audit-archiver -h
 #
-# Export (some of the) Groups registry to CSV:
+# Export Groups registry to YAML:
 #
-#   % jgrouper-exporter -h
+#   % jgrouper-export -h
 #
 # Grant privileges:
 #
@@ -158,13 +170,22 @@ module JGrouper
 
     # TODO Do this for everything?
     %w( 
+        edu.internet2.middleware.grouper.Field
         edu.internet2.middleware.grouper.GroupFinder
+        edu.internet2.middleware.grouper.GroupTypeFinder
         edu.internet2.middleware.grouper.privs.Privilege
+        edu.internet2.middleware.subject.provider.SourceManager
       ).each do |klass|
         java_import klass do |pkg, cls| "J#{cls}"; end
       end
   end
 
+  # TODO Block method?
+  def self.start_root_session
+    # TODO Block method?
+    GrouperSession.start_root_session
+  end
+
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jruby-jars
@@ -100,9 +100,12 @@ files:
 - lib/jgrouper.rb
 - lib/jgrouper/audit_archiver.rb
 - lib/jgrouper/exporter.rb
+- lib/jgrouper/field.rb
 - lib/jgrouper/group.rb
+- lib/jgrouper/group_type.rb
 - lib/jgrouper/member.rb
 - lib/jgrouper/privilege.rb
+- lib/jgrouper/source.rb
 - lib/jgrouper/stem.rb
 - lib/jgrouper/subject.rb
 - lib/jgrouper/version.rb