confluencer 0.2.8 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.3.0

data/confluencer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.2.8"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabor Ratky"]
@@ -30,9 +30,11 @@ Gem::Specification.new do |s|
      "lib/confluence/bookmark.rb",
      "lib/confluence/client.rb",
      "lib/confluence/error.rb",
+     "lib/confluence/findable.rb",
      "lib/confluence/page.rb",
      "lib/confluence/record.rb",
      "lib/confluence/session.rb",
+     "lib/confluence/space.rb",
      "lib/confluencer.rb",
      "script/console",
      "script/console_init.rb",
@@ -42,6 +44,7 @@ Gem::Specification.new do |s|
      "spec/confluence/page_spec.rb",
      "spec/confluence/record_spec.rb",
      "spec/confluence/session_spec.rb",
+     "spec/confluence/space_spec.rb",
      "spec/confluencer_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -57,6 +60,7 @@ Gem::Specification.new do |s|
      "spec/confluence/page_spec.rb",
      "spec/confluence/record_spec.rb",
      "spec/confluence/session_spec.rb",
+     "spec/confluence/space_spec.rb",
      "spec/confluencer_spec.rb",
      "spec/spec_helper.rb"
   ]

data/lib/confluence/blog_entry.rb

@@ -1,17 +1,23 @@
 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 self.find_by_id(entryid)
-      self.new(client.getBlogEntries(entryid))
+    private
+    
+    def self.find_all
+      raise ArgumentError, "Cannot find all blog entries, find by id or title instead."
     end
     
-    def self.find_by_space(spacekey)
-      client.getBlogEntries(spacekey).collect {|summary| BlogEntry.new(client.getBlogEntry(summary["id"]))}
+    def self.find_criteria(args)
+      if args.key? :id
+        self.new(client.getBlogEntries(args[:id]))
+      end
     end
   end
 end

data/lib/confluence/bookmark.rb

@@ -1,7 +1,5 @@
 module Confluence
   class Bookmark < Page
-    BOOKMARKS_PAGE_TITLE = ".bookmarks"
-
     attr_reader :bookmark_url, :description
 
     def initialize(hash)
@@ -34,22 +32,25 @@ module Confluence
     
     def store
       # always set .bookmarks as the parent page
-      self.parent_id = Page.find_by_title(space, BOOKMARKS_PAGE_TITLE).page_id
+      self.parent_id = Page.find(:space => space, :title => Space::BOOKMARKS_PAGE_TITLE).page_id
       
       # continue with storing the page
       super
     end
     
-    def self.find_by_space(spacekey)
-      # get the .bookmarks page for the space
-      bookmarks_page = Page.find_by_title(spacekey, BOOKMARKS_PAGE_TITLE)
+    private
+    
+    def self.find_criteria(args)
+      result = super(args) || begin
+        if args.key? :space
+          space = Space.find :space => args[:space]
+          space.bookmarks
+        end
+      end
       
-      # map each page to a Bookmark
-      bookmarks_page.children.collect {|page| Bookmark.new(page.attributes)}
+      result
     end
     
-    private
-    
     def update_content
       self.content = "{bookmark:url=#{@bookmark_url}}#{@description}{bookmark}"
     end

data/lib/confluence/client.rb

@@ -81,7 +81,7 @@ module Confluence
 		    if args.empty?
   		    log.debug "#{method_name}"
 		    else
-		      log.debug "#{method_name}(#{args.join(', ')})"
+		      log.debug "#{method_name}(#{(args.collect {|a| a.inspect}).join(', ')})"
 	      end
  		    result = proxy.send(method_name, *([@token] + args))
  		    log.debug(result.inspect)

data/lib/confluence/findable.rb

@@ -0,0 +1,17 @@
+module Confluence
+  module Findable
+    # Finds records by the given criteria.
+    #
+    # ==== Parameters
+    # args<Hash>:: The search arguments.
+    def find(args)
+      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

@@ -1,5 +1,7 @@
 module Confluence
   class Page < Record
+    extend Findable
+    
     record_attr_accessor :id => :page_id
     record_attr_accessor :parentId => :parent_id
     record_attr_accessor :space
@@ -7,18 +9,18 @@ module Confluence
     record_attr_accessor :created, :modified, :version
     record_attr_accessor :url
         
-    def children
+    def children(klass = self.class)
       children = client.getChildren(page_id)
-      children.collect { |child| Page.find_by_id(child["id"]) } if children
+      children.collect { |child| klass.find(:id => child["id"]) } if children
     end
     
     def store
       unless self.version
         # check for existing page by id or title
         existing_page = if page_id
-          Page.find_by_id(page_id)
+          Page.find :id => page_id
         else
-          Page.find_by_title(space, title)
+          Page.find :space => space, :title => title
         end
         
         # take page_id and version from existing page if available
@@ -38,18 +40,18 @@ module Confluence
     def remove
       client.removePage(page_id)
     end
