confluencer 0.4.2 → 0.4.3

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/confluencer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabor Ratky"]
-  s.date = %q{2010-05-13}
+  s.date = %q{2010-05-14}
   s.description = %q{ActiveRecord-like classes to access Confluence through XMLRPC.}
   s.email = %q{rgabo@rgabostyle.com}
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "lib/confluence/record.rb",
      "lib/confluence/session.rb",
      "lib/confluence/space.rb",
+     "lib/confluence/user.rb",
      "lib/confluencer.rb",
      "script/console",
      "script/console_init.rb",
@@ -45,6 +46,7 @@ Gem::Specification.new do |s|
      "spec/confluence/record_spec.rb",
      "spec/confluence/session_spec.rb",
      "spec/confluence/space_spec.rb",
+     "spec/confluence/user_spec.rb",
      "spec/confluencer_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
      "spec/confluence/record_spec.rb",
      "spec/confluence/session_spec.rb",
      "spec/confluence/space_spec.rb",
+     "spec/confluence/user_spec.rb",
      "spec/confluencer_spec.rb",
      "spec/spec_helper.rb"
   ]

data/lib/confluence/bookmark.rb

@@ -2,13 +2,28 @@ 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
+      # 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)
@@ -40,11 +55,8 @@ module Confluence
     def to_hash
       page_hash = super
 
-      if page_hash.key? "content"
-        page_hash["content"] << "\n" << bookmark_content
-      else
-        page_hash["content"] = bookmark_content
-      end
+      page_hash["content"] << "\n" unless page_hash["content"].empty?
+      page_hash["content"] << bookmark_content
       
       page_hash
     end
@@ -58,7 +70,7 @@ module Confluence
     def self.find_criteria(args)
       result = super(args) || begin
         if args.key? :space
-          space = Space.find :space => args[:space]
+          space = Space.find :key => args[:space]
           space.bookmarks
         end
       end

data/lib/confluence/page.rb

@@ -1,10 +1,15 @@
 module Confluence
   class Page < Record
     class Details < Hash
+      REGEXP = /\{details:label=([^\}]+)\}([^\{}]*)\{details\}/m
+      PAIR_REGEXP = /([^:]+):([^\n]+)/m
+      
       attr_reader :label
       
-      def initialize(label)
-        @label = label
+      def initialize(args)
+        @label = args[:label]
+        
+        parse(args[:content])
       end
             
       def to_s
@@ -12,14 +17,48 @@ module Confluence
         content = "{details:label=#{label}}\n"
         
         each_pair do |key, value|
-          content << "#{key}=#{value}\n"
+          content << "#{key}:#{value}\n"
         end
         
         # end of details macro
-        content << "{details}"
+        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
@@ -29,26 +68,14 @@ module Confluence
     record_attr_accessor :created, :modified, :version
     record_attr_accessor :url
 
+    attr_accessor :details
+    
     def initialize(hash)
       super(hash)
 
-      @details = []
-    end
-    
-    def details(label = :all)
-      return @details if label == :all
-      
-      unless result = @details.find {|d| d.label == label}
-        @details << (result = Details.new(label))
-      end
-            
-      result
+      @details = DetailsCollection.new(content)
     end
-    
-    def details=(value)
-      @details = value
-    end
-    
+        
     def children(klass = self.class)
       children = client.getChildren(page_id)
       children.collect { |child| klass.find(:id => child["id"]) } if children
@@ -86,10 +113,10 @@ module Confluence
       record_hash = super
       
       # always include content in hash
-      record_hash['content'] ||= ''
+      record_hash["content"] ||= ""
       
       # prepend details sections before content
-      record_hash['content'].insert(0, details_content + "\n") if details_content
+      record_hash["content"].insert(0, details.to_s)
       
       # result
       record_hash
@@ -97,10 +124,6 @@ module Confluence
 
     private
     
-    def details_content
-      @details.join("\n") unless @details.empty?
-    end
-    
     def self.find_all
       raise ArgumentError, "Cannot find all pages, find by id or title instead."
     end

data/lib/confluence/space.rb

@@ -26,6 +26,24 @@ module Confluence
       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

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

@@ -11,6 +11,7 @@ require 'confluence/session'
 
 require 'confluence/findable'
 require 'confluence/record'
+require 'confluence/user'
 require 'confluence/space'
 require 'confluence/page'
 require 'confluence/bookmark'

data/spec/confluence/bookmark_spec.rb

@@ -1,6 +1,8 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
 describe Confluence::Bookmark do
+  include SessionHelperMethods
+  
   it "should initialize bookmark_url and description from hash" do
     bookmark = Confluence::Bookmark.new :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home'
     
@@ -8,6 +10,15 @@ describe Confluence::Bookmark do
     bookmark.description.should == 'Home sweet home'
   end
   
+  it "should initialize bookmark_url and descrition from content" do
+    bookmark = Confluence::Bookmark.new "content" => "{bookmark:url=http://github.com/rgabo/confluencer}Home sweet home{bookmark}"
+    
+    bookmark.bookmark_url.should == 'http://github.com/rgabo/confluencer'
+    bookmark.description.should == 'Home sweet home'
+    
+    bookmark.content.should_not include "bookmark"
+  end
+  
   it "should get and set bookmark_url and description using #[]" do
     bookmark = Confluence::Bookmark.new :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home'
 
