qbfc 0.3.0

data/spec/unit/session_spec.rb

@@ -0,0 +1,144 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe QBFC::Session do
+
+  before(:each) do
+    @ole_object = mock("WIN32OLE")
+    @ole_object.stub!(:OpenConnection2)
+    @ole_object.stub!(:BeginSession)    
+    WIN32OLE.stub!(:new).and_return(@ole_object)
+    
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    QBFC::OLEWrapper.stub!(:new).and_return(@ole_wrapper)
+    
+    @qb_sess = QBFC::Session.new()
+  end
+
+  it "should create an QBFC WIN32OLE object" do
+    WIN32OLE.should_receive(:new).with("QBFC6.QBSessionManager").and_return(@ole_object)
+    QBFC::Session.new()
+  end
+  
+  it "should wrap WIN32OLE object" do
+    QBFC::OLEWrapper.should_receive(:new).with(@ole_object)
+    QBFC::Session.new()  
+  end
+
+  it "should open connection to Quickbooks and establish a session" do
+    @ole_object.should_receive(:OpenConnection2)
+    QBFC::Session.new()
+  end
+  
+  it "should begin a session with Quickbooks" do
+    @ole_object.should_receive(:BeginSession)
+    QBFC::Session.new()
+  end
+  
+  it "should raise an error if session can't be established" do
+    @ole_object.should_receive(:BeginSession).and_raise(WIN32OLERuntimeError)
+    @ole_object.should_receive(:CloseConnection)
+    lambda { QBFC::Session.new }.should raise_error(QBFC::QuickbooksClosedError)
+  end
+  
+  it "should accept an app_name option" do
+    @ole_object.should_receive(:OpenConnection2).with('', 'Test Application', 1)
+    QBFC::Session.new(:app_name => 'Test Application')
+  end
+  
+  it "should accept an app_id option" do
+    @ole_object.should_receive(:OpenConnection2).with('ID', 'Test Application', 1)
+    QBFC::Session.new(:app_name => 'Test Application', :app_id => 'ID')
+  end
+  
+  it "should accept a conn_type option" do
+    @ole_object.should_receive(:OpenConnection2).with('', 'Test Application', 0)
+    QBFC::Session.new(:app_name => 'Test Application', :conn_type => QBFC_CONST::CtUnknown)  
+  end
+  
+  it "should accept an open mode constant" do
+    @ole_object.should_receive(:BeginSession).with('', 0)
+    QBFC::Session.new(:open_mode => QBFC_CONST::OmSingleUser )
+    
+    @ole_object.should_receive(:BeginSession).with('', 1)
+    QBFC::Session.new(:open_mode => QBFC_CONST::OmMultiUser)
+
+    @ole_object.should_receive(:BeginSession).with('', 2)
+    QBFC::Session.new(:open_mode => QBFC_CONST::OmDontCare)
+  end
+  
+  it "should accept a filename option" do
+    @ole_object.should_receive(:BeginSession).with('TestCompany.qbw', 2)
+    QBFC::Session.new(:filename => 'TestCompany.qbw')
+  end
+    
+  it "should close session and connection on close" do
+    @ole_wrapper.should_receive(:EndSession)
+    @ole_wrapper.should_receive(:CloseConnection)
+    @qb_sess.close()
+  end
+  
+  describe "::open" do
+    
+    before(:each) do
+      @ole_wrapper.stub!(:EndSession)
+      @ole_wrapper.stub!(:CloseConnection)
+    end
+  
+    it "should accept a block" do
+      QBFC::Session.open do |qb|
+        qb.should be_kind_of(QBFC::Session)
+      end
+    end
+    
+    it "should return session if called without a block" do
+      QBFC::Session.open.should be_kind_of(QBFC::Session)
+    end
+  end
+  
+  it "should create an instance of QBFC::Base descendant from a singular method with params" do
+    @base = mock(QBFC::Base)
+    QBFC::Customer.should_receive(:find_by_unique_id).with(@qb_sess, '1234-5678').and_return(@base)
+    @qb_sess.customer('1234-5678').should == @base
+    
+    QBFC::Vendor.should_receive(:find_by_unique_id).with(@qb_sess, '1234-5678').and_return(@base)
+    @qb_sess.vendor('1234-5678').should == @base
+  end
+
+  it "should create an instance of QBFC::Base descendant from a singular method" do
+    @base = mock(QBFC::Base)
+    QBFC::Customer.should_receive(:find).with(@qb_sess, :first).and_return(@base)
+    @qb_sess.customer.should == @base
+  end
+  
+  it "should create an instance of QBFC::QBCollection a plural method" do
+    @collection = mock(QBFC::QBCollection)
+    QBFC::QBCollection.should_receive(:new).with(@qb_sess, :Customer).and_return(@collection)
+    @qb_sess.customers.should == @collection
+    
+    QBFC::QBCollection.should_receive(:new).with(@qb_sess, :Vendor).and_return(@collection)
+    @qb_sess.vendors.should == @collection
+  end
+  
+  it "should create QBFC::QBCollection QBFC::QBClass from #classes" do
+    @collection = mock(QBFC::QBCollection)
+    QBFC::QBCollection.should_receive(:new).with(@qb_sess, :QBClass).and_return(@collection)
+    @qb_sess.classes.should == @collection
+  end
+
+  it "should create QBFC::QBCollection for QBFC::Terms from #terms" do
+    @collection = mock(QBFC::QBCollection)
+    QBFC::QBCollection.should_receive(:new).with(@qb_sess, :Terms).and_return(@collection)
+    @qb_sess.terms.should == @collection
+  end
+  
+  it "should let OLEWrapper handle other unknown methods" do
+    @ole_wrapper.should_receive(:qbfc_method_missing).with(@qb_sess, :FullName).and_return(true)
+    @qb_sess.FullName
+
+    @ole_wrapper.should_receive(:qbfc_method_missing).with(@qb_sess, :full_name).and_return(true)
+    @qb_sess.full_name
+    
+    @ole_wrapper.should_receive(:qbfc_method_missing).with(@qb_sess, :full_name=, 'Full Name').and_return(true)
+    @qb_sess.full_name = 'Full Name'
+  end
+end

