jiraSOAP 0.8.0 → 0.8.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +6 -33
- data/docs/GettingStarted.markdown +12 -10
- data/lib/jiraSOAP/version.rb +1 -1
- metadata +1 -1
data/README.markdown
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
# jiraSOAP - Ruby interface to the JIRA SOAP API
|
|
2
2
|
|
|
3
3
|
Uses [handsoap](http://wiki.github.com/unwire/handsoap/) to build a
|
|
4
|
-
client for the JIRA SOAP API that works on
|
|
5
|
-
1.9.
|
|
4
|
+
client for the JIRA SOAP API that works on Ruby 1.9 as well as MacRuby.
|
|
6
5
|
|
|
7
6
|
You can read the documentation for the
|
|
8
7
|
[latest release](http://rubydoc.info/gems/jiraSOAP/) or
|
|
@@ -31,44 +30,18 @@ Pick up where `jira4r` left off:
|
|
|
31
30
|
|
|
32
31
|
## Getting Started
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
# Using rubygems
|
|
38
|
-
gem install jiraSOAP
|
|
39
|
-
|
|
40
|
-
# Building from source
|
|
41
|
-
git clone git://github.com/Marketcircle/jiraSOAP.git
|
|
42
|
-
rake build install
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Once installed, you can run a quick demo (making appropriate substitutions):
|
|
46
|
-
|
|
47
|
-
```ruby
|
|
48
|
-
require 'jiraSOAP'
|
|
49
|
-
|
|
50
|
-
db = JIRA::JIRAService.new 'http://jira.yourSite.com:8080'
|
|
51
|
-
db.login 'user', 'password'
|
|
52
|
-
|
|
53
|
-
issues = db.get_issues_from_jql_search 'reporter = currentUser()', 100
|
|
54
|
-
issues.each { |issue|
|
|
55
|
-
#do something...
|
|
56
|
-
puts issue.key
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
db.logout
|
|
60
|
-
```
|
|
33
|
+
See the {file:docs/GettingStarted.markdown Getting Started} guide.
|
|
61
34
|
|
|
62
35
|
|
|
63
36
|
## TODO
|
|
64
37
|
|
|
65
|
-
|
|
66
|
-
-
|
|
67
|
-
- Performance optimizations
|
|
38
|
+
|
|
39
|
+
- Finish implementing all of the JIRA API
|
|
40
|
+
- Performance optimizations
|
|
68
41
|
+ Using GCD/Threads for parsing arrays of results; a significant
|
|
69
42
|
speed up for large types and large arrays (ie. creating issues from
|
|
70
43
|
JQL searches)
|
|
71
|
-
+ Parsing
|
|
44
|
+
+ Parsing might be doable with array indexing instead of hash lookups
|
|
72
45
|
+ Use a different web driver backend (net/http is slow under load)
|
|
73
46
|
- Public test suite
|
|
74
47
|
+ Needs a lot of mock data
|
|
@@ -1,36 +1,38 @@
|
|
|
1
|
-
|
|
2
|
-
===============
|
|
1
|
+
# Getting Started
|
|
3
2
|
|
|
4
3
|
`jiraSOAP` should run on Ruby 1.9.2+ and MacRuby 0.8+. It is available through rubygems or you can build from source:
|
|
5
4
|
|
|
6
|
-
|
|
5
|
+
# Using rubygems
|
|
7
6
|
gem install jiraSOAP
|
|
8
7
|
|
|
9
8
|
# Building from source
|
|
10
9
|
git clone git://github.com/Marketcircle/jiraSOAP.git
|
|
11
|
-
rake
|
|
10
|
+
rake install
|
|
12
11
|
|
|
13
12
|
Once installed, you can run a quick demo (making appropriate substitutions):
|
|
14
13
|
|
|
15
|
-
|
|
14
|
+
require 'jiraSOAP'
|
|
16
15
|
|
|
17
16
|
The first thing that you need to do is create a JIRAService object:
|
|
18
17
|
|
|
19
|
-
|
|
18
|
+
db = JIRA::JIRAService.new 'http://jira.yourSite.com:8080'
|
|
20
19
|
|
|
21
20
|
Then you need to log in (a failed login will raise an exception):
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
db.login 'mrada', 'secret'
|
|
24
23
|
|
|
25
24
|
Once you are logged in, you can start querying the server for information:
|
|
26
25
|
|
|
27
|
-
|
|
26
|
+
issues = db.issues_from_jql_search 'reporter = currentUser()', 100
|
|
28
27
|
issues.each { |issue|
|
|
29
28
|
#do something...
|
|
30
|
-
puts issue.
|
|
29
|
+
puts issue.summary
|
|
31
30
|
}
|
|
32
31
|
|
|
33
32
|
Don't forget to log out when you are done:
|
|
34
33
|
|
|
35
|
-
|
|
34
|
+
db.logout
|
|
36
35
|
|
|
36
|
+
To find out what APIs are available, check out the {JIRA::RemoteAPI}
|
|
37
|
+
module, as well as the {JIRA::RemoteAPIAdditions} module for
|
|
38
|
+
conveniences that `jiraSOAP` has added.
|
data/lib/jiraSOAP/version.rb
CHANGED