bosdk 0.1.0-universal-java-1.6 → 0.1.1-universal-java-1.6

data/README.rdoc

@@ -7,22 +7,26 @@ 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
+- An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java
+  SDK directory
 - JRuby >= 1.4.0
 
 == Usage
 
  require 'bosdk'
- session = BOSDK::EnterpriseSession.new 'cms', 'Administrator', ''
+ boe = BOSDK::EnterpriseSession.new('cms', 'Administrator', '')
 
- ...do stuff with 'session.boe'...
+ stmt = "SELECT TOP 10 * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User'"
+ boe.query(stmt).each do |obj|
+   puts obj.title
+ end
 
- session.disconnect if session.connected?
+ boe.disconnect
 
 == Future Enhancements
 
-In the future there will be wrappers around the more commonly used portions of the SDK,
-including IInfoStore and IInfoObject.
+In the future there may be wrappers around the more commonly used portions of
+the SDK, such as IInfoObject.
 
 == Resources
 

data/bosdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "bosdk"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   
   s.author = "Shane Emmons"
   s.description = "A JRuby wrapper for the Business Objects Java SDK"

data/lib/bosdk/enterprise_session.rb

@@ -1,22 +1,40 @@
 module BOSDK
+  # Creates a wrapper around the Business Objects Java SDK
   class EnterpriseSession
-    attr_reader :boe
+    # 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)
-      @boe = CrystalEnterprise.getSessionMgr.logon(username, password, cms, 'secEnterprise')
+      @session = CrystalEnterprise.getSessionMgr.logon(username, password, cms, 'secEnterprise')
+      @infostore = @session.getService('', 'InfoStore')
       @connected = true
 
       at_exit { disconnect }
     end
 
+    # Returned true/false if connected to the CMS.
     def connected?
       return @connected
     end
 
+    # Disconnects from the CMS is connected.
     def disconnect
-      @boe.logoff if connected?
-      @boe = nil
+      @session.logoff if connected?
+      @session = nil
       @connected = false
+      nil
+    end
+
+    # Queries the InfoStore with the provided statement.
+    def query(stmt)
+      @infostore.query(stmt)
     end
   end
 end

data/spec/enterprise_session_spec.rb

@@ -12,11 +12,13 @@ module BOSDK
       # 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).with.and_return(@session_mgr)
+      CrystalEnterprise.should_receive(:getSessionMgr).and_return(@session_mgr)
       @session_mgr.should_receive(:logon).once.with('Administrator', '', 'cms', 'secEnterprise').and_return(@session)
-      @session.should_receive(:logoff).at_most(2).with.and_return
+      @session.should_receive(:getService).once.with('', 'InfoStore').and_return(@infostore)
 
       @es = EnterpriseSession.new('cms', 'Administrator', '')
     end
@@ -26,18 +28,38 @@ module BOSDK
     end
 
     specify "#connected? returns 'false' when not connected to a CMS" do
+      @session.should_receive(:logoff).once.with.and_return
+
       @es.disconnect
       @es.connected?.should be_false
     end
 
     specify "#disconnect should disconnect from the CMS" do
+      @session.should_receive(:logoff).once.with.and_return
+
       @es.disconnect
       @es.connected?.should be_false
     end
 
     specify "#disconnect shouldn't raise an error when not connected" do
-      @es.disconnect
-      lambda{@es.disconnect}.should_not raise_exception
+      @session.should_receive(:logoff).once.with.and_return
+
+      lambda{2.times{ @es.disconnect }}.should_not raise_exception
+    end
+
+    specify "#query should send the statement to the underlying InfoStore" do
+      stmt = 'SELECT * FROM CI_infoobjectS'
+      @infostore.should_receive(:query).once.with(stmt)
+
+      results = @es.query(stmt)
+    end
+
+    specify "#query should return the IInfoObjects" do
+      stmt = 'SELECT * FROM CI_INFOOBJECTS'
+      @infostore.should_receive(:query).once.with(stmt).and_return(@infoobjects)
+
+      results = @es.query(stmt)
+      results.should == @infoobjects
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bosdk
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: universal-java-1.6
 authors: 
   - Shane Emmons