fishbowl 0.0.1 → 1.0.2

data/spec/examples/work_order.xml

@@ -0,0 +1,228 @@
+<WO>
+  <ID>1</ID>
+  <Num>1:001</Num>
+  <Type>Manufacture</Type>
+  <TypeID>6</TypeID>
+  <MOItemID>1</MOItemID>
+  <WOItems>
+    <WOItem>
+      <ID>1</ID>
+      <MOItemID>2</MOItemID>
+      <TypeID>10</TypeID>
+      <Part>
+        <PartID>36</PartID>
+        <PartClassID>0</PartClassID>
+        <TypeID>10</TypeID>
+        <UOM>
+          <UOMID>1</UOMID>
+          <Name>Each</Name>
+          <Code>ea</Code>
+          <Integral>true</Integral>
+          <Active>true</Active>
+          <Type>Count</Type>
+          <UOMConversions>
+            <UOMConversion>
+              <MainUOMID>1</MainUOMID>
+              <ToUOMID>17</ToUOMID>
+              <ToUOMCode>pr</ToUOMCode>
+              <ConversionMultiply>1.0</ConversionMultiply>
+              <ConversionFactor>2.0</ConversionFactor>
+              <ToUOMIsIntegral>false</ToUOMIsIntegral>
+            </UOMConversion>
+            <UOMConversion>
+              <MainUOMID>1</MainUOMID>
+              <ToUOMID>18</ToUOMID>
+              <ToUOMCode>pk</ToUOMCode>
+              <ConversionMultiply>1.0</ConversionMultiply>
+              <ConversionFactor>20.0</ConversionFactor>
+              <ToUOMIsIntegral>false</ToUOMIsIntegral>
+            </UOMConversion>
+          </UOMConversions>
+        </UOM>
+        <Num>BB2002</Num>
+        <Description>Comfort Bike</Description>
+        <Details/>
+        <StandardCost>0</StandardCost>
+        <HasBOM>false</HasBOM>
+        <Configurable>false</Configurable>
+        <ActiveFlag>true</ActiveFlag>
+        <SerializedFlag>true</SerializedFlag>
+        <TrackingFlag>true</TrackingFlag>
+        <Weight>20</Weight>
+        <WeightUOM>
+          <UOM>
+            <UOMID>3</UOMID>
+            <Name>Pound</Name>
+            <Code>lbs</Code>
+            <Integral>false</Integral>
+            <Active>true</Active>
+            <Type>Weight</Type>
+            <UOMConversions>
+              <UOMConversion>
+                <MainUOMID>3</MainUOMID>
+                <ToUOMID>8</ToUOMID>
+                <ToUOMCode>kg</ToUOMCode>
+                <ConversionMultiply>1.0</ConversionMultiply>
+                <ConversionFactor>2.2046000957489014</ConversionFactor>
+                <ToUOMIsIntegral>false</ToUOMIsIntegral>
+              </UOMConversion>
+            </UOMConversions>
+          </UOM>
+        </WeightUOM>
+        <Width>0</Width>
+        <Height>0</Height>
+        <Len>0</Len>
+        <SizeUOM>
+          <UOM>
+            <UOMID>2</UOMID>
+            <Name>Foot</Name>
+            <Code>ft</Code>
+            <Integral>false</Integral>
+            <Active>true</Active>
+            <Type>Length</Type>
+            <UOMConversions>
+              <UOMConversion>
+                <MainUOMID>2</MainUOMID>
+                <ToUOMID>7</ToUOMID>
+                <ToUOMCode>in</ToUOMCode>
+                <ConversionMultiply>12.0</ConversionMultiply>
+                <ConversionFactor>1.0</ConversionFactor>
+                <ToUOMIsIntegral>false</ToUOMIsIntegral>
+              </UOMConversion>
+              <UOMConversion>
+                <MainUOMID>2</MainUOMID>
+                <ToUOMID>9</ToUOMID>
+                <ToUOMCode>m</ToUOMCode>
+                <ConversionMultiply>1.0</ConversionMultiply>
+                <ConversionFactor>3.2808001041412354</ConversionFactor>
+                <ToUOMIsIntegral>false</ToUOMIsIntegral>
+              </UOMConversion>
+            </UOMConversions>
+          </UOM>
+        </SizeUOM>
+        <UPC/>
+        <PartTrackingList>
+          <PartTracking>
+            <PartTrackingID>4</PartTrackingID>
+            <Name>Serial Number</Name>
+            <Abbr>SN(s)</Abbr>
+            <Description/>
+            <SortOrder>4</SortOrder>
+            <TrackingTypeID>40</TrackingTypeID>
+            <Active>true</Active>
+            <Primary>true</Primary>
+          </PartTracking>
+        </PartTrackingList>
+        <VendorPartNums>
+          <VendorPartNumber>
+            <Number>BB2002</Number>
+          </VendorPartNumber>
+          <VendorPartNumber>
+            <Number>BB2002</Number>
+          </VendorPartNumber>
+        </VendorPartNums>
+      </Part>
+      <Description>Create BB2002</Description>
+      <Cost>$0.00</Cost>
+      <DateScheduled>2004-11-04T00:00:00</DateScheduled>
+      <InstructionNote/>
+      <InstructionURL/>
+      <QtyScrapped>0</QtyScrapped>
+      <QtyToFulfill>1</QtyToFulfill>
+      <QtyUsed>1</QtyUsed>
+      <DestLocation>
+        <Location>
+          <LocationID>10</LocationID>
+          <TypeID>70</TypeID>
+          <Name>Store Front</Name>
+          <Description>Point of Sale location</Description>
+          <CountedAsAvailable>true</CountedAsAvailable>
+          <Default>true</Default>
+          <Active>true</Active>
+          <Pickable>true</Pickable>
+          <Receivable>true</Receivable>
+          <LocationGroupID>1</LocationGroupID>
+          <LocationGroupName>SLC</LocationGroupName>
+          <SortOrder>10013</SortOrder>
+          <TagID>384</TagID>
+          <TagNumber>371</TagNumber>
+        </Location>
+      </DestLocation>
+      <UOM>
+        <UOMID>1</UOMID>
+        <Name>Each</Name>
+        <Code>ea</Code>
+        <Integral>true</Integral>
+        <Active>true</Active>
+        <Type>Count</Type>
+        <UOMConversions>
+          <UOMConversion>
+            <MainUOMID>1</MainUOMID>
+            <ToUOMID>17</ToUOMID>
+            <ToUOMCode>pr</ToUOMCode>
+            <ConversionMultiply>1.0</ConversionMultiply>
+            <ConversionFactor>2.0</ConversionFactor>
+            <ToUOMIsIntegral>false</ToUOMIsIntegral>
+          </UOMConversion>
+          <UOMConversion>
+            <MainUOMID>1</MainUOMID>
+            <ToUOMID>18</ToUOMID>
+            <ToUOMCode>pk</ToUOMCode>
+            <ConversionMultiply>1.0</ConversionMultiply>
+            <ConversionFactor>20.0</ConversionFactor>
+            <ToUOMIsIntegral>false</ToUOMIsIntegral>
+          </UOMConversion>
+        </UOMConversions>
+      </UOM>
+      <Tracking/>
+      <SortID>1</SortID>
+    </WOItem>
+  </WOItems>
+  <Cost>0</Cost>
+  <Location>
+    <Location>
+      <LocationID>9</LocationID>
+      <TypeID>80</TypeID>
+      <Name>Manufacturing</Name>
+      <Description>The place where things are Manufactured</Description>
+      <CountedAsAvailable>true</CountedAsAvailable>
+      <Default>true</Default>
+      <Active>true</Active>
+      <Pickable>true</Pickable>
+      <Receivable>true</Receivable>
+      <LocationGroupID>1</LocationGroupID>
+      <LocationGroupName>SLC</LocationGroupName>
+      <SortOrder>10004</SortOrder>
+      <TagID>383</TagID>
+      <TagNumber>370</TagNumber>
+    </Location>
+  </Location>
+  <LocationGroup>
+    <LocationGroup>
+      <LocationGroupID>1</LocationGroupID>
+      <LocationGroupName>SLC</LocationGroupName>
+      <DefaultQBClassID>2</DefaultQBClassID>
+    </LocationGroup>
+  </LocationGroup>
+  <Note/>
+  <StatusID>40</StatusID>
+  <QBClass>None</QBClass>
+  <QBClassID>1</QBClassID>
+  <QtyOrdered>1</QtyOrdered>
+  <QtyTarget>1</QtyTarget>
+  <DateCreated>2004-11-04T16:59:40</DateCreated>
+  <DateFinished>2004-11-04T17:01:07</DateFinished>
+  <DateLastModified>2004-11-04T17:01:07</DateLastModified>
+  <DateScheduled>2004-11-04T00:00:00</DateScheduled>
+  <DateStarted>2004-11-04T16:59:40</DateStarted>
+  <User>
+    <User>
+      <ID>1</ID>
+      <UserName>admin</UserName>
+      <FirstName>Administrator</FirstName>
+      <LastName>Administrator</LastName>
+      <Initials>ADM</Initials>
+      <Active>true</Active>
+    </User>
+  </User>
+</WO>

