confluence-client 0.0.3 → 0.0.4

data/HISTORY

@@ -1,3 +1,8 @@
+2011-04-06 v0.0.4
+  - Added 'Confluence#add_group'
+  - Added 'Confluence#get_group'
+  - Added 'Confluence#remove_group'
+
 2011-04-04 v0.0.3
   - Added 'Confluence#add_user'
   - Added 'Confluence#get_user'

data/README.rdoc

@@ -12,6 +12,9 @@
       # Print error message if error on last API call.
       puts confluence.error if confluence.error?
       
+      ##########
+      # Spaces #
+      ##########
       space = confluence.get_space('foo')
       if space
         puts "found space: #{space.inspect}"
@@ -30,6 +33,9 @@
         puts "unable to remove space: #{c.error}"
       end
       
+      #########
+      # Users #
+      #########
       user = confluence.get_user('stan')
       if user
         puts "found user: #{user.inspect}"
@@ -43,6 +49,22 @@
         puts "unable to remove user: #{c.error}"
       end
       
+      #########
+      # Users #
+      #########
+      group = confluence.get_group('some:group')
+      if group
+        puts "found group: #{group.inspect}"
+      else
+        group = confluence.add_group('some:group')
+      end
+
+      if confluence.remove_group('some:group')
+        puts 'removed group'
+      else
+        puts "unable to remove group: #{c.error}"
+      end
+      
       confluence.logout
     end
 

data/lib/confluence-client.rb

@@ -15,6 +15,9 @@ module Confluence # :nodoc:
   #       # Print error message if error on last API call.
   #       puts confluence.error if confluence.error?
   #       
+  #       ##########
+  #       # Spaces #
+  #       ##########
   #       space = confluence.get_space('foo')
   #       if space
   #         puts "found space: #{space.inspect}"
@@ -33,6 +36,9 @@ module Confluence # :nodoc:
   #         puts "unable to remove space: #{c.error}"
   #       end
   #       
+  #       #########
+  #       # Users #
+  #       #########
   #       user = confluence.get_user('stan')
   #       if user
   #         puts "found user: #{user.inspect}"
@@ -46,6 +52,22 @@ module Confluence # :nodoc:
   #         puts "unable to remove user: #{c.error}"
   #       end
   #       
+  #       #########
+  #       # Users #
+  #       #########
+  #       group = confluence.get_group('some:group')
+  #       if group
+  #         puts "found group: #{group.inspect}"
+  #       else
+  #         group = confluence.add_group('some:group')
+  #       end
+  #
+  #       if confluence.remove_group('some:group')
+  #         puts 'removed group'
+  #       else
+  #         puts "unable to remove group: #{c.error}"
+  #       end
+  #       
   #       confluence.logout
   #     end
   #
@@ -76,6 +98,16 @@ module Confluence # :nodoc:
       yield self if block_given?
     end
 
+    # Create Confluence group.  Returns group hash or nil.
+    #
+    # Params:
+    # +name+:: Group name.
+    def add_group(name)
+      addGroup(name)
+      return { 'name' => name } if ok?
+      return nil
+    end
+
     # Create Confluence space.  Return space hash or nil.
     #
     # Params:
@@ -106,6 +138,19 @@ module Confluence # :nodoc:
       !ok?
     end
 
+    # Return Confluence group hash or nil.
+    #
+    # Params:
+    # +name+:: Group name.
+    def get_group(name)
+      groups = getGroups
+      if ok?
+        return { 'name' => name } if groups.include?(name)
+        @error = 'group not found'
+      end
+      nil
+    end
+
     # Return Confluence space hash or nil.
     #
     # Params:
@@ -162,6 +207,15 @@ module Confluence # :nodoc:
       @error.nil?
     end
 
+    # Remove Confluence group.  Returns boolean.
+    #
+    # Params:
+    # +name+:: Remove group with this name.
+    # +default_group+:: If specified, members of +name+ will be added to this group. Defaults to +''+.
+    def remove_group(name, default_group='')
+      return removeGroup( name, default_group )
+    end
+
     # Remove Confluence space.  Returns boolean.
     #
     # Params:

data/lib/confluence-client/version.rb

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

metadata

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