jasperserver-client 0.5.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.5.0 2008-09-25
+
+* Initial release

data/License.txt

@@ -0,0 +1,165 @@
+       GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+init.rb
+lib/jasper_server/client.rb
+lib/jasper_server/error.rb
+lib/jasper_server/protocols/basic.rb
+lib/jasper_server/protocols/soap.rb
+lib/jasper_server/protocols/soap_monkeypatch.rb
+lib/jasper_server/report_request.rb
+lib/jasper_server/version.rb
+lib/jasperserver-client.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_jasperserver-client.rb
+

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on jasperserver-client, see http://jasperserver-client.rubyforge.org
+
+

data/README.txt

@@ -0,0 +1,62 @@
+= JasperServer-Client
+
+* http://jasper-client.rubyforge.org
+* http://github.com/gunark/jasperserver-client
+
+== DESCRIPTION:
+
+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.
+
+== USAGE:
+
+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 
+  # http://example.com/jasperserver
+  client = JasperServer::Client.new("http://example.com/jasperserver/services/repository",
+                                    "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 = JasperServer::Request.new("/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).
+  File.open('/tmp/report.pdf', 'w') do |f|
+    f.puts(pdf_data)
+  end
+
+== REQUIREMENTS:
+
+* A Ruby interpreter.
+* The *soap4r* gem, version 1.5.8 or greater. (This should be automatically
+  installed as a dependency; otherwise run <tt>gem install soap4r</tt>.)
+* A running JasperServer instance. The client has been tested  with versions 2.0 through 
+  to 3.0 of JasperServer.
+
+== INSTALL:
+
+* Via RubyGems: 
+    gem install jasperserver-client
+
+== LICENSE:
+
+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 <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'jasper_server/version'
+
+AUTHOR = 'Matt Zukowski'  # can also be an array of Authors
+EMAIL = "matt@zukowski.ca"
+DESCRIPTION = "Ruby-based client for JasperServer. Allows for requesting and fetching reports using Ruby from a networked JasperServer over SOAP."
+GEM_NAME = 'jasperserver-client' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'jasper-client' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['soap4r', '>= 1.5.8']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "gunark"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+ENV['NODOT'] = '1'
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = JasperServer::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'JasperServer-Client documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README.txt",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/init.rb

@@ -0,0 +1,5 @@
+# This file makes it possible to install JasperServer-Client as a Rails plugin.
+
+$: << File.expand_path(File.dirname(__FILE__))+'/lib'
+
+require 'jasperserver-client'

data/lib/jasper_server/client.rb

@@ -0,0 +1,52 @@
+require 'jasper_server/protocols/soap'
+
+module JasperServer
+
+  # The client through which all report requests are sent to the JasperServer.
+  class Client
+    
+    # Create a new instance of the client.
+    #
+    # url :: The URL of the JasperServer. This should look something like:
+    #        "http://<hostname>:<port>/jasperserver/services/repository"
+    # username :: The username used to connect to the JasperServer.
+    # password :: The password used to connect to the JasperServer.
+    def initialize(url, username, password)
+      unless url =~ /\/services\/repository\/?$/
+        # add the /services/repository suffix to the URL if the user forgot
+        # to include it
+        url << "/services/repository"
+        
+        puts "WARNING: You may have forgotten to add the '/services/repository' "+
+              "to your JasperServer URL. Your URL has been automatically changed to #{url.inspect}."
+      end
+      
+      @jasper_url       = url
+      @jasper_username  = username
+      @jasper_password  = password
+    end
+    
+    # Request a report from the server based on the ReportRequest object you provide.
+    # Returns the report data. 
+    # 
+    # For example if your request specifies <tt>PDF</tt> as the output format, PDF 
+    # binary data will be returned. 
+    #
+    #   client = JasperServer::Client.new("http://example.com/jasperserver/services/repository",
+    #                                     "jasperadmin", "secret!")
+    #   request = JasperServer::Request.new("/example/my-report", "PDF", {'fruit' => 'apple'})
+    #   pdf_data = client.request_report(request)
+    #   File.open('/tmp/report.pdf', 'w') do |f|
+    #     f.puts(pdf_data)
+    #   end
+    #
+    # For debugging purposes, try requesting output in <tt>CSV</tt> format, since 
+    # request_report will then return an easily readable String.
+    def request_report(request)
+      soap = JasperServer::Protocols::SOAP.new
+      soap.connect(@jasper_url, @jasper_username, @jasper_password)
+      soap.request_report_via_soap(request)
+    end
+
+  end
+end

