jgrouper 0.0.3 → 0.0.4

data/HISTORY.md

@@ -1,8 +1,16 @@
 JGrouper History
 ================
 
-JGrouper v0.0.3
+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
+
+
+2012-08-17 JGrouper v0.0.3
+--------------------------
 * Add *JGrouper::Shell*
 * Add *bin/jgrouper* interactive shell
 * Rename *JGrouper::Stem#root_stem* to *JGrouper::Stem#root*

data/README.rdoc

@@ -35,6 +35,15 @@
   # 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.uuid         # Group UUID
+  end
+
 === Group Types
 
   # Create group type
@@ -44,9 +53,7 @@
   end
 
   # Find all group types
-  group_types = JGrouper::GroupType.all do |group_type|
-    ...
-  end
+  group_types = JGrouper::GroupType.all { |group_type| ... }
 
   # Find group type
   JGrouper::GroupType.find(name)
@@ -88,5 +95,5 @@ https://github.com/blairc/jgrouper
 
 == See Also
 
-JGrouper::Shell, https://github.com/blairc/jgrouper-server, http://grouper.internet2.edu
+JGrouper::Shell https://github.com/blairc/jgrouper-shell, JGrouper::Server https://github.com/blairc/jgrouper-server, http://grouper.internet2.edu
 

data/TODO.md

@@ -3,18 +3,19 @@ JGrouper To Do
 
 JGrouper v0.0.4
 ---------------
-* Add *JGrouper::Group*
-* Add *JGrouper::Group.find(name)*
-* Add *JGrouper::Stem#add_group( name, display_name = nil )*
-* Add *JGrouper::Group.create( name, display_name = nil )*
 * Add *JGrouper::Group#types*
 * Add *JGrouper::Group#add_type*
-* Add *JGrouper::Group#members*
-* Add *JGrouper::Group#add_member(?)*
+* 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)*
@@ -46,8 +47,4 @@ Future
 * JGrouper::TestCase
 * JGrouper::Subject::TestCase
 * JGrouper::Subject::TestCase
-* Make *JGrouper::Shell* startup less chatty
-* Extract *JGrouper::Shell* to own gem?
-* Add *gsh* compatibility commands to *JGrouper::Shell*?
-* Should *JGrouper::Shell* be able to run scripts?
 

data/jgrouper.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = JGrouper::VERSION
 
   gem.add_dependency 'json'
-  gem.add_dependency 'pry'
 
   gem.add_development_dependency 'factory_girl', "~> 4.0"
   gem.add_development_dependency 'mocha'

data/lib/jgrouper/group.rb

@@ -0,0 +1,119 @@
+module JGrouper # :nodoc:
+  #
+  # = JGrouper::Group - A Grouper group
+  #
+  class Group
+
+    attr_accessor :display_name, :name, :uuid
+
+    def initialize
+      @grouper_group = nil
+      yield self if block_given?
+      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
+
+    #
+    # Find group by name or returns +nil+.
+    #
+    #   group = JGrouper::Group.find(name)
+    #   
+    def self.find(name)
+      group = from_grouper GroupFinder.findByName( GrouperSession.startRootSession, name, false ) # XXX 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
+
+    #
+    # Return String representation of JGrouper::Group 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 |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
+      end
+    end
+
+  end
+end
+

data/lib/jgrouper/version.rb

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

data/lib/jgrouper.rb

@@ -1,6 +1,7 @@
 require 'java'
 require 'json'
 
+require_relative 'jgrouper/group'
 require_relative 'jgrouper/group_type'
 require_relative 'jgrouper/stem'
 require_relative 'jgrouper/subject'
@@ -45,6 +46,15 @@ require_relative 'jgrouper/version'
 #   # 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.uuid         # Group UUID
+#   end
+#
 # === Group Types
 #
 #   # Create group type
@@ -54,9 +64,7 @@ require_relative 'jgrouper/version'
 #   end
 #
 #   # Find all group types
-#   group_types = JGrouper::GroupType.all do |group_type|
-#     ...
-#   end
+#   group_types = JGrouper::GroupType.all { |group_type| ... }
 #
 #   # Find group type
 #   JGrouper::GroupType.find(name)
@@ -98,7 +106,7 @@ require_relative 'jgrouper/version'
 #
 # == See Also
 #
-# JGrouper::Shell, https://github.com/blairc/jgrouper-server, http://grouper.internet2.edu
+# JGrouper::Shell https://github.com/blairc/jgrouper-shell, JGrouper::Server https://github.com/blairc/jgrouper-server, http://grouper.internet2.edu
 #
 module JGrouper
 
@@ -119,6 +127,7 @@ module JGrouper
     #      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.StemFinder
     ).each { |klass| include_class klass }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jgrouper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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
@@ -142,8 +126,7 @@ dependencies:
 description: JRuby wrapper around the Internet2 Grouper API
 email:
 - blair.christensen@gmail.com
-executables:
-- jgrouper
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -154,12 +137,11 @@ files:
 - README.rdoc
 - Rakefile
 - TODO.md
-- bin/jgrouper
 - jgrouper.gemspec
 - lib/jgrouper.rb
+- lib/jgrouper/group.rb
 - lib/jgrouper/group_type.rb
 - lib/jgrouper/group_type/test_case.rb
-- lib/jgrouper/shell.rb
 - lib/jgrouper/stem.rb
 - lib/jgrouper/stem/test_case.rb
 - lib/jgrouper/subject.rb

data/bin/jgrouper

@@ -1,9 +0,0 @@
-#!/usr/bin/env jruby
-
-# TODO Will this work post-installation?
-
-require_relative '../lib/jgrouper/shell'
-JGrouper::Shell.run!
-
-# vim: syntax=ruby
-

data/lib/jgrouper/shell.rb

@@ -1,75 +0,0 @@
-require_relative '../jgrouper'
-
-require 'pry'
-
-module JGrouper # :nodoc:
-  #
-  # = JGrouper::Shell - JGrouper interactive shell
-  #
-  # == Usage
-  #
-  #   # Launch
-  #   % jgrouper
-  #
-  # === Group Types
-  #
-  # Any JGrouper::GroupType methods, such as:
-  #
-  #   JGrouper::Shell:0> group_type.all
-  #
-  # === Stems
-  #
-  # Any JGrouper::Stem methods, such as:
-  #
-  #   JGrouper::Shell:0> stem.root_stem
-  #
-  # === Subjects
-  #
-  # Any JGrouper::Subject methods, such as:
-  #
-  #   JGrouper::Shell:0> subject.root_subject
-  #
-  class Shell
-
-    def initialize
-      yield self if block_given?
-      self
-    end
-
-    #
-    # Access JGrouper::GroupType commands
-    #
-    def group_type
-      JGrouper::GroupType
-    end
-
-    #
-    # Start JGrouper shell
-    #
-    def self.run!
-      JGrouper.home ENV['GROUPER_HOME'] if ENV['GROUPER_HOME']
-      shell = new do |shell|
-        Pry.start shell,
-                  :prompt => [ proc { |obj, nest_level| "#{obj.class.name}:#{nest_level}> " },
-                               proc { "> " }
-                             ]
-      end
-    end
-
-    #
-    # Access JGrouper::Stem commands
-    #
-    def stem
-      JGrouper::Stem
-    end
-
-    #
-    # Access JGrouper::Subject commands
-    #
-    def subject
-      JGrouper::Subject
-    end
-
-  end
-end
-