jgrouper 0.0.4 → 0.0.5

data/HISTORY.md

@@ -1,8 +1,19 @@
 JGrouper History
 ================
 
-JGrouper v0.0.4
----------------
+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
+
+2012-10-04 JGrouper v0.0.4
+--------------------------
 * Add *JGrouper::Group*
 * Add *JGrouper::Group.find*
 * Add *JGrouper::Group* support to *JGrouper::Shell*

data/README.rdoc

@@ -5,25 +5,27 @@
   require 'jgrouper'
 
   # Set path to your Grouper API installation
-  JGrouper.home = '/path/to/your/grouper/api/installation/directory'
+  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.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.display_name    # Stem display name
+    stem.name            # Stem name
+    stem.uuid            # Stem UUID
+    stem.getChildGroups  # Call native Grouper API methods
   end
 
   # Find by name
@@ -39,17 +41,22 @@
 
   # Find by name
   group = JGrouper::Group.find(name) do |group|
-    group.display_name # Group display name
-    group.name         # Group name
-    group.uuid         # Group UUID
+    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.name       # Group type name
+    group_type.uuid       # Group type uuid
+    group_type.getFields  # Call native Grouper API methods
   end
 
   # Find all group types

data/Rakefile

@@ -12,7 +12,7 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.libs       << 'test'
-  t.test_files =   FileList['test/test*.rb']
+  t.test_files =   FileList['test/test_*.rb']
   t.verbose    =   true
 end 
 

data/TODO.md

@@ -1,50 +1,17 @@
 JGrouper To Do
 ==============
 
-JGrouper v0.0.4
----------------
-* Add *JGrouper::Group#types*
-* Add *JGrouper::Group#add_type*
+Future
+------
+* Fix *JGrouper::Stem* tests
+* Set (select) *JGrouper::Stem* attributes
+* List *JGrouper::Stem* privileges
+* Grant *JGrouper::Stem* privileges
+* Revoke *JGrouper::Stem* privileges
+* Set (select) *JGrouper::Group* attributes
+* Fix *JGrouper::GroupType* tests
+* Fix *JGrouper::Subject* tests
 * Add *JGrouper::Stem#children( recurse = false )*
 * Add *JGrouper::Stem#groups( recurse = false )*
 * Add *JGrouper::Stem#stems( recurse = false )*
 
-
-Future
-------
-* Add *JGrouper::Stem#add_group( name, display_name = nil )*
-* Add *JGrouper::Group.create( name, display_name = nil )*
-* Add *JGrouper::Group#members*
-* Add *JGrouper::Group#add_member(?)*
-* Add *JGrouper::Stem#delete( recurse = false )*
-* Add *JGrouper::Stem.delete( name, recurse = false )*
-* Add *JGrouper::Stem.find(uuid)*
-* Add *JGrouper::Stem.exists?(name)*
-* Add *JGrouper::Group.exists?(name)*
-* Add *JGrouper::Stem#root?(name)*
-* Add *JGrouper::Group*
-* Add *JGrouper::Group.find(name)*
-* Implement *JGrouper::Subject.sources* (using *edu.internet2.middleware.subject.provider.SourceManager*)
-* Implement *JGrouper::Subject.source(id)* (using *edu.internet2.middleware.subject.provider.SourceManager*)
-* Implement *JGrouper::Subject::Source#to_json* (for "jgrouper-server")
-* Add child stem
-* Get child stems
-* Delete child stem
-* Add child group
-* Get child groups
-* Delete child group
-* Add group member
-* Get group members
-* Remove group member
-* Grant stem privileges
-* Get stem privileges
-* Revoke stem privileges
-* Grant group privileges
-* Get group privileges
-* Revoke group privileges
-* Add privilege to stem and all children
-* Add privilege to all groups beneath a stem
-* JGrouper::TestCase
-* JGrouper::Subject::TestCase
-* JGrouper::Subject::TestCase
-

data/lib/jgrouper/group/test_case.rb

@@ -0,0 +1,18 @@
+# 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.rb

@@ -4,7 +4,8 @@ module JGrouper # :nodoc:
   #
   class Group
 
-    attr_accessor :display_name, :name, :uuid
+    attr_reader :display_extension, :display_name, :extension, :name, :types, :uuid
+
 
     def initialize
       @grouper_group = nil
@@ -12,52 +13,31 @@ module JGrouper # :nodoc:
       self
     end
 