data/lib/jasper_server/error.rb

@@ -0,0 +1,4 @@
+module JasperServer
+  class Error < Exception
+  end
+end

data/lib/jasper_server/protocols/basic.rb

@@ -0,0 +1,97 @@
+require 'jasper_server/error'
+
+module JasperServer
+  module Protocols
+    
+    # <b>THIS PROTOCOL ADAPTER DOES NOT YET WORK!!!</b>
+    #
+    # This was an attempt at fetching reports using scraping... unfortunately
+    # I can't figure out how to fake the Spring authentication session :(
+    class Basic
+      # EXAMPLE URL FOR FETCHING REPORT
+      # http://jas01:8080/jasperserver/flow.html?_flowId=viewReportFlow&reportUnit=/u-track/project-totals-for-orgunit&standAlone=true&ParentFolderUri=/u-track&orgunit-id=2&start-date=20080801040000&end-date=20080831040000&output=swf&decorate=no
+
+      def request_report_via_url(request)
+        report_unit   = request.report_unit
+        output_format = request.output_format
+        report_params = request.report_params
+        
+        params = {}
+        report_params.each do |name, value|
+          if value.kind_of? Time
+            params[name] = ReportRequest.convert_time_to_jasper_timestamp(value) 
+          else
+            params[name] = value
+          end
+        end
+        
+        params['_flowId']    = 'viewReportFlow'
+        params['standAlone'] = 'true'
+        #params['parentFolderUri'] = '/u-track'
+        params['decorate']   = 'no'
+        
+        params['reportUnit'] = report_unit
+        params['output']     = output_format
+        
+        puts "FETCHING LOGIN PAGE"
+        uri = URI.parse("http://jas01:8080/jasperserver/login.html")
+        res = Net::HTTP.start(uri.host, uri.port) do |http|
+          http.get(uri.path)
+        end
+        res['set-cookie'] =~ /JSESSIONID=([a-z0-9]*);/i
+        jsessionid = $~[1]
+        puts "SESSION ID IS #{jsessionid}"
+
+        sleep 1
+        
+        uri = URI.parse("http://jas01:8080/jasperserver/j_acegi_security_check")
+        
+        # FIXME: logging in doesn't work :(
+        
+        puts "LOGGING IN"
+        req = Net::HTTP::Post.new(uri.path)
+        req.set_form_data({'j_username' => 'jasperadmin', 'j_password' => 'jasper!', 'btnsubmit' => 'Login', 'jsessionid' => jsessionid})
+        
+        client = Net::HTTP.new(uri.host, uri.port)
+        result = client.start do |http|
+          puts "LOGIN REQ"
+          puts req.to_hash.inspect
+          http.request(req)
+        end
+        #res = Net::HTTP.post_form(uri, {'j_username' => 'jasperadmin', 'j_password' => 'jasper!', 'btnsubmit' => 'Login'})
+        puts "LOGIN RESP HEADERS"
+        puts res.to_hash.inspect
+        puts res.inspect
+        
+        
+        
+        uri = URI.parse("http://jas01:8080/jasperserver/flow.html")
+        #
+        #req = Net::HTTP::Post.new(uri.path)
+        #req.set_form_data(params, '&')
+        
+        sleep 1
+        
+        # FIXME: this should fetch the report, but instead we get redirected to the login page
+        #        since I can't seem to get the fake login to work :(
+        
+        params['jsessionid'] = 
+        q = params.collect{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join("&")
+        uri.query = q
+        req = Net::HTTP::Get.new(uri.request_uri)
+        puts uri.request_uri
+        
+        client = Net::HTTP.new(uri.host, uri.port)
+        result = client.start do |http|
+          puts req.to_hash.inspect
+          http.request(req)
+        end
+                
+        return result
+      end
+      
+      class Error < JasperServer::Error
+      end
+    end
+  end
+end