confluence-client 0.0.1 → 0.0.2

data/HISTORY

@@ -1,3 +1,9 @@
+2011-04-04 v0.0.2
+  - Added 'Confluence#add_space'
+  - Added 'Confluence#get_space'
+  - Added 'Confluence#remove_space'
+  - Improved formatting of Confluence exception messages
+
 2011-04-01 v0.0.1
   - Initial prototype release.
 

data/README.rdoc

@@ -4,10 +4,33 @@
 
   Confluence::Client.new(url) do |confluence|
     
-    # Login
-    confluence.login(user, pass)
-    
-    # Logout
-    confluence.logout
-    
+    if confluence.login(user, pass)
+      
+      # Was last API call successful?
+      confluence.ok?
+
+      # Print error message if error on last API call.
+      puts confluence.error if confluence.error?
+      
+      space = confluence.get_space('foo')
+      if space
+        puts "found space: #{space.inspect}"
+      else
+        space = confluence.add_space( 'foo', 'space name', 'space description' )
+        if space
+          puts "created space: #{space.inspect}"
+        else
+          puts "unable to create space: #{c.error}"
+        end
+      end
+      
+      if confluence.remove_space('foo')
+        puts 'removed space'
+      else
+        puts "unable to remove space: #{c.error}"
+      end
+      
+      confluence.logout
+    end
+
   end 

data/lib/confluence-client/version.rb

@@ -1,5 +1,5 @@
 module Confluence
   class Client
-    VERSION = "0.0.1"
+    VERSION = '0.0.2'
   end
 end

data/lib/confluence-client.rb

@@ -7,12 +7,35 @@ module Confluence # :nodoc:
   #
   #   Confluence::Client.new(url) do |confluence|
   #     
-  #     # Login
-  #     confluence.login(user, pass)
-  #     
-  #     # Logout
-  #     confluence.logout
-  #     
+  #     if confluence.login(user, pass)
+  #       
+  #       # Was last API call successful?
+  #       confluence.ok?
+  #
+  #       # Print error message if error on last API call.
+  #       puts confluence.error if confluence.error?
+  #       
+  #       space = confluence.get_space('foo')
+  #       if space
+  #         puts "found space: #{space.inspect}"
+  #       else
+  #         space = confluence.add_space( 'foo', 'space name', 'space description' )
+  #         if space
+  #           puts "created space: #{space.inspect}"
+  #         else
+  #           puts "unable to create space: #{c.error}"
+  #         end
+  #       end
+  #       
+  #       if confluence.remove_space('foo')
+  #         puts 'removed space'
+  #       else
+  #         puts "unable to remove space: #{c.error}"
+  #       end
+  #       
+  #       confluence.logout
+  #     end
+  #
   #   end 
   class Client
 
@@ -40,11 +63,33 @@ module Confluence # :nodoc:
       yield self if block_given?
     end
 
+    # Create Confluence space.  Returns space or nil.
+    #
+    # Params:
+    # +key+:: Key for space.
+    # +name+:: Name of space.
+    # +description+:: Description for space.
+    def add_space(key, name, description)
+      space = addSpace( { 'key' => key, 'name' => name, 'description' => description } )
+      return space if ok?
+      nil 
+    end
+
     # Was there an error on the last request?
     def error?
       !ok?
     end
 
+    # Return Confluence space or nil.
+    #
+    # Params:
+    # +key+:: Confluence key for space.
+    def get_space(key)
+      space = getSpace(key)
+      return space if ok?
+      nil
+    end
+
     # Login to the Confluence XML/RPC API.
     def login(user, password)
       raise ArgumentError if user.nil? || password.nil?
@@ -53,9 +98,9 @@ module Confluence # :nodoc:
         @token  = @confluence.login(@user, @password)
         @error  = nil
       rescue XMLRPC::FaultException => e
-        @error = e.faultString
+        @error = tidy_exception( e.faultString )
       rescue => e
-        @error = e.message
+        @error = tidy_exception( e.message )
       end
       return ok?
     end
@@ -69,9 +114,9 @@ module Confluence # :nodoc:
         @error = nil
         return @confluence.send( method_name, *( [@token] + args ) )  
       rescue XMLRPC::FaultException => e
-        @error = e.faultString
+        @error = tidy_exception( e.faultString )
       rescue Exception => e
-        @error = e.message
+        @error = tidy_exception( e.message )
       end
       return ok?
     end
@@ -81,6 +126,22 @@ module Confluence # :nodoc:
       @error.nil?
     end
 
+    # Remove Confluence space.  Returns boolean.
+    #
+    # Params:
+    # +key+:: Confluence key for space to remove.
+    def remove_space(key)
+      return removeSpace(key)
+    end
+
+    # Make the Confluence exceptions more readable.
+    #
+    # Params:
+    # +txt+:: Exception text to clean up.
+    def tidy_exception(txt)
+      txt.gsub!( /^java.lang.Exception: com.atlassian.confluence.rpc.RemoteException:\s+/, '' )
+    end
+
   end # class Client
 end # module Confluence
 

metadata

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