bosdk 1.0.1-universal-java-1.6 → 1.0.2-universal-java-1.6

data/README.rdoc

@@ -1,4 +1,4 @@
-= BOSDK.gem v1.0.1
+= BOSDK.gem
 
 == Description
 

data/bosdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "bosdk"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
   
   s.author = "Shane Emmons"
   s.description = "A JRuby wrapper for the Business Objects Java SDK"
@@ -10,8 +10,10 @@ Gem::Specification.new do |s|
     "lib/bosdk.rb",
     "lib/bosdk/enterprise_session.rb",
     "lib/bosdk/info_object.rb",
+    "lib/bosdk/webi_report_engine.rb",
     "spec/enterprise_session_spec.rb",
     "spec/info_object_spec.rb",
+    "spec/webi_report_engine_spec.rb",
   ]
 
   s.homepage = "http://semmons99.github.com/bosdk"

data/lib/bosdk.rb

@@ -24,9 +24,11 @@ include Java
 Dir.glob(ENV["BOE_JAVA_LIB"] + "/*.jar").each{|jar| require jar}
 include_class "com.crystaldecisions.sdk.framework.CrystalEnterprise"
 include_class "com.crystaldecisions.sdk.uri.PagingQueryOptions"
+include_class "com.businessobjects.rebean.wi.ReportEngines"
 
 require 'bosdk/enterprise_session'
 require 'bosdk/info_object'
+require 'bosdk/webi_report_engine'
 
 module BOSDK
   # A closure over EnterpriseSession

data/lib/bosdk/enterprise_session.rb

@@ -1,4 +1,5 @@
 require 'bosdk/info_object'
+require 'bosdk/webi_report_engine'
 
 module BOSDK
   # Creates a wrapper around the Business Objects Java SDK.
@@ -13,10 +14,11 @@ module BOSDK
     #  EnterpriseSession.new('cms', 'Administrator', '')
     #
     # Automatically calls disconnect when cleaned up.
-    def initialize(cms, username, password)
+    def initialize(cms, username, password, options = Hash.new)
       @session = CrystalEnterprise.getSessionMgr.logon(username, password, cms, 'secEnterprise')
       @infostore = @session.getService('', 'InfoStore')
       @connected = true
+      @locale = options[:locale] || 'en_US'
 
       at_exit { disconnect }
     end