-# XXX     #
-# XXX     # Create child stem (along with missing intermediaries).
-# XXX     #
-# XXX     #   # Create child stem 'foo'
-# XXX     #   child = stem.add_stem 'foo'
-# XXX     #
-# XXX     #   # Create child stem 'foo' with display name of 'Foo'
-# XXX     #   child = stem.add_stem 'foo', 'Foo'
-# XXX     #
-# XXX     #   # Create child stem 'foo:bar:baz' along with any missing intermediaries
-# XXX     #   child = stem.add_stem 'foo:bar:baz'
-# XXX     #
-# XXX     #
-# XXX     def add_stem( name, display_name = nil )
-# XXX       # TODO What if names.size != display_names.size?
-# XXX       names         = name.split ':'
-# XXX       display_names = display_name.nil? ? names.clone.split : display_name.split(':')
-# XXX 
-# XXX       name, display_name = names.shift, display_names.shift
-# XXX 
-# XXX       child = JGrouper::Stem.find self.name.empty? ? name : [ self.name, name ].join(':') # TODO Yuck
-# XXX       child = JGrouper::Stem.from_grouper @grouper_stem.addChildStem(name, display_name) if child.nil?
-# XXX 
-# XXX       # TODO What if child can't be created?
-# XXX       child = child.add_stem( names.join(':'), display_names.join(':') ) unless names.empty?
-# XXX       yield child if block_given?
-# XXX       child
-# XXX     end
-# XXX 
-# XXX     #
-# XXX     # Create stem (along with missing intermediaries).
-# XXX     #
-# XXX     #   # Create top-level 'foo' stem
-# XXX     #   stem = JGrouper::Stem.create 'foo'
-# XXX     #
-# XXX     #   # Create top-level 'foo' stem with display name of 'Foo'
-# XXX     #   stem = JGrouper::Stem.create 'foo', 'Foo'
-# XXX     #
-# XXX     #   # Create 'foo:bar:baz' stem, along with any missing intermediaries
-# XXX     #   stem = JGrouper::Stem.create 'foo:bar:baz'
-# XXX     #
-# XXX     def self.create( name, display_name = nil )
-# XXX       stem = root.add_stem name, display_name
-# XXX       yield stem if block_given?
-# XXX       stem
-# XXX     end
+    #
+    # Add group type.  Returns +true+ if type added or group already has type.
+    #
+    #   group.add_type 'group type'
+    #
+    def add_type(name)
+      return true  if types.include? name
+      t = Java::EduInternet2MiddlewareGrouper::GroupTypeFinder.find name, false
+      return false unless t
+      @grouper_group.add_type t
+      true
+    end
+
+    #
+    # Delete group type.  Returns +true+ if type deleted or group does not have type.
+    #
+    #   group.delete_type 'group type'
+    #
+    def delete_type(name)
+      t = Java::EduInternet2MiddlewareGrouper::GroupTypeFinder.find name, false
+      return false unless t
+      return true  unless types.include? name
+      @grouper_group.delete_type t
+      true
+    end
 
     #
     # Find group by name or returns +nil+.
@@ -65,39 +45,55 @@ module JGrouper # :nodoc:
     #   group = JGrouper::Group.find(name)
     #   
     def self.find(name)
-      group = from_grouper GroupFinder.findByName( GrouperSession.startRootSession, name, false ) # XXX How to handle sessions?
+      group = from_grouper GroupFinder.findByName( GrouperSession.startRootSession, name, false ) # How to handle sessions?
       yield group if block_given?
       group
     end
 
-# XXX     #
-# XXX     # Generate JGrouper::Stem instance from JSON by calling +JSON.parse(json_string)+
-# XXX     # 
-# XXX     def self.json_create(json)
-# XXX       new do |stem|
-# XXX         stem.display_name = json['display_name']
-# XXX         stem.name         = json['name']
-# XXX         stem.uuid         = json['uuid']
-# XXX       end
-# XXX     end
-# XXX 
-# XXX     #
-# XXX     # Return JSON representation of JGrouper::Stem instance.
-# XXX     #
-# XXX     def to_json
-# XXX       {
-# XXX         :json_class   => self.class.name,
-# XXX         :display_name => self.display_name,
-# XXX         :name         => self.name,
-# XXX         :uuid         => self.uuid
-# XXX       }.to_json
-# XXX     end
+    #
+    # Generate JGrouper::Group instance from JSON by calling +JSON.parse(json_string)+
+    # 
+    def self.json_create(json)
+      new do |group|
+        group.instance_variable_set :@display_extension, json['display_extension']
+        group.instance_variable_set :@display_name,      json['display_name']
+        group.instance_variable_set :@extension,         json['extension']
+        group.instance_variable_set :@name,              json['name']
+        group.instance_variable_set :@types,             json['types']
+        group.instance_variable_set :@uuid,              json['uuid']
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      begin
+        warn "METHOD_MISSING: meth=#{ meth } args=#{ args }"
+        block.call @grouper_group.send(meth, *args) if block
+        @grouper_group.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
+    #
+    # Return JSON representation of JGrouper::Group instance.
+    #
+    def to_json
+      {
+        :json_class        => self.class.name,
+        :display_extension => self.display_extension,
+        :display_name      => self.display_name,
+        :extension         => self.extension,
+        :name              => self.name,
+        :types             => self.types,
+        :uuid              => self.uuid
+      }.to_json
+    end
 
     #
     # Return String representation of JGrouper::Group instance.
     #
     def to_s