data/spec/unit/terms/generated_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "QBFC::Terms generated.rb" do
+  
+  it "should generate classes" do
+    QBFC::DateDrivenTerms.superclass.should be(QBFC::Terms)
+    QBFC::StandardTerms.superclass.should be(QBFC::Terms)
+  end
+  
+  it "should not include Modifiable in any classes" do
+    QBFC::DateDrivenTerms.included_modules.should_not include(QBFC::Modifiable)
+    QBFC::StandardTerms.included_modules.should_not include(QBFC::Modifiable)
+  end
+end

data/spec/unit/terms_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe QBFC::Terms do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+  end
+
+  it "is a base class" do
+    QBFC::Terms.is_base_class?.should be_true
+  end
+  
+  describe ".find" do
+    it "should return subclass objects"
+  end
+  
+end

data/spec/unit/transaction_finders_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class TxnFind < QBFC::Transaction
+    def self.qb_name
+      "Check"
+    end
+  end
+end
+
+describe QBFC::Transaction do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @txn = QBFC::Test::Txn.new(@sess, @ole_wrapper)
+    
+    # Request related mocks
+    @request = mock("QBFC::Request")
+    @request.stub!(:dup).and_return(@request)
+    @txn_query = mock("QBFC::OLEWrapper#txn_query")
+    @response = mock("QBFC::Request#response")
+    
+    # Filter mock
+    @filter = mock("QBFC::OLEWrapper#Filter")
+    @request.stub!(:filter).and_return(@filter)
+    @request.stub!(:add_limit)
+    @request.stub!(:filter_available?).and_return(true)
+    @request.stub!(:apply_options)
+  end
+  
+  def setup_request
+    QBFC::Request.should_receive(:new).with(@sess, 'CheckQuery').and_return(@request)
+    @request.should_receive(:kind_of?).with(QBFC::Request).and_return(true)
+    @request.stub!(:response).and_return(@response)
+    @response.stub!(:GetAt).with(0).and_return(@ole_wrapper)
+    @response.stub!(:ole_methods).and_return(["GetAt"])
+  end
+  
+  describe ".find_by_ref" do
+    before(:each) do 
+      @ref_list = mock("QBFC::OLEWrapper#ref_list")
+    end
+    
+    def setup_request
+      super
+      @request.should_receive(:query).and_return(@txn_query)
+      @txn_query.should_receive(:RefNumberList).and_return(@ref_list)
+      @ref_list.should_receive(:Add).with("12345")
+    end
+    
+    it "should set up Request, specifying RefNumberList" do
+      setup_request
+      QBFC::Test::TxnFind.find_by_ref(@sess, "12345")
+    end
+  
+    it "should return a Transaction object" do
+      setup_request
+      list = QBFC::Test::TxnFind.find_by_ref(@sess, "12345")
+      list.should be_kind_of(QBFC::Test::TxnFind)
+    end
+  
+    it "should return nil if none found" do
+      setup_request
+      @request.should_receive(:response).and_return(nil)
+      QBFC::Test::TxnFind.find_by_ref(@sess, "12345").should be_nil
+    end
+  end
+  
+  describe ".find_by_id" do
+    before(:each) do 
+      @txn_id_list = mock("QBFC::OLEWrapper#txn_id_list")
+    end
+    
+    def setup_request
+      super
+      @request.should_receive(:query).and_return(@txn_query)
+      @txn_query.should_receive(:TxnIDList).and_return(@txn_id_list)
+      @txn_id_list.should_receive(:Add).with("123-456")
+    end
+    
+    it "should set up Request, specifying TxnIDTxn" do
+      setup_request
+      QBFC::Test::TxnFind.find_by_id(@sess, "123-456")
+    end
+  
+    it "should return a Transaction object" do
+      setup_request
+      list = QBFC::Test::TxnFind.find_by_id(@sess, "123-456")
+      list.should be_kind_of(QBFC::Test::TxnFind)
+    end
+  
+    it "should return nil if none found" do
+      setup_request
+      @request.should_receive(:response).and_return(nil)
+      QBFC::Test::TxnFind.find_by_id(@sess, "123-456").should be_nil
+    end
+  end
+  
+  describe ".find_by_name_or_id" do    
+    it "should try to find_by_id" do
+      QBFC::Test::TxnFind.should_receive(:find_by_id).with(@sess, "123-456").and_return("Txn By ID")
+      QBFC::Test::TxnFind.find_by_ref_or_id(@sess, "123-456").should == "Txn By ID"
+    end
+    
+    it "should try to find_by_ref if id fails" do
+      QBFC::Test::TxnFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::TxnFind.should_receive(:find_by_ref).with(@sess, "123-456").and_return("Txn By Ref")
+      QBFC::Test::TxnFind.find_by_ref_or_id(@sess, "123-456").should == "Txn By Ref"
+    end
+    
+    it "should return nil if both ref and id return nil" do
+      QBFC::Test::TxnFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::TxnFind.should_receive(:find_by_ref).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::TxnFind.find_by_ref_or_id(@sess, "123-456").should be_nil
+    end
+
+    it "should be aliased as .find_by_unique_id" do
+      QBFC::Test::TxnFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::TxnFind.should_receive(:find_by_ref).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::TxnFind.find_by_unique_id(@sess, "123-456").should be_nil
+    end
+  end
+  
+end

