bosdk 1.2.0-java

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Shane Emmons
+
+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/README.md

@@ -0,0 +1,76 @@
+BOSDK.gem
+=========
+
+Description
+-----------
+
+A JRuby wrapper for the Business Objects SDK
+
+Requirements
+------------
+
+- The Business Objects Java SDK
+- An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java
+  SDK directory
+- JRuby >= 1.4.0
+
+Usage
+-----
+
+    require 'bosdk'
+    include BOSDK
+    session = EnterpriseSession.new('cms', 'Administrator', '')
+   
+    stmt = "SELECT TOP 10 * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User'"
+    session.query(stmt).each do |obj|
+      puts obj.path
+    end
+  
+    session.disconnect
+
+Alternatively you can use the #connect closure.
+
+    require 'bosdk'
+    BOSDK.connect('cms', 'Administrator', '') do |session|
+      stmt = "SELECT TOP 10 * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User'"
+      session.query(stmt).each do |obj|
+        puts obj.path
+      end
+    end
+
+BOIRB
+-----
+
+The library ships with an extension to the standard irb shell that connects you
+to a cms and gives you a handful of helpful shortcuts.
+ 
+    connect(cms, username, password, options = Hash.new)
+Creates a new EnterpriseSession and binds it to @boe.
+
+    connected?
+Tests whether @boe is connected to a cms.
+
+    disconnect
+Disconnects @boe from the cms.
+
+    query(stmt)
+Runs the provided query on @boe and returns the resulting InfoObject array.
+
+    open_webi(docid)
+Opens the specified InfoObject using a ReportEngine and returns a handle to the
+WebiInstance. It also creates the following instance variables: @doc, @objs and
+@vars. @doc is a handle to the WebiInstance, @objs is an alias for @doc.objects
+and @vars is an alias for @doc.variables.
+
+    objects
+Shortcut to @objs which is an alias for @doc.objects
+
+    variables
+Shortcut to @vars which is an alias for @doc.variables
+
+Resources
+---------
+
+- [Website](http://semmons99.github.com/bosdk)
+- [Git Repo](http://github.com/semmons99/bosdk)
+- [Twitter](http://twitter.com/bosdk_gem)

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake/clean'
+
+CLOBBER.include('doc', '.yardoc')
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("../bosdk.gemspec", __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rake/gempackagetask'
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end
+task :gem => :gemspec
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/bin/boirb

@@ -0,0 +1,63 @@
+#!/usr/bin/env jruby
+
+require 'irb'
+
+module IRB
+  def self.start_session(binding)
+    IRB.setup(nil)
+
+    workspace = WorkSpace.new(binding)
+
+    if @CONF[:SCRIPT]
+      irb = Irb.new(workspace, @CONF[:SCRIPT])
+    else
+      irb = Irb.new(workspace)
+    end
+
+    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:MAIN_CONTEXT] = irb.context
+
+    trap("SIGINT") do
+      irb.signal_handle
+    end
+
+    catch(:IRB_EXIT) do
+      irb.eval_input
+    end
+  end
+end
+
+require 'bosdk'
+
+def connect(cms, username, password, options = Hash.new)
+  @boe = BOSDK::EnterpriseSession.new(cms, username, password, options)
+end
+
+def connected?
+  @boe and @boe.connected?
+end
+
+def disconnect
+  @boe.disconnect if connected?
+end
+
+def query(stmt)
+  @boe.query(stmt) if connected?
+end
+
+def open_webi(docid)
+  @doc = @boe.open_webi(docid) if connected?
+  @objs = @doc.objects
+  @vars = @doc.variables
+  @doc
+end
+
+def objects
+  @objs
+end
+
+def variables
+  @vars
+end
+
+IRB.start_session(Kernel.binding)

data/bosdk.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = "bosdk"
+  s.version     = "1.2.0"
+  s.platform    = "java"
+  s.authors     = ["Shane Emmons"]
+  s.email       = "semmons99@gmail.com"
+  s.homepage    = "http://semmons99.github.com/bosdk"
+  s.summary     = "JRuby Business Object Java SDK wrapper"
+  s.description = "A JRuby wrapper for the Business Objects Java SDK"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.requirements = ["An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java SDK directory"]
+
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "yard"
+
+  s.files =  Dir.glob("{bin,lib,spec}/**/*")
+  s.files += %w(README.md LICENSE)
+  s.files += %w(Rakefile .gemtest bosdk.gemspec)
+
+  s.executables  = ["boirb"]
+  s.require_path = "lib"
+end
+

data/lib/bosdk/enterprise_session.rb

@@ -0,0 +1,54 @@
+module BOSDK
+  # Creates a wrapper around the Business Objects Java SDK.
+  class EnterpriseSession
+    # The underlying IEnterpriseSession
+    attr_reader :session
+
+    # The underlying IInfoStore
+    attr_reader :infostore
+
+    # Creates a new EnterpriseSession object, connecting to the specified CMS.
+    #  EnterpriseSession.new('cms', 'Administrator', '')
+    #
+    # Automatically calls disconnect when cleaned up.
+    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
+
+    # Returns true/false if connected to the CMS.
+    def connected?
+      return @connected
+    end
+
+    # Disconnects from the CMS is connected.
+    def disconnect
+      @session.logoff if connected?
+      @session = nil
+      @connected = false
+      nil
+    end
+
+    # Converts 'path://', 'query://' and 'cuid://' special forms to a SDK query
+    def path_to_sql(path_stmt)
+      @infostore.getStatelessPageInfo(path_stmt, PagingQueryOptions.new).getPageSQL
+    end
+
+    # Queries the InfoStore with the provided statement, returning an Array of
+    # InfoObject(s).
+    def query(stmt)
+      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)
+      WebiInstance.new(@webi_report_engine.open(docid))
+    end
+  end
+end

data/lib/bosdk/info_object.rb

@@ -0,0 +1,53 @@
+module BOSDK
+  # Creates a wrapper around an IInfoObject.
+  class InfoObject
+    # The underlying IInfoObject.
+    attr_reader :obj
+
+    # Creates a new InfoObject from the provided IInfoObject.
+    #  InfoObject.new(obj)
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Returns the Business Objects ID (alias for #getID).
+    def docid
+      getID
+    end
+
+    # Returns true/false if #obj is a root node.
+    def is_root?
+      parent_id.nil? or parent_id == 0 or parent_id == docid
+    end
+
+    # Returns the parent of #obj as an InfoObject
+    def parent
+      return nil if is_root?
+      @parent ||= InfoObject.new(getParent)
+    end
+
+    # Returns the path of #obj as a String.
+    def path
+      @path ||= (is_root? ? '' : parent.path) + "/#{title}"
+    end
+
+    # Compares one InfoObject to another by #title.
+    def <=>(other_infoobject)
+      title <=> other_infoobject.title
+    end
+
+    # Forwards method to underlying IInfoObject and stores the results
+    def method_missing(method, *args)
+      eval "return @#{method.to_s}" if instance_variables.include?("@#{method.to_s}")
+      if @obj.respond_to?(method)
+        eval "return @#{method.to_s} = @obj.send(method, *args)"
+      end
+      super
+    end
+
+    # Returns true if underlying IInfoObject#respond_to? is true
+    def respond_to?(method)
+      @obj.respond_to?(method) || super
+    end
+  end
+end

data/lib/bosdk/webi_instance.rb

@@ -0,0 +1,46 @@
+module BOSDK
+  # Creates a wrapper around a DocumentInstance
+  class WebiInstance
+    # The underlying DocumentInstance
+    attr_reader :instance
+
+    # Create a new WebiInstance from the provided DocumentInstance
+    def initialize(instance)
+      @instance = instance
+    end
+
+    # Returns an array of hashes representing report objects.
+    def objects
+      return @objects unless @objects.nil?
+      objs = []
+      dict = @instance.getDictionary
+      (0 ... dict.getChildCount).each do |i|
+        obj = dict.getChildAt(i)
+        objs << {
+          :name => obj.getName,
+          :qual => obj.getQualification.toString.downcase.to_sym,
+          :type => obj.getType.toString.downcase.to_sym,
+          :object => obj,
+        }
+      end
+      @objects = objs
+    end
+
+    # Returns an array of hashes representing report variables.
+    def variables
+      return @variables unless @variables.nil?
+      vars = []
+      dict = @instance.getDictionary
+      dict.getVariables.each do |var|
+        vars << {
+          :name => var.getName,
+          :qual => var.getQualification.toString.downcase.to_sym,
+          :type => var.getType.toString.downcase.to_sym,
+          :formula => var.getFormula.getValue,
+          :variable => var,
+        }
+      end
+      @variables = vars
+    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/lib/bosdk.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2010 Shane Emmons
+# 
+# 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.
+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'
+require 'bosdk/webi_instance'
+
+module BOSDK
+  # A closure over EnterpriseSession
+  def BOSDK.connect(cms, username, password, options = Hash.new, &block)
+    session = EnterpriseSession.new(cms, username, password, options)
+    yield session
+    session.disconnect
+  end
+end

data/spec/bosdk_spec.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk'
+
+module BOSDK
+  describe BOSDK do
+    describe "#connect" do
+      before(:each) do
+        @es = mock("EnterpriseSession").as_null_object
+        class EnterpriseSession; end
+        EnterpriseSession.should_receive(:new).once.with('cms', 'Administrator', '', {:locale => "en_US"}).and_return(@es)
+        @es.should_receive(:disconnect).once.with.and_return
+      end
+
+      specify "wraps EnterpriseSession#new in a closure" do
+        BOSDK.connect('cms', 'Administrator', '', :locale => "en_US") do |session|
+          session.should == @es
+        end
+      end
+    end
+  end
+end

data/spec/enterprise_session_spec.rb

@@ -0,0 +1,170 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/enterprise_session'
+
+module BOSDK
+  describe EnterpriseSession do
+    before(:each) do
+      @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
+
+      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
+
+    describe "#new" do
+      it "should accept an optional locale setting" do
+        EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+      end
+    end
+
+    describe "#connected?" do
+      before(:each) do
+        @session.should_receive(:logoff).at_most(1).with.and_return
+      end
+
+      it "returns 'true' when connected to a CMS" do
+        @es.connected?.should be_true
+      end
+
+      it "returns 'false' when not connected to a CMS" do
+        @es.disconnect
+        @es.connected?.should be_false
+      end
+    end
+
+    describe "#disconnect" do
+      before(:each) do
+        @session.should_receive(:logoff).once.with.and_return
+      end
+
+      it "should disconnect from the CMS" do
+        @es.disconnect
+        @es.connected?.should be_false
+      end
+
+      it "shouldn't raise an error when not connected" do
+        lambda{2.times{ @es.disconnect }}.should_not raise_exception
+      end
+    end
+
+    describe "#path_to_sql" do
+      before(:each) do
+        @path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
+        @stmt = "SELECT SI_ID FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administrator'"
+        
+        @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)
+      end
+
+      it "should convert a path query to an sql query" do
+        @es.path_to_sql(@path_query).should == @stmt
+      end
+    end
+
+    describe "#query" do
+      context "when :type => sql" do
+        before(:each) do
+          @stmt = 'SELECT * FROM CI_INFOOBJECTS'
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should send the statement to the underlying InfoStore" do
+          @es.query(@stmt)
+        end
+      end
+
+      context "when :type => path://" do
+        before(:each) do
+          @path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
+          @stmt = "SELECT * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administator'"
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a path:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
+
+      context "when :type => query://" do
+        before(:each) do
+          @path_query = 'query://{SELECT * FROM CI_INFOOBJECTS}'
+          @stmt = 'SELECT * FROM CI_INFOOBJECTS'
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a query:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
+
+      context "when :type => cuid://" do
+        before(:each) do
+          @path_query = 'cuid://ABC'
+          @stmt = "SELECT * FROM CI_INFOOBJECTS WHERE SI_CUID='ABC'"
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a cuid:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
+    end
+
+    describe "#open_webi" do
+      before(:each) do
+        @webi_report_engine = mock("WebiReportEngine").as_null_object
+        @document_instance = mock("DocumentInstance").as_null_object
+        @webi_instance = mock("WebiInstance").as_null_object
+        class WebiReportEngine; end
+        class WebiInstance; end
+        WebiInstance.should_receive(:new).at_least(1).with(@document_instance).and_return(@webi_instance)
+        @webi_report_engine.should_receive(:open).at_least(1).with("1234").and_return(@document_instance)
+      end
+
+      context "when :locale => en_US" do
+        before(:each) do
+          WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
+        end
+
+        it "should create a WebiReportEngine and call #open" do
+          @es.open_webi("1234")
+        end
+
+        it "should only create a WebiReportEngine once" do
+          2.times{@es.open_webi("1234")}
+        end
+
+        it "should create a WebiInstance and return it" do
+          @es.open_webi("1234").should == @webi_instance
+        end
+      end
+
+      context "when :locale => en_CA" do
+        before(:each) do
+          WebiReportEngine.should_receive(:new).once.with(@session, 'en_CA').and_return(@webi_report_engine)
+        end
+
+        it "should pass any specified locale" do
+          es = EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+          es.open_webi("1234")
+        end
+      end
+    end
+  end
+end

data/spec/info_object_spec.rb

@@ -0,0 +1,149 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/info_object'
+
+module BOSDK
+  describe InfoObject do
+    before(:each) do
+      @infoobject = mock("IInfoObject").as_null_object
+
+      @obj = InfoObject.new(@infoobject)
+    end
+    
+    describe "#docid" do
+      before(:each) do
+        @infoobject.should_receive(:getID).once.with.and_return(1)
+      end
+
+      it "should call #getID and return the result" do
+        @obj.docid.should == 1
+      end
+
+      it "should only call #getID once" do
+        2.times{@obj.docid.should == 1}
+      end
+    end
+
+    describe "#is_root?" do
+      context "when #parent_id == nil" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+        end
+
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      end
+
+      context "when #parent_id == 0" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(0)
+        end
+
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      end
+
+      context "when #parent_id == #getID" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(1)
+        end
+
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      end
+
+      context "when #parent_id != nil, 0 or #getID" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(2)
+        end
+
+        it "should return false" do
+          @obj.is_root?.should be_false
+        end
+      end
+    end
+
+    describe "#parent" do
+      context "when #is_root? == true" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+        end
+
+        it "should return nil" do
+          @obj.parent.should be_nil
+        end
+      end
+
+      context "when #is_root? == false" do
+        before(:each) do
+          @parent_obj = mock("IInfoObject").as_null_object
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(2)
+          @infoobject.should_receive(:getParent).once.with.and_return(@parent_obj)
+        end
+
+        it "should return results of #getParent" do
+          parent = @obj.parent
+          parent.should be_instance_of InfoObject
+          parent.obj.should == @parent_obj
+        end
+
+        it "should only call the underlying #getParent once" do
+          2.times{@obj.parent}
+        end
+      end
+    end
+
+    describe "#path" do
+      context "when #is_root? == true" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+          @infoobject.should_receive(:title).once.with.and_return('test obj')
+        end
+
+        it "should return /#title" do
+          @obj.path.should == '/test obj'
+        end
+      end
+
+      context "when #is_root? == false" do
+        before(:each) do
+          @parent_obj = mock("IInfoObject").as_null_object
+          @parent_obj.should_receive(:parent_id).once.with.and_return(nil)
+          @parent_obj.should_receive(:title).once.with.and_return('test parent')
+
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(2)
+          @infoobject.should_receive(:title).once.with.and_return('test obj')
+          @infoobject.should_receive(:getParent).once.with.and_return(@parent_obj)
+        end
+
+        it "should return #parent_title/../#title" do
+          @obj.path.should == '/test parent/test obj'
+        end
+
+        it "should only call the underlying #title, #parent#path, etc. once" do
+          2.times{@obj.path}
+        end
+      end
+    end
+
+    describe "#<=>" do
+      it "should use #title" do
+        objs = []
+        ('a'..'c').to_a.reverse.each do |ltr|
+          obj = mock("IInfoObject").as_null_object
+          obj.should_receive(:title).once.with.and_return(ltr)
+          objs << InfoObject.new(obj)
+        end
+
+        sorted_objs = objs.sort
+        sorted_objs.should == objs.reverse
+      end
+    end
+  end
+end

data/spec/webi_instance_spec.rb

@@ -0,0 +1,112 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/webi_instance'
+
+module BOSDK
+  describe WebiInstance do
+    before(:each) do
+      @document_instance = mock("DocumentInstance").as_null_object
+
+      @webi = WebiInstance.new(@document_instance)
+    end
+
+    describe "#new" do
+      it "should store the passed DocumentInstance in @doc_instance" do
+        @webi.instance.should == @document_instance
+      end
+    end
+
+    describe "#objects" do
+      before(:each) do
+        @report_dictionary = mock("ReportDictionary").as_null_object
+        @report_expression_1 = mock("ReportExpression").as_null_object
+        @report_expression_2 = mock("ReportExpression").as_null_object
+        @object_qualification_1 = mock("ObjectQualification").as_null_object
+        @object_qualification_2 = mock("ObjectQualification").as_null_object
+        @object_type_1 = mock("ObjectType").as_null_object
+        @object_type_2 = mock("ObjectType").as_null_object
+
+        @document_instance.should_receive(:getDictionary).once.with.and_return(@report_dictionary)
+
+        @report_dictionary.should_receive(:getChildCount).once.with.and_return(2)
+        @report_dictionary.should_receive(:getChildAt).once.with(0).and_return(@report_expression_1)
+        @report_dictionary.should_receive(:getChildAt).once.with(1).and_return(@report_expression_2)
+
+        @report_expression_1.should_receive(:getName).once.with.and_return("Object1")
+        @report_expression_1.should_receive(:getQualification).once.with.and_return(@object_qualification_1)
+        @report_expression_1.should_receive(:getType).once.with.and_return(@object_type_1)
+
+        @report_expression_2.should_receive(:getName).once.with.and_return("Object2")
+        @report_expression_2.should_receive(:getQualification).once.with.and_return(@object_qualification_2)
+        @report_expression_2.should_receive(:getType).once.with.and_return(@object_type_2)
+
+        @object_qualification_1.should_receive(:toString).once.with.and_return("DIMENSION")
+        @object_qualification_2.should_receive(:toString).once.with.and_return("MEASURE")
+
+        @object_type_1.should_receive(:toString).once.with.and_return("TEXT")
+        @object_type_2.should_receive(:toString).once.with.and_return("NUMERIC")
+
+        @objects = [
+          {:name => 'Object1', :qual => :dimension, :type => :text, :object => @report_expression_1},
+          {:name => 'Object2', :qual => :measure, :type => :numeric, :object => @report_expression_2},
+        ]
+      end
+
+      it "should return an array of report objects" do
+        @webi.objects.should == @objects
+      end
+
+      it "should cache results" do
+        2.times{@webi.objects}
+      end
+    end
+
+    describe "#variables" do
+      before(:each) do
+        @report_dictionary = mock("ReportDictionary").as_null_object
+        @variable_expression_1 = mock("VariableExpression").as_null_object
+        @variable_expression_2 = mock("VariableExpression").as_null_object
+        @object_qualification_1 = mock("ObjectQualification").as_null_object
+        @object_qualification_2 = mock("ObjectQualification").as_null_object
+        @object_type_1 = mock("ObjectType").as_null_object
+        @object_type_2 = mock("ObjectType").as_null_object
+        @formula_expression_1 = mock("FormulaExpression").as_null_object
+        @formula_expression_2 = mock("FormulaExpression").as_null_object
+
+        @document_instance.should_receive(:getDictionary).once.with.and_return(@report_dictionary)
+        @report_dictionary.should_receive(:getVariables).once.with.and_return([@variable_expression_1, @variable_expression_2])
+
+        @variable_expression_1.should_receive(:getName).once.with.and_return("Variable1")
+        @variable_expression_1.should_receive(:getQualification).once.with.and_return(@object_qualification_1)
+        @variable_expression_1.should_receive(:getType).once.with.and_return(@object_type_1)
+        @variable_expression_1.should_receive(:getFormula).once.with.and_return(@formula_expression_1)
+
+        @variable_expression_2.should_receive(:getName).once.with.and_return("Variable2")
+        @variable_expression_2.should_receive(:getQualification).once.with.and_return(@object_qualification_2)
+        @variable_expression_2.should_receive(:getType).once.with.and_return(@object_type_2)
+        @variable_expression_2.should_receive(:getFormula).once.with.and_return(@formula_expression_2)
+
+        @object_qualification_1.should_receive(:toString).once.with.and_return("DIMENSION")
+        @object_qualification_2.should_receive(:toString).once.with.and_return("MEASURE")
+
+        @object_type_1.should_receive(:toString).once.with.and_return("TEXT")
+        @object_type_2.should_receive(:toString).once.with.and_return("NUMERIC")
+
+        @formula_expression_1.should_receive(:getValue).once.with.and_return('If([Object1]="Object1";"Yes";"False")')
+        @formula_expression_2.should_receive(:getValue).once.with.and_return('Sum([Object2])')
+
+        @variables = [
+          {:name => 'Variable1', :qual => :dimension, :type => :text, :formula => 'If([Object1]="Object1";"Yes";"False")', :variable => @variable_expression_1},
+          {:name => 'Variable2', :qual => :measure, :type => :numeric, :formula => 'Sum([Object2])', :variable => @variable_expression_2},
+        ]
+      end
+
+      it "should return an array of variables" do
+        @webi.variables.should == @variables
+      end
+
+      it "should cache results" do
+        2.times{@webi.variables}
+      end
+    end
+  end
+end

data/spec/webi_report_engine_spec.rb

@@ -0,0 +1,39 @@
+$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")
+
+      @wre = WebiReportEngine.new(@enterprise_session)
+    end
+
+    describe "#new" do
+      before(:each) do
+        @webi_report_engine.should_receive(:setLocale).once.with("en_CA")
+      end
+
+      it "should allow you to set the locale" do
+        WebiReportEngine.new(@enterprise_session, "en_CA")
+      end
+    end
+
+    describe "#open" do
+      before(:each) do
+        @webi_report_engine.should_receive(:openDocument).once.with("1234")
+      end
+
+      it  "should call the underlying #openDocument with the supplied docid" do
+        @wre.open("1234")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: bosdk
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.2.0
+platform: java
+authors: 
+  - Shane Emmons
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 -05:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 2.0.0
+    type: :development
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id002
+description: A JRuby wrapper for the Business Objects Java SDK
+email: semmons99@gmail.com
+executables: 
+  - boirb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - bin/boirb
+  - lib/bosdk.rb
+  - lib/bosdk/enterprise_session.rb
+  - lib/bosdk/info_object.rb
+  - lib/bosdk/webi_instance.rb
+  - lib/bosdk/webi_report_engine.rb
+  - spec/bosdk_spec.rb
+  - spec/enterprise_session_spec.rb
+  - spec/info_object_spec.rb
+  - spec/webi_instance_spec.rb
+  - spec/webi_report_engine_spec.rb
+  - README.md
+  - LICENSE
+  - Rakefile
+  - .gemtest
+  - bosdk.gemspec
+has_rdoc: true
+homepage: http://semmons99.github.com/bosdk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.6
+requirements: 
+  - An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java SDK directory
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: JRuby Business Object Java SDK wrapper
+test_files: []
+