data/spec/examples/work_order_item.xml

@@ -0,0 +1,172 @@
+<WOItem>
+  <ID>1</ID>
+  <MOItemID>2</MOItemID>
+  <TypeID>10</TypeID>
+  <Part>
+    <PartID>36</PartID>
+    <PartClassID>0</PartClassID>
+    <TypeID>10</TypeID>
+    <UOM>
+      <UOMID>1</UOMID>
+      <Name>Each</Name>
+      <Code>ea</Code>
+      <Integral>true</Integral>
+      <Active>true</Active>
+      <Type>Count</Type>
+      <UOMConversions>
+        <UOMConversion>
+          <MainUOMID>1</MainUOMID>
+          <ToUOMID>17</ToUOMID>
+          <ToUOMCode>pr</ToUOMCode>
+          <ConversionMultiply>1.0</ConversionMultiply>
+          <ConversionFactor>2.0</ConversionFactor>
+          <ToUOMIsIntegral>false</ToUOMIsIntegral>
+        </UOMConversion>
+        <UOMConversion>
+          <MainUOMID>1</MainUOMID>
+          <ToUOMID>18</ToUOMID>
+          <ToUOMCode>pk</ToUOMCode>
+          <ConversionMultiply>1.0</ConversionMultiply>
+          <ConversionFactor>20.0</ConversionFactor>
+          <ToUOMIsIntegral>false</ToUOMIsIntegral>
+        </UOMConversion>
+      </UOMConversions>
+    </UOM>
+    <Num>BB2002</Num>
+    <Description>Comfort Bike</Description>
+    <Details/>
+    <StandardCost>0</StandardCost>
+    <HasBOM>false</HasBOM>
+    <Configurable>false</Configurable>
+    <ActiveFlag>true</ActiveFlag>
+    <SerializedFlag>true</SerializedFlag>
+    <TrackingFlag>true</TrackingFlag>
+    <Weight>20</Weight>
+    <WeightUOM>
+      <UOM>
+        <UOMID>3</UOMID>
+        <Name>Pound</Name>
+        <Code>lbs</Code>
+        <Integral>false</Integral>
+        <Active>true</Active>
+        <Type>Weight</Type>
+        <UOMConversions>
+          <UOMConversion>
+            <MainUOMID>3</MainUOMID>
+            <ToUOMID>8</ToUOMID>
+            <ToUOMCode>kg</ToUOMCode>
+            <ConversionMultiply>1.0</ConversionMultiply>
+            <ConversionFactor>2.2046000957489014</ConversionFactor>
+            <ToUOMIsIntegral>false</ToUOMIsIntegral>
+          </UOMConversion>
+        </UOMConversions>
+      </UOM>
+    </WeightUOM>
+    <Width>0</Width>
+    <Height>0</Height>
+    <Len>0</Len>
+    <SizeUOM>
+      <UOM>
+        <UOMID>2</UOMID>
+        <Name>Foot</Name>
+        <Code>ft</Code>
+        <Integral>false</Integral>
+        <Active>true</Active>
+        <Type>Length</Type>
+        <UOMConversions>
+          <UOMConversion>
+            <MainUOMID>2</MainUOMID>
+            <ToUOMID>7</ToUOMID>
+            <ToUOMCode>in</ToUOMCode>
+            <ConversionMultiply>12.0</ConversionMultiply>
+            <ConversionFactor>1.0</ConversionFactor>
+            <ToUOMIsIntegral>false</ToUOMIsIntegral>
+          </UOMConversion>
+          <UOMConversion>
+            <MainUOMID>2</MainUOMID>
+            <ToUOMID>9</ToUOMID>
+            <ToUOMCode>m</ToUOMCode>
+            <ConversionMultiply>1.0</ConversionMultiply>
+            <ConversionFactor>3.2808001041412354</ConversionFactor>
+            <ToUOMIsIntegral>false</ToUOMIsIntegral>
+          </UOMConversion>
+        </UOMConversions>
+      </UOM>
+    </SizeUOM>
+    <UPC/>
+    <PartTrackingList>
+      <PartTracking>
+        <PartTrackingID>4</PartTrackingID>
+        <Name>Serial Number</Name>
+        <Abbr>SN(s)</Abbr>
+        <Description/>
+        <SortOrder>4</SortOrder>
+        <TrackingTypeID>40</TrackingTypeID>
+        <Active>true</Active>
+        <Primary>true</Primary>
+      </PartTracking>
+    </PartTrackingList>
+    <VendorPartNums>
+      <VendorPartNumber>
+        <Number>BB2002</Number>
+      </VendorPartNumber>
+      <VendorPartNumber>
+        <Number>BB2002</Number>
+      </VendorPartNumber>
+    </VendorPartNums>
+  </Part>
+  <Description>Create BB2002</Description>
+  <Cost>$0.00</Cost>
+  <DateScheduled>2004-11-04T00:00:00</DateScheduled>
+  <InstructionNote/>
+  <InstructionURL/>
+  <QtyScrapped>0</QtyScrapped>
+  <QtyToFulfill>1</QtyToFulfill>
+  <QtyUsed>1</QtyUsed>
+  <DestLocation>
+    <Location>
+      <LocationID>10</LocationID>
+      <TypeID>70</TypeID>
+      <Name>Store Front</Name>
+      <Description>Point of Sale location</Description>
+      <CountedAsAvailable>true</CountedAsAvailable>
+      <Default>true</Default>
+      <Active>true</Active>
+      <Pickable>true</Pickable>
+      <Receivable>true</Receivable>
+      <LocationGroupID>1</LocationGroupID>
+      <LocationGroupName>SLC</LocationGroupName>
+      <SortOrder>10013</SortOrder>
+      <TagID>384</TagID>
+      <TagNumber>371</TagNumber>
+    </Location>
+  </DestLocation>
+  <UOM>
+    <UOMID>1</UOMID>
+    <Name>Each</Name>
+    <Code>ea</Code>
+    <Integral>true</Integral>
+    <Active>true</Active>
+    <Type>Count</Type>
+    <UOMConversions>
+      <UOMConversion>
+        <MainUOMID>1</MainUOMID>
+        <ToUOMID>17</ToUOMID>
+        <ToUOMCode>pr</ToUOMCode>
+        <ConversionMultiply>1.0</ConversionMultiply>
+        <ConversionFactor>2.0</ConversionFactor>
+        <ToUOMIsIntegral>false</ToUOMIsIntegral>
+      </UOMConversion>
+      <UOMConversion>
+        <MainUOMID>1</MainUOMID>
+        <ToUOMID>18</ToUOMID>
+        <ToUOMCode>pk</ToUOMCode>
+        <ConversionMultiply>1.0</ConversionMultiply>
+        <ConversionFactor>20.0</ConversionFactor>
+        <ToUOMIsIntegral>false</ToUOMIsIntegral>
+      </UOMConversion>
+    </UOMConversions>
+  </UOM>
+  <Tracking/>
+  <SortID>1</SortID>
+</WOItem>

