qbfc 0.3.0

data/spec/unit/entity_spec.rb

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

data/spec/unit/info/generated_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "QBFC::Info generated.rb" do
+  
+  it "should generate classes" do
+    QBFC::Company.superclass.should be(QBFC::Info)
+    QBFC::CompanyActivity.superclass.should be(QBFC::Info)
+    QBFC::Host.superclass.should be(QBFC::Info)
+    QBFC::Preferences.superclass.should be(QBFC::Info)
+  end
+  
+end

data/spec/unit/info_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class Info < QBFC::Info
+    def self.qb_name
+      "Company"
+    end
+  end
+end
+
+describe QBFC::Info do
+
+ before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @info = mock(QBFC::Test::Info)
+    
+    # Request related mocks
+    @request = mock("QBFC::Request")
+    @response = mock("QBFC::Request#response")
+    
+    QBFC::Request.stub!(:new).with(@sess, 'CompanyQuery').and_return(@request)
+    @request.stub!(:response).and_return(@response)
+    QBFC::Test::Info.stub!(:new).with(@sess, @response).and_return(@info)
+    @request.stub!(:apply_options)
+  end
+  
+  describe ".get" do
+    it "should create Request and get response" do
+      QBFC::Request.should_receive(:new).with(@sess, 'CompanyQuery').and_return(@request)
+      @request.should_receive(:response).and_return(@response)
+      QBFC::Test::Info.should_receive(:new).with(@sess, @response).and_return(@info)
+      QBFC::Test::Info::get(@sess)
+    end
+    
+    it "applies options to Request" do
+      @request.should_receive(:apply_options).with({:owner_id => 0})
+      QBFC::Test::Info::get(@sess, :owner_id => 0)
+    end
+  end
+  
+  describe ".find" do
+    it "should forward request, without 'what' argument, to get" do
+      QBFC::Test::Info.should_receive(:get).with(@sess, {})
+      QBFC::Test::Info::find(@sess, :first, {})
+    end
+  end
+end

data/spec/unit/item_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe QBFC::Item do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+  end
+
+  it "is a base class" do
+    QBFC::Item.is_base_class?.should be_true
+  end
+  
+  describe ".find" do
+    it "should return subclass objects"
+  end
+  
+  describe ".add_special" do
+    before(:each) do 
+      @request = mock("QBFC::Request")
+      @response = mock("QBFC::Request#response")
+    end
+    
+    it "should add a Special Account" do
+      QBFC::Request.should_receive(:new).with(@sess, "SpecialItemAdd").and_return(@request)
+      @request.should_receive(:special_item_type=).with(QBFC_CONST::SitFinanceCharge)
+      @request.should_receive(:response).and_return(@response)
+  
+      QBFC::Item.add_special(@sess, QBFC_CONST::SitFinanceCharge)
+    end
+  end
+  
+end

data/spec/unit/items/generated_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "QBFC::Item generated.rb" do
+  
+  it "should generate classes" do
+    QBFC::ItemGroup.superclass.should be(QBFC::Item)
+    QBFC::ItemDiscount.superclass.should be(QBFC::Item)
+    QBFC::ItemPayment.superclass.should be(QBFC::Item)
+  end
+  
+  it "should include Modifiable in all classes" do
+    QBFC::ItemGroup.included_modules.should include(QBFC::Modifiable)
+    QBFC::ItemDiscount.included_modules.should include(QBFC::Modifiable)
+    QBFC::ItemPayment.included_modules.should include(QBFC::Modifiable)
+  end
+end

