confluencer 0.4.7 → 0.4.8

data/Rakefile

@@ -29,6 +29,7 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts = ['--text-report', '--include-file lib/confluence/', '--exclude app,config,gems,lib,src,spec']
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.4.7
+0.4.8

data/confluencer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.4.7"
+  s.version = "0.4.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabor Ratky"]
-  s.date = %q{2010-05-17}
+  s.date = %q{2010-05-20}
   s.description = %q{ActiveRecord-like classes to access Confluence through XMLRPC.}
   s.email = %q{rgabo@rgabostyle.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "confluencer.gems",
      "confluencer.gemspec",
+     "lib/confluence/attachment.rb",
      "lib/confluence/blog_entry.rb",
      "lib/confluence/bookmark.rb",
      "lib/confluence/client.rb",
@@ -40,6 +41,7 @@ Gem::Specification.new do |s|
      "script/console",
      "script/console_init.rb",
      "spec/confluence.yaml.example",
+     "spec/confluence/attachment_spec.rb",
      "spec/confluence/bookmark_spec.rb",
      "spec/confluence/client_spec.rb",
      "spec/confluence/page_spec.rb",
@@ -57,7 +59,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Useful classes to manage Confluence.}
   s.test_files = [
-    "spec/confluence/bookmark_spec.rb",
+    "spec/confluence/attachment_spec.rb",
+     "spec/confluence/bookmark_spec.rb",
      "spec/confluence/client_spec.rb",
      "spec/confluence/page_spec.rb",
      "spec/confluence/record_spec.rb",

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

@@ -9,11 +9,7 @@ module Confluence
     record_attr_accessor :url
   
     private
-    
-    def self.find_all
-      raise ArgumentError, "Cannot find all blog entries, find by id or title instead."
-    end
-    
+        
     def self.find_criteria(args)
       if args.key? :id
         self.new(client.getBlogEntries(args[:id]))

data/lib/confluence/findable.rb

@@ -7,7 +7,10 @@ module Confluence
     def find(args)
       begin
         case args
-        when :all: find_all
+        when :all: begin
+          raise "Cannot find all #{self.class.name.downcase}s, find by criteria instead." unless respond_to? :find_all
+          find_all
+        end
         when Hash: find_criteria(args)
         end
       rescue Confluence::Error

data/lib/confluence/page.rb

@@ -80,7 +80,12 @@ module Confluence
         
     def children(klass = self.class)
       children = client.getChildren(page_id)
-      children.collect { |child| klass.find(:id => child["id"]) } if children
+      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 = {})
@@ -115,6 +120,12 @@ module Confluence
     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
@@ -132,10 +143,6 @@ module Confluence
 
     private
     
-    def self.find_all
-      raise ArgumentError, "Cannot find all pages, find by id or title instead."
-    end
-    
     def self.find_criteria(args)
       if args.key? :id
         self.new(client.getPage(args[:id]))

data/lib/confluencer.rb

@@ -16,7 +16,8 @@ require 'confluence/space'
 require 'confluence/page'
 require 'confluence/bookmark'
 require 'confluence/blog_entry'
+require 'confluence/attachment'
 
 module Confluencer
-  VERSION = "0.2.7"
+  VERSION = "0.4.8"
 end

data/spec/confluence/attachment_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Confluence::Attachment do
+  include PageHelperMethods
+
+  FILENAME = File.basename(__FILE__)
+  
+  it "should store an attachment" do
+    with_test_page do |page|
+      attachment = Confluence::Attachment.new :pageId => page.page_id, :fileName => FILENAME, :contentType => "text/plain", :comment => "Test upload"
+      attachment.data = IO.read(__FILE__)
+      attachment.store
+      
+      attachment.attachment_id.should_not be_nil
+      attachment.filesize.should_not be_nil
+      attachment.url.should_not be_nil
+    end
+  end
+  
+  it "should find an attachment and get its data" do
+    with_test_page do |page|
+      attachment = Confluence::Attachment.new :pageId => page.page_id, :fileName => FILENAME, :contentType => "text/plain", :comment => "Test upload"
+      attachment.data = IO.read(__FILE__)
+      attachment.store
+
+      attachment = Confluence::Attachment.find :page_id => page.page_id, :filename => FILENAME
+      attachment.should_not be_nil
+      attachment.filename.should == FILENAME
+      attachment.data.should == IO.read(__FILE__)
+    end    
+  end
+  
+  it "should remove an attachment" do
+    with_test_page do |page|
+      attachment = Confluence::Attachment.new :pageId => page.page_id, :fileName => FILENAME, :contentType => "text/plain", :comment => "Test upload"
+      attachment.data = IO.read(__FILE__)
+      attachment.store
+      
+      # remove attachment
+      attachment.remove
+      
+      # should not be able to find attachment
+      Confluence::Attachment.find(:page_id => page.page_id, :filename => FILENAME).should be_nil
+    end
+  end
+end

data/spec/confluence/bookmark_spec.rb

@@ -46,8 +46,16 @@ describe Confluence::Bookmark do
   
   it "should find bookmarks by space" do
     new_session do
