confluencer 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@confluencer

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gabor Ratky
+
+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,17 @@
+= confluencer
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Gabor Ratky. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "confluencer"
+    gem.summary = %Q{Useful scripts and classes to manage Confluence}
+    gem.description = %Q{ActiveRecord-like classes that map to Confluence entities and useful scripts that automate tasks}
+    gem.email = "rgabo@rgabostyle.com"
+    gem.homepage = "http://github.com/rgabo/confluencer"
+    gem.authors = ["Gabor Ratky"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_runtime_dependency "thor", ">= 0.13.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "confluencer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/confluencer

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'confluencer'
+
+# start Confluencer
+Confluencer::App.start

data/bin/confluencer-bookmarks

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'confluencer'
+
+# start Confluencer
+Confluencer::Bookmarks.start

data/confluencer.gems

@@ -0,0 +1,3 @@
+# confluencer generated gem export file. Note that any env variable settings will be missing. Append these after using a ';' field separator
+rspec -v1.3.0
+thor -v0.13.4

data/confluencer.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{confluencer}
+  s.version = "0.1.1"
+
+  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.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"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rvmrc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/confluencer",
+     "bin/confluencer-bookmarks",
+     "confluencer.gems",
+     "confluencer.gemspec",
+     "lib/confluence/bookmark.rb",
+     "lib/confluence/client.rb",
+     "lib/confluence/page.rb",
+     "lib/confluence/record.rb",
+     "lib/confluencer.rb",
+     "lib/confluencer/app.rb",
+     "lib/confluencer/bookmarks.rb",
+     "script/console",
+     "script/console_client.rb",
+     "script/console_init.rb",
+     "spec/confluencer_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "templates/webpage.erb"
+  ]
+  s.homepage = %q{http://github.com/rgabo/confluencer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Useful scripts and classes to manage Confluence}
+  s.test_files = [
+    "spec/confluencer_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0.13.4"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<thor>, [">= 0.13.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<thor>, [">= 0.13.4"])
+  end
+end
+

data/lib/confluence/bookmark.rb

@@ -0,0 +1,27 @@
+module Confluence
+  class Bookmark < Page
+    BOOKMARKS_PAGE_TITLE = ".bookmarks"
+
+    def initialize(hash)
+      super(hash)
+    end
+    
+    def bookmark_url
+      # return url portion of {bookmark} macro in content
+      content[/\{bookmark:url=([^\}]+)\}/, 1]
+    end
+    
+    def description
+      # return description portion of {bookmark} macro in content
+      content[/\{bookmark.*\}([^\{]*)\{bookmark\}/, 1]
+    end
+    
+    def self.find_by_space(spacekey)
+      # get the .bookmarks page for the space
+      bookmarks_page = Page.find_by_title(spacekey, BOOKMARKS_PAGE_TITLE)
+      
+      # map each page to a Bookmark
+      bookmarks_page.children.collect {|page| Bookmark.new(page.attributes)}
+    end
+  end
+end

data/lib/confluence/client.rb

@@ -0,0 +1,69 @@
+require 'xmlrpc/client'
+require 'ruby-debug'
+
+# 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)). Also takes care of re-logging in
+# if your login times out.
+#
+# Usage:
+#
+# client = Confluence::Client.new("http://confluence.atlassian.com")
+# client.login("user", "password")
+# puts client.getSpaces()
+#
+module Confluence
+  class Client
+    PREFIX = "confluence1"
+    
+    attr_reader :username, :token
+     
+		def initialize(options = {})
+		  server_url = options[:url]
+			server_url += "/rpc/xmlrpc" unless server_url[-11..-1] == "/rpc/xmlrpc"
+			@server_url = server_url
+			
+			client = XMLRPC::Client.new_from_uri(server_url)
+			
+			@confluence = client.proxy(PREFIX)
+			@token = options[:token]
+		end
+		
+		def logged_in?
+		  !@token.nil?
+	  end
+	  
+		def login(username, password)
+			@username = username
+			@password = password
+
+		  request do |confluence|
+		    @token = confluence.login(@username, @password)
+	    end
+		end
+		
+		def logout
+		  request do |confluence|
+		    confluence.logout(@token)
+	    end
+		end	
+
+		def method_missing(method_name, *args)
+		  request do |confluence|
+		    confluence.send(method_name, *([@token] + args))
+	    end
+		end
+		
+		private
+		
+		def request(&block)
+		  begin
+		    block.call(@confluence)
+			rescue XMLRPC::FaultException => e
+				raise e.faultString
+			end
+		end
+	end
+end

data/lib/confluence/page.rb

@@ -0,0 +1,29 @@
+module Confluence
+  class Page < Record
+    record_attr_accessor :id => :page_id
+    record_attr_accessor :parentId, :space
+    record_attr_accessor :title, :creator, :modifier, :content
+    record_attr_accessor :created, :modified
+    record_attr_accessor :url
+        
+    def children
+      client.getChildren(page_id).collect { |child| Page.find_by_id(child["id"]) }
+    end
+    
+    def store
+      initialize(client.storePage(attributes))
+    end
+    
+    def remove
+      client.removePage(page_id)
+    end
+        
+    def self.find_by_id(pageid)
+      self.new(client.getPage(pageid))
+    end
+    
+    def self.find_by_title(spacekey, title)
+      self.new(client.getPage(spacekey, title))
+    end
+  end
+end

data/lib/confluence/record.rb

@@ -0,0 +1,76 @@
+module Confluence
+  class Record
+    class << self
+      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
+
+    attr_accessor :attributes
+    
+    def initialize(hash)
+      @attributes = Hash[*(hash.keys.map {|k| k.to_sym}).zip(hash.values).flatten]
+    end
+        
+    def [](attr)
+      @attributes[attr]
+    end
+    
+    def []=(attr, value)
+      @attributes[attr] = value
+    end
+    
+    def record_id
+      self[:id]
+    end
+    
+    def labels
+      client.getLabelsById(record_id).collect {|label| label["name"]}
+    end
+    
+    def labels=(value)
+      existing_labels = labels
+      removed_labels = existing_labels - value
+      added_labels = value - existing_labels
+      
+      client.removeLabelByName(removed_labels.join(" "), record_id) unless removed_labels.empty?
+      client.addLabelByName(added_labels.join(" "), record_id) unless added_labels.empty?
+    end
+    
+    @@client = nil
+    
+    def self.client=(client)
+      @@client = client
+    end
+    
+    def self.client
+      @@client
+    end
+    
+    def client
+      @@client
+    end
+  end
+end

data/lib/confluencer.rb

@@ -0,0 +1,15 @@
+# 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 'thor'
+
+require 'confluence/client'
+require 'confluence/record'
+require 'confluence/page'
+require 'confluence/bookmark'
+
+module Confluencer
+  autoload :App, 'confluencer/app'
+  autoload :Bookmarks, 'confluencer/bookmarks'
+end

data/lib/confluencer/app.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'thor'
+
+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"
+
+    # explicitly specify default_task => :help
+    default_task :help
+
+    desc "login", "Logs in and verifies the Confluence account"
+    def login
+      with_confluence do |confluence|
+        @token = confluence.login(options[:username], options[:password])
+      end
+    end
+  
+    private
+    
+    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?
+  
+      client = Confluence::Client.new(:url => options[:url], :token => @token)
+  
+      begin
+        # Record objects should use this clent
+        Confluence::Record::client = client
+        
+        block.call(client)
+        
+        # Nil out client
+        Confluence::Record::client = nil
+      rescue RuntimeError => e
+        raise Thor::Error, e.message.split(":").last.strip
+      end
+    end
+  end
+end

data/lib/confluencer/bookmarks.rb

@@ -0,0 +1,65 @@
+require 'confluencer/app'
+require 'erb'
+
+module Confluencer
+  class Bookmarks < Confluencer::App
+    BOOKMARKS_PAGE_TITLE = ".bookmarks"
+
+    desc "list SPACEKEY", "Lists the bookmarks in a given space"
+    def list(spacekey)
+      invoke :login
+
+      with_confluence do
+        # grab all bookmarks from space
+        bookmarks = Confluence::Bookmark.find_by_space(spacekey)
+      
+        # print out bookmarks
+        puts bookmarks.collect {|b| "#{b.bookmark_url} (#{b.title})"}.join "\n"
+      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
+    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|
+          puts bookmark.title
+          
+          labels = bookmark.labels << "bookmark"
+          
+          page = Confluence::Page.new :space => spacekey, :parentId => parent_page.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
+        end
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+libs =  " -r irb/completion"
+
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/confluencer.rb'}"
+
+# also initialize a default client for the records
+libs <<  " -r #{File.dirname(__FILE__) + '/console_client.rb'}"
+
+# load console_init
+libs <<  " -r #{File.dirname(__FILE__) + '/console_init.rb'}"
+
+puts "Loading confluencer..."
+exec "irb #{libs} --simple-prompt"

data/script/console_client.rb

@@ -0,0 +1,9 @@
+# TODO: take client configuration from YAML (console_client.yaml) that is ignored by default, add console_client.yaml.example
+# initialize client
+client = Confluence::Client.new :url => "http://192.168.1.80:3800"
+
+# log in with account
+client.login('bender', 'futurama')
+
+# Set client for Confluence records
+Confluence::Record::client = client

data/script/console_init.rb

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

data/spec/confluencer_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Confluencer do
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'confluencer'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/templates/webpage.erb

@@ -0,0 +1,9 @@
+Bookmarked by [~<%= bookmark.creator %>]
+
+<% unless bookmark.description.empty? %>
+h5. Description
+
+<%= bookmark.description %>
+<% end%>
+----
+{webpage:src=<%= bookmark.bookmark_url %>}

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: confluencer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Gabor Ratky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 13
+        - 4
+        version: 0.13.4
+  type: :runtime
+  version_requirements: *id002
+description: ActiveRecord-like classes that map to Confluence entities and useful scripts that automate tasks
+email: rgabo@rgabostyle.com
+executables: 
+- confluencer
+- confluencer-bookmarks
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/confluencer
+- bin/confluencer-bookmarks
+- confluencer.gems
+- confluencer.gemspec
+- lib/confluence/bookmark.rb
+- lib/confluence/client.rb
+- lib/confluence/page.rb
+- lib/confluence/record.rb
+- lib/confluencer.rb
+- lib/confluencer/app.rb
+- lib/confluencer/bookmarks.rb
+- script/console
+- script/console_client.rb
+- script/console_init.rb
+- spec/confluencer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- templates/webpage.erb
+has_rdoc: true
+homepage: http://github.com/rgabo/confluencer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Useful scripts and classes to manage Confluence
+test_files: 
+- spec/confluencer_spec.rb
+- spec/spec_helper.rb