jgrouper 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9def1caf50b60b2a1a77ab47c0878a90375e73fd
-  data.tar.gz: d506dc1c06a51c97e32d4ac80cfc9fb857da6781
+  metadata.gz: 1d34d0e3926d5850e95ca673912825fae7f2d4d7
+  data.tar.gz: ef0be60e432fcddbf3245cc20988aa5fe2f48c86
 SHA512:
-  metadata.gz: bdce81b2d092b14ce5e754e77533dd814c9ba5079a8a0c03cd87e14c346546e67dac986cdb441e850bd95f01069788b46f58c0c6801efb95570704569b2cc8fa
-  data.tar.gz: 4f1a97bf662d5ad4a3f5b2041469c275dd6ba98a45cab039d5ccdf32c6c6a2622895dd56e6fb61e649687e72f7dfa6314ba134db1daeca3ac458135025a7abbf
+  metadata.gz: 8f05bcf26ee9937fbcb84390de299457cff24f82071308d78c0ab2c600c1c4c0a2ceca64b154f861b7e2d4633ef3a63096461b0299c9ee2e04aa8a490a0cfee3
+  data.tar.gz: dc8d6104cb439831e5550c7829b386044d0c1aebf48db5ee7594627302510637b3700097b36563511284d14e4ae0c916d64bad7c4299e11f75047d350fc9bf90

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '1.9.3', engine: 'jruby', engine_version: '1.7.3'
+ruby '1.9.3' # TODO , engine: 'jruby', engine_version: '1.7.3'
 
 # Specify your gem's dependencies in jgrouper.gemspec
 gemspec

data/HISTORY.md

@@ -1,6 +1,20 @@
 JGrouper History
 ================
 
+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()*
+
+
 2013-05-17 JGrouper v0.2.0
 --------------------------
 * Add "-d directory" option to "jgrouper-audit-archiver"

data/README.rdoc

@@ -57,6 +57,13 @@ Export (some of the) Groups registry to CSV:
 
   % jgrouper-exporter -h
 
+Grant privileges:
+
+  % jgrouper-grant $group admin $subject
+  % jgrouper-grant $stem stem $subject
+  % jgrouper-grant -R $stem admin $subject
+  % jgrouper-grant -R $stem stem $subject
+
 == Installation
 
 Add this line to your application's Gemfile:

data/bin/jgrouper-audit-archiver

@@ -10,7 +10,7 @@ JGrouper::AuditArchiver.new do |archiver|
   opts = OptionParser.new do |opts|
     opts.banner = "USAGE: #{ File.basename(__FILE__) } [options]"
 
-    opts.on( '-d', '--directory DIR', 'Write output to this diretory [DEFAULT: .]' ) do |directory|
+    opts.on( '-d', '--directory DIR', 'Write output to this directory [DEFAULT: .]' ) do |directory|
       archiver.directory = directory  
     end   
     opts.on( '-n', '--number DAYS', Integer, 'Archive this many days [DEFAULT: 1]' ) do |number|
@@ -19,7 +19,7 @@ JGrouper::AuditArchiver.new do |archiver|
     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
     end