data/spec/objects/account_spec.rb

@@ -14,6 +14,21 @@ describe Fishbowl::Objects::Account do
 
   let(:connection) { FakeTCPSocket.instance }
 
+  describe "instances" do
+
+    let(:account) {
+      doc = Nokogiri::XML.parse(example_file('account.xml'))
+      Fishbowl::Objects::Account.new(doc.xpath('//Account'))
+    }
+
+    it "should properly initialize from example file" do
+      account.name.should eq("Cost Variance")
+      account.accounting_id.should eq("8000001B-1310422643")
+      account.account_type.should eq("12")
+      account.balance.should eq("0")
+    end
+  end
+
   describe ".get_list" do
     let(:proper_request) do
       Nokogiri::XML::Builder.new do |xml|
@@ -26,41 +41,32 @@ describe Fishbowl::Objects::Account do
       end
     end
 
-    let(:canned_response) do
-
-    end
-
-    it "should properly format the request" do
-      Fishbowl::Objects::Account.get_list
-      connection.last_write.should be_equivalent_to(proper_request.to_xml)
-    end
-
-    it "should return array of Accounts"
-
-    it "should return empty array when no accounts" do
-
-    end
-  end
-
-  describe ".get_balance" do
-    let(:proper_request) do
-      Nokogiri::XML::Builder.new do |xml|
-        xml.FbiXml {
-          xml.Ticket
-          xml.FbiMsgsRq {
-            xml.GetAccountBalanceRq {
-              xml.Account "General Account"
-            }
+    before :each do
+      canned_response = Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.GetAccountListRs(statusCode: '1000', statusMessage: "Success!") {
+            (rand(3) + 2).times do |i|
+              xml.Account {
+                xml.Name          "Demo Account #{i}"
+                xml.AccountingID  "DEMO#{i}"
+                xml.AccountType   i
+                xml.Balance       "1200.00"
+              }
+            end
           }
         }
       end
+
+      mock_the_response(canned_response)
     end
 
     it "should properly format the request" do
-      Fishbowl::Objects::Account.get_balance("General Account")
+      Fishbowl::Objects::Account.get_list
       connection.last_write.should be_equivalent_to(proper_request.to_xml)
     end
 
-    it "should return the balance for the requested Account"
+    it "should return array of Accounts" do
+      Fishbowl::Objects::Account.get_list.should be_an(Array)
+    end
   end
 end

data/spec/objects/address_information_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::AddressInformation do
+  describe "instances" do
+
+    let(:address_info) {
+      doc = Nokogiri::XML.parse(example_file('address.xml'))
+      Fishbowl::Objects::AddressInformation.new(doc.xpath('//AddressInformation'))
+    }
+
+    it "should properly initialize from example file" do
+      address_info.name.should eq("Main Office")
+      address_info.data.should eq("Address Data")
+      address_info.default.should eq("true")
+      address_info.type.should eq("Home")
+    end
+  end
+end

data/spec/objects/address_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Address do
+  before :each do
+    mock_tcp_connection
+    mock_login_response
+    Fishbowl::Connection.connect(host: 'localhost')
+    Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+  end
+
+  after :each do
+    unmock_tcp
+  end
+
+  let(:connection) { FakeTCPSocket.instance }
+
+  describe "instances" do
+
+    let(:address) {
+      doc = Nokogiri::XML.parse(example_file('address.xml'))
+      Fishbowl::Objects::Address.new(doc.xpath('//Address'))
+    }
+
+    it "should properly initialize from example file" do
+      address.name.should eq("Main Office")
+      address.attn.should eq("Attn")
+      address.street.should eq("123 Neverland dr.")
+
+      address.state.should be_a(Fishbowl::Objects::State)
+      address.country.should be_a(Fishbowl::Objects::Country)
+      address.address_information_list.should be_a(Array)
+      address.address_information_list.first.should be_a(Fishbowl::Objects::AddressInformation)
+    end
+  end
+end
+

data/spec/objects/base_object_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe Fishbowl::Objects::BaseObject do
   let(:ticket) { "thisisasample" }
   let(:base_object) { Fishbowl::Objects::BaseObject.new }
+  let(:connection) { FakeTCPSocket.instance }
 
   let(:empty_ticket_builder) do
     Nokogiri::XML::Builder.new do |xml|
@@ -10,7 +11,7 @@ describe Fishbowl::Objects::BaseObject do
         xml.Ticket
 
         xml.FbiMsgsRq {
-          xml.SampleRequest
+          xml.SampleRq
         }
       }
     end