@@ -45,5 +47,11 @@ module BOSDK
       sql = stmt.match(/^(path|query|cuid):\/\//i) ? path_to_sql(stmt) : stmt
       @infostore.query(sql).map{|o| InfoObject.new(o)}
     end
+
+    # Open a Webi document from the provided docid
+    def open_webi(docid)
+      @webi_report_engine ||= WebiReportEngine.new(@session, @locale)
+      @webi_report_engine.open(docid)
+    end
   end
 end

data/lib/bosdk/webi_report_engine.rb

@@ -0,0 +1,22 @@
+module BOSDK
+  # Creates a wrapper around a Webi based ReportEngine.
+  class WebiReportEngine
+    # The underlying ReportEngine.
+    attr_reader :webi_report_engine
+
+    # Creates a new ReportEngine using the provided EnterpriseSession and an
+    # optional locale setting.
+    #  WebiReportEngine.new(enterprise_session)
+    def initialize(enterprise_session, locale = "en_US")
+      report_engines = enterprise_session.getService("ReportEngines")
+      @webi_report_engine = report_engines.getService(ReportEngines::ReportEngineType::WI_REPORT_ENGINE)
+      @webi_report_engine.setLocale(locale)
+      #enterprise_session.setAttribute("widReportEngine", @webi_report_engine)
+    end
+
+    # Opens the webi document specified by the docid.
+    def open(docid)
+      @webi_report_engine.openDocument(docid)
+    end
+  end
+end

data/spec/enterprise_session_spec.rb

@@ -1,29 +1,27 @@
 # encoding: utf-8
-include Java
-Dir.glob(ENV["BOE_JAVA_LIB"] + "/*.jar").each {|jar| require jar}
-include_class "com.crystaldecisions.sdk.framework.CrystalEnterprise"
-include_class "com.crystaldecisions.sdk.uri.PagingQueryOptions"
-
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'bosdk/enterprise_session'
 
 module BOSDK
   describe EnterpriseSession do
     before(:each) do
-      # mocks
       @session_mgr = mock("ISessionMgr").as_null_object
       @session = mock("IEnterpriseSession").as_null_object
       @infostore = mock("IInfoStore").as_null_object
       @infoobjects = mock("IInfoObjects").as_null_object
 
-      # stubs
-      CrystalEnterprise.should_receive(:getSessionMgr).and_return(@session_mgr)
-      @session_mgr.should_receive(:logon).once.with('Administrator', '', 'cms', 'secEnterprise').and_return(@session)
-      @session.should_receive(:getService).once.with('', 'InfoStore').and_return(@infostore)
+      class CrystalEnterprise; end
+      CrystalEnterprise.should_receive(:getSessionMgr).at_least(1).with.and_return(@session_mgr)
+      @session_mgr.should_receive(:logon).at_least(1).with('Administrator', '', 'cms', 'secEnterprise').and_return(@session)
+      @session.should_receive(:getService).at_least(1).with('', 'InfoStore').and_return(@infostore)
 
       @es = EnterpriseSession.new('cms', 'Administrator', '')
     end
 
+    specify "#new should accept an optional locale setting" do
+      EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+    end
+
     specify "#connected? returns 'true' when connected to a CMS" do
       @es.connected?.should be_true
     end
@@ -54,6 +52,7 @@ module BOSDK
       
       @stateless_page_info = mock("IStatelessPageInfo").as_null_object
 
+      class PagingQueryOptions; end
       PagingQueryOptions.should_receive(:new).once.with
       @infostore.should_receive(:getStatelessPageInfo).once.with(path_query, nil).and_return(@stateless_page_info)
       @stateless_page_info.should_receive(:getPageSQL).once.with.and_return(stmt)
@@ -97,5 +96,33 @@ module BOSDK
 
       @es.query(path_query)
     end
+
+    specify "#open_webi should create a WebiReportEngine and call #open" do
+      @webi_report_engine = mock("WebiReportEngine").as_null_object
+      class WebiReportEngine; end
+      WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
+      @webi_report_engine.should_receive(:open).once.with("1234")
+
+      @es.open_webi("1234")
+    end
+
+    specify "#open_webi should only create a WebiReportEngine once" do
+      @webi_report_engine = mock("WebiReportEngine").as_null_object
+      class WebiReportEngine; end
+      WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
+      @webi_report_engine.should_receive(:open).twice.with("1234")
+
+      2.times{@es.open_webi("1234")}
+    end
+
+    specify "#open_webi should pass any specified locale" do
+      @webi_report_engine = mock("WebiReportEngine").as_null_object
+      class WebiReportEngine; end
+      WebiReportEngine.should_receive(:new).once.with(@session, 'en_CA').and_return(@webi_report_engine)
+      @webi_report_engine.should_receive(:open).once.with("1234")
+
+      es = EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+      es.open_webi("1234")
+    end
   end
 end

data/spec/webi_report_engine_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/webi_report_engine'
+
+module BOSDK
+  describe WebiReportEngine do
+    before(:each) do
+      @enterprise_session = mock("EnterpriseSession").as_null_object
+      @report_engines = mock("ReportEngines").as_null_object
+      @webi_report_engine = mock("ReportEngine").as_null_object
+
+      @enterprise_session.should_receive(:getService).at_least(1).with("ReportEngines").and_return(@report_engines)
+      module ReportEngines; module ReportEngineType; module WI_REPORT_ENGINE; end; end; end
+      @report_engines.should_receive(:getService).at_least(1).with(ReportEngines::ReportEngineType::WI_REPORT_ENGINE).and_return(@webi_report_engine)
+      @webi_report_engine.should_receive(:setLocale).at_least(1).with("en_US")
+      #@enterprise_session.should_receive(:setAttribute).at_least(1).with("widReportEngine", @webi_report_engine)
+
+      @wre = WebiReportEngine.new(@enterprise_session)
+    end
+
+    specify "#new should allow you to set the locale" do
+      @webi_report_engine.should_receive(:setLocale).once.with("en_CA")
+
+      WebiReportEngine.new(@enterprise_session, "en_CA")
+    end
+
+    specify "#open should call the underlying #openDocument with the supplied docid" do
+      @webi_report_engine.should_receive(:openDocument).once.with("1234")
+
+      @wre.open("1234")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bosdk
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: universal-java-1.6
 authors: 
   - Shane Emmons
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -05:00
+date: 2010-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,8 +29,10 @@ files:
   - lib/bosdk.rb
   - lib/bosdk/enterprise_session.rb
   - lib/bosdk/info_object.rb
+  - lib/bosdk/webi_report_engine.rb
   - spec/enterprise_session_spec.rb
   - spec/info_object_spec.rb
+  - spec/webi_report_engine_spec.rb
 has_rdoc: true
 homepage: http://semmons99.github.com/bosdk
 licenses: []