Ruby client for JasperServer (via SOAP).
Ruby JavaScript
Failed to load latest commit information.
script fixed soap4r requirement; filled out website template Sep 24, 2008
tasks generated newgem files, configured, and added client code Sep 23, 2008
website added documentation links to rubyforge website Sep 25, 2008
.project generated newgem files, configured, and added client code Sep 23, 2008
History.txt releasing as 1.0.0 Apr 27, 2010
README.rdoc renamed README.txt to .rdoc for github prettiness Apr 13, 2010
Rakefile generated newgem files, configured, and added client code Sep 23, 2008




JasperServer-Client is – you guessed it – a Ruby-based client for JasperServer. The library allows for requesting and fetching reports from a networked JasperServer over SOAP.


Here we request a report to be generated in PDF format and then save the resulting data to a local file:

# Create a new client instance for the JasperServer running at 
client ="",
                                  "jasperadmin", "secret!")

# Create a request for a report. The first parameter is the full path of the 
# report unit, the second is the desired output format, and the last is an 
# optional hash of parameters to be fed into the report.
request ="/example/my-report", "PDF", {'fruit' => 'apple'})

# Send the report request to the server and return the output data.
pdf_data = client.request_report(request)

# Write the report data to a file (instead you could send the data to the user's
# browser if you're doing this in, for example, a Rails controller action).'/tmp/report.pdf', 'w') do |f|


  • A Ruby interpreter.

  • The soap4r gem, version 1.5.8 or greater. (This should be automatically installed as a dependency; otherwise run gem install soap4r.)

  • A running JasperServer instance. The client has been tested with versions 2.0 through to 3.0 of JasperServer.


  • Via RubyGems:

    gem install jasperserver-client


JasperServer-Client is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

JasperServer-Client is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <>.