-        
-    def self.find_by_id(page_id)
-      begin
-        self.new(client.getPage(page_id))
-      rescue Confluence::Error
-      end
+    
+    private
+    
+    def self.find_all
+      raise ArgumentError, "Cannot find all pages, find by id or title instead."
     end
     
-    def self.find_by_title(space, title)
-      begin
-        self.new(client.getPage(space, title))
-      rescue Confluence::Error
+    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

data/lib/confluence/record.rb

@@ -1,15 +1,23 @@
 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 = {}
         
@@ -38,6 +46,10 @@ module Confluence
 
     attr_accessor :attributes
     
+    # 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 = {}
 
@@ -46,7 +58,7 @@ module Confluence
         self[key.to_sym] = value
       end
     end
-        
+    
     def [](attr)
       @attributes[attr]
     end
@@ -54,7 +66,9 @@ module Confluence
     def []=(attr, value)
       @attributes[attr] = value
     end
-    
+
+    # Returns the id of the record.
+    #
     def record_id
       self[:id]
     end
@@ -73,6 +87,8 @@ module Confluence
       @labels = value
     end
     
+    private
+    
     def client
       Record.client
     end

data/lib/confluence/space.rb

@@ -0,0 +1,41 @@
+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
+      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
+    
+    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/confluencer.rb

@@ -9,7 +9,9 @@ require 'confluence/error'
 require 'confluence/client'
 require 'confluence/session'
 
+require 'confluence/findable'
 require 'confluence/record'
+require 'confluence/space'
 require 'confluence/page'
 require 'confluence/bookmark'
 require 'confluence/blog_entry'

data/spec/confluence/page_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
-module PageHelperMethods
+describe Confluence::Page do
   include SessionHelperMethods
   
   def create_test_page(content = "foobar")
@@ -12,16 +12,12 @@ module PageHelperMethods
       return create_test_page.store
     end
   end
-end
-
-describe Confluence::Page do
-  include PageHelperMethods
   
   after :each do
     new_session do
       begin
         # check whether we need to remove the test page
-          test_page = Confluence::Page.find_by_title config[:space], config[:page_title]
+          test_page = Confluence::Page.find :space => config[:space], :title => config[:page_title]
         test_page.remove if test_page
       rescue Confluence::Error
       end
@@ -31,7 +27,7 @@ describe Confluence::Page do
   it "should add a new page in Confluence" do
     page = nil
     
-    new_session do |client|
+    new_session do
       # initialize test page
       page = create_test_page
       
@@ -48,7 +44,7 @@ describe Confluence::Page do
     # initialize new session
     new_session do
       # find page by id
-      new_page = Confluence::Page.find_by_id page.page_id
+      new_page = Confluence::Page.find :id => page.page_id
       
       # assert page
       new_page.should_not be_nil

data/spec/confluence/space_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Confluence::Space do
+  include SessionHelperMethods
+
+  def test_space
+    @test_space ||= Confluence::Space.find(:key => config[:space])
+  end
+  
+  it "should find all spaces" do
+    new_session do
+      spaces = Confluence::Space.find(:all)
+    
+      spaces.should_not be_empty
+    end
+  end
+  
+  it "should find a space by its key" do
+    new_session do
+      space = Confluence::Space.find(:key => config[:space])
+      
+      space.should_not be_nil
+      space.key.should == config[:space]
+    end
+  end
+  
+  it "should find a page in the space" do
+    new_session do
+      page = test_space.find_page :title => "Home"
+      
+      page.should_not be_nil
+      page.space.should == test_space.key
+    end
+  end
+  
+  it "should return all bookmarks in the space" do
+    new_session do
+      # create a bookmark in the test_space
+      bookmark = Confluence::Bookmark.new :space => test_space.key, :title => "Atlassian", :bookmark_url => "http://atlassian.com"
+      bookmark.store
+      
+      bookmarks = test_space.bookmarks
+      bookmarks.should_not be_empty
+
+      # delete test bookmark
+      bookmark.remove
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 8
-  version: 0.2.8
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -54,9 +54,11 @@ files:
 - lib/confluence/bookmark.rb
 - lib/confluence/client.rb
 - lib/confluence/error.rb
+- lib/confluence/findable.rb
 - lib/confluence/page.rb
 - lib/confluence/record.rb
 - lib/confluence/session.rb
+- lib/confluence/space.rb
 - lib/confluencer.rb
 - script/console
 - script/console_init.rb
@@ -66,6 +68,7 @@ files:
 - spec/confluence/page_spec.rb
 - spec/confluence/record_spec.rb
 - spec/confluence/session_spec.rb
+- spec/confluence/space_spec.rb
 - spec/confluencer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -105,5 +108,6 @@ test_files:
 - spec/confluence/page_spec.rb
 - spec/confluence/record_spec.rb
 - spec/confluence/session_spec.rb
+- spec/confluence/space_spec.rb
 - spec/confluencer_spec.rb
 - spec/spec_helper.rb