gunark-jasperserver-client 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-09-19
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/jasperserver-client.rb
+lib/jasperserver-client/version.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
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on jasperserver-client, see http://jasperserver-client.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,48 @@
+= jasperserver-client
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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,70 @@
+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}"
+
+@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
+
+
+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",
+    "--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}/#{GEM_NAME}"
+$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,50 @@
+require 'jasper_server/protocols/soap'
+
+module 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 given ReportRequest.
+    # Returns the report data. 
+    # 
+    # For example if your request specifies 'PDF' 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 'CSV' 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
+    
+    # THIS DOES NOT WORK!!!
+    #
+    # 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

data/lib/jasper_server/protocols/soap.rb

@@ -0,0 +1,70 @@
+require 'jasper_server/protocols/soap_monkeypatch'
+require 'jasper_server/error'
+
+module JasperServer
+  module Protocols
+    class SOAP
+      JASPER_URN = "urn:"
+      
+      def request_report_via_soap(request)
+        raise Error, "Must connect to JasperServer first!" if @driver.nil?
+        
+        report = request.report_unit
+        format = request.output_format
+        params = request.report_params
+        
+        params_xml = ""
+        params.each do |name, value|
+          if value.kind_of? Array
+            value.each do |item|
+              params_xml << %{<parameter name="#{name}" isListItem="true">#{@@html_encoder.encode(item, :decimal)}</parameter>\n}
+            end
+          elsif value.kind_of? Time
+            ts = ReportRequest.convert_time_to_jasper_timestamp(value)
+            params_xml << %{<parameter name="#{name}">#{ts}</parameter>\n}
+          elsif value.kind_of? Integer
+            params_xml << %{<parameter name="#{name}">#{value}</parameter>\n}
+          elsif !value.blank?
+            params_xml << %{<parameter name="#{name}"><![CDATA[#{value}]]></parameter>\n}
+          end
+        end
+        
+        request = %Q|<request operationName="runReport" locale="en">
+          <argument name="RUN_OUTPUT_FORMAT">#{format}</argument>
+          <resourceDescriptor name="" wsType=""
+              uriString="#{report}"
+              isNew="false">
+            <label>null</label>
+            #{params_xml}
+          </resourceDescriptor>
+        </request>|
+        
+        RAILS_DEFAULT_LOGGER.debug "JasperSoapClient Request:\n#{request}" 
+    
+        result = @driver.runReport(request)
+        
+        RAILS_DEFAULT_LOGGER.debug "JasperSoapClient Response:\n#{result}"
+        
+        xml = XmlSimple.xml_in_string(result)
+        unless xml['returnCode'].first.to_i == 0
+          raise JasperServer::Error, "JasperServer replied with an error: #{xml['returnMessage'] ? xml['returnMessage'].first : xml.inspect}"
+        end
+        
+        result.instance_variable_get(:@env).external_content['report'].data.content
+      end
+      
+      def connect(url, username, password)
+        @driver = connect_to_soap_service(url, username, password)
+      end
+      
+      protected
+      def connect_to_soap_service(url, username, password)
+        driver = ::SOAP::RPC::Driver.new(url, JASPER_URN)
+        driver.options['protocol.http.basic_auth'] << [url, username, password]
+        
+        driver.add_method('runReport', 'requestXmlString')
+        return driver
+      end
+    end
+  end
+end

data/lib/jasper_server/protocols/soap_monkeypatch.rb

@@ -0,0 +1,54 @@
+require 'soap/rpc/driver'
+
+# Modify SOAP::RPC::Proxy class to return SOAP Message in addition to object mapping 
+# to access the SOAP attachments
+# Taken from: http://www.jasperforge.org/index.php?option=com_joomlaboard&Itemid=&func=view&catid=10&id=31754#31754
+module SOAP
+  module RPC
+    
+    class Proxy
+      include SOAP
+      
+      def call(name, *params)
+        unless op_info = @operation[name]
+          raise MethodDefinitionError, "method: #{name} not defined"
+        end
+        mapping_opt = create_mapping_opt
+        req_header = create_request_header
+        req_body = SOAPBody.new(
+          op_info.request_body(params, @mapping_registry,
+            @literal_mapping_registry, mapping_opt)
+        )
+        reqopt = create_encoding_opt(
+          :soapaction => op_info.soapaction || @soapaction,
+          :envelopenamespace => @options["soap.envelope.requestnamespace"],
+          :default_encodingstyle =>
+            @default_encodingstyle || op_info.request_default_encodingstyle,
+          :elementformdefault => op_info.elementformdefault,
+          :attributeformdefault => op_info.attributeformdefault
+        )
+        resopt = create_encoding_opt(
+          :envelopenamespace => @options["soap.envelope.responsenamespace"],
+          :default_encodingstyle =>
+            @default_encodingstyle || op_info.response_default_encodingstyle,
+          :elementformdefault => op_info.elementformdefault,
+          :attributeformdefault => op_info.attributeformdefault
+        )
+        env = route(req_header, req_body, reqopt, resopt)
+        raise EmptyResponseError unless env
+        receive_headers(env.header)
+        begin
+          check_fault(env.body)
+        rescue ::SOAP::FaultError => e
+          op_info.raise_fault(e, @mapping_registry, @literal_mapping_registry)
+        end
+        response_obj = op_info.response_obj(env.body, @mapping_registry,
+          @literal_mapping_registry, mapping_opt)
+        response_obj.instance_variable_set(:@env, env)
+        return response_obj
+      end
+    end
+  
+  end
+end
+