jgrouper 0.0.5 → 0.1.0

data/lib/jgrouper/stem.rb

@@ -1,137 +1,84 @@
+require 'csv'
+
 module JGrouper # :nodoc:
+
+  #
+  # = JGrouper::Stem - Grouper Stem
+  #
+  # == Usage
+  #
+  #   require 'jgrouper'
   #
-  # = JGrouper::Stem - A Grouper stem
+  #   root = JGrouper::Stem.root
   #
   class Stem
 
-    attr_accessor :display_name, :name, :uuid
-
-    def initialize
-      @grouper_stem = nil
+    def initialize( obj = nil )
+      @obj = obj
       yield self if block_given?
       self
     end
 
     #
-    # Create child stem (along with missing intermediaries).
-    #
-    #   # Create child stem 'foo'
-    #   child = stem.add_stem 'foo'
-    #
-    #   # Create child stem 'foo' with display name of 'Foo'
-    #   child = stem.add_stem 'foo', 'Foo'
-    #
-    #   # Create child stem 'foo:bar:baz' along with any missing intermediaries
-    #   child = stem.add_stem 'foo:bar:baz'
-    #
-    #
-    def add_stem( name, display_name = nil )
-      # TODO What if names.size != display_names.size?
-      names         = name.split ':'
-      display_names = display_name.nil? ? names.clone.split : display_name.split(':')
-
-      name, display_name = names.shift, display_names.shift
-
-      child = JGrouper::Stem.find self.name.empty? ? name : [ self.name, name ].join(':') # TODO Yuck
-      child = JGrouper::Stem.from_grouper @grouper_stem.addChildStem(name, display_name) if child.nil?
-
-      # TODO What if child can't be created?
-      child = child.add_stem( names.join(':'), display_names.join(':') ) unless names.empty?
-      yield child if block_given?
-      child
-    end
-
-    #
-    # Create stem (along with missing intermediaries).
-    #
-    #   # Create top-level 'foo' stem
-    #   stem = JGrouper::Stem.create 'foo'
-    #
-    #   # Create top-level 'foo' stem with display name of 'Foo'
-    #   stem = JGrouper::Stem.create 'foo', 'Foo'
-    #
-    #   # Create 'foo:bar:baz' stem, along with any missing intermediaries
-    #   stem = JGrouper::Stem.create 'foo:bar:baz'
-    #
-    def self.create( name, display_name = nil )
-      stem = root.add_stem name, display_name
-      yield stem if block_given?
-      stem
-    end
-
-    #
-    # Find stem by name or returns +nil+.
+    # Find Grouper stem by name.  Returns +JGrouper::Stem+ or +nil+.
     #
-    #   stem = JGrouper::Stem.find(name)
-    #   
     def self.find(name)
-      stem = from_grouper StemFinder.findByName( GrouperSession.startRootSession, name, false ) # XXX How to handle sessions?
+      obj = StemFinder.find_by_name GrouperSession.start_root_session, name, false
+      return nil if obj.nil?
+      stem = self.new obj
       yield stem if block_given?
-      stem
+      stem 
     end
 
     #
-    # Generate JGrouper::Stem instance from JSON by calling +JSON.parse(json_string)+
-    # 
-    def self.json_create(json)
-      new do |stem|
-        stem.display_name = json['display_name']
-        stem.name         = json['name']
-        stem.uuid         = json['uuid']
+    # Yield child groups.
+    #
+    def groups
+      @obj.child_groups.collect do |child|
+        g = JGrouper::Group.new child
+        yield g if block_given?
+        g
       end
     end
 
+    #
+    # For passing methods on to Grouper Stem object.
+    #
     def method_missing(meth, *args, &block)
+      super if @obj.nil?
       begin
-        block.call @grouper_stem.send(meth, *args) if block
-        @grouper_stem.send(meth, *args)
+        block.call @obj.send(meth, *args) if block
+        @obj.send(meth, *args)
       rescue NoMethodError
         super
       end
     end
 
     #
-    # Return root stem.
-    #
-    #   root_stem = JGrouper::Stem.root
+    # Find Grouper root stem.  Returns +JGrouper::Stem+ or +nil+.
     #
     def self.root
-      stem = from_grouper StemFinder.findRootStem( GrouperSession.startRootSession ) # XXX How to handle sessions?
+      obj = StemFinder.find_root_stem GrouperSession.start_root_session
+      return nil if obj.nil?
+      stem = self.new obj
       yield stem if block_given?
       stem
     end
 
     #
-    # Return JSON representation of JGrouper::Stem instance.
+    # Yield child stems.
     #
-    def to_json
-      {
-        :json_class   => self.class.name,
-        :display_name => self.display_name,
-        :name         => self.name,
-        :uuid         => self.uuid
-      }.to_json
+    def stems
+      @obj.child_stems.collect do |child|
+        s = self.new child
+        yield s if block_given?
+        s
+      end
     end
 
-    #
-    # Return String representation of JGrouper::Stem instance.
-    #
     def to_s
-      %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.join(' | ') 
-    end
-
-
-    private
-
-    def self.from_grouper(grouper)
-      return nil if grouper.nil?
-      new do |stem|
-        stem.instance_variable_set :@grouper_stem, grouper # XXX Is this even needed?
-
-        stem.display_name = grouper.getDisplayName
-        stem.name         = grouper.getName
-        stem.uuid         = grouper.getUuid
-      end
+      return nil if @obj.nil?
+      CSV.generate_line %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }
     end
 
   end

data/lib/jgrouper/version.rb

@@ -1,3 +1,4 @@
 module JGrouper
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end
+

data/lib/jgrouper.rb

@@ -1,16 +1,13 @@
 require 'java'
-require 'json'
-
-require_relative 'jgrouper/group'
-require_relative 'jgrouper/group_type'
-require_relative 'jgrouper/stem'
-require_relative 'jgrouper/subject'
-require_relative 'jgrouper/version'
 
+require 'jgrouper/group'
+require 'jgrouper/member'
+require 'jgrouper/stem'
+require 'jgrouper/version'
 
 #
 # = JGrouper - JRuby wrapper around the Internet2 Grouper API
-#
+# 
 # == Usage
 #
 #   require 'jgrouper'
@@ -18,69 +15,6 @@ require_relative 'jgrouper/version'
 #   # Set path to your Grouper API installation
 #   JGrouper.home '/path/to/your/grouper/api/installation/directory'
 #
-# === Subjects
-#
-#   # Find root subject
-#   JGrouper::Subject.root do |subject|
-#     subject.id         # Subject identifier
-#     subject.name       # Subject name
-#     subject.source     # Subject source identifier
-#     subject.type       # Subject type name
-#     subject.getSource  # Call native Subject API methods
-#   end
-#
-# === Stems
-#
-#   # Find root stem
-#   JGrouper::Stem.root do |stem|
-#     stem.display_name    # Stem display name
-#     stem.name            # Stem name
-#     stem.uuid            # Stem UUID
-#     stem.getChildGroups  # Call native Grouper API methods
-#   end
-#
-#   # Find by name
-#   stem = JGrouper::Stem.find(name) { |stem| ... }
-#
-#   # Create stem(s)
-#   stem = JGrouper::Stem.create 'foo:bar:baz', 'Foo:Bar:Baz'
-#
-#   # Create child stem(s)
-#   child = stem.create 'foo:bar:baz'
-#
-# === Groups
-#
-#   # Find by name
-#   group = JGrouper::Group.find(name) do |group|
-#     group.display_name              # Group display name
-#     group.name                      # Group name
-#     group.types                     # Array of group type names
-#     group.uuid                      # Group UUID
-#     group.add_type 'group type'     # Add group type
-#     group.delete_type 'group_type'  # Delete group type
-#     group.getParentStem             # Call native Grouper API methods
-#   end
-#
-# === Group Types
-#
-#   # Create group type
-#   JGrouper::GroupType.create(name) do |group_type|
-#     group_type.name       # Group type name
-#     group_type.uuid       # Group type uuid
-#     group_type.getFields  # Call native Grouper API methods
-#   end
-#
-#   # Find all group types
-#   group_types = JGrouper::GroupType.all { |group_type| ... }
-#
-#   # Find group type
-#   JGrouper::GroupType.find(name)
-#
-#   # Delete group type
-#   JGrouper::GroupType.delete(name)
-#   # ... or ...
-#   JGrouper::GroupType.find(name).delete
-#
 # == Installation
 #
 # Add this line to your application's Gemfile:
@@ -109,48 +43,41 @@ require_relative 'jgrouper/version'
 #
 # == Home Page
 #
-# https://github.com/blairc/jgrouper
+# https://github.com/blairc/jgrouper/
 #
 # == See Also
 #
-# JGrouper::Shell https://github.com/blairc/jgrouper-shell, JGrouper::Server https://github.com/blairc/jgrouper-server, http://grouper.internet2.edu
+# http://grouper.internet2.edu
 #
 module JGrouper
 
   #