data/spec/unit/transaction_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class Txn < QBFC::Transaction
+    def qb_name
+      "Check"
+    end
+  end
+end
+
+describe QBFC::Transaction do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @txn = QBFC::Test::Txn.new(@sess, @ole_wrapper)
+  end
+  
+  describe "::ID_NAME" do
+    it "should be 'TxnID'" do
+      QBFC::Test::Txn::ID_NAME.should == "TxnID"
+    end
+  end
+
+  describe "#id" do
+    it "is an alias of txn_id" do
+      @ole_wrapper.should_receive(:txn_id).and_return('T123')
+      @txn.id.should == 'T123'
+    end
+  end
+    
+  describe "#delete" do
+    it "should setup a TxnDelRq with Txn Type and ID" do
+      @del_rq = mock(QBFC::Request)
+      @ole_wrapper.should_receive(:txn_id).and_return('123-456')
+      QBFC::Request.should_receive(:new).with(@sess, "TxnDel").and_return(@del_rq)
+      @del_rq.should_receive(:txn_del_type=).with(QBFC_CONST::TdtCheck)
+      @del_rq.should_receive(:txn_id=).with('123-456')
+      @del_rq.should_receive(:submit)
+      @txn.delete.should be_true
+    end
+  end
+  
+  describe "#display" do
+    before(:each) do
+      @display_rq = mock(QBFC::Request)
+    end
+  
+    it "should call TxnDisplayAdd for new records" do
+      QBFC::Request.should_receive(:new).with(@sess, "TxnDisplayAdd").and_return(@display_rq)
+      @display_rq.should_receive(:txn_display_add_type=).with(QBFC_CONST::TdatCheck)
+      @display_rq.should_receive(:submit)
+      @txn.instance_variable_set(:@new_record, true)
+      @txn.display
+    end
+    
+    it "should call TxnDisplayMod for existing records" do
+      @ole_wrapper.should_receive(:txn_id).and_return('123-456')
+
+      QBFC::Request.should_receive(:new).with(@sess, "TxnDisplayMod").and_return(@display_rq)
+      @display_rq.should_receive(:txn_display_mod_type=).with(QBFC_CONST::TdmtCheck)
+      @display_rq.should_receive(:txn_id=).with('123-456')
+      @display_rq.should_receive(:submit)
+      @txn.display
+    end
+  end
+  
+  describe "#cleared_status=" do
+    before(:each) do
+      @ole_wrapper.should_receive(:txn_id).and_return('123-456')
+      
+      @cs_rq = mock(QBFC::Request)
+      QBFC::Request.should_receive(:new).with(@sess, "ClearedStatusMod").and_return(@cs_rq)
+      @cs_rq.should_receive(:txn_id=).with('123-456')
+      @cs_rq.should_receive(:submit)
+    end
+    
+    it "should submit a ClearedStatusModRq" do
+      @cs_rq.should_receive(:cleared_status=).with(QBFC_CONST::CsCleared)
+      @txn.cleared_status = QBFC_CONST::CsCleared
+    end
+    
+    it "should accept true for CsCleared" do
+      @cs_rq.should_receive(:cleared_status=).with(QBFC_CONST::CsCleared)
+      @txn.cleared_status = true
+    end
+    
+    it "should accept false for CsNotCleared" do
+      @cs_rq.should_receive(:cleared_status=).with(QBFC_CONST::CsNotCleared)
+      @txn.cleared_status = false
+    end
+
+  end
+end