-    opts.on( '-S', '--stop DATE', 'So not archive entries from this date onward [DEFAULT: none]' ) do |date|
+    opts.on( '-S', '--stop DATE', 'Do 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

data/bin/jgrouper-grant

@@ -0,0 +1,107 @@
+#!/usr/bin/env jruby
+
+require 'jgrouper'
+require 'optparse'
+
+
+class MyApp
+
+  attr_accessor :recurse, :verbose
+
+  def initialize
+    @recurse = false
+    @verbose = false
+    yield self if block_given?
+    self
+  end
+
+  def grant(stem_or_group, privilege, subject)
+    raise 'ERROR: stem-or-group is nil' if stem_or_group.nil?
+    raise 'ERROR: privilege is nil'     if stem_or_group.nil?
+    raise 'ERROR: subject is nil'       if stem_or_group.nil?
+
+    priv = JGrouper::Privilege.find privilege
+    raise "ERROR: could not find privilege: #{privilege}" if priv.nil?
+    puts "found privilege: #{priv.to_s}" if verbose?
+    subj = JGrouper::Subject.find(subject)
+    raise "ERROR: could not find subject: #{subject}"     if subj.nil?
+    puts "found subject: #{subj.to_s}"   if verbose?
+
+    stem = JGrouper::Stem.find(stem_or_group)
+    return grant_stem(stem, priv, subj) unless stem.nil?
+
+    group = JGrouper::Group.find(stem_or_group)
+    return grant_group(group, priv, subj) unless group.nil?
+
+    raise "ERROR: could not find stem-or-group: #{stem_or_group}"
+  end
+
+  def recurse? ; @recurse ; end
+  def verbose? ; @verbose ; end
+ 
+  
+  private
+
+  def grant_group(group, privilege, subject)
+    if privilege.naming?
+      warn 'WARNING: cannot grant naming privilege on group'
+      return false
+    end
+
+    puts "granting privilege #{privilege.name} to subject #{subject} on group #{group.name}" if verbose?
+    group.grant(subject, privilege)
+  end
+
+  def grant_stem(stem, privilege, subject)
+    if privilege.access?
+      unless recurse?
+        warn 'WARNING: cannot grant access privilege on stem without specifying -R'
+        return false
+      end
+      stem.groups do |group|
+        puts "granting privilege #{privilege.name} to subject #{subject} on group #{group.name}" if verbose?
+        group.grant(subject, privilege)
+      end
+      stem.stems { |child| grant_stem(child, privilege, subject) }
+      return
+    end 
+
+    puts "granting privilege #{privilege.name} to subject #{subject} on stem #{stem.name}" if verbose?
+    stem.grant(subject, privilege)
+    stem.stems { |child| grant_stem(child, privilege, subject) } if recurse?
+    true
+  end
+
+end
+
+
+MyApp.new do |app|
+
+  opts = OptionParser.new do |opts|
+    opts.banner = "USAGE: #{ File.basename(__FILE__) } [options] <stem-or-group> <privilege> <subject>"
+    opts.on('-R', '--[no-]recurse', 'Recursively grant privileges [DEFAULT: no]') do |recurse|
+      app.recurse = recurse
+    end
+    opts.on_tail('-h', '--help', 'Show help') do
+      puts opts
+      exit
+    end
+    opts.on_tail('-v', '--[no-]verbose', 'Enable verbose mode [DEFAULT: no]') do |verbose|
+      app.verbose = verbose
+    end
+  end.parse!
+
+  # TODO DRY
+  if ENV['GROUPER_HOME']
+    JGrouper.home! ENV['GROUPER_HOME']
+  else
+    warn "ERROR: GROUPER_HOME not set"
+    exit 1
+  end
+
+  app.grant( ARGV.shift, ARGV.shift, ARGV.shift ) or exit 1
+
+end
+
+# vim: syntax=ruby
+

data/lib/jgrouper/group.rb

@@ -19,6 +19,25 @@ module JGrouper # :nodoc:
       self
     end
 
+    #
+    # Find Grouper group by name.  Returns +JGrouper::Group+ or +nil+.
+    #
+    def self.find(name)
+      begin
+        obj = JGroupFinder.find_by_name GrouperSession.start_root_session, name, false
+      rescue => e
+        warn "JGrouper::Group.find(#{name}) => #{e}"
+      end
+      return nil if obj.nil?
+      group = self.new obj
+      yield group if block_given?
+      group 
+    end
+
+    def grant(subject, privilege)
+      @obj.grantPriv subject.to_grouper, privilege.to_grouper, false
+    end
+
     #
     # For passing methods on to Grouper Group object.
     #
@@ -34,7 +53,7 @@ module JGrouper # :nodoc:
 
     def to_s
       return nil if @obj.nil?
-      CSV.generate_line %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }
+      %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
     end
 
   end

data/lib/jgrouper/member.rb

@@ -22,7 +22,11 @@ module JGrouper # :nodoc:
     # Find Grouper member by UUID.  Returns +JGrouper::Member+ or +nil+.
     #
     def self.find(uuid)
-      m = MemberFinder.find_by_uuid GrouperSession.start_root_session, uuid, false
+      begin
+        m = MemberFinder.find_by_uuid GrouperSession.start_root_session, uuid, false
+      rescue => e
+        warn "JGrouper::Member.find(#{uuid}) => #{e}"
+      end
       return nil if m.nil?
       member = self.new m
       yield member if block_given?

data/lib/jgrouper/privilege.rb

