confluence-client 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.*.swp
+*.gem
+.bundle
+Gemfile.lock
+out.txt
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in confluence-client.gemspec
+gemspec

data/HISTORY

@@ -0,0 +1,3 @@
+2011-04-01 v0.0.1
+  - Initial prototype release.
+

data/README.rdoc

@@ -0,0 +1,13 @@
+= Confluence::Client - Ruby client for the Confluence XML::RPC API.
+
+== Usage
+
+  Confluence::Client.new(url) do |confluence|
+    
+    # Login
+    confluence.login(user, pass)
+    
+    # Logout
+    confluence.logout
+    
+  end 

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/confluence-client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "confluence-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "confluence-client"
+  s.version     = Confluence::Client::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Blair Christensen']
+  s.email       = ['blair.christensen@gmail.com']
+  s.homepage    = 'https://github.com/blairc/confluence-client'
+  s.summary     = %q{Ruby client for the Confluence XML::RPC API}
+  s.description = %q{Ruby client for the Confluence XML::RPC API}
+
+  s.rubyforge_project = "confluence-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency( %q<rspec>,  [ ">=2.5.0" ] )
+end

data/lib/confluence-client/version.rb

@@ -0,0 +1,5 @@
+module Confluence
+  class Client
+    VERSION = "0.0.1"
+  end
+end

data/lib/confluence-client.rb

@@ -0,0 +1,86 @@
+require 'xmlrpc/client'
+
+module Confluence # :nodoc:
+  # = Confluence::Client - Ruby client for the Confluence XML::RPC API.
+  # 
+  # == Usage
+  #
+  #   Confluence::Client.new(url) do |confluence|
+  #     
+  #     # Login
+  #     confluence.login(user, pass)
+  #     
+  #     # Logout
+  #     confluence.logout
+  #     
+  #   end 
+  class Client
+
+    # Error message from last request (if any).
+    attr_reader :error
+    # Security token.
+    attr_reader :token
+
+    # Create new Confluence client.
+    #
+    # Params:
+    # +url+:: Base URL for the Confluence XML/RPC API.  'rpc/xmlrpc' appended if not present.
+    def initialize(url)
+      raise ArgumentError if url.nil? || url.empty?
+      url += '/rpc/xmlrpc' unless url =~ /\/rpc\/xmlrpc$/
+      @server         = XMLRPC::Client.new2(url)
+      @server.timeout = 305                                 # XXX 
+      @confluence     = @server.proxy_async('confluence1')  # XXX
+
+      @error          = nil
+      @password       = nil
+      @token          = nil
+      @user           = nil
+
+      yield self if block_given?
+    end
+
+    # Was there an error on the last request?
+    def error?
+      !ok?
+    end
+
+    # Login to the Confluence XML/RPC API.
+    def login(user, password)
+      raise ArgumentError if user.nil? || password.nil?
+      @user, @password = user, password
+      begin
+        @token  = @confluence.login(@user, @password)
+        @error  = nil
+      rescue XMLRPC::FaultException => e
+        @error = e.faultString
+      rescue => e
+        @error = e.message
+      end
+      return ok?
+    end
+
+    def method_missing(method_name, *args)
+      unless @token
+        @error = "not authenticated"
+        return false
+      end
+      begin
+        @error = nil
+        return @confluence.send( method_name, *( [@token] + args ) )  
+      rescue XMLRPC::FaultException => e
+        @error = e.faultString
+      rescue Exception => e
+        @error = e.message
+      end
+      return ok?
+    end
+
+    # Was the last request successful?
+    def ok?
+      @error.nil?
+    end
+
+  end # class Client
+end # module Confluence
+

data/spec/confluence_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe "Confluence" do
+
+  before(:each) do
+    @url  = 'http://example.org'
+    @user = 'user'
+    @pass = 'password'
+  end
+
+
+  describe "Client initialization" do
+
+    context "with no arguments" do
+      it "should raise ArgumentError" do
+        lambda { Confluence::Client.new }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "with one argument" do
+      
+      context "that is invalid" do
+        it "should raise ArgumentError when nil" do
+          lambda { Confluence::Client.new(nil) }.should raise_error(ArgumentError)
+        end
+        it "should raise ArgumentError when blank" do
+          lambda { Confluence::Client.new('') }.should raise_error(ArgumentError)
+        end
+      end
+
+      context "that is string" do
+        it "should raise RuntimeError when not a URL" do
+          lambda { Confluence::Client.new(@user) }.should raise_error(RuntimeError, 'Wrong URI as parameter!' )
+        end
+        it "should not raise errors when given URL" do
+          lambda { Confluence::Client.new(@url) }.should_not raise_error
+        end
+      end
+
+    end
+
+  end
+
+
+  describe "Client#login" do
+
+    before(:each) do
+      @confluence = Confluence::Client.new(@url)
+    end
+    
+    context "with invalid arguments" do
+      it "should raise ArgumentError with no arguments" do
+        lambda { @confluence.login() }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError with not enough arguments" do
+        lambda { @confluence.login(@user) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError with too many arguments" do
+        lambda { @confluence.login(@user, @pass, @pass) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError when :user is nil" do
+        lambda { @confluence.login(nil, @pass) }.should raise_error(ArgumentError)
+      end
+      it "should raise ArgumentError when :password is nil" do
+        lambda { @confluence.login(@user, nil) }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "with successful login" do
+      it "should return security token" do
+        token = 'some security token'
+        @confluence.stub(:login).with(@user, @pass) { token }
+        @confluence.login(@user, @pass).should be(token)
+      end
+    end
+
+    # TODO Pointless test
+    context "with unsuccessful login" do
+      it "should raise XMLRPC::FaultException" do
+        @confluence.should_receive(:login).with(@user, @pass).and_raise( XMLRPC::FaultException.new(:faultCode, :faultString) )
+        lambda { @confluence.login(@user, @pass) }.should raise_error(XMLRPC::FaultException)
+      end
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join( File.dirname(__FILE__), '..', 'lib', 'confluence-client' )
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: confluence-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Blair Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-01 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157279640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157279640
+description: Ruby client for the Confluence XML::RPC API
+email:
+- blair.christensen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY
+- README.rdoc
+- Rakefile
+- confluence-client.gemspec
+- lib/confluence-client.rb
+- lib/confluence-client/version.rb
+- spec/confluence_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/blairc/confluence-client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: confluence-client
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Ruby client for the Confluence XML::RPC API
+test_files:
+- spec/confluence_spec.rb
+- spec/spec_helper.rb