@@ -22,43 +23,86 @@ describe Fishbowl::Objects::BaseObject do
         xml.Ticket ticket
 
         xml.FbiMsgsRq {
-          xml.SampleRequest
+          xml.SampleRq
         }
       }
     end
   end
 
-  context "Protected Methods" do
-    describe "#send_request" do
+  before :each do
+    mock_tcp_connection
+    mock_login_response
+    Fishbowl::Connection.connect(host: 'localhost')
+    Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+  end
 
-    end
+  after :each do
+    unmock_tcp
   end
 
-  context "Private Methods" do
-    describe "#build_request" do
-      it "should build a request document" do
-        base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
-      end
+  describe "#send_request" do
+    before :each do
+      mock_the_response
+    end
 
-      it "should accept an XML Builder" do
-        builder = Nokogiri::XML::Builder.new { |xml| xml.request { xml.SampleRequest } }
-        base_object.send(:build_request, builder, true).to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
-      end
+    it "should include the ticket value when it's set" do
+      base_object.ticket = ticket
+      base_object.send_request("SampleRq", "SampleRs")
+      connection.last_write.should be_equivalent_to(ticket_builder.to_xml)
+    end
 
-      context "when ticket is empty" do
-        it "should return an empty Nokogiri::XML::Builder" do
-          base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(empty_ticket_builder.to_xml)
-        end
+    it "should send the specified request" do
+      base_object.send_request("SampleRq", "SampleRs")
+      connection.last_write.should be_equivalent_to(empty_ticket_builder.to_xml)
+    end
+
+    it "should get the expected response" do
+      code, message, response = base_object.send_request("SampleRq", "SampleRs")
+
+      code.should_not be_nil
+      message.should_not be_nil
+      response.should be_equivalent_to(mock_response.to_xml)
+    end
+  end
+
+  context "Protected Methods" do
+    describe ".attributes" do
+      it "should return an array containing 'ID' by default" do
+        Fishbowl::Objects::BaseObject.attributes.should eq(["ID"])
       end
