confluencer 0.1.2 → 0.1.3

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+config/*.yaml

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/config/confluencer.yaml.example

@@ -0,0 +1,7 @@
+# confluencer external configuration example
+
+# Confluence configuration
+:confluence:
+    :url: http://confluence.acmecorp.com
+    :username: roger
+    :password: jessica

data/confluencer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.1.2"
+  s.version = "0.1.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-03}
+  s.date = %q{2010-05-04}
   s.description = %q{ActiveRecord-like classes that map to Confluence entities and useful scripts that automate tasks}
   s.email = %q{rgabo@rgabostyle.com}
   s.executables = ["confluencer", "confluencer-bookmarks"]
@@ -27,8 +27,10 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/confluencer",
      "bin/confluencer-bookmarks",
+     "config/confluencer.yaml.example",
      "confluencer.gems",
      "confluencer.gemspec",
+     "lib/confluence/blog_entry.rb",
      "lib/confluence/bookmark.rb",
      "lib/confluence/client.rb",
      "lib/confluence/page.rb",

data/lib/confluence/blog_entry.rb

@@ -0,0 +1,17 @@
+module Confluence
+  class BlogEntry < Record
+    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))
+    end
+    
+    def self.find_by_space(spacekey)
+      client.getBlogEntries(spacekey).collect {|summary| BlogEntry.new(client.getBlogEntry(summary["id"]))}
+    end
+  end
+end

data/lib/confluence/bookmark.rb

@@ -2,18 +2,35 @@ module Confluence
   class Bookmark < Page
     BOOKMARKS_PAGE_TITLE = ".bookmarks"
 
+    attr_reader :bookmark_url, :description
+    
     def initialize(hash)
       super(hash)
+
+      # parse bookmark_url and description out of content
+      @bookmark_url = content[/\{bookmark:url=([^\}]+)\}/, 1] if content
+      @description = content[/\{bookmark.*\}([^\{]*)\{bookmark\}/, 1] if content
+    end
+    
+    def bookmark_url=(value)
+      @bookmark_url = value
+      
+      # update content with new bookmark_url
+      update_content
     end
     
-    def bookmark_url
-      # return url portion of {bookmark} macro in content
-      content[/\{bookmark:url=([^\}]+)\}/, 1]
+    def description=(value)
+      @description = value
+
+      # update content with new description
+      update_content
     end
     
-    def description
-      # return description portion of {bookmark} macro in content
-      content[/\{bookmark.*\}([^\{]*)\{bookmark\}/, 1]
+    def store
+      # always set .bookmarks as the parent page
+      parent_id = Page.find_by_title(space, BOOKMARKS_PAGE_TITLE).page_id
+      
+      super
     end
     
     def self.find_by_space(spacekey)
@@ -23,5 +40,11 @@ module Confluence
       # map each page to a Bookmark
       bookmarks_page.children.collect {|page| Bookmark.new(page.attributes)}
     end
+    
+    private
+    
+    def update_content
+      self.content = "{bookmark:url=#{@bookmark_url}}#{@description}{bookmark}"
+    end
   end
 end

data/lib/confluencer.rb

@@ -8,6 +8,7 @@ require 'confluence/client'
 require 'confluence/record'
 require 'confluence/page'
 require 'confluence/bookmark'
+require 'confluence/blog_entry'
 
 module Confluencer
   autoload :App, 'confluencer/app'

data/lib/confluencer/app.rb

@@ -1,36 +1,40 @@
 require 'rubygems'
 require 'thor'
+require 'yaml'
 
 module Confluencer
   class App < Thor
     attr_reader :token
-    
+        
     # -v, --verbose
     class_option :verbose, :desc => "Verbose output", :type => :boolean, :default => false, :aliases => "-v"
 
-    # XMLRPC url and authentication
-    class_option :url, :type => :string, :required => false, :group => "Confluence", :desc => "URL where Confluence is available"
-    class_option :username, :type => :string, :required => false, :aliases => "-u", :group => "Confluence", :desc => "Confluence username"
-    class_option :password, :type => :string, :required => false, :aliases => "-p", :group => "Confluence", :desc => "Confluence password"
-
+    # external configuration
+    class_option :config, :type => :string, :aliases => "-c", :desc => "Confluence configuration", :default => "config/confluencer.yaml"
+    class_option :instance, :type => :string, :aliases => "-i", :desc => "Name of the Confluence instance", :default => "confluence"
     # explicitly specify default_task => :help
     default_task :help
 
     desc "login", "Logs in and verifies the Confluence account"
-    def login
+    def login      
+      raise Thor::Error, "Required configuration 'username' missing." unless configuration.key? :username
+      raise Thor::Error, "Required configuration 'password' missing." unless configuration.key? :password
+      
       with_confluence do |confluence|
-        @token = confluence.login(options[:username], options[:password])
+        @token = confluence.login(configuration[:username], configuration[:password])
       end
     end
   
     private
     
+    def configuration
+      @configuration ||= YAML::load(File.open(options[:config]))[options[:instance].to_sym]
+    end
+    
     def with_confluence(&block)
-      raise Thor::Error, "Required option '--url' missing." unless options.url?
-      raise Thor::Error, "Required option '--username' missing." unless options.username?
-      raise Thor::Error, "Required option '--password' missing." unless options.password?
+      raise Thor::Error, "Required configuration 'url' missing." unless configuration.key? :url
   
-      client = Confluence::Client.new(:url => options[:url], :token => @token)
+      client = Confluence::Client.new(:url => configuration[:url], :token => @token)
   
       begin
         # Record objects should use this clent

data/lib/confluencer/bookmarks.rb

@@ -18,48 +18,55 @@ module Confluencer
       end
     end
 
-    method_option :parent, :type => :string, :default => "Bookmarks", :desc => "Parent page for the pages created", :required => true
-    method_option :template, :type => :string, :desc => "ERB template to use", :required => true
+    method_option :parent, :type => :string, :default => "Bookmarks", :desc => "Parent page for the pages created"
+    method_option :template, :type => :string, :desc => "ERB template to use", :required => :true
     desc "create-pages SPACEKEY", "Creates pages for every bookmark"
     def create_pages(spacekey)
       invoke :login
-      
+            
       with_confluence do
-        begin
-          # get parent page
-          parent_page = Confluence::Page.find_by_title(spacekey, options[:parent])
-        rescue RuntimeError
-          # page does not exist yet, create it
-          parent_page = Confluence::Page.new :space => spacekey, :title => options[:parent], :content => ""
-          parent_page.store
-        end
-        
-        # grab the title of all existing pages
-        existing_titles = parent_page.children.collect {|page| page.title }
-        
-        # grab all bookmarks from space
-        bookmarks = Confluence::Bookmark.find_by_space(spacekey)
-           
-        # initialize ERB template
-        template = ERB.new(IO.read(options[:template])) unless bookmarks.empty?
-           
         # add a page for each bookmark, remove bookmark in the process
-        bookmarks.each do |bookmark|
+        bookmarks(spacekey).each do |bookmark|
           puts bookmark.title
           
           labels = bookmark.labels << "bookmark"
           
-          page = Confluence::Page.new :space => spacekey, :parentId => parent_page.page_id, :title => bookmark.title
+          page = Confluence::Page.new :space => spacekey, :parentId => parent_page(spacekey).page_id, :title => bookmark.title
           page.content = template.result(binding)
 
           # remove bookmark before storing page with same title
           bookmark.remove
           page.store
           
-          # update labels
-          page.labels = labels
+          # update labels, add bookmark
+          page.labels = labels << "bookmark"
+        end
+      end
+    end
+    
+    private
+    
+    def bookmarks(spacekey)
+      Confluence::Bookmark.find_by_space(spacekey)
+    end
+
+    def parent_page(spacekey)
+      @parent_pages[spacekey] ||= begin
+        unless @parent_pages[spacekey]
+          begin
+            # get parent page
+            @parent_pages[spacekey] = Confluence::Page.find_by_title(spacekey, options[:parent])
+          rescue RuntimeError
+            # page does not exist yet, create it
+            @parent_pages[spacekey] = Confluence::Page.new :space => spacekey, :title => options[:parent], :content => ""
+            @parent_pages[spacekey].store
+          end
         end
       end
     end
+    
+    def template
+      @template ||= ERB.new(IO.read(options[:template]))
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-03 00:00:00 +02:00
+date: 2010-05-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,8 +65,10 @@ files:
 - VERSION
 - bin/confluencer
 - bin/confluencer-bookmarks
+- config/confluencer.yaml.example
 - confluencer.gems
 - confluencer.gemspec
+- lib/confluence/blog_entry.rb
 - lib/confluence/bookmark.rb
 - lib/confluence/client.rb
 - lib/confluence/page.rb