confluence-client 0.0.2 → 0.0.3

data/HISTORY

@@ -1,3 +1,8 @@
+2011-04-04 v0.0.3
+  - Added 'Confluence#add_user'
+  - Added 'Confluence#get_user'
+  - Added 'Confluence#remove_user'
+
 2011-04-04 v0.0.2
   - Added 'Confluence#add_space'
   - Added 'Confluence#get_space'

data/README.rdoc

@@ -30,6 +30,19 @@
         puts "unable to remove space: #{c.error}"
       end
       
+      user = confluence.get_user('stan')
+      if user
+        puts "found user: #{user.inspect}"
+      else
+        user = confluence.add_user( 'stan', 'stan has a name', 'stan@example.com' )       
+      end
+      
+      if confluence.remove_user('stan')
+        puts 'removed user'
+      else
+        puts "unable to remove user: #{c.error}"
+      end
+      
       confluence.logout
     end
 

data/lib/confluence-client.rb

@@ -33,6 +33,19 @@ module Confluence # :nodoc:
   #         puts "unable to remove space: #{c.error}"
   #       end
   #       
+  #       user = confluence.get_user('stan')
+  #       if user
+  #         puts "found user: #{user.inspect}"
+  #       else
+  #         user = confluence.add_user( 'stan', 'stan has a name', 'stan@example.com' )       
+  #       end
+  #       
+  #       if confluence.remove_user('stan')
+  #         puts 'removed user'
+  #       else
+  #         puts "unable to remove user: #{c.error}"
+  #       end
+  #       
   #       confluence.logout
   #     end
   #
@@ -63,7 +76,7 @@ module Confluence # :nodoc:
       yield self if block_given?
     end
 
-    # Create Confluence space.  Returns space or nil.
+    # Create Confluence space.  Return space hash or nil.
     #
     # Params:
     # +key+:: Key for space.
@@ -75,21 +88,44 @@ module Confluence # :nodoc:
       nil 
     end
 
+    # Create Confluence user.  Return user hash or nil.
+    #
+    # Params:
+    # +login+:: User login.
+    # +name+:: User name.
+    # +email+:: User email.
+    # +password+:: User password. Defaults to +Time.now.to_i.to_s+.
+    def add_user(login, name, email, password = nil )
+      addUser( { 'email' => email, 'fullname' => name, 'name' => login }, password || Time.now.to_i.to_s )
+      return get_user(login) if ok?
+      nil
+    end
+
     # Was there an error on the last request?
     def error?
       !ok?
     end
 
-    # Return Confluence space or nil.
+    # Return Confluence space hash or nil.
     #
     # Params:
-    # +key+:: Confluence key for space.
+    # +key+:: Fetch this space.
     def get_space(key)
       space = getSpace(key)
       return space if ok?
       nil
     end
 
+    # Return Confluence user hash or nil.
+    #
+    # Params:
+    # +login+:: Fetch this user.
+    def get_user(login)
+      user = getUser(login)
+      return user if ok?
+      nil
+    end
+
     # Login to the Confluence XML/RPC API.
     def login(user, password)
       raise ArgumentError if user.nil? || password.nil?
@@ -134,6 +170,14 @@ module Confluence # :nodoc:
       return removeSpace(key)
     end
 
+    # Remove Confluence user.  Returns boolean.
+    #
+    # Params:
+    # +login+:: Remove this user.
+    def remove_user(login)
+      return removeUser(login)
+    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.2'
+    VERSION = '0.0.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confluence-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2158439060 !ruby/object:Gem::Requirement
+  requirement: &2154665360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2158439060
+  version_requirements: *2154665360
 description: Ruby client for the Confluence XML::RPC API
 email:
 - blair.christensen@gmail.com