jasperserver-client 0.5.0 → 1.0.0

data/History.txt

@@ -1,3 +1,14 @@
-== 0.5.0 2008-09-25
+== 1.0.0 2010-04-27
+
+* Should now work when Nokogiri is being used as the ActiveSupport MiniXml backend.
+* Releasing as 1.0. It appears that we are mostly bug-free.
+
+== 0.2.0 2009-08-14
+
+* Should now work with Rails 2.3
+* Can now specify the maximum time the client will wait for a response from the Jasper Server
+
+
+== 0.1.0 2008-09-25
 
 * Initial release

data/lib/jasper_server/client.rb

@@ -11,7 +11,8 @@ module JasperServer
     #        "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)
+    # timeout  :: Maximum time to wait for a response from the JasperServer (default it 60 seconds).
+    def initialize(url, username, password, timeout = 60)
       unless url =~ /\/services\/repository\/?$/
         # add the /services/repository suffix to the URL if the user forgot
         # to include it
@@ -24,6 +25,7 @@ module JasperServer
       @jasper_url       = url
       @jasper_username  = username
       @jasper_password  = password
+      @timeout = timeout
     end
     
     # Request a report from the server based on the ReportRequest object you provide.
@@ -44,9 +46,10 @@ module JasperServer
     # 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.connect(@jasper_url, @jasper_username, @jasper_password, @timeout)
       soap.request_report_via_soap(request)
     end
 
   end
 end
+

data/lib/jasper_server/protocols/soap.rb

@@ -1,34 +1,60 @@
 require 'jasper_server/protocols/soap_monkeypatch'
 require 'jasper_server/error'
 
+gem 'xml-simple'
+require 'xmlsimple'
+
+if Object.const_defined?(:XmlSimple) && !XmlSimple.respond_to?(:xml_in_string)
+  class XmlSimple
+    # Same as xml_in but doesn't try to smartly shoot itself in the foot.
+    def xml_in_string(string, options = nil)
+      handle_options('in', options)
+
+      @doc = parse(string)
+      result = collapse(@doc.root)
+
+      if @options['keeproot']
+        merge({}, @doc.root.name, result)
+      else
+        result
+      end
+    end
+
+    def self.xml_in_string(string, options = nil)
+      new.xml_in_string(string, options)
+    end
+  end
+end
+
 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
+          case value
+          when Array
             value.each do |item|
-              params_xml << %{<parameter name="#{name}" isListItem="true">#{@@html_encoder.encode(item, :decimal)}</parameter>\n}
+              params_xml << %{<parameter name="#{name}" isListItem="true"><![CDATA[#{item}]]></parameter>\n}
             end
-          elsif value.kind_of? Time
+          when Time, DateTime, Date
             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?
+          else
+            unless value.blank?
             params_xml << %{<parameter name="#{name}"><![CDATA[#{value}]]></parameter>\n}
           end
         end
-        
+        end
+
         request = %Q|<request operationName="runReport" locale="en">
           <argument name="RUN_OUTPUT_FORMAT">#{format}</argument>
           <resourceDescriptor name="" wsType=""
@@ -38,33 +64,55 @@ module JasperServer
             #{params_xml}
           </resourceDescriptor>
         </request>|
-        
-        RAILS_DEFAULT_LOGGER.debug "JasperSoapClient Request:\n#{request}" 
-    
+
+        RAILS_DEFAULT_LOGGER.debug "#{self.class.name} Request:\n#{request}" if Object.const_defined?('RAILS_DEFAULT_LOGGER')
+
         result = @driver.runReport(request)
-        
-        RAILS_DEFAULT_LOGGER.debug "JasperSoapClient Response:\n#{result}"
-        
-        xml = XmlSimple.xml_in_string(result)
+
+        RAILS_DEFAULT_LOGGER.debug "#{self.class.name} Response:\n#{result}" if Object.const_defined?('RAILS_DEFAULT_LOGGER')
+
+        if Object.const_defined?(:ActiveSupport) && ActiveSupport.const_defined?(:XmlMini)
+          # for Rails 2.3+
+          xml = ActiveSupport::XmlMini.parse(result)
+          xml = xml['operationResult']
+
+          begin
+            content_key = ActiveSupport::XmlMini.backend::CONTENT_KEY
+          rescue NameError
+            # Nokogiri doesn't define a CONTENT_KEY const -- the content key is always just '__content__'
+            content_key = '__content__'
+          end
+
+          xml.each do |k,v|
+            if v.kind_of?(Hash) && v[content_key]
+              xml[k] = [v[content_key]]
+            end
+          end
+        else
+          xml = XmlSimple.xml_in_string(result)
+        end
+
         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)
+
+      def connect(url, username, password, timeout = 60)
+        @driver = connect_to_soap_service(url, username, password, timeout)
       end
-      
+
       protected
-      def connect_to_soap_service(url, username, password)
+      def connect_to_soap_service(url, username, password, timeout = 60)
         driver = ::SOAP::RPC::Driver.new(url, JASPER_URN)
         driver.options['protocol.http.basic_auth'] << [url, username, password]
-        
+        driver.options['receive_timeout'] = timeout
+
+
         driver.add_method('runReport', 'requestXmlString')
         return driver
       end
     end
   end
-end
+end

data/lib/jasper_server/report_request.rb

@@ -18,14 +18,17 @@ module JasperServer
     #                  are automatically adjusted for timezone).
     #                  E.g. <tt>{ 'fruit' => "Apple", 'date' => Time.now}</tt>
     def initialize(report_unit, output_format, report_params = {})
+      raise ArgumentError, "Missing output_format in report request!" if output_format.nil? || output_format.empty?
       @report_unit   = report_unit
       @output_format = output_format.upcase
       @report_params = report_params
     end
     
-    # Converts the given Time into a timestamp integer acceptable by JasperServer.
+    # Converts the given Time/DateTime/Date into a timestamp integer acceptable by JasperServer.
     # The timezone adjustment is performed (converted to UTC).
     def self.convert_time_to_jasper_timestamp(time)
+      time = Time.parse(time.to_s) unless time.kind_of?(Time)
+
       # convert to milisecond timestamp
       ts = time.to_i * 1000
       # adjust for timezone
@@ -34,4 +37,4 @@ module JasperServer
     end
     
   end
-end
+end

data/lib/jasperserver-client.rb

@@ -1 +1,3 @@
-require 'jasper_server/client'
+require 'jasper_server/client'
+require 'jasper_server/report_request'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jasperserver-client
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Matt Zukowski
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-25 00:00:00 -04:00
+date: 2010-04-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,14 +33,12 @@ extra_rdoc_files:
 - History.txt
 - License.txt
 - Manifest.txt
-- PostInstall.txt
-- README.txt
+- README.rdoc
 files: 
 - History.txt
 - License.txt
 - Manifest.txt
-- PostInstall.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
@@ -65,14 +63,12 @@ files:
 - test/test_jasperserver-client.rb
 has_rdoc: true
 homepage: http://jasper-client.rubyforge.org
-post_install_message: |+
-  
-  For more information on jasperserver-client, see http://jasperserver-client.rubyforge.org
-  
-  
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,10 +86,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: jasper-client
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
-summary: Ruby-based client for JasperServer. Allows for requesting and fetching reports using Ruby from a networked JasperServer over SOAP.
+summary: Ruby-based client for JasperServer.
 test_files: 
 - test/test_jasperserver-client.rb
 - test/test_helper.rb

data/PostInstall.txt

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