qarioz-confluencer 0.6.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Secret Sauce Partners, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,135 @@
+= confluencer
+
+Easy to use, ActiveRecord-like classes to find spaces, pages and bookmarks as well as adding new ones and updating existing ones.
+It uses ruby's method missing to translate methods to Confluence XMLRPC API (v2) call.
+
+For Confluence XML RPC API documentation, please take a look at these links:  
+
+{Confluence XML-RPC and SOAP APIs}[https://developer.atlassian.com/display/CONFDEV/Confluence+XML-RPC+and+SOAP+APIs]  
+
+{Remote Confluence Data Objects}[https://developer.atlassian.com/display/CONFDEV/Remote+Confluence+Data+Objects]  
+
+{https://developer.atlassian.com/display/CONFDEV/Remote+Confluence+Methods}[https://developer.atlassian.com/display/CONFDEV/Remote+Confluence+Methods]  
+
+== Installation
+=== Install from rubygems
+    gem install qarioz-confluencer
+=== Build and install from source
+Clone the repository, build the gem, install the gem.
+
+    git clone git://github.com/qarioz/confluencer.git
+    cd confluencer
+    gem install jeweler log4r
+    gem build confluencer.gemspec
+    gem install qarioz-confluencer-0.6.0.gem
+=== Include in Gemfile
+Or if you are using Gemfile, add this to your Gemfile
+
+    gem 'qarioz-confluencer', :git => 'git://github.com/qarioz/confluencer.git'
+
+== Usage
+
+This is the usage example for confluencer
+
+    require 'confluencer'
+    begin
+      #login
+      client = Confluence::Client.new(url: "https://mywiki.atlassian.net/wiki/")
+      client.login("username", "password")
+      # no need to save resulting token; api handles it
+
+      # get all spaces
+      all_spaces = client.get_spaces
+      # => [{'url', 'name', 'key', 'type'}]
+
+      # get specific space
+      test_space = client.get_space( "TestSpace")
+      # => {'url', 'name', 'key', 'type', 'homepage'}
+
+      # create a new space
+      s = Confluence::Space.new
+      # => {}
+
+      # get pages from a space
+      ps = client.get_pages( "TestSpace")
+      # => [{ 'url', 'id', 'version', 'title', 'space', 'parentId', 'permissions'}]
+      page_id = ps[0]['id'] # => "8345678"
+      pidcl = page_id.class # => String
+
+      # get comments from a page
+      comments = client.get_comments( page_id)
+      # => [{ 'modifier', 'creator', 'content', 'title',
+      #       'parentId', 'id', 'pageId', 'modified', 'url', 'created'}]
+
+      # create a comment
+      new_comment = client.add_comment( {pageId: page_id, title: "ruby sez", content: "blah blah blah"})
+
+      # create a label for a page
+      label = client.add_label_by_name( "new-label", page_id)
+      # => true
+
+      #update a page
+      npage = client.store_page(
+          space: "TestSpace", title: "yapage29", content: "Here is the content, also from ruby")
+      # => {'id', 'current', 'content', 'title', 'version', 'modifier',
+      #     'url', 'homePage', 'creator', 'contentStatus', 'modified',
+      #     'created', 'space', 'parentId', 'permissions'}
+      # if "yapage29" exists, throws {Confluence::Error}Could not save or update record
+    rescue Exception => e
+      puts "error: " + e.to_s
+    end
+
+=== Troubleshooting
+==== SSL Problem
+
+If you get SSL Problem while using this gem on windows, follow the steps below to fix it.
+
+    Uncaught exception: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
+
+This assumes your have already installed the [Rails Installer](http://railsinstaller.org) for Windows.
+
+Download the ruby script to your *Desktop* folder from [https://gist.github.com/raw/867550/win_fetch_cacerts.rb](https://gist.github.com/raw/867550/win_fetch_cacerts.rb). Then in your command prompt, execute the ruby script:
+
+    ruby "%USERPROFILE%\Desktop\win_fetch_cacerts.rb"
+
+Or copy paste the script below:
+
+    require 'net/http'
+
+    # create a path to the file "C:\RailsInstaller\cacert.pem"
+    cacert_file = File.join(%w{c: RailsInstaller cacert.pem})
+
+    Net::HTTP.start("curl.haxx.se") do |http|
+      resp = http.get("/ca/cacert.pem")
+      if resp.code == "200"
+        open(cacert_file, "wb") { |file| file.write(resp.body) }
+        puts "\n\nA bundle of certificate authorities has been installed to"
+        puts "C:\\RailsInstaller\\cacert.pem\n"
+        puts "* Please set SSL_CERT_FILE in your current command prompt session with:"
+        puts "     set SSL_CERT_FILE=C:\\RailsInstaller\\cacert.pem"
+        puts "* To make this a permanent setting, add it to Environment Variables"
+        puts "  under Control Panel -> Advanced -> Environment Variables"
+      else
+        abort "\n\n>>>> A cacert.pem bundle could not be downloaded."
+      end
+    end
+
+Now make ruby aware of your certificate authority bundle by setting `SSL_CERT_FILE`. To set this in your current command prompt session, type:
+
+    set SSL_CERT_FILE=C:\RailsInstaller\cacert.pem
+
+To make this a permanent setting, add this in your [control panel](http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/environment_variables.mspx?mfr=true).
+
+==== The Manual Way (Boring)
+
+Download the `cacert.pem` file from [http://curl.haxx.se/ca/cacert.pem](http://curl.haxx.se/ca/cacert.pem). Save this file to `C:\RailsInstaller\cacert.pem`.
+
+Now make ruby aware of your certificate authority bundle by setting `SSL_CERT_FILE`. To set this in your current command prompt session, type:
+
+    set SSL_CERT_FILE=C:\RailsInstaller\cacert.pem
+
+To make this a permanent setting, add this in your [control panel](http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/environment_variables.mspx?mfr=true).
+
+== Copyright
+
+Copyright (c) 2010 Secret Sauce Partners, Inc. See LICENSE for details.

data/lib/confluence/attachment.rb

@@ -0,0 +1,36 @@
+module Confluence
+  class Attachment < Record
+    extend Findable
+
+    record_attr_accessor :id => :attachment_id
+    record_attr_accessor :pageId => :page_id
+    record_attr_accessor :fileName => :filename
+    record_attr_accessor :fileSize => :filesize
+    record_attr_accessor :contentType => :content_type
+    record_attr_accessor :title, :creator, :created, :url, :comment
+
+    attr_writer :data
+
+    def data
+      @data ||= client.getAttachmentData(page_id, filename, "0")
+    end
+
+    def store
+      # reinitialize attachment after storing it
+      initialize(client.addAttachment(page_id, self.to_hash, XMLRPC::Base64.new(@data)))
+
+      # return self
+      self
+    end
+
+    def remove
+      client.removeAttachment(page_id, filename)
+    end
+
+    def self.find_criteria(args)
+      if args.key? :page_id and args.key? :filename
+        self.new(client.getAttachment(args[:page_id], args[:filename], args[:version] || "0"))
+      end
+    end
+  end
+end

data/lib/confluence/blog_entry.rb

@@ -0,0 +1,30 @@
+module Confluence
+  class BlogEntry < Record
+    extend Findable
+
+    record_attr_accessor :id => :entry_id
+    record_attr_accessor :space
+    record_attr_accessor :title, :content
+    record_attr_accessor :publishDate
+    record_attr_accessor :url
+
+    def store
+      # reinitialize blog entry after storing it
+      initialize(client.storeBlogEntry(self.to_hash))
+    end
+
+    def remove
+      client.removePage(self.entry_id)
+    end
+
+    private
+
+    def self.find_criteria(args)
+      if args.key? :id
+        self.new(client.getBlogEntry(args[:id]))
+      elsif args.key? :space
+        client.getBlogEntries(args[:space]).collect { |summary| BlogEntry.find(:id => summary["id"]) }
+      end
+    end
+  end
+end

data/lib/confluence/bookmark.rb

@@ -0,0 +1,85 @@
+module Confluence
+  class Bookmark < Page
+    attr_accessor :bookmark_url, :description
+
+    BOOKMARK_REGEXP = /\{bookmark.*\}[^\{]*\{bookmark\}/
+    BOOKMARK_URL_REGEXP = /\{bookmark:url=([^\}]+)\}/
+    DESCRIPTION_REGEXP = /\{bookmark.*\}([^\{]*)\{bookmark\}/
+
+    def initialize(hash)
+      # set and delete bookmark_url and description coming from hash
+      @bookmark_url = hash.delete :bookmark_url
+      @description = hash.delete :description
+
+      # initialize page
+      super(hash)
+
+      if content
+        # if no bookmark_url from hash, initialize from content
+        unless @bookmark_url
+          @bookmark_url = content[BOOKMARK_URL_REGEXP, 1]
+          @description = content[DESCRIPTION_REGEXP, 1]
+        end
+
+        # remove {bookmark} macro from content
+        content.gsub!(BOOKMARK_REGEXP, "")
+      end
+    end
+
+    def [](attr)
+      case attr
+      when :bookmark_url
+        @bookmark_url
+      when :description
+        @description
+      else
+        super(attr)
+      end
+    end
+
+    def []=(attr, value)
+      case attr
+      when :bookmark_url
+        @bookmark_url = value
+      when :description
+        @description = value
+      else
+        super(attr, value)
+      end
+    end
+
+    def store(args = {})
+      # always set .bookmarks as the parent page
+      self.parent_id = Page.find(:space => space, :title => Space::BOOKMARKS_PAGE_TITLE).page_id
+
+      # continue with storing the page
+      super(args)
+    end
+
+    def to_hash
+      page_hash = super
+
+      page_hash["content"] << "\n" unless page_hash["content"].empty?
+      page_hash["content"] << bookmark_content
+
+      page_hash
+    end
+
+    private
+
+    def bookmark_content
+      "{bookmark:url=#{@bookmark_url}}#{@description}{bookmark}"
+    end
+
+    def self.find_criteria(args)
+      result = super(args) || begin
+      if args.key? :space
+        space = Space.find :key => args[:space]
+        space.bookmarks
+      end
+      end
+
+      result
+    end
+  end
+end

data/lib/confluence/client.rb

@@ -0,0 +1,145 @@
+require 'xmlrpc/client'
+
+# Module containing Confluence-related classes.
+module Confluence
+  # Originally confluence4r, available at: http://confluence.atlassian.com/display/DISC/Confluence4r
+
+  # A useful helper for running Confluence XML-RPC from Ruby. Takes care of
+  # adding the token to each method call (so you can call server.getSpaces()
+  # instead of server.getSpaces(token)).
+  #
+  # Usage:
+  #
+  # client = Confluence::Client.new(:url => "http://confluence.atlassian.com")
+  # client.login("user", "password")
+  # p client.getSpaces
+  #
+  class Client
+    PREFIX = "confluence2"
+    XMLRPC_SUFFIX = "/rpc/xmlrpc"
+
+    attr_reader :url, :username, :token
+
+    # Initializes a new client with the given arguments.
+    #
+    # ==== Parameters
+    # arguments<Hash>:: Described below.
+    #
+    # ==== Arguments
+    # :url    - The url of the Confluence instance. The trailing '/rpc/xmlrpc' path is optional.
+    # :token  - An existing session token to reuse.
+    #
+    def initialize(arguments = {})
+      @url = arguments[:url]
+      @token = arguments[:token]
+
+      Log4r::MDC.put('token', @token || 'nil')
+      log.info "initialized client (:url => #{@url}, :token => #{@token || 'nil'})"
+    end
+
+    # Returns true, if the client has a session token.
+    #
+    def has_token?
+      !@token.nil?
+    end
+
+    # Logs in and returns the newly acquired session token.
+    #
+    # ==== Parameters
+    # username<String>:: The username.
+    # password<String>:: The password.
+    #
+    def login(username, password)
+      handle_fault do
+        if @token = proxy.login(username, password)
+          Log4r::MDC.put('token', @token)
+          log.info "logged in as '#{username}' and acquired token."
+
+          @username = username
+          @password = password
+        end
+      end
+
+      @token
+    end
+
+    # Logs out and invalidates the session token.
+    #
+    def logout
+      handle_fault do
+        @token = nil if @token and result = proxy.logout(@token)
+        log.info "logged out"
+        Log4r::MDC.put('token', 'nil')
+        result
+      end
+    end
+
+    # Translates every call into XMLRPC calls.
+    #
+    def method_missing(method_name, *args)
+      handle_fault do
+        if args.empty?
+          log.debug "#{method_name}"
+        else
+          log.debug "#{method_name}(#{(args.collect {|a| a.inspect}).join(', ')})"
+        end
+
+        begin
+          method_name = camel_case_lower(method_name.to_s).to_sym if !(method_name.match(/[A-Z]/))
+          result = proxy.send(method_name, *([@token] + args))
+          log.debug(result.inspect)
+          result
+        rescue EOFError => e
+          log.warn "Could not complete XMLRPC call, retrying... Error: #{e.inspect}"
+          retry
+        end
+      end
+    end
+
+    private
+
+    # Returns the Confluence::Client logger.
+    def log
+      Log4r::Logger[Confluence::Client.to_s] || Log4r::Logger.root
+    end
+
+    # Returns the Confluence XMLRPC endpoint url.
+    #
+    def xmlrpc_url
+      unless @url[-11..-1] == XMLRPC_SUFFIX
+        @url + XMLRPC_SUFFIX
+      else
+        @url
+      end
+    end
+
+    # Returns the XMLRPC client proxy for the Confluence API v1.
+    #
+    def proxy
+      @proxy ||= XMLRPC::Client.new_from_uri(xmlrpc_url).proxy(PREFIX)
+    end
+
+    # Yields and translates any XMLRPC::FaultExceptions raised by Confluence to Confluence::Errors.
+    #
+    def handle_fault(&block)
+      begin
+        block.call
+      rescue XMLRPC::FaultException => e
+        log.warn message = e.faultString.rpartition(':').last.strip
+
+        case message
+        when /Transaction rolled back/
+          raise Confluence::Error, "Could not save or update record."
+        else
+          raise Confluence::Error, message
+        end
+      end
+    end
+
+    # Make camel case with lower first letter
+    def camel_case_lower(original_string)
+      original_string.split('_').inject([]){ |buffer,e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+    end
+
+  end
+end

data/lib/confluence/error.rb

@@ -0,0 +1,4 @@
+module Confluence
+  class Error < StandardError
+  end
+end

data/lib/confluence/findable.rb

@@ -0,0 +1,23 @@
+module Confluence
+  module Findable
+    # Finds records by the given criteria.
+    #
+    # ==== Parameters
+    # args<Hash>:: The search arguments.
+    def find(args)
+      if args.has_key?(:all) && !respond_to?(:find_all)
+        raise "Cannot find all #{self.class.name.downcase}s, find by criteria instead."
+      end
+
+      begin
+        case args
+        when :all
+          find_all
+        when Hash
+          find_criteria(args)
+        end
+      rescue Confluence::Error
+      end
+    end
+  end
+end

data/lib/confluence/page.rb

@@ -0,0 +1,160 @@
+module Confluence
+  class Page < Record
+    INVALID_TITLE_CHARS = ":@/\\|^#;[]{}<>"
+
+    class Details < Hash
+      REGEXP = /\{details:label=([^\}]+)\}([^\{}]*)\{details\}/m
+      PAIR_REGEXP = /([^:]+):([^\n]+)/m
+
+      attr_reader :label
+
+      def initialize(args)
+        @label = args[:label]
+
+        parse(args[:content])
+      end
+
+      def to_s
+        # details macro
+        content = "{details:label=#{label}}\n"
+
+        each_pair do |key, value|
+          content << "#{key}:#{value}\n"
+        end
+
+        # end of details macro
+        content << "{details}\n"
+      end
+
+      private
+
+      def parse(content)
+        if content && content =~ REGEXP
+          # match label and the key/value pairs
+          @label, pairs = content.match(REGEXP).captures
+
+          pairs.strip.lines.each do |line|
+            if line =~ PAIR_REGEXP
+              self[$1.to_sym] = $2.strip
+            end
+          end
+        end
+      end
+    end
+
+    class DetailsCollection < Hash
+      def initialize(content)
+        if content
+          content.gsub!(Details::REGEXP) do |content|
+            self[$1.to_sym] = Details.new(:content => content)
+            ""
+          end
+        end
+      end
+
+      def [](key)
+        super(key) or self[key] = Details.new(:label => key)
+      end
+
+      def to_s
+        values.join("\n")
+      end
+    end
+
+    extend Findable
+
+    record_attr_accessor :id => :page_id
+    record_attr_accessor :parentId => :parent_id
+    record_attr_accessor :space
+    record_attr_accessor :title, :creator, :modifier, :content
+    record_attr_accessor :created, :modified, :version
+    record_attr_accessor :url
+
+    attr_accessor :details
+
+    def initialize(hash)
+      super(hash)
+
+      @details = DetailsCollection.new(content)
+    end
+
+    def children(klass = self.class)
+      children = client.getChildren(page_id)
+      children.collect { |hash| klass.find(:id => hash["id"]) } if children
+    end
+
+    def attachments
+      attachments = client.getAttachments(page_id)
+      attachments.collect { |hash| Attachment.new(hash) } if attachments
+    end
+
+    def store(args = {})
+      unless self.version
+        # check for existing page by id or title
+        existing_page = if page_id
+                          Page.find :id => page_id
+                        else
+                          Page.find :space => space, :title => title
+                        end
+
+        # take page_id and version from existing page if available
+        if existing_page
+          if args[:recreate_if_exists]
+            # remove existing page
+            existing_page.remove
+          else
+            # update page with page_id and version info
+            self.page_id = existing_page.page_id
+            self.version = existing_page.version
+          end
+        end
+      end
+
+      # reinitialize page after storing it
+      initialize(client.storePage(self.to_hash))
+
+      # return self
+      self
+    end
+
+    def remove
+      client.removePage(page_id)
+    end
+
+    def add_attachment(filename, content_type, data = IO.read(filename), comment = "")
+      attachment = Attachment.new :pageId => page_id, :fileName => filename, :contentType => content_type, :comment => comment
+      attachment.data = data
+      attachment.store
+    end
+
+    def to_hash
+      # record hash
+      record_hash = super
+
+      # always include content in hash
+      record_hash["content"] ||= ""
+
+      # prepend details sections before content
+      record_hash["content"].insert(0, details.to_s)
+
+      # result
+      record_hash
+    end
+
+    private
+
+    def self.find_criteria(args)
+      if args.key? :id
+        self.new(client.getPage(args[:id]))
+      elsif args.key?(:space) && args.key?(:title)
+        self.new(client.getPage(args[:space], args[:title]))
+      end
+    end
+  end
+end
+
+class String
+  def to_page_title
+    self.delete(Confluence::Page::INVALID_TITLE_CHARS).strip
+  end
+end

data/lib/confluence/record.rb

@@ -0,0 +1,107 @@
+module Confluence
+  # Base class for working with Confluence records.
+  #
+  class Record
+    class << self
+      # The client used for Confluence API calls.
+      #
+      def client
+        raise "Confluence client is unavailable. Did you forget to use Confluence::Session.new?" unless @@client
+        @@client
+      end
+
+      # Sets the client.
+      #
+      def client=(value)
+        @@client = value
+      end
+
+      # Defines an attr_accessor for a Record attribute.
+      #
+      def record_attr_accessor(*args)
+        attributes = {}
+
+        # iterate through each argument
+        args.each do |arg|
+          attributes = case arg
+                       when Symbol
+                         { arg => arg }
+                       when Hash
+                         arg
+                       else
+                         break
+                       end
+
+          attributes.each_pair do |key, name|
+            class_eval %Q{
+              def #{name}
+                self[:#{key}]
+              end
+
+              def #{name}=(value)
+                self[:#{key}] = value
+              end
+              }
+          end
+        end
+      end
+    end
+
+    # Returns the the Confluence API client.
+    #
+    def client
+      Record.client
+    end
+
+    # Initializes a new record.
+    #
+    # ==== Parameters
+    # hash<Hash>:: A hash containing the attributes and its values. Keys can be Strings or Symbols.
+    def initialize(hash = {})
+      @attributes = {}
+
+      # iterate through each key/value pair and set attribute keyed by symbol
+      hash.each_pair do |key, value|
+        self[key.to_sym] = value
+      end
+    end
+
+    def [](attr)
+      @attributes[attr]
+    end
+
+    def []=(attr, value)
+      @attributes[attr] = value
+    end
+
+    # Returns the id of the record.
+    #
+    def record_id
+      self[:id]
+    end
+
+    # Retrieves the labels of the record.
+    #
+    def labels
+      @labels ||= client.getLabelsById(record_id).collect {|label| label["name"]}
+    end
+
+    # Sets the labels of the record.
+    #
+    def labels=(value)
+      removed_labels = labels - value
+      added_labels = value - labels
+
+      client.removeLabelByName(removed_labels.join(" "), record_id) unless removed_labels.empty?
+      client.addLabelByName(added_labels.join(" "), record_id) unless added_labels.empty?
+
+      @labels = value
+    end
+
+    def to_hash
+      hash = Hash.new
+      @attributes.each { |key, value| hash[key.to_s] = value }
+      hash
+    end
+  end
+end

data/lib/confluence/session.rb

@@ -0,0 +1,88 @@
+module Confluence
+  # Wraps a Confluence::Client and manages the lifetime of a session.
+  #
+  class Session
+    attr_reader :client
+
+    # Initializes a new session with the given arguments and sets it for other classes like Confluence::Page.
+    #
+    # If a block is given to initialize, initialize yields with the Confluence::Client and automatically logs out of the session afterwards.
+    # Otherwise Session#destroy should be called after finished.
+    #
+    # ==== Parameters
+    # arguments<Hash>:: Described below.
+    #
+    # ==== Arguments
+    # :url      - The url of the Confluence instance.
+    # :username - The username.
+    # :password - The password.
+    #
+    def initialize(arguments = {})
+      raise ArgumentError, "Required argument 'url' is missing." unless arguments.key? :url
+
+      @client = Confluence::Client.new(arguments)
+
+      unless @client.has_token?
+        raise ArgumentError, "Required argument 'username' is missing." unless arguments.key? :username
+        raise ArgumentError, "Required argument 'password' is missing." unless arguments.key? :password
+
+        @client.login(arguments[:username], arguments[:password])
+      end
+
+      # set client for records
+      Confluence::Record.client = @client
+
+      # yield if block was given and destroy afterwards
+      if block_given?
+        yield @client
+
+        self.destroy
+      end
+    end
+
+    # Returns the current session token.
+    #
+    def token
+      client.token if client
+    end
+
+    # Returns the currently logged in username.
+    #
+    def username
+      client.username if client
+    end
+
+    # Logs in and acquire a new token after destroying the previous session.
+    #
+    # ==== Parameters
+    # arguments<Hash>:: Described below.
+    #
+    # ==== Arguments
+    # :username - The username.
+    # :password - The password.
+    #
+    def login(arguments)
+      raise ArgumentError, "Required argument 'username' is missing." unless arguments.key? :username
+      raise ArgumentError, "Required argument 'password' is missing." unless arguments.key? :password
+
+      # log out first
+      client.logout if client
+
+      # log in with credentials
+      @client.login(arguments[:username], arguments[:password])
+    end
+
+    # Destroys the session by logging out and resets other classes like Confluence::Page.
+    #
+    def destroy
+      # invalidate the token
+      client.logout
+
+      # client is not valid anymore
+      @client = nil
+
+      # reset client for records
+      Confluence::Record.client = nil
+    end
+  end
+end

data/lib/confluence/space.rb

@@ -0,0 +1,59 @@
+module Confluence
+  # A Confluence space.
+  class Space < Record
+    extend Findable
+
+    BOOKMARKS_PAGE_TITLE = ".bookmarks"
+
+    record_attr_accessor :key, :name, :url, :description
+    record_attr_accessor :homePage => :homepage
+
+    def bookmark_page
+      @bookmark_page ||= Page.find :space => self.key, :title => BOOKMARKS_PAGE_TITLE
+    end
+
+    def bookmarks
+      @bookmarks ||= bookmark_page ? bookmark_page.children(Bookmark) : []
+    end
+
+    def blog_entries
+      client.getBlogEntries(self.key).collect {|summary| BlogEntry.new(client.getBlogEntry(summary["id"]))}
+    end
+
+    def find_page(args)
+      if args.key? :title
+        Page.find :space => self.key, :title => args[:title]
+      end
+    end
+
+    def get_page(args)
+      args[:parent_title] ||= "Home"
+
+      # check if page already exists
+      find_page(args) or begin
+      # page does not exist yet, create it
+      page = Confluence::Page.new :space => self.key, :title => args[:title]
+
+      # look for the parent by title, set parentId if found
+      if parent_page = find_page(:title => args[:parent_title])
+        page.parent_id = parent_page.page_id
+      end
+
+      # store the page
+      page.store
+    end
+  end
+
+  private
+
+  def self.find_all
+    client.getSpaces.collect { |summary| Space.find(:key => summary["key"]) }
+  end
+
+  def self.find_criteria(args)
+    if args.key? :key
+      Space.new(client.getSpace(args[:key]))
+    end
+  end
+end
+end

data/lib/confluence/user.rb

@@ -0,0 +1,19 @@
+module Confluence
+  class User < Record
+    extend Findable
+
+    record_attr_accessor :name, :fullname, :email, :url
+
+    private
+
+    def self.find_all
+      client.getActiveUsers(true).collect { |name| User.find :name => name }
+    end
+
+    def self.find_criteria(args)
+      if args.key? :name
+        User.new(client.getUser(args[:name]))
+      end
+    end
+  end
+end

data/lib/confluencer.rb

@@ -0,0 +1,23 @@
+# ensure that lib is in the load path
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'log4r'
+
+require 'confluence/error'
+
+require 'confluence/client'
+require 'confluence/session'
+
+require 'confluence/findable'
+require 'confluence/record'
+require 'confluence/user'
+require 'confluence/space'
+require 'confluence/page'
+require 'confluence/bookmark'
+require 'confluence/blog_entry'
+require 'confluence/attachment'
+
+module Confluencer
+  VERSION = "0.6.0"
+end

data/script/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+libs =  " -r irb/completion"
+
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/confluencer.rb'}"
+
+# load console_init
+libs <<  " -r #{File.dirname(__FILE__) + '/console_init.rb'}"
+
+puts "Loading confluencer..."
+exec "irb #{libs} --simple-prompt"

data/script/console_init.rb

@@ -0,0 +1,5 @@
+begin
+  # try to load awesome_print
+  require 'ap'
+rescue LoadError
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: qarioz-confluencer
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Secret Sauce Partners, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+description: ActiveRecord-like classes to access Confluence through XMLRPC.
+email: github@secretsaucepartners.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- script/console
+- script/console_init.rb
+- lib/confluencer.rb
+- lib/confluence/client.rb
+- lib/confluence/bookmark.rb
+- lib/confluence/error.rb
+- lib/confluence/page.rb
+- lib/confluence/space.rb
+- lib/confluence/blog_entry.rb
+- lib/confluence/attachment.rb
+- lib/confluence/record.rb
+- lib/confluence/user.rb
+- lib/confluence/findable.rb
+- lib/confluence/session.rb
+- LICENSE
+- README.rdoc
+homepage: http://github.com/sspinc/confluencer
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Useful classes to manage Confluence.
+test_files: []