grouper-rest-client 0.0.1 → 0.1.0

data/HISTORY

@@ -1,3 +1,8 @@
+2011-03-18 v0.1.0
+  - API namespace change.
+  - Added "#subject(subject)" WS call.
+  - Added "#error?" and "#ok?"
+
 2011-03-17 v0.0.1
   - Initial prototype release.
   - Implements "#groups(subject, [stem_filter])" WS call.

data/README.rdoc

@@ -2,11 +2,20 @@
 
 == Usage
 
-  Grouper::Rest::Client.new url, :user => user, :password => pass do |grouper|
+  Grouper::Rest::Client::Resource.new url, :user => user, :password => pass do |grouper|
     # Get all group memberships.
     groups = grouper.groups('blair')
   
     # Get group memberships within stem prefix.
     filtered_groups = grouper.groups('blair', 'some:stem:')
+    
+    # Get subjects matching query.
+    subjects = grouper.subjects('blair')
+     
+    # Was the last WS call successful?
+    grouper.ok?
+    
+    # Was there an error on the last WS call?
+    grouper.error?
   end
 

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
+require 'rspec/core/rake_task'
+
 Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+

data/grouper-rest-client.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency( %q<json>,         [ ">=1.5.1" ] )
   s.add_dependency( %q<rest-client>,  [ ">=1.6.1" ] )
+
+  s.add_development_dependency( %q<rspec> )
 end
 

data/lib/grouper-rest-client.rb

@@ -2,48 +2,96 @@ require 'rubygems'
 require 'json'
 require 'rest_client'
 
-module Grouper  # :nodoc:
-  module Rest   # :nodoc:
+module Grouper    # :nodoc:
+  module Rest     # :nodoc:
     # = Minimal REST client for interacting with the Grouper WS API. 
     # 
     # == Usage
-    #   Grouper::Rest::Client.new url, :user => user, :password => pass do |grouper|
+    #   Grouper::Rest::Client::Resource.new url, :user => user, :password => pass do |grouper|
     #     # Get all group memberships.
     #     groups = grouper.groups('blair')
     #     
     #     # Get group memberships within stem prefix.
     #     filtered_groups = grouper.groups('blair', 'some:stem:')