-      %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.join(' | ') 
+      %w( name display_name uuid ).collect { |k| "#{k}=#{ self.send(k) }" }.join(' | ') + " | types=#{ types.join(',') }"
     end
 
 
@@ -106,11 +102,14 @@ module JGrouper # :nodoc:
     def self.from_grouper(grouper)
       return nil if grouper.nil?
       new do |group|
-        group.instance_variable_set :@grouper_group, grouper # XXX Is this even needed?
-
-        group.display_name = grouper.getDisplayName
-        group.name         = grouper.getName
-        group.uuid         = grouper.getUuid
+        group.instance_variable_set :@grouper_group,     grouper
+        group.instance_variable_set :@display_extension, grouper.getDisplayExtension
+        group.instance_variable_set :@display_name,      grouper.getDisplayName
+        group.instance_variable_set :@extension,         grouper.getExtension
+        group.instance_variable_set :@name,              grouper.getName
+        # TODO Testing hack
+        group.instance_variable_set :@types,             grouper.getTypes.collect { |t| t.kind_of?(String) ? t : t.getName }
+        group.instance_variable_set :@uuid,              grouper.getUuid
       end
     end
 

data/lib/jgrouper/group_type/test_case.rb

@@ -4,7 +4,7 @@ require 'test/unit'
 require 'factory_girl'
 
 
-module JGrouper #: :nodoc:
+class JGrouper #: :nodoc:
   #
   # = JGrouper::GroupType::TestCase - For testing JGrouper::GroupType
   #

data/lib/jgrouper/group_type.rb

@@ -84,6 +84,15 @@ module JGrouper # :nodoc:
       end
     end
 
+    def method_missing(meth, *args, &block)
+      begin
+        block.call @grouper_group_type.send(meth, *args) if block
+        @grouper_group_type.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
     #
     # Return JSON representation of JGrouper::GroupType instance.
     #

data/lib/jgrouper/stem/test_case.rb

@@ -4,7 +4,7 @@ require 'test/unit'
 require 'factory_girl'
 
 
-module JGrouper #: :nodoc:
+class JGrouper # :nodoc:
   #
   # = JGrouper::Stem::TestCase - For testing JGrouper::Stem
   #

data/lib/jgrouper/stem.rb

@@ -81,6 +81,15 @@ module JGrouper # :nodoc:
       end
     end
 
+    def method_missing(meth, *args, &block)
+      begin
+        block.call @grouper_stem.send(meth, *args) if block
+        @grouper_stem.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
     #
     # Return root stem.
     #

data/lib/jgrouper/subject/test_case.rb

@@ -4,7 +4,7 @@ require 'test/unit'
 require 'factory_girl'
 
 
-module JGrouper #: :nodoc:
+class JGrouper #: :nodoc:
   #
   # = JGrouper::Subject::TestCase - For testing JGrouper::Subject
   #

data/lib/jgrouper/subject.rb

@@ -24,6 +24,15 @@ module JGrouper #: :nodoc:
       end
     end
 
+    def method_missing(meth, *args, &block)
+      begin
+        block.call @grouper_subject.send(meth, *args) if block
+        @grouper_subject.send(meth, *args)
+      rescue NoMethodError
+        super
+      end
+    end
+
     #
     # Return root subject.
     #

data/lib/jgrouper/version.rb

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

data/lib/jgrouper.rb

@@ -16,25 +16,27 @@ require_relative 'jgrouper/version'
 #   require 'jgrouper'
 #
 #   # Set path to your Grouper API installation
-#   JGrouper.home = '/path/to/your/grouper/api/installation/directory'
+#   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.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.display_name    # Stem display name
+#     stem.name            # Stem name
+#     stem.uuid            # Stem UUID
+#     stem.getChildGroups  # Call native Grouper API methods
 #   end
 #
 #   # Find by name
