confluencer 0.1.4 → 0.2.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Gabor Ratky
+Copyright (c) 2010 Gabor Ratky
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,13 +5,12 @@ 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.summary = %Q{Useful classes to manage Confluence.}
+    gem.description = %Q{ActiveRecord-like classes to access Confluence through XMLRPC.}
     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

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.1

data/confluencer.gems

@@ -1,3 +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

@@ -5,14 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{confluencer}
-  s.version = "0.1.4"
+  s.version = "0.2.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-04}
-  s.description = %q{ActiveRecord-like classes that map to Confluence entities and useful scripts that automate tasks}
+  s.date = %q{2010-05-05}
+  s.description = %q{ActiveRecord-like classes to access Confluence through XMLRPC.}
   s.email = %q{rgabo@rgabostyle.com}
-  s.executables = ["confluencer", "confluencer-bookmarks"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -25,9 +24,6 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
-     "bin/confluencer",
-     "bin/confluencer-bookmarks",
-     "config/confluencer.yaml.example",
      "confluencer.gems",
      "confluencer.gemspec",
      "lib/confluence/blog_entry.rb",
@@ -35,22 +31,19 @@ Gem::Specification.new do |s|
      "lib/confluence/client.rb",
      "lib/confluence/page.rb",
      "lib/confluence/record.rb",
+     "lib/confluence/session.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"
+     "spec/spec_helper.rb"
   ]
   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.summary = %q{Useful classes to manage Confluence.}
   s.test_files = [
     "spec/confluencer_spec.rb",
      "spec/spec_helper.rb"
@@ -62,14 +55,11 @@ Gem::Specification.new do |s|
 
     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/client.rb

@@ -10,7 +10,7 @@ require 'ruby-debug'
 #
 # Usage:
 #
-# client = Confluence::Client.new("http://confluence.atlassian.com")
+# client = Confluence::Client.new(:url => "http://confluence.atlassian.com")
 # client.login("user", "password")
 # puts client.getSpaces()
 #
@@ -31,7 +31,7 @@ module Confluence
 			@token = options[:token]
 		end
 		
-		def logged_in?
+		def has_token?
 		  !@token.nil?
 	  end
 	  

data/lib/confluence/record.rb

@@ -60,17 +60,18 @@ module Confluence
     end
     
     @@client = nil
+
+    def self.client
+      raise "Confluence client is unavailable. Did you forget to use Confluence::Session.new?" unless @@client
+      @@client
+    end
     
     def self.client=(client)
       @@client = client
     end
     
-    def self.client
-      @@client
-    end
-    
     def client
-      @@client
+      Record.client
     end
   end
 end

data/lib/confluence/session.rb

@@ -0,0 +1,34 @@
+module Confluence
+  class Session
+    attr_reader :client
+    
+    def token
+      client.token
+    end
+    
+    def initialize(arguments = {}, &block)
+      raise ArgumentError, "Required argument 'url' is missing." unless arguments.key? :url
+      
+      @client = Client.new(arguments)
+      
+      unless @client.has_token?
+        raise ArgumentError, "Required argument 'username' is missing." unless arguments.key? :username
+        raise ArgumentError, "Required argument 'password' is missing." unless arguments.key? :password
+        
+        @client.login(arguments[:username], arguments[:password])
+      end
+
+      begin
+        # set client for records
+        Confluence::Record::client = @client
+
+        block.call(@client) if block
+
+        Confluence::Record::client = nil
+      rescue RuntimeError => e
+        # strip non-message part of java exception message
+        raise e.message.split(":").last.strip
+      end
+    end
+  end
+end

data/lib/confluencer.rb

@@ -5,12 +5,9 @@ require 'rubygems'
 require 'thor'
 
 require 'confluence/client'
+require 'confluence/session'
+
 require 'confluence/record'
 require 'confluence/page'
 require 'confluence/bookmark'
 require 'confluence/blog_entry'
-
-module Confluencer
-  autoload :App, 'confluencer/app'
-  autoload :Bookmarks, 'confluencer/bookmarks'
-end

data/script/console

@@ -4,9 +4,6 @@ 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'}"
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 4
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors: 
 - Gabor Ratky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-04 00:00:00 +02:00
+date: 2010-05-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,25 +31,10 @@ dependencies:
         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
+description: ActiveRecord-like classes to access Confluence through XMLRPC.
 email: rgabo@rgabostyle.com
-executables: 
-- confluencer
-- confluencer-bookmarks
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -63,9 +48,6 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/confluencer
-- bin/confluencer-bookmarks
-- config/confluencer.yaml.example
 - confluencer.gems
 - confluencer.gemspec
 - lib/confluence/blog_entry.rb
@@ -73,16 +55,13 @@ files:
 - lib/confluence/client.rb
 - lib/confluence/page.rb
 - lib/confluence/record.rb
+- lib/confluence/session.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: []
@@ -112,7 +91,7 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Useful scripts and classes to manage Confluence
+summary: Useful classes to manage Confluence.
 test_files: 
 - spec/confluencer_spec.rb
 - spec/spec_helper.rb

data/bin/confluencer

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

data/bin/confluencer-bookmarks

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

data/config/confluencer.yaml.example

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

data/lib/confluencer/app.rb

@@ -1,61 +0,0 @@
-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"
-
-    # external configuration
-    class_option :config, :type => :string, :aliases => "-c", :desc => "confluencer configuration file", :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 "create-config", "Creates a confluencer configuration file"
-    def create_config
-      default_configuration = { :confluence => { :url => "http://confluence.acmecorp.com", :username => "roger", :password => "jessica"}}
-      
-      File.open(options[:config], "w+") do |file|
-        file.puts(default_configuration.to_yaml)
-      end
-    end
-    
-    desc "login", "Logs in and verifies the Confluence account"
-    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(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 configuration 'url' missing." unless configuration.key? :url
-  
-      client = Confluence::Client.new(:url => configuration[: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

@@ -1,72 +0,0 @@
-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"
-    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
-        # add a page for each bookmark, remove bookmark in the process
-        bookmarks(spacekey).each do |bookmark|
-          puts bookmark.title
-          
-          labels = bookmark.labels << "bookmark"
-          
-          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, 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

data/script/console_client.rb

@@ -1,9 +0,0 @@
-# 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/templates/webpage.erb

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