jiraSOAP 0.8.0 → 0.8.1

data/README.markdown

@@ -1,8 +1,7 @@
 # jiraSOAP - Ruby interface to the JIRA SOAP API
 
 Uses [handsoap](http://wiki.github.com/unwire/handsoap/) to build a
-client for the JIRA SOAP API that works on MacRuby as well as Ruby
-1.9.
+client for the JIRA SOAP API that works on Ruby 1.9 as well as MacRuby.
 
 You can read the documentation for the
 [latest release](http://rubydoc.info/gems/jiraSOAP/) or
@@ -31,44 +30,18 @@ Pick up where `jira4r` left off:
 
 ## Getting Started
 
-`jiraSOAP` should run on Ruby 1.9.2 and MacRuby 0.8 or newer. It is available through rubygems or you can build from source:
-
-```bash
-# Using rubygems
-gem install jiraSOAP
-
-# Building from source
-git clone git://github.com/Marketcircle/jiraSOAP.git
-rake build install
-```
-
-Once installed, you can run a quick demo (making appropriate substitutions):
-
-```ruby
-require 'jiraSOAP'
-
-db = JIRA::JIRAService.new 'http://jira.yourSite.com:8080'
-db.login 'user', 'password'
-
-issues = db.get_issues_from_jql_search 'reporter = currentUser()', 100
-issues.each { |issue|
-  #do something...
-  puts issue.key
-}
-
-db.logout
-```
+See the {file:docs/GettingStarted.markdown Getting Started} guide.
 
 
 ## TODO
 
-- Finish implementing all of the API
-- Stabilize API
-- Performance optimizations; there are a number of places that can be optimized
+
+- Finish implementing all of the JIRA API
+- Performance optimizations
   + Using GCD/Threads for parsing arrays of results; a significant
   speed up for large types and large arrays (ie. creating issues from
   JQL searches)
-  + Parsing can be done with array indexing instead of hash lookups
+  + Parsing might be doable with array indexing instead of hash lookups
   + Use a different web driver backend (net/http is slow under load)
 - Public test suite
   + Needs a lot of mock data

data/docs/GettingStarted.markdown

@@ -1,36 +1,38 @@
- Getting Started
-===============
+#  Getting Started
 
 `jiraSOAP` should run on Ruby 1.9.2+ and MacRuby 0.8+. It is available through rubygems or you can build from source:
 
-    # Using rubygems
+   # Using rubygems
     gem install jiraSOAP
 
     # Building from source
     git clone git://github.com/Marketcircle/jiraSOAP.git
-    rake build install
+    rake install
 
 Once installed, you can run a quick demo (making appropriate substitutions):
 
-    require 'jiraSOAP'
+   require 'jiraSOAP'
 
 The first thing that you need to do is create a JIRAService object:
 
-    db = JIRA::JIRAService.new 'http://jira.yourSite.com:8080'
+   db = JIRA::JIRAService.new 'http://jira.yourSite.com:8080'
 
 Then you need to log in (a failed login will raise an exception):
 
-    db.login 'mrada', 'secret'
+   db.login 'mrada', 'secret'
 
 Once you are logged in, you can start querying the server for information:
 
-     issues = db.get_issues_from_jql_search 'reporter = currentUser()', 100
+    issues = db.issues_from_jql_search 'reporter = currentUser()', 100
      issues.each { |issue|
        #do something...
-       puts issue.key
+       puts issue.summary
      }
 
 Don't forget to log out when you are done:
 
-    db.logout
+   db.logout
 
+To find out what APIs are available, check out the {JIRA::RemoteAPI}
+module, as well as the {JIRA::RemoteAPIAdditions} module for
+conveniences that `jiraSOAP` has added.

data/lib/jiraSOAP/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

metadata

@@ -2,7 +2,7 @@
 name: jiraSOAP
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors: 
 - Mark Rada