@@ -50,17 +52,22 @@ require_relative 'jgrouper/version'
 #
 #   # Find by name
 #   group = JGrouper::Group.find(name) do |group|
-#     group.display_name # Group display name
-#     group.name         # Group name
-#     group.uuid         # Group UUID
+#     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.name       # Group type name
+#     group_type.uuid       # Group type uuid
+#     group_type.getFields  # Call native Grouper API methods
 #   end
 #
 #   # Find all group types
@@ -133,5 +140,17 @@ module JGrouper
     ).each { |klass| include_class klass }
   end
 
+  #
+  # Initialize Grouper API.
+  #
+  def self.home=(path)
+    self.home path
+  end
+
+end
+
+if __FILE__ == $0
+  JGrouper.home ENV['GROUPER_HOME']
+  puts JGrouper::Group.find('etc:wheel')
 end
 

data/test/factories.rb

@@ -4,6 +4,27 @@ require 'factory_girl'
 
 
 FactoryGirl.define do
+  # Groups
+  factory :grouper_wheel_group, class: OpenStruct do
+    getDisplayExtension 'Wheel'
+    getDisplayName      'Etc:Wheel'
+    getExtension        'wheel'
+    getName             'etc:wheel'
+    getTypes            [ 'base'] # FIXME
+    getUuid             'etc-wheel-group'
+  end
+
+  factory :wheel_group, class: OpenStruct do
+    json_class   JGrouper::Group
+    display_extension 'Wheel'
+    display_name      'Etc:Wheel'
+    extension         'wheel'
+    name              'etc:wheel'
+    types             [ 'base' ]
+    uuid              'etc-wheel-group'
+  end
+
+
   # Group Types
   factory :jgrouper_type, class: OpenStruct do
     json_class JGrouper::GroupType

data/test/test_group.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require_relative 'helper'
+require_relative '../lib/jgrouper/group/test_case'
+
+
+class JGrouper::Group::TestCase < Test::Unit::TestCase
+
+  def test_mocked_find_wheel
+    Java::EduInternet2MiddlewareGrouper::GrouperSession.expects(:startRootSession).returns true
+    Java::EduInternet2MiddlewareGrouper::GroupFinder.expects(:findByName).returns grouper_wheel_group
+
+    JGrouper::Group.find('etc:wheel') do |group|
+      assert_not_nil group
+      assert         group.kind_of? JGrouper::Group
+      assert_equal   'Wheel',           group.display_extension
+      assert_equal   'Etc:Wheel',       group.display_name
+      assert_equal   'wheel',           group.extension
+      assert_equal   'etc:wheel',       group.name
+      assert_equal   [ 'base' ],        group.types # FIXME
+      assert_equal   'etc-wheel-group', group.uuid
+    end
+  end
+
+  def test_mocked_group_to_json
+    Java::EduInternet2MiddlewareGrouper::GrouperSession.expects(:startRootSession).returns true
+    Java::EduInternet2MiddlewareGrouper::GroupFinder.expects(:findByName).returns grouper_wheel_group
+
+    assert_equal wheel_group_as_json, JGrouper::Group.find('etc:wheel').to_json
+  end
+
+  def test_group_from_json
+    group = JSON.parse wheel_group_as_json
+    assert_not_nil group
+    assert         group.kind_of? JGrouper::Group
+    assert_equal   'Wheel',           group.display_extension
+    assert_equal   'Etc:Wheel',       group.display_name
+    assert_equal   'wheel',           group.extension
+    assert_equal   'etc:wheel',       group.name
+    assert_equal   [ 'base' ],        group.types
+    assert_equal   'etc-wheel-group', group.uuid
+  end
+
+  def test_group_types
+    Java::EduInternet2MiddlewareGrouper::GrouperSession.expects(:startRootSession).returns true
+    Java::EduInternet2MiddlewareGrouper::GroupFinder.expects(:findByName).returns grouper_wheel_group
+
+    JGrouper::Group.find('etc:wheel') do |group|
+      assert_equal  true,   group.add_type('base')    # Add already present type
+                                                      # TODO Add type
+      assert_equal  false,  group.add_type('foo')     # Add invalid group type
+
+                                                      # TODO Delete unassigned type
+                                                      # TODO Delete type
+      assert_equal  false,  group.delete_type('foo')  # Delete invalid group type
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -140,6 +140,7 @@ files:
 - jgrouper.gemspec
 - lib/jgrouper.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/stem.rb
@@ -149,6 +150,7 @@ files:
 - 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
@@ -179,6 +181,8 @@ 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: