confkit 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +16 -0
- data/Rakefile +45 -0
- data/VERSION +1 -0
- data/lib/confkit.rb +5 -0
- data/lib/confkit/base.rb +32 -0
- data/spec/confkit_spec.rb +47 -0
- data/spec/spec.opts +1 -0
- data/spec/spec_helper.rb +9 -0
- metadata +94 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Kirill Ishanov
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
= ConfKit
|
2
|
+
|
3
|
+
ConfKit is a simple XML-RPC client to [Attlassian Confluence API|http://confluence.atlassian.com/display/CONFDEV/Remote+API+Specification].
|
4
|
+
|
5
|
+
To start using it, simply create a WikiClient object:
|
6
|
+
|
7
|
+
client = ConfKit::WikiClient.new(:url => URL_TO_WIKI_API, :login => YOUR_CONFLUENCE_LOGIN, :password => YOUR_CONFLUENCE_PASSWORD)
|
8
|
+
|
9
|
+
After creating a client, you can call remote methods as a methods of "WikiClient" object. Check the documentation for exact method names and parameters.
|
10
|
+
|
11
|
+
puts client.getPage('SomeSpaceKey')
|
12
|
+
|
13
|
+
|
14
|
+
== Copyright
|
15
|
+
|
16
|
+
Copyright (c) 2010 Kirill Ishanov. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "confkit"
|
8
|
+
gem.summary = %Q{Ruby client to Attlassian Confluence Wiki}
|
9
|
+
gem.description = %Q{ConfKit allows to call Confluence methods using XML-RPC API by abusing method_missing.}
|
10
|
+
gem.email = "kirill.ishanov@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/kylichuku/confkit"
|
12
|
+
gem.authors = ["Kirill Ishanov"]
|
13
|
+
gem.add_development_dependency "rspec", ">= 1.2.9"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'spec/rake/spectask'
|
22
|
+
Spec::Rake::SpecTask.new(:spec) do |spec|
|
23
|
+
spec.libs << 'lib' << 'spec'
|
24
|
+
spec.spec_files = FileList['spec/**/*_spec.rb']
|
25
|
+
end
|
26
|
+
|
27
|
+
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
28
|
+
spec.libs << 'lib' << 'spec'
|
29
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
30
|
+
spec.rcov = true
|
31
|
+
end
|
32
|
+
|
33
|
+
task :spec => :check_dependencies
|
34
|
+
|
35
|
+
task :default => :spec
|
36
|
+
|
37
|
+
require 'rake/rdoctask'
|
38
|
+
Rake::RDocTask.new do |rdoc|
|
39
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
40
|
+
|
41
|
+
rdoc.rdoc_dir = 'rdoc'
|
42
|
+
rdoc.title = "confkit #{version}"
|
43
|
+
rdoc.rdoc_files.include('README*')
|
44
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
45
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
data/lib/confkit.rb
ADDED
data/lib/confkit/base.rb
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
require 'xmlrpc/client'
|
2
|
+
require 'yaml'
|
3
|
+
|
4
|
+
module ConfKit
|
5
|
+
VERSION = '1.0'
|
6
|
+
|
7
|
+
class WikiClient
|
8
|
+
|
9
|
+
attr_reader :token
|
10
|
+
|
11
|
+
def initialize(auth_info, rpc_client=XMLRPC::Client)
|
12
|
+
@client = rpc_client.new2(auth_info[:url])
|
13
|
+
@token = @client.call('confluence1.login', auth_info[:login], auth_info[:password])
|
14
|
+
end
|
15
|
+
|
16
|
+
def method_missing(methodname, *args)
|
17
|
+
@client.call("confluence1.#{methodname.to_s}", @token, *args)
|
18
|
+
end
|
19
|
+
|
20
|
+
class << self
|
21
|
+
|
22
|
+
def from_config
|
23
|
+
auth = YAML.load_file(File.expand_path('~/.confkitrc'))
|
24
|
+
WikiClient.new(auth)
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
end
|
30
|
+
|
31
|
+
end
|
32
|
+
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
2
|
+
|
3
|
+
describe "Wiki Client" do
|
4
|
+
|
5
|
+
before do
|
6
|
+
@url = "https://wiki.mydomain.com/rpc/xmlrpc"
|
7
|
+
@login = "login"
|
8
|
+
@password = "swordfish"
|
9
|
+
|
10
|
+
@auth = {
|
11
|
+
:url => @url,
|
12
|
+
:login => @login,
|
13
|
+
:password => @password
|
14
|
+
}
|
15
|
+
|
16
|
+
@rpc = mock("XMLRPC Client Class")
|
17
|
+
@rpc_client = mock("Created Client Class")
|
18
|
+
@rpc.stub!(:new2).and_return(@rpc_client)
|
19
|
+
@rpc_client.stub!(:call).and_return("bebebe")
|
20
|
+
end
|
21
|
+
|
22
|
+
it "creates XMLRPC client based on wiki URL" do
|
23
|
+
@rpc.should_receive(:new2).with(@auth[:url]).once
|
24
|
+
|
25
|
+
client = ConfKit::WikiClient.new(@auth, @rpc)
|
26
|
+
end
|
27
|
+
|
28
|
+
it "recieves API token from remote server" do
|
29
|
+
token = "bebebeko"
|
30
|
+
@rpc_client.should_receive(:call).with('confluence1.login', @login, @password).and_return(token)
|
31
|
+
ConfKit::WikiClient.new(@auth, @rpc).token.should == token
|
32
|
+
end
|
33
|
+
|
34
|
+
it "creates WikiClient from config" do
|
35
|
+
YAML.should_receive(:load_file).with(File.expand_path('~/.confkitrc')).and_return(@auth)
|
36
|
+
ConfKit::WikiClient.should_receive(:new).with(@auth)
|
37
|
+
client = ConfKit::WikiClient.from_config
|
38
|
+
end
|
39
|
+
|
40
|
+
it "should exec remote methods as object methods" do
|
41
|
+
client = ConfKit::WikiClient.new(@auth, @rpc)
|
42
|
+
@rpc_client.should_receive(:call).with('confluence1.getActiveUsers', client.token, "bebebe")
|
43
|
+
client.getActiveUsers("bebebe")
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
47
|
+
|
data/spec/spec.opts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--color
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,94 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: confkit
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 27
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 1
|
9
|
+
- 0
|
10
|
+
version: 0.1.0
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- Kirill Ishanov
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-06-22 00:00:00 -04:00
|
19
|
+
default_executable:
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: rspec
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 13
|
30
|
+
segments:
|
31
|
+
- 1
|
32
|
+
- 2
|
33
|
+
- 9
|
34
|
+
version: 1.2.9
|
35
|
+
type: :development
|
36
|
+
version_requirements: *id001
|
37
|
+
description: ConfKit allows to call Confluence methods using XML-RPC API by abusing method_missing.
|
38
|
+
email: kirill.ishanov@gmail.com
|
39
|
+
executables: []
|
40
|
+
|
41
|
+
extensions: []
|
42
|
+
|
43
|
+
extra_rdoc_files:
|
44
|
+
- LICENSE
|
45
|
+
- README.rdoc
|
46
|
+
files:
|
47
|
+
- .document
|
48
|
+
- .gitignore
|
49
|
+
- LICENSE
|
50
|
+
- README.rdoc
|
51
|
+
- Rakefile
|
52
|
+
- VERSION
|
53
|
+
- lib/confkit.rb
|
54
|
+
- lib/confkit/base.rb
|
55
|
+
- spec/confkit_spec.rb
|
56
|
+
- spec/spec.opts
|
57
|
+
- spec/spec_helper.rb
|
58
|
+
has_rdoc: true
|
59
|
+
homepage: http://github.com/kylichuku/confkit
|
60
|
+
licenses: []
|
61
|
+
|
62
|
+
post_install_message:
|
63
|
+
rdoc_options:
|
64
|
+
- --charset=UTF-8
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
none: false
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
hash: 3
|
73
|
+
segments:
|
74
|
+
- 0
|
75
|
+
version: "0"
|
76
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
77
|
+
none: false
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
hash: 3
|
82
|
+
segments:
|
83
|
+
- 0
|
84
|
+
version: "0"
|
85
|
+
requirements: []
|
86
|
+
|
87
|
+
rubyforge_project:
|
88
|
+
rubygems_version: 1.3.7
|
89
|
+
signing_key:
|
90
|
+
specification_version: 3
|
91
|
+
summary: Ruby client to Attlassian Confluence Wiki
|
92
|
+
test_files:
|
93
|
+
- spec/spec_helper.rb
|
94
|
+
- spec/confkit_spec.rb
|