@@ -0,0 +1,62 @@
+module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::Privilege - Grouper Privilee
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
+  #
+  #   priv = JGrouper::Privilege.find name
+  #
+  class Privilege
+
+    # TODO
+    def initialize( obj = nil )
+      @obj = obj
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Find Grouper privilege by name.  Returns +JGrouper::Privilege+ or +nil+.
+    #
+    def self.find(name)
+      begin
+        priv = JPrivilege.getInstance name
+      rescue => e
+        warn "JGrouper::Privilege.find(#{name}) => #{e}"
+      end
+      return nil if priv.nil?
+      privilege = self.new priv
+      yield privilege if block_given?
+      privilege
+    end
+
+    #
+    # For passing methods on to Grouper subject 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 access?; JPrivilege.isAccess(@obj);   end
+    def naming?; JPrivilege.isNaming(@obj);   end
+    def type;    access? ? :access : :naming; end
+
+    def to_grouper; @obj; end
+
+    def to_s
+      return nil if @obj.nil?
+      %w( name type ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
+    end
+
+  end
+end
+

data/lib/jgrouper/stem.rb

@@ -23,13 +23,21 @@ module JGrouper # :nodoc:
     # Find Grouper stem by name.  Returns +JGrouper::Stem+ or +nil+.
     #
     def self.find(name)
-      obj = StemFinder.find_by_name GrouperSession.start_root_session, name, false
+      begin
+        obj = StemFinder.find_by_name GrouperSession.start_root_session, name, false
+      rescue => e
+        warn "JGrouper::Group.find(#{name}) => #{e}"
+      end
       return nil if obj.nil?
       stem = self.new obj
       yield stem if block_given?
       stem 
     end
 
+    def grant(subject, privilege)
+      @obj.grantPriv subject.to_grouper, privilege.to_grouper, false
+    end
+
     #
     # Yield child groups.
     #
@@ -70,7 +78,7 @@ module JGrouper # :nodoc:
     #
     def stems
       @obj.child_stems.collect do |child|
-        s = self.new child
+        s = self.class.new child
         yield s if block_given?
         s
       end
@@ -78,7 +86,7 @@ module JGrouper # :nodoc:
 
     def to_s
       return nil if @obj.nil?
-      CSV.generate_line %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }
+      %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.to_csv.chomp
     end
 
   end

data/lib/jgrouper/subject.rb

@@ -0,0 +1,58 @@
+module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::Subject - Grouper Subject
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
+  #
+  #   subj = JGrouper::Subject.find id_or_identifier
+  #
+  class Subject
+
+    # TODO
+    def initialize( obj = nil )
+      @obj = obj
+      yield self if block_given?
+      self
+    end
+
+    #
+    # Find Grouper subject by id-or-identifier.  Returns +JGrouper::Subject+ or +nil+.
+    #
+    def self.find(id_or_identifier)
+      begin
+        subj = SubjectFinder.find_by_id_or_identifier id_or_identifier, false
+      rescue => e
+        warn "JGrouper::Subject.find(#{id_or_identifier}) => #{e}"
+      end
+      return nil if subj.nil?
+      subject = self.new subj
+      yield subject if block_given?
+      subject
+    end
+
+    #
+    # For passing methods on to Grouper subject 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_grouper; @obj; 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
+
+  end
+end
+

data/lib/jgrouper/version.rb

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

data/lib/jgrouper.rb

@@ -2,7 +2,9 @@ require 'java'
 
 require 'jgrouper/group'
 require 'jgrouper/member'
+require 'jgrouper/privilege'
 require 'jgrouper/stem'
+require 'jgrouper/subject'
 require 'jgrouper/version'
 
 #
@@ -65,6 +67,13 @@ require 'jgrouper/version'
 #
 #   % jgrouper-exporter -h
 #
+# Grant privileges:
+#
+#   % jgrouper-grant $group admin $subject
+#   % jgrouper-grant $stem stem $subject
+#   % jgrouper-grant -R $stem admin $subject
+#   % jgrouper-grant -R $stem stem $subject
+#
 # == Installation
 #
 # Add this line to your application's Gemfile:
@@ -120,7 +129,16 @@ module JGrouper
         edu.internet2.middleware.grouper.GrouperSession
         edu.internet2.middleware.grouper.MemberFinder
         edu.internet2.middleware.grouper.StemFinder
+        edu.internet2.middleware.grouper.SubjectFinder
       ).each { |klass| java_import klass }
+
+    # TODO Do this for everything?
+    %w( 
+        edu.internet2.middleware.grouper.GroupFinder
+        edu.internet2.middleware.grouper.privs.Privilege
+      ).each do |klass|
+        java_import klass do |pkg, cls| "J#{cls}"; end
+      end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - blair christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,7 @@ email:
 executables:
 - jgrouper-audit-archiver
 - jgrouper-export
+- jgrouper-grant
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,13 +72,16 @@ files:
 - TODO.md
 - bin/jgrouper-audit-archiver
 - bin/jgrouper-export
+- bin/jgrouper-grant
 - jgrouper.gemspec
 - lib/jgrouper.rb
 - lib/jgrouper/audit_archiver.rb
 - lib/jgrouper/exporter.rb
 - lib/jgrouper/group.rb
 - lib/jgrouper/member.rb
+- lib/jgrouper/privilege.rb
 - lib/jgrouper/stem.rb
+- lib/jgrouper/subject.rb
 - lib/jgrouper/version.rb
 homepage: https://github.com/blairc/jgrouper/
 licenses:
@@ -99,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: JRuby wrapper around the Internet2 Grouper API