cmckni3 / ruby-jasperserver Goto Github PK

View Code? Open in Web Editor NEW

19.0 8.0 15.0 92 KB

Rails integration for JasperSoft Reports

License: MIT License

Ruby 85.71% JavaScript 2.49% CSS 2.12% HTML 8.98% Dockerfile 0.70%

jasperserver ruby rails

ruby-jasperserver's Introduction

JasperserverRails

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

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'

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

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

Documentation
Background processing
Add more tests

Copyright and License

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

Contributing

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

ruby-jasperserver's People

Contributors

Stargazers

Watchers

Forkers

elisoncampos nicwillemse danieldenis01 barlowdw erlinis ceochronos nagireddymule fabiomussi luizcarvalho fossabot

ruby-jasperserver's Issues

Rails 5 Compatibility

It appears this gem will not work be supported against rails 5, any plan to fix this ?

Caching

Investigate caching in rest-client. Possibly switch to faraday or some other library to make the requests.

Rename project

Rename everything to ruby-jasperserver and publish to rubygems.org

Add more badges to README

License
Dependency status

Consider switching to shields.io

Hello, I am using this gem in order to connect a rails app to a jasper server.
I noticed the behaviour of the run_report method is to create a file on the rails' app path, it is ok but it isn't what I desire, I want the hability to download a file so I forked the repository and added a download_report method and I used like this on my app:

def machine_report
  machine_id = params[:id]
  filename = 'machines' 
  file = JasperserverRails::Jasperserver.new.download_report filename do
    format 'pdf'
    report "reports/#{filename}"
    params({ :machine_id => machine_id})
  end
  render_report(file, filename)    
end

def render_report(file, name)                                                                                 
   fullpath = File.expand_path(file.path) 
   send_file(fullpath, filename: "#{name}.pdf", type: 'application/pdf')
end

so far it works, please take a look and let me know what you think. In other hand I am not familiar with the tool that you used to test the features, VCR cassette.
There's any simpler way to test or any easy way to learn VCR?

However, test are failing due to we are testing against an unsupported combination of Ruby and rest-client

Can we remove all unsupported ruby versions and add current versions? According to https://www.ruby-lang.org/en/downloads/branches/, as of today, the only supported versions are: 2.3, 2.4 y 2.5.

I think I can do it.

I will start working on it in a different branch in the fork I just created.

class ReportsController < ApplicationController
  require 'jasperserver-rails'

  def index
    @council_report = CouncilReport.find(params[:council_report_id])
  end

  def run_report(report_name, report_id)
    JasperserverRails::Jasperserver.new.run_report report_name + '.pdf' do
      format 'pdf'
      report report_name
      params({ :council_report_id => report_id.to_s })
    end
  end

  def proposed_works_summary
    @council_report = CouncilReport.find(params[:council_report_id])
    run_report('cams/proposed_works_summary', @council_report)
  end
end

Everything else is as per the usage instructions. What am I missing?

Download Report

Reverted the changes in ffe38af because it needs to be refactored.

Add this feature back and release it rubygems