+    end
 
-      context "when ticket is set" do
-        before :each do
-          base_object.ticket = ticket
+    describe "#parse_attributes" do
+      it "should parse the requested attributes from the supplied xml" do
+        parse_xml = Nokogiri::XML::Builder.new do |xml|
+          xml.parse {
+            xml.ID "5"
+            xml.DataID "15"
+            xml.Name "Demo"
+            xml.SKU "DEMO"
+          }
         end
+        parse_xml = Nokogiri::XML.parse(parse_xml.to_xml)
 
-        it "should return the ticket wrapped in a Nokogiri::XML::Builder" do
-          base_object.send(:build_request, "SampleRequest").to_xml.should be_equivalent_to(ticket_builder.to_xml)
+        class Fishbowl::Objects::BaseObject
+          def self.attributes
+            %w{ID DataID Name SKU}
+          end
         end
+
+        base_object.instance_variable_set("@xml", parse_xml.xpath('parse'))
+
+        base_object.send(:parse_attributes)
+
+        base_object.instance_variables.should include(:@db_id)
+        base_object.instance_variables.should include(:@data_id)
+        base_object.instance_variables.should include(:@name)
+        base_object.instance_variables.should include(:@sku)
+
+        base_object.instance_variable_get(:@db_id).should eq("5")
+        base_object.instance_variable_get(:@data_id).should eq("15")
+        base_object.instance_variable_get(:@name).should eq("Demo")
+        base_object.instance_variable_get(:@sku).should eq("DEMO")
       end
     end
   end

data/spec/objects/carrier_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Carrier do
+  describe "instances" do
+
+    let(:carrier) {
+      doc = Nokogiri::XML.parse(example_file('carrier.xml'))
+      Fishbowl::Objects::Carrier.new(doc.xpath('//Carrier'))
+    }
+
+    it "should properly initialize from example file" do
+      carrier.name.should eq("Will Call")
+    end
+  end
+end