-  # Initialize Grouper API.
+  # Initialize Grouper API or raise exception if path does not exist.
   #
-  def self.home(path)
-    # TODO This could/should be so much better.
+  def self.home!(path)
+    raise "ERROR: path does not exist - #{path}" unless File.directory?(path)
+
+    ENV['CLASSPATH'].split(':').each { |cp| $CLASSPATH << cp }
+
     [ "#{path}/lib/grouper/", "#{path}/lib/jdbcSamples" ].each do |dir|
       Dir[ "#{dir}/*.jar" ].each { |jar| $CLASSPATH << jar } 
     end
+
     $CLASSPATH << File.join( path, 'conf' )
     $CLASSPATH << File.join( path, 'dist', 'lib', 'grouper.jar' )
 
-    # TODO Can I eliminate these if I refer to everything by full path?
-    #      Or maybe something like:
-    #        include_class 'java.lang.String' { |package, name| 'JString' }
-    #      Test the above w/ GroupType?
     %w( edu.internet2.middleware.subject.SubjectNotFoundException
         edu.internet2.middleware.grouper.GrouperSession
-        edu.internet2.middleware.grouper.GroupFinder
-        edu.internet2.middleware.grouper.SubjectFinder
+        edu.internet2.middleware.grouper.MemberFinder
         edu.internet2.middleware.grouper.StemFinder
-    ).each { |klass| include_class klass }
-  end
-
-  #
-  # Initialize Grouper API.
-  #
-  def self.home=(path)
-    self.home path
+      ).each { |klass| java_import klass }
   end
 
 end
 
-if __FILE__ == $0
-  JGrouper.home ENV['GROUPER_HOME']
-  puts JGrouper::Group.find('etc:wheel')
+
+def edu
+  Java::Edu
 end
 
+

metadata

@@ -1,100 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - blair christensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  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'
 - !ruby/object:Gem::Dependency
   name: rdoc-readme
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,87 +48,59 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: JRuby wrapper around the Internet2 Grouper API
 email:
 - blair.christensen@gmail.com
-executables: []
+executables:
+- jgrouper-audit-archiver
+- jgrouper-export
 extensions: []
 extra_rdoc_files: []
 files:
+- .autotest
 - .gitignore
 - Gemfile
 - HISTORY.md
-- LICENSE
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - TODO.md
+- bin/jgrouper-audit-archiver
+- bin/jgrouper-export
 - jgrouper.gemspec
 - lib/jgrouper.rb
+- lib/jgrouper/audit_archiver.rb
+- lib/jgrouper/exporter.rb
 - lib/jgrouper/group.rb
-- lib/jgrouper/group/test_case.rb
-- lib/jgrouper/group_type.rb
-- lib/jgrouper/group_type/test_case.rb
+- lib/jgrouper/member.rb
 - lib/jgrouper/stem.rb
-- lib/jgrouper/stem/test_case.rb
-- lib/jgrouper/subject.rb
-- lib/jgrouper/subject/test_case.rb
 - lib/jgrouper/version.rb
-- test/factories.rb
-- test/helper.rb
-- test/test_group.rb
-- test/test_group_type.rb
-- test/test_stem.rb
-- test/test_subject.rb
-homepage: https://github.com/blairc/jgrouper
-licenses: []
+homepage: https://github.com/blairc/jgrouper/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: JRuby wrapper around the Internet2 Grouper API
-test_files:
-- test/factories.rb
-- test/helper.rb
-- test/test_group.rb
-- test/test_group_type.rb
-- test/test_stem.rb
-- test/test_subject.rb
-has_rdoc: 
+test_files: []

data/lib/jgrouper/group/test_case.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-require 'test/unit'
-require 'factory_girl'
-
-
-class JGrouper::Group::TestCase < Test::Unit::TestCase
-
-  def grouper_wheel_group
-    FactoryGirl.build :grouper_wheel_group
-  end
-
-  def wheel_group_as_json
-    FactoryGirl.attributes_for(:wheel_group).to_json
-  end
-
-end
-

data/lib/jgrouper/group_type/test_case.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-
-require 'test/unit'
-require 'factory_girl'
-
-
-class JGrouper #: :nodoc:
-  #
-  # = JGrouper::GroupType::TestCase - For testing JGrouper::GroupType
-  #
-  class GroupType::TestCase < Test::Unit::TestCase
-
-    def grouper_type
-      FactoryBuild :jgrouper_grouper_tyype
-    end
-
-    def jgrouper_type_as_json
-      FactoryGirl.attributes_for(:jgrouper_type).to_json
-    end
-
-  end
-end
-