@@ -32,4 +43,11 @@ describe Confluence::Bookmark do
     bookmark.to_hash.key?('description').should be_false
     bookmark.to_hash.key?('title').should be_true
   end
+  
+  it "should find bookmarks by space" do
+    new_session do
+      bookmarks = Confluence::Bookmark.find :space => "confluencer"
+      bookmarks.should_not be_empty
+    end
+  end
 end

data/spec/confluence/page_spec.rb

@@ -1,5 +1,50 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
 
+describe Confluence::Page::Details do
+  it "should initialize with a label" do
+    details = Confluence::Page::Details.new :label => :confluencer
+    details.label.should == :confluencer
+  end
+  
+  it "should return {details} macro" do
+    details = Confluence::Page::Details.new :label => :confluencer
+    details[:creator] = "rgabo"
+    
+    details.to_s.should == <<-DETAILS
+{details:label=confluencer}
+creator:rgabo
+{details}
+DETAILS
+  end
+  
+  it "should initialize with macro content" do
+    details = Confluence::Page::Details.new :content => <<-DETAILS
+{details:label=confluencer}
+creator:rgabo
+{details}
+DETAILS
+
+    details.label.should == "confluencer"
+    details[:creator].should == "rgabo"
+  end
+end
+
+describe Confluence::Page::DetailsCollection do
+  it "should scan content for details" do
+    hash = Confluence::Page::DetailsCollection.new <<-CONTENT
+{details:label=confluencer}
+creator:rgabo
+{details}
+
+{details:label=ruby}
+creator=matz
+{details}
+CONTENT
+
+    hash.should include(:confluencer)
+  end
+end
+
 describe Confluence::Page do
   include SessionHelperMethods
   
@@ -94,27 +139,34 @@ describe Confluence::Page do
     page = store_test_page
     
     # set :creator in {details:label=bender} to 'rgabo'
-    page.details(:confluencer)[:creator] = 'rgabo'
+    page.details[:confluencer][:creator] = 'rgabo'
   
-    page.details(:confluencer)[:creator].should == 'rgabo'
+    page.details[:confluencer][:creator].should == 'rgabo'
   end
   
   it "should include metadata in content of the page" do
     page = store_test_page
 
     # set :creator in {details:label=bender} to 'rgabo'
-    page.details(:confluencer)[:creator] = 'rgabo'
+    page.details[:confluencer][:creator] = 'rgabo'
           
-    page.to_hash['content'].should include("{details:label=confluencer}\ncreator=rgabo\n{details}")
+    page.to_hash['content'].should include("{details:label=confluencer}\ncreator:rgabo\n{details}")
   end
   
   it "should copy metadata from one page to another" do
     page = create_test_page
-    page.details(:confluencer)[:creator] = 'rgabo'
+    page.details[:confluencer][:creator] = 'rgabo'
     
     new_page = create_test_page
     new_page.details = page.details
     
-    new_page.details(:confluencer)[:creator].should == 'rgabo'
+    new_page.details[:confluencer][:creator].should == 'rgabo'
+  end
+  
+  it "should parse metadata from content" do
+    page = Confluence::Page.new "content" => "{details:label=confluencer}\ncreator:rgabo\n{details}\nh3. Some other content"
+    
+    page.details[:confluencer][:creator].should == "rgabo"
   end
 end
+

data/spec/confluence/space_spec.rb

@@ -46,4 +46,17 @@ describe Confluence::Space do
       bookmark.remove
     end
   end
+  
+  it "should get a page and create if it does not exist" do
+    new_session do
+      # get page with random name
+      random_page = test_space.get_page :title => "RandomPage #{rand(10000)}"
+      
+      random_page.should_not be_nil
+      random_page.space == test_space.key
+      
+      # remove random_page afterwards
+      random_page.remove
+    end
+  end
 end

data/spec/confluence/user_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Confluence::User do
+  include SessionHelperMethods
+  
+  it "should find all users" do
+    new_session do
+      users = Confluence::User.find :all
+      users.should_not be_empty
+    end
+  end
+  
+  it "should find a user by its name" do
+    new_session do
+      # find all users
+      users = Confluence::User.find :all
+      
+      # find first user by name
+      first_user = Confluence::User.find :name => users.first.name
+      
+      first_user.name.should == users.first.name
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 +02:00
+date: 2010-05-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - lib/confluence/record.rb
 - lib/confluence/session.rb
 - lib/confluence/space.rb
+- lib/confluence/user.rb
 - lib/confluencer.rb
 - script/console
 - script/console_init.rb
@@ -83,6 +84,7 @@ files:
 - spec/confluence/record_spec.rb
 - spec/confluence/session_spec.rb
 - spec/confluence/space_spec.rb
+- spec/confluence/user_spec.rb
 - spec/confluencer_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -123,5 +125,6 @@ test_files:
 - spec/confluence/record_spec.rb
 - spec/confluence/session_spec.rb
 - spec/confluence/space_spec.rb
+- spec/confluence/user_spec.rb
 - spec/confluencer_spec.rb
 - spec/spec_helper.rb