confluence-client 0.0.4 → 0.0.5

data/HISTORY

@@ -1,17 +1,22 @@
+2011-04-08 v0.0.5
+  - Added 'Client#add_user_to_group'
+  - Added 'Client#member?'
+  - Added 'Client#remove_user_from_group'
+
 2011-04-06 v0.0.4
-  - Added 'Confluence#add_group'
-  - Added 'Confluence#get_group'
-  - Added 'Confluence#remove_group'
+  - Added 'Client#add_group'
+  - Added 'Client#get_group'
+  - Added 'Client#remove_group'
 
 2011-04-04 v0.0.3
-  - Added 'Confluence#add_user'
-  - Added 'Confluence#get_user'
-  - Added 'Confluence#remove_user'
+  - Added 'Client#add_user'
+  - Added 'Client#get_user'
+  - Added 'Client#remove_user'
 
 2011-04-04 v0.0.2
-  - Added 'Confluence#add_space'
-  - Added 'Confluence#get_space'
-  - Added 'Confluence#remove_space'
+  - Added 'Client#add_space'
+  - Added 'Client#get_space'
+  - Added 'Client#remove_space'
   - Improved formatting of Confluence exception messages
 
 2011-04-01 v0.0.1

data/README.rdoc

@@ -65,6 +65,26 @@
         puts "unable to remove group: #{c.error}"
       end
       
+      ##########
+      # Groups #
+      ##########
+      if confluence.member?('stan', 'some:group')
+        if confluence.remove_user_from_group('stan', 'some:group')
+          puts 'removed user from group'
+        else
+          puts "unable to remove user from group: #{c.error}"
+        end
+      else
+        if confluence.add_user_to_group('stan', 'some:group')
+          puts 'added user to group'
+        else
+          puts "unable to add user to group: #{c.error}"
+        end
+      end
+     
+      ########## 
+      # Logout #
+      ########## 
       confluence.logout
     end
 

data/Rakefile

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

data/lib/confluence-client.rb

@@ -68,6 +68,26 @@ module Confluence # :nodoc:
   #         puts "unable to remove group: #{c.error}"
   #       end
   #       
+  #       ##########
+  #       # Groups #
+  #       ##########
+  #       if confluence.member?('stan', 'some:group')
+  #         if confluence.remove_user_from_group('stan', 'some:group')
+  #           puts 'removed user from group'
+  #         else
+  #           puts "unable to remove user from group: #{c.error}"
+  #         end
+  #       else
+  #         if confluence.add_user_to_group('stan', 'some:group')
+  #           puts 'added user to group'
+  #         else
+  #           puts "unable to add user to group: #{c.error}"
+  #         end
+  #       end
+  #      
+  #       ########## 
+  #       # Logout #
+  #       ########## 
   #       confluence.logout
   #     end
   #
@@ -108,6 +128,19 @@ module Confluence # :nodoc:
       return nil
     end
 
+    # Add user to group.  Returns boolean.
+    #
+    # Params:
+    # +user+:: User to add.
+    # +group:: Add user to this group.
+    def add_user_to_group(user, group)
+      if member?(user, group)
+        @error = 'already a member'
+        return false
+      end
+      addUserToGroup(user, group)
+    end
+
     # Create Confluence space.  Return space hash or nil.
     #
     # Params:
@@ -186,6 +219,15 @@ module Confluence # :nodoc:
       return ok?
     end
 
+    # Is user a member of this group?  Returns boolean.
+    #
+    # Params:
+    # +user+:: Check membership for this user.
+    # +group+:: Check for membership in this group.
+    def member?(user, group)
+      getUserGroups(user).include?(group)
+    end
+
     def method_missing(method_name, *args)
       unless @token
         @error = "not authenticated"
@@ -232,6 +274,19 @@ module Confluence # :nodoc:
       return removeUser(login)
     end
 
+    # Remove user from group.  Returns boolean.
+    #
+    # Params:
+    # +user+:: User to remove.
+    # +group+:: Remove user from this group.
+    def remove_user_from_group(user, group)
+      unless member?(user, group)
+        @error = 'not a member'
+        return false
+      end
+      removeUserFromGroup(user, group)
+    end
+
     # Make the Confluence exceptions more readable.
     #
     # Params:

data/lib/confluence-client/version.rb

@@ -1,5 +1,5 @@
 module Confluence
   class Client
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confluence-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-06 00:00:00.000000000 -05:00
+date: 2011-04-08 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156138740 !ruby/object:Gem::Requirement
+  requirement: &2157939440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2156138740
+  version_requirements: *2157939440
 description: Ruby client for the Confluence XML::RPC API
 email:
 - blair.christensen@gmail.com