data/spec/unit/transactions/generated_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "QBFC::Transactions generated.rb" do
+  
+  it "should generate classes" do
+    QBFC::Check.superclass.should be(QBFC::Transaction)
+    QBFC::Bill.superclass.should be(QBFC::Transaction)
+    QBFC::CreditMemo.superclass.should be(QBFC::Transaction)
+  end
+  
+  it "should include Voidable in voidable classes" do
+    QBFC::Check.included_modules.should include(QBFC::Voidable)
+    QBFC::Estimate.included_modules.should_not include(QBFC::Voidable)
+  end
+  
+  it "should include Modifiable in modifiable classes" do
+    QBFC::Check.included_modules.should include(QBFC::Modifiable)
+    QBFC::Deposit.included_modules.should_not include(QBFC::Modifiable)
+  end
+end

data/spec/unit/voidable_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class TxnVoid < QBFC::Transaction
+    include QBFC::Voidable
+    
+    def qb_name
+      "Check"
+    end
+  end
+end
+
+describe QBFC::Voidable do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @txn = QBFC::Test::TxnVoid.new(@sess, @ole_wrapper)
+  end
+
+  describe "#void" do
+    it "should call a TxnVoidRq with Txn Type and ID" do
+      @void_rq = mock(QBFC::Request)
+      @ole_wrapper.should_receive(:txn_id).and_return('{123-456}')
+      QBFC::Request.should_receive(:new).with(@sess, "TxnVoid").and_return(@void_rq)
+      @void_rq.should_receive(:txn_void_type=).with(QBFC_CONST::const_get("TvtCheck"))
+      @void_rq.should_receive(:txn_id=).with("{123-456}")
+      @void_rq.should_receive(:submit)
+      @txn.void.should be_true
+    end
+  end
+end