data/spec/unit/list_finders_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class ListFind < QBFC::List
+    def self.qb_name
+      "Account"
+    end
+  end
+end
+
+describe QBFC::List do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @list = QBFC::Test::List.new(@sess, @ole_wrapper)
+
+    # Request related mocks
+    @request = mock("QBFC::Request")
+    @request.stub!(:dup).and_return(@request)
+    @list_query = mock("QBFC::OLEWrapper#list_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, 'AccountQuery').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_name" do    
+    before(:each) do 
+      @full_name_list = mock("QBFC::OLEWrapper#full_name_list")
+    end
+    
+    def setup_request
+      super
+      @request.should_receive(:query).and_return(@list_query)
+      @list_query.should_receive(:FullNameList).and_return(@full_name_list)
+      @full_name_list.should_receive(:Add).with("Bob Customer")
+    end
+    
+    it "should set up Request, specifying FullNameList" do
+      setup_request
+      QBFC::Test::ListFind.find_by_name(@sess, "Bob Customer")
+    end
+  
+    it "should return a List object" do
+      setup_request
+      list = QBFC::Test::ListFind.find_by_name(@sess, "Bob Customer")
+      list.should be_kind_of(QBFC::Test::ListFind)
+    end
+  
+    it "should return nil if none found" do
+      setup_request
+      @request.should_receive(:response).and_return(nil)
+      QBFC::Test::ListFind.find_by_name(@sess, "Bob Customer").should be_nil
+    end
+    
+    it "should alias as find_by_full_name" do
+      setup_request
+      QBFC::Test::ListFind.find_by_full_name(@sess, "Bob Customer")
+    end
+  end
+  
+  describe ".find_by_id" do
+    before(:each) do 
+      @list_id_list = mock("QBFC::OLEWrapper#list_id_list")
+    end
+    
+    def setup_request
+      super
+      @request.should_receive(:query).and_return(@list_query)
+      @list_query.should_receive(:ListIDList).and_return(@list_id_list)
+      @list_id_list.should_receive(:Add).with("123-456")
+    end
+    
+    it "should set up Request, specifying ListIDList" do
+      setup_request
+      QBFC::Test::ListFind.find_by_id(@sess, "123-456")
+    end
+  
+    it "should return a List object" do
+      setup_request
+      list = QBFC::Test::ListFind.find_by_id(@sess, "123-456")
+      list.should be_kind_of(QBFC::Test::ListFind)
+    end
+  
+    it "should return nil if none found" do
+      setup_request
+      @request.should_receive(:response).and_return(nil)
+      QBFC::Test::ListFind.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::ListFind.should_receive(:find_by_id).with(@sess, "123-456").and_return("List By ID")
+      QBFC::Test::ListFind.find_by_name_or_id(@sess, "123-456").should == "List By ID"
+    end
+    
+    it "should try to find_by_name if id fails" do
+      QBFC::Test::ListFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::ListFind.should_receive(:find_by_name).with(@sess, "123-456").and_return("List By Name")
+      QBFC::Test::ListFind.find_by_name_or_id(@sess, "123-456").should == "List By Name"
+    end
+    
+    it "should return nil if both name and id return nil" do
+      QBFC::Test::ListFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::ListFind.should_receive(:find_by_name).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::ListFind.find_by_name_or_id(@sess, "123-456").should be_nil
+    end
+
+    it "should be aliased as .find_by_unique_id" do
+      QBFC::Test::ListFind.should_receive(:find_by_id).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::ListFind.should_receive(:find_by_name).with(@sess, "123-456").and_return(nil)
+      QBFC::Test::ListFind.find_by_unique_id(@sess, "123-456").should be_nil
+    end
+  end
+end

data/spec/unit/list_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class List < QBFC::List
+    def self.qb_name
+      "Account"
+    end
+  end
+end
+
+describe QBFC::List do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @list = QBFC::Test::List.new(@sess, @ole_wrapper)
+  end
+  
+  it "should specify if it is a superclass_list (such as Entity)"
+  
+  describe "::ID_NAME" do
+    it "should be 'ListID'" do
+      QBFC::Test::List::ID_NAME.should == "ListID"
+    end
+  end
+  
+  describe "#id" do
+    it "is an alias of list_id" do
+      @ole_wrapper.should_receive(:list_id).and_return('L123')
+      @list.id.should == 'L123'
+    end
+  end
+  
+  describe "#full_name" do
+    before(:each) do
+      @ole_wrapper.stub!(:full_name).and_return("Full Name")
+      @ole_wrapper.stub!(:name).and_return("Short Name")
+    end
+    
+    it "aliases name if not defined by OLE object" do
+       @ole_wrapper.should_receive(:respond_to_ole?).with("FullName").and_return(false)
+       @list.full_name.should == "Short Name"
+    end
+    
+    it "calls OLE object's FullName method if defined" do
+       @ole_wrapper.should_receive(:respond_to_ole?).with("FullName").and_return(true)
+       @list.full_name.should == "Full Name"    
+    end
+  end
+  
+  describe "#delete" do
+    it "should setup a ListDelRq with List Type and ID" do
+      @del_rq = mock(QBFC::Request)
+      @ole_wrapper.should_receive(:list_id).and_return('{123-456}')
+      QBFC::Request.should_receive(:new).with(@sess, "ListDel").and_return(@del_rq)
+      @del_rq.should_receive(:list_del_type=).with(QBFC_CONST::const_get("LdtAccount"))
+      @del_rq.should_receive(:list_id=).with("{123-456}")
+      @del_rq.should_receive(:submit)
+      @list.delete.should be_true
+    end
+  end
+  
+  describe "#display" do
+    before(:each) do
+      @display_rq = mock(QBFC::Request)
+    end
+  
+    it "should call ListDisplayAdd for new records" do
+      QBFC::Request.should_receive(:new).with(@sess, "ListDisplayAdd").and_return(@display_rq)
+      @display_rq.should_receive(:list_display_add_type=).with(QBFC_CONST::LdatAccount)
+      @display_rq.should_receive(:submit)
+      @list.instance_variable_set(:@new_record, true)
+      @list.display
+    end
+    
+    it "should call ListDisplayMod for existing records" do
+      @ole_wrapper.should_receive(:list_id).and_return('123-456')
+
+      QBFC::Request.should_receive(:new).with(@sess, "ListDisplayMod").and_return(@display_rq)
+      @display_rq.should_receive(:list_display_mod_type=).with(QBFC_CONST::LdatAccount)
+      @display_rq.should_receive(:list_id=).with('123-456')
+      @display_rq.should_receive(:submit)
+      @list.display
+    end
+  end
+end

data/spec/unit/lists/account_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe QBFC::Account do
+
+ before(:each) do 
+    @sess = mock(QBFC::Session)
+    @request = mock("QBFC::Request")
+    @response = mock("QBFC::Request#response")
+  end
+  
+  it "should add a Special Account" do
+    QBFC::Request.should_receive(:new).with(@sess, "SpecialAccountAdd").and_return(@request)
+    @request.should_receive(:special_account_type=).with(QBFC_CONST::SatAccountsReceivable)
+    @request.should_receive(:response).and_return(@response)
+    QBFC::Account.should_receive(:new).with(@sess, @response)
+
+    QBFC::Account.add_special(@sess, QBFC_CONST::SatAccountsReceivable)
+  end
+
+end

data/spec/unit/lists/generated_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe "QBFC::List generated.rb" do
+  
+  it "should generate classes" do
+    QBFC::Customer.ancestors.should include(QBFC::List)
+    QBFC::Account.ancestors.should include(QBFC::List)
+    QBFC::Account.superclass.should be(QBFC::List)
+  end
+  
+  it "should include Modifiable in modifiable classes" do
+    QBFC::Customer.included_modules.should include(QBFC::Modifiable)
+    QBFC::CustomerMsg.included_modules.should_not include(QBFC::Modifiable)
+  end
+end

data/spec/unit/lists/qb_class_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe QBFC::QBClass do
+
+  it "should access QBFC 'Class' elements" do
+    QBFC::QBClass.qb_name.should == "Class"
+  end
+
+end

data/spec/unit/modifiable_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module QBFC::Test
+  class ListMod < QBFC::List
+    include QBFC::Modifiable
+    
+    def self.qb_name
+      "Account"
+    end
+  end
+
+  class TxnMod < QBFC::Transaction
+    include QBFC::Modifiable
+    
+    def self.qb_name
+      "Check"
+    end
+  end
+end
+
+describe 'QBFC::Modifiable' do
+
+  before(:each) do 
+    @sess = mock(QBFC::Session)
+    @ole_wrapper = mock(QBFC::OLEWrapper)
+    @ole_wrapper.stub!(:list_id).and_return "{list-id}"
+    @ole_wrapper.stub!(:txn_id).and_return "{txn-id}"
+    @ole_wrapper.stub!(:edit_sequence).and_return "123"
+    @ole_wrapper.stub!(:setter=)
+
+    @mod_rq = mock(QBFC::Request)
+    @mod_ole = mock(WIN32OLE)
+    @mod_rq.should_receive(:ole_object).and_return(@mod_ole)
+    @mod_rq.stub!(:list_id=)
+    @mod_rq.stub!(:txn_id=)
+    @mod_rq.stub!(:edit_sequence=)
+    QBFC::Request.stub!(:new).and_return(@mod_rq)
+  end
+
+  describe "#initialize" do
+    it "should setup Mod Request for existing records" do
+      QBFC::Request.should_receive(:new).with(@sess, "AccountMod").and_return(@mod_rq)
+      QBFC::Test::ListMod.new(@sess, @ole_wrapper)
+    end
+
+    it "should not set Mod Request for new records" do
+      QBFC::Request.should_not_receive(:new).with(@sess, "AccountMod")
+      QBFC::Test::ListMod.new(@sess)
+    end
+  end
+  
+  describe "#setup_mod_request" do
+  
+    it "should create a Mod Request object" do
+      QBFC::Request.should_receive(:new).with(@sess, "AccountMod").and_return(@mod_rq)
+      QBFC::Test::ListMod.new(@sess, @ole_wrapper)
+    end
+    
+    it "should set the Mod's id (for Lists) to the ole_object's id" do
+      @mod_rq.should_receive(:list_id=).with("{list-id}")
+      QBFC::Test::ListMod.new(@sess, @ole_wrapper)
+    end
+    
+    it "should set the Mod's txn_id (for Transaction) to the ole_object's id" do
+      @mod_rq.should_receive(:txn_id=).with("{txn-id}")
+      QBFC::Test::TxnMod.new(@sess, @ole_wrapper)
+    end
+
+    it "should set the Mod's edit_sequence" do
+      @mod_rq.should_receive(:edit_sequence=).with("123")
+      QBFC::Test::TxnMod.new(@sess, @ole_wrapper)
+    end
+    
+    it "should add the Mod request's ole_object as the @ole.setter" do
+      @ole_wrapper.should_receive(:setter=).with(@mod_ole)
+      QBFC::Test::TxnMod.new(@sess, @ole_wrapper)
+    end
+    
+    it "should assign the Mod request as the @setter" do
+      txn = QBFC::Test::TxnMod.new(@sess, @ole_wrapper)
+      txn.instance_variable_get(:@setter).should be(@mod_rq)
+    end
+  end
+end