grouper-rest-client 0.2.1 → 0.2.2

data/HISTORY

@@ -1,3 +1,6 @@
+2011-05-04 v0.2.2
+  - Added "Grouper::Client::Resource::Group#members()" for retrieving group members.
+
 2011-05-03 v0.2.1
   - Added "Grouper::Client::Resource#debug" accessor for enabling/disabling debugging
   - Fixed Grouper WS API bug in "Grouper::Client::Resource#group"

data/README.rdoc

@@ -22,6 +22,9 @@
     # UUID of group.
     group['uuid']
 
+    # Get members of group.
+    members = group.members
+
 
     # Find all subjects matching identifier.
     subjects = grouper.subjects('foo')
@@ -39,11 +42,9 @@
     # In what groups within the specified stem is this subject a member?
     my_filtered_groups = subject.groups('some:stem')
 
-
     # Was the last WS call successful?
     grouper.ok?
-    
+     
     # Was there an error on the last WS call?
     grouper.error?
   end
-

data/Rakefile

@@ -1,10 +1,10 @@
 require 'bundler'
+require 'rdoc-readme/rake_task'
 require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
-
+RDoc::Readme::RakeTask.new 'lib/grouper-rest-client.rb', 'README.rdoc'
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
-

data/lib/grouper-rest-client.rb

@@ -2,9 +2,10 @@ require File.join( File.expand_path( File.dirname(__FILE__) ), 'grouper-rest-cli
 
 module Grouper    # :nodoc:
   module Rest     # :nodoc:
-    # = Minimal REST client for interacting with the Grouper WS API. 
+    # = Grouper::Rest::Client - Minimal REST client for interacting with the Grouper WS API. 
     # 
     # == Usage
+    #
     #   Grouper::Rest::Client::Resource.new url, :user => user, :password => pass do |grouper|
     #     # Find all stems matching identifier.
     #     stems = grouper.stems('some:approximate:stem')
@@ -25,6 +26,9 @@ module Grouper    # :nodoc:
     #     # UUID of group.
     #     group['uuid']
     #
+    #     # Get members of group.
+    #     members = group.members
+    #
     #
     #     # Find all subjects matching identifier.
     #     subjects = grouper.subjects('foo')
@@ -42,7 +46,6 @@ module Grouper    # :nodoc:
     #     # In what groups within the specified stem is this subject a member?
     #     my_filtered_groups = subject.groups('some:stem')
     #
-    #
     #     # Was the last WS call successful?
     #     grouper.ok?
     #      

data/lib/grouper-rest-client/resource.rb

@@ -83,6 +83,7 @@ module Grouper    # :nodoc:
           return result
         end
 
+        # Get group(s) matching identifier.
         # Was the last WS call successful?
         def ok?; !error?; end
 
@@ -150,6 +151,18 @@ module Grouper    # :nodoc:
             return nil
           end
 
+          # Get member(s) of group.
+          # Returns list of Grouper::Rest::Client::Resource::Subject objects OR JSON error response.
+          def members
+            raise ArgumentError if self['name'].nil? || self['name'].empty?
+            k1, k2  = 'WsGetMembersLiteResult', 'wsSubjects'
+            result  = @resource.call("groups/#{ self['name'] }/members")
+            if result.key?(k1) && result[k1].key?(k2)
+              return result[k1][k2].collect { |s| Grouper::Rest::Client::Resource::Subject.new(@resource, s) }
+            end
+            return result
+          end
+ 
           def to_s
             return "#{ self.class.name}: #{ @json.keys.sort.collect { |k| "#{ k }=#{ @json[k] }" }.join(', ') }" if @json
             super

data/lib/grouper-rest-client/version.rb

@@ -1,7 +1,7 @@
 module Grouper  # :nodoc:
   module Rest   # :nodoc:
     module Client
-      VERSION = "0.2.1"
+      VERSION = "0.2.2"
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: grouper-rest-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Blair Christensen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 -05:00
+date: 2011-05-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency