Skip to content

cmckni3/ruby-jasperserver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

eee9f44 · Nov 14, 2024

History

76 Commits
Jun 15, 2018
Jan 13, 2013
Oct 25, 2017
Feb 9, 2017
Mar 23, 2016
May 22, 2018
Apr 4, 2016
May 22, 2018
Jan 13, 2013
Aug 25, 2019
Jan 13, 2013
Mar 19, 2018

Repository files navigation

JasperserverRails

Gem Version Travis Code Climate License

Download reports in various formats from jasperserver

Formats supported:

  • HTML
  • PDF
  • XLS
  • RTF
  • CSV
  • XML
  • jrprint

Installation

Install the gem

Add this line to your application's Gemfile:

gem 'jasperserver-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jasperserver-rails

Install the generator

  • Install the initializer and config file

    $ rails g jasperserver_rails:install
    
  • Edit config/jasperserver.yml

Usage

  1. Add jasperserver configuration to config/jasperserver.yml
development:
  url: 'http://server:port/jasperserver/'
  username: 'username'
  password: 'password'

test:
  url: 'http://server:port/jasperserver/'
  username: 'username'
  password: 'password'

production:
  url: 'http://server:port/jasperserver/'
  username: 'username'
  password: 'password'
  1. Run a report
pdf = JasperserverRails::Jasperserver.new.generate_report do
        format 'pdf'
        report '/reports/TestReport'
        params(Value1: 'Value1')
      end
send_data pdf, filename: 'Test.pdf', type: :pdf
  1. Download a report using the DSL
file_path = Rails.root.join('tmp', 'reports', 'test.pdf')
JasperserverRails::Jasperserver.new.run_report file_path do
  format 'pdf'
  report '/reports/TestReport'
  params(Value1: 'Value1')
end

TODO

  1. Documentation
  2. Background processing
  3. Add more tests

Copyright and License

JasperserverRails © 2013 by Chris McKnight.

JasperserverRails is licensed under the MIT license. Please see the MIT-LICENSE document for more information.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request