Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cmckni3/ruby-jasperserver

Rails integration for JasperSoft Reports
https://github.com/cmckni3/ruby-jasperserver

jasperserver rails ruby

Last synced: 2 days ago
JSON representation

Rails integration for JasperSoft Reports

Host: GitHub
URL: https://github.com/cmckni3/ruby-jasperserver
Owner: cmckni3
License: mit
Created: 2013-01-13T10:58:07.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-11-25T16:38:27.000Z (about 2 months ago)
Last Synced: 2025-01-03T13:11:02.896Z (9 days ago)
Topics: jasperserver, rails, ruby
Language: Ruby
Homepage:
Size: 91.8 KB
Stars: 19
Watchers: 8
Forks: 15
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
- Support: support/docker/Dockerfile

Awesome Lists containing this project

README

# JasperserverRails
[![Gem Version](https://img.shields.io/gem/v/jasperserver-rails.svg)](https://rubygems.org/gems/jasperserver-rails)
[![Travis](https://img.shields.io/travis/cmckni3/ruby-jasperserver.svg)](https://travis-ci.org/cmckni3/rails-jasperserver)
[![Code Climate](https://api.codeclimate.com/v1/badges/9dfe8fd29537fc32faeb/maintainability)](https://codeclimate.com/github/cmckni3/ruby-jasperserver/maintainability)
[![License](https://img.shields.io/github/license/cmckni3/ruby-jasperserver.svg)](https://github.com/cmckni3/ruby-jasperserver/blob/master/MIT-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

```yaml
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'
```

2. Run a report

```ruby
pdf = JasperserverRails::Jasperserver.new.generate_report do
format 'pdf'
report '/reports/TestReport'
params(Value1: 'Value1')
end
send_data pdf, filename: 'Test.pdf', type: :pdf
```

3. Download a report using the DSL

```ruby
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 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