-    #     end
-    class Client
-
-      # Response object from last request.
-      attr_reader :response
-
-      # Create Grouper REST client.
-      # Params:
-      # +url+:: Base URL for Grouper WS API.
-      # +:user => user+:: Authenticate to the API as this user.
-      # +:password => password+:: Authenticate to the API with this password.
-      def initialize( url, options={} )
-        @client   = RestClient::Resource.new(url, options) 
-        @response = nil
-        yield self if block_given?
-        self
-      end
-
-      # Get subject's group memberships.
-      # Returns array of hashes of group memberships.
-      # Params:
-      # +subject+:: Get groups for this subject.
-      # +stem_filter+:: Limit groups to those within this stem prefix. (optional)
-      def groups(subject, stem_filter=nil)
-        @response = @client["subjects/#{subject}/groups"].get :content_type => 'text/x-json'
-        result    = JSON.parse( @response.body )
-        groups    = result['WsGetGroupsLiteResult']['wsGroups']
-        groups    = groups.select { |group| group['name'] =~ /^#{stem_filter}/ } if stem_filter
-        groups
-      end
-    end
-  end
-end
+    #
+    #     # Get subjects matching query.
+    #     subjects = grouper.subjects('blair')
+    #
+    #     # Was the last WS call successful?
+    #     grouper.ok?
+    #
+    #     # Was there an error on the last WS call?
+    #     grouper.error?
+    #   end
+    module Client
+      class Resource
+
+        # Response object from last request.
+        attr_reader :response
+
+        # Create Grouper REST client.
+        # Params:
+        # +url+:: Base URL for Grouper WS API.
+        # +:user => user+:: Authenticate to the API as this user.
+        # +:password => password+:: Authenticate to the API with this password.
+        def initialize( url, options={} )
+          raise ArgumentError if url.nil? || url.empty?
+          @error    = false
+          @client   = RestClient::Resource.new( url, options.merge!( :headers => { :content_type => 'text/x-json' } ) )
+          @response = nil
+          yield self if block_given?
+          self
+        end
+
+        # Was there an error on the last WS call?
+        def error?; @error; end
+
+        # Get memberships for subject(s) matching identifier.
+        # Returns array of hashes of group memberships OR JSON error response.
+        # Params:
+        # +subject+:: Get groups for this subject.
+        # +stem_filter+:: Limit groups to those within this stem prefix. (optional)
+        def groups(subject, stem_filter=nil)
+          raise ArgumentError if subject.nil? || subject.empty?
+          k1, k2 = 'WsGetGroupsLiteResult', 'wsGroups'
+          result  = call("subjects/#{subject}/groups")
+          if result.key?(k1) && result[k1].key?(k2)
+            groups  = result['WsGetGroupsLiteResult']['wsGroups']
+            groups  = groups.select { |group| group['name'] =~ /^#{stem_filter}/ } if stem_filter
+            return groups
+          end
+          return result
+        end
+
+        # Was the last WS call successful?
+        def ok?; !error?; end
+
+        # Get subject(s) matching identifier.
+        # Returns array of hashes of subjects OR JSON error response.
+        # Params:
+        # +subjects+:: Get subject(s) matching this identifier.
+        def subjects(subject)
+          raise ArgumentError if subject.nil? || subject.empty?
+          k1, k2 = 'WsGetSubjectsResults', 'wsSubjects'
+          result = call("subjects/#{subject}")
+          return result[k1][k2] if result.key?(k1) && result[k1].key?(k2)
+          return result
+        end
+
+        private
+
+        # Make WS call and return JSON response.
+        def call(resource, method = :get)
+          @response = @client[resource].send(method)
+          @error    = false
+          JSON.parse( @response.body )
+        rescue RestClient::Exception => e
+          @error    = true
+          return JSON.parse( e.response )
+        end
+
+      end # class Resource
+    end # module Client
+  end # module Rest
+end # module Grouper
 

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

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

data/spec/resource_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe "Grouper::Rest::Client::Resource initialization" do
+
+  context "with no arguments" do
+    it "should raise ArgumentError" do
+      lambda { Grouper::Rest::Client::Resource.new }.should raise_error(ArgumentError)
+    end
+  end
+
+  context "with one argument" do
+
+    context "that is invalid" do
+      it "should raise ArgumentError when nil" do
+        lambda { Grouper::Rest::Client::Resource.new(nil) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError when blank" do
+        lambda { Grouper::Rest::Client::Resource.new('') }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "that is valid" do
+      it "should return Grouper::Rest::Client::Resource object" do
+        Grouper::Rest::Client::Resource.new('foo').should be_an_instance_of(Grouper::Rest::Client::Resource)
+      end
+    end
+
+  end
+
+end # describe initialization
+
+
+describe "Grouper::Rest::Client::Resource#groups()" do
+
+  before(:each) do
+    @grouper = Grouper::Rest::Client::Resource.new('foo')
+  end
+
+  context "with no arguments" do
+    it "should raise ArgumentError" do
+      lambda { @grouper.groups }.should raise_error(ArgumentError)
+    end
+  end
+
+  context "with one argument" do
+    context "that is invalid" do
+      it "should raise ArgumentError when nil" do
+        lambda { @grouper.groups(nil) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError when blank" do
+        lambda { @grouper.groups('') }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+end # describe #groups()
+
+
+describe "Grouper::Rest::Client::Resource#error?()" do
+  context "before any WS calls have been made" do
+    it "should be false" do
+      Grouper::Rest::Client::Resource.new('foo').error?.should be_false
+    end
+  end
+end # describe #error?()
+
+
+describe "Grouper::Rest::Client::Resource#ok?()" do
+  context "before any WS calls have been made" do
+    it "should be true" do
+      Grouper::Rest::Client::Resource.new('foo').ok?.should be_true
+    end
+  end
+end # describe #ok?()
+
+
+describe "Grouper::Rest::Client::Resource#response" do
+  context "before any WS calls have been made" do
+    it "should be nil" do
+      Grouper::Rest::Client::Resource.new('foo').response.should be_nil
+    end
+  end
+end # describe #response
+
+
+describe "Grouper::Rest::Client::Resource#subjects()" do
+
+  before(:each) do
+    @grouper = Grouper::Rest::Client::Resource.new('foo')
+  end
+
+  context "with no arguments" do
+    it "should raise ArgumentError" do
+      lambda { @grouper.subjects }.should raise_error(ArgumentError)
+    end
+  end
+
+  context "with one argument" do
+    context "that is invalid" do
+      it "should raise ArgumentError when nil" do
+        lambda { @grouper.subjects(nil) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError when blank" do
+        lambda { @grouper.subjects('') }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+end # describe #subjects()
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join( File.dirname(__FILE__), '..', 'lib', 'grouper-rest-client' )
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grouper-rest-client
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Blair Christensen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 -05:00
+date: 2011-03-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,20 @@ dependencies:
         version: 1.6.1
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: REST client for accessing the Grouper WS API
 email: 
 - blair.christensen@gmail.com
@@ -68,6 +82,8 @@ files:
 - grouper-rest-client.gemspec
 - lib/grouper-rest-client.rb
 - lib/grouper-rest-client/version.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/blairc/
 licenses: []
@@ -102,5 +118,6 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: REST client for accessing the Grouper WS API
-test_files: []
-
+test_files: 
+- spec/resource_spec.rb
+- spec/spec_helper.rb