+      # add a test bookmark to the confluencer space
+      bookmark = Confluence::Bookmark.new :space => "confluencer", :bookmark_url => 'http://github.com/rgabo/confluencer', :description => 'Home sweet home', :title => "Page title"
+      bookmark.store
+      
+      # find bookmarks in space
       bookmarks = Confluence::Bookmark.find :space => "confluencer"
       bookmarks.should_not be_empty
+
+      # remove test bookmark
+      bookmark.remove
     end
   end
 end

data/spec/confluence/page_spec.rb

@@ -46,32 +46,9 @@ CONTENT
 end
 
 describe Confluence::Page do
-  include SessionHelperMethods
-  
-  def create_test_page(content = "foobar")
-    Confluence::Page.new :space => config[:space], :title => config[:page_title], :content => content
-  end
-  
-  def store_test_page
-    new_session do
-      return create_test_page.store
-    end
-  end
-  
-  after :each do
-    new_session do
-      begin
-        # check whether we need to remove the test page
-          test_page = Confluence::Page.find :space => config[:space], :title => config[:page_title]
-        test_page.remove if test_page
-      rescue Confluence::Error
-      end
-    end    
-  end
+  include PageHelperMethods
   
   it "should add a new page in Confluence" do
-    page = nil
-    
     new_session do
       # initialize test page
       page = create_test_page
@@ -84,23 +61,21 @@ describe Confluence::Page do
       
       # check page_id
       page.page_id.should_not be_nil
-    end
 
-    # initialize new session
-    new_session do
       # find page by id
       new_page = Confluence::Page.find :id => page.page_id
       
       # assert page
       new_page.should_not be_nil
       new_page.title.should == page.title
+      
+      # remove page
+      new_page.remove
     end
   end
   
   it "should update an existing page in Confluence by id" do
-    page = store_test_page
-    
-    new_session do
+    with_test_page do |page|
       # create test page with same id but updated content
       updated_page = create_test_page "updated content"
 
@@ -116,9 +91,7 @@ describe Confluence::Page do
   end
   
   it "should update an existing page in Confluence by space and title" do
-    page = store_test_page
-    
-    new_session do
+    with_test_page do |page|
       # create test page with same title but updated content
       updated_page = create_test_page "updated content"
 
@@ -136,7 +109,7 @@ describe Confluence::Page do
   end
   
   it "should keep metadata for the page" do
-    page = store_test_page
+    page = create_test_page
     
     # set :creator in {details:label=bender} to 'rgabo'
     page.details[:confluencer][:creator] = 'rgabo'
@@ -145,7 +118,7 @@ describe Confluence::Page do
   end
   
   it "should include metadata in content of the page" do
-    page = store_test_page
+    page = create_test_page
 
     # set :creator in {details:label=bender} to 'rgabo'
     page.details[:confluencer][:creator] = 'rgabo'
@@ -168,5 +141,19 @@ describe Confluence::Page do
     
     page.details[:confluencer][:creator].should == "rgabo"
   end
+  
+  it "should add an attachment" do
+    with_test_page do |page|
+      page.add_attachment(File.basename(__FILE__), "text/plain", IO.read(__FILE__), "test attachment comment")
+      
+      page.attachments.count.should == 1
+      
+      attachment = page.attachments.first
+      
+      attachment.should_not be_nil
+      attachment.url.should_not be_nil
+      attachment.data.should == IO.read(__FILE__)
+    end
+  end
 end
 

data/spec/spec_helper.rb

@@ -34,4 +34,23 @@ module SessionHelperMethods
     end
   end
 end
+
+module PageHelperMethods
+  include SessionHelperMethods
   
+  def create_test_page(content = "foobar")
+    Confluence::Page.new :space => config[:space], :title => config[:page_title], :content => content
+  end
+    
+  def with_test_page
+    new_session do
+      begin
+        # yield created test page
+        yield page = create_test_page.store
+      ensure
+        # remove test page
+        page.remove
+      end
+    end
+  end
+end  

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: confluencer
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 4
-  - 7
-  version: 0.4.7
+  - 8
+  version: 0.4.8
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 +02:00
+date: 2010-05-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,7 @@ files:
 - VERSION
 - confluencer.gems
 - confluencer.gemspec
+- lib/confluence/attachment.rb
 - lib/confluence/blog_entry.rb
 - lib/confluence/bookmark.rb
 - lib/confluence/client.rb
@@ -83,6 +84,7 @@ files:
 - script/console
 - script/console_init.rb
 - spec/confluence.yaml.example
+- spec/confluence/attachment_spec.rb
 - spec/confluence/bookmark_spec.rb
 - spec/confluence/client_spec.rb
 - spec/confluence/page_spec.rb
@@ -128,6 +130,7 @@ signing_key:
 specification_version: 3
 summary: Useful classes to manage Confluence.
 test_files: 
+- spec/confluence/attachment_spec.rb
 - spec/confluence/bookmark_spec.rb
 - spec/confluence/client_spec.rb
 - spec/confluence/page_spec.rb