fishbowl 0.0.1 → 1.0.2

data/spec/objects/carton_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Carton do
+  describe "instances" do
+
+    let(:carton) {
+      doc = Nokogiri::XML.parse(example_file('carton.xml'))
+      Fishbowl::Objects::Carton.new(doc.xpath('//Carton'))
+    }
+
+    it "should properly initialize from example file" do
+      carton.db_id.should eq("64")
+      carton.ship_id.should eq("63")
+      carton.carton_num.should eq("1")
+      carton.tracking_num.should be_empty
+      carton.freight_weight.should eq("1.2")
+      carton.freight_amount.should eq("0")
+
+      carton.shipping_items.first.should be_a(Fishbowl::Objects::ShippingItem)
+    end
+  end
+end
+

data/spec/objects/country_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Country do
+  describe "instances" do
+
+    let(:country) {
+      doc = Nokogiri::XML.parse(example_file('address.xml'))
+      Fishbowl::Objects::Country.new(doc.xpath('//Country'))
+    }
+
+    it "should properly initialize from example file" do
+      country.name.should eq("United States")
+      country.code.should eq("US")
+    end
+  end
+end

data/spec/objects/shipping_item_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::Carton do
+  describe "instances" do
+
+    let(:shipping_item) {
+      doc = Nokogiri::XML.parse(example_file('carton.xml'))
+      Fishbowl::Objects::ShippingItem.new(doc.xpath('//ShippingItem'))
+    }
+
+    it "should properly initialize from example file" do
+      shipping_item.ship_item_id.should eq("169")
+      shipping_item.product_number.should eq("B201")
+
+      shipping_item.uom.should be_a(Fishbowl::Objects::UOM)
+      shipping_item.weight_uom.should be_a(Fishbowl::Objects::UOM)
+      shipping_item.display_weight_uom.should be_a(Fishbowl::Objects::UOM)
+    end
+  end
+end
+

data/spec/objects/state_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::State do
+  describe "instances" do
+
+    let(:state) {
+      doc = Nokogiri::XML.parse(example_file('address.xml'))
+      Fishbowl::Objects::State.new(doc.xpath('//State'))
+    }
+
+    it "should properly initialize from example file" do
+      state.name.should eq("Utah")
+      state.code.should eq("UT")
+      state.country_id.should eq("2")
+    end
+  end
+end

data/spec/objects/uom_conversion_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::UOMConversion do
+  describe "instances" do
+
+    let(:uom_conversion) {
+      doc = Nokogiri::XML.parse(example_file('uom_conversion.xml'))
+      Fishbowl::Objects::UOMConversion.new(doc.xpath('//UOMConversion'))
+    }
+
+    it "should properly initialize from example file" do
+      uom_conversion.main_uom_id.should eq("1")
+      uom_conversion.to_uom_id.should eq("17")
+      uom_conversion.to_uom_code.should eq("pr")
+      uom_conversion.conversion_multiply.should eq("1.0")
+      uom_conversion.conversion_factor.should eq("2.0")
+      uom_conversion.to_uom_is_integral.should eq("false")
+    end
+  end
+end

data/spec/objects/uom_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::UOM do
+  describe "instances" do
+
+    let(:uom) {
+      doc = Nokogiri::XML.parse(example_file('uom.xml'))
+      Fishbowl::Objects::UOM.new(doc.xpath('//UOM'))
+    }
+
+    it "should properly initialize from example file" do
+      uom.uomid.should eq("1")
+      uom.name.should eq("Each")
+      uom.code.should eq("ea")
+
+      uom.uom_conversions.should be_a(Array)
+      uom.uom_conversions.first.should be_a(Fishbowl::Objects::UOMConversion)
+    end
+  end
+end

data/spec/objects/user_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Fishbowl::Objects::User do
+  describe "instances" do
+
+    let(:user) {
+      doc = Nokogiri::XML.parse(example_file('user.xml'))
+      Fishbowl::Objects::User.new(doc.xpath('//User'))
+    }
+
+    it "should properly initialize from example file" do
+      user.db_id.should eq("1")
+      user.user_name.should eq("admin")
+      user.first_name.should eq("Administrator")
+      user.last_name.should eq("Administrator")
+      user.initials.should eq("ADM")
+      user.active.should eq("true")
+    end
+  end
+end

data/spec/requests/add_inventory_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#add_inventory" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    let(:valid_options) {
+      {
+        part_number:          "B103",
+        quantity:             6,
+        uom_id:               1,
+        cost:                 33.01,
+        location_tag_number:  1,
+        tag_number:           1
+      }
+    }
+
+    it "requires valid options" do
+      lambda {
+        Fishbowl::Requests.add_inventory(valid_options)
+      }.should_not raise_error(ArgumentError)
+
+      valid_options.each do |excluded_key, excluded_value|
+        invalid_options = valid_options.keep_if {|k,v| k != excluded_key}
+
+        lambda {
+          Fishbowl::Requests.add_inventory(invalid_options)
+        }.should raise_error(ArgumentError)
+      end
+    end
+
+    it "sends proper request" do
+      mock_the_response('AddInventoryRs')
+      Fishbowl::Requests.add_inventory(valid_options)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    it "includes note option when supplied" do
+      additional_options = { note: 'This is a test' }
+
+      mock_the_response('AddInventoryRs')
+      Fishbowl::Requests.add_inventory(valid_options.merge(additional_options))
+      connection.last_write.should be_equivalent_to(expected_request(additional_options))
+    end
+
+    it "includes tracking option when supplied"
+
+    def expected_request(options = {})
+      options = valid_options.merge(options)
+
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.AddInventoryRq {
+              xml.PartNum options[:part_number]
+              xml.Quantity options[:quantity]
+              xml.UOMID options[:uom_id]
+              xml.Cost options[:cost]
+              xml.Note options[:note] unless options[:note].nil?
+              xml.Tracking options[:tracking] unless options[:tracking].nil?
+              xml.LocationTagNum valid_options[:location_tag_number]
+              xml.TagNum valid_options[:tag_number]
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+  end
+end

data/spec/requests/add_sales_order_item_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#add_sales_order_item" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    let(:valid_options) {
+      {
+        order_number:           1,
+        id:                     -1,
+        product_number:         'BTY100-Core',
+        sales_order_id:         94,
+        description:            'Battery Pack',
+        taxable:                true,
+        quantity:               1,
+        product_price:          95.00,
+        total_price:            95.00,
+        uom_code:               'ea',
+        item_type:              20,
+        status:                 10,
+        quickbooks_class_name:  'Salt Lake City',
+        new_item_flag:          false
+      }
+    }
+
+    it "requires valid options" do
+      lambda {
+        Fishbowl::Requests.add_sales_order_item(valid_options)
+      }.should_not raise_error(ArgumentError)
+
+      valid_options.each do |excluded_key, excluded_value|
+        invalid_options = valid_options.keep_if {|k,v| k != excluded_key}
+
+        lambda {
+          Fishbowl::Requests.add_sales_order_item(invalid_options)
+        }.should raise_error(ArgumentError)
+      end
+    end
+
+    it "sends proper request" do
+      mock_the_response('AddSOItemRs')
+      Fishbowl::Requests.add_sales_order_item(valid_options)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request(options = {})
+      options = valid_options.merge(options)
+
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.AddSOItemRq {
+              xml.OrderNum options[:order_number]
+              xml.SalesOrderItem {
+                xml.ID options[:id]
+                xml.ProductNumber options[:product_number]
+                xml.SOID options[:sales_order_id]
+                xml.Description options[:description]
+                xml.Taxable options[:taxable]
+                xml.Quantity options[:quantity]
+                xml.ProductPrice options[:product_price]
+                xml.TotalPrice options[:total_price]
+                xml.UOMCode options[:uom_code]
+                xml.ItemType options[:item_type]
+                xml.Status options[:status]
+                xml.QuickBooksClassName options[:quickbooks_class_name]
+                xml.NewItemFlag options[:new_item_flag]
+              }
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+  end
+end

data/spec/requests/adjust_inventory_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#adjust_inventory" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    let(:valid_options) {
+      {
+        tag_number: 1,
+        quantity:   5
+      }
+    }
+
+    it "requires valid options" do
+      lambda {
+        Fishbowl::Requests.adjust_inventory(valid_options)
+      }.should_not raise_error(ArgumentError)
+
+      valid_options.each do |excluded_key, excluded_value|
+        invalid_options = valid_options.keep_if {|k,v| k != excluded_key}
+
+        lambda {
+          Fishbowl::Requests.adjust_inventory(invalid_options)
+        }.should raise_error(ArgumentError)
+      end
+    end
+
+    it "sends proper request" do
+      mock_the_response('AdjustInventoryRs')
+      Fishbowl::Requests.adjust_inventory(valid_options)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    it "includes tracking when provided"
+
+    def expected_request(options = {})
+      options = valid_options.merge(options)
+
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.AdjustInventoryRq {
+              xml.TagNum valid_options[:tag_number]
+              xml.Quantity valid_options[:quantity]
+              xml.Tracking options[:tracking] unless options[:tracking].nil?
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+  end
+end

data/spec/requests/calculate_sales_order_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#calculate_sales_order" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+    let(:mock_sales_order) {
+      #TODO mock a SalesOrder
+    }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.calculate_sales_order(mock_sales_order)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.CalculateSORq {
+              #TODO mock a SalesOrder object
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.CalculateSORs(statusCode: '1000', statusMessage: "Success!") {
+            #TODO figure out what goes here!
+          }
+        }
+      end
+    end
+  end
+end

data/spec/requests/close_short_sales_order_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#close_short_sales_order" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.close_short_sales_order(50069)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.CloseShortSORq {
+              xml.SONumber 50069
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.CloseShortSORs(statusCode: '1000', statusMessage: "Success!") {
+            #TODO figure out what goes here!
+          }
+        }
+      end
+    end
+  end
+end

data/spec/requests/cycle_count_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#cycle_count" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    let(:valid_options) {
+      #TODO Identify valid options to supply
+    }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.cycle_count(valid_options)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.CycleCountRq {
+              #TODO use valid options
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.CycleCountRs(statusCode: '1000', statusMessage: "Success!") {
+            #TODO figure out what goes here!
+          }
+        }
+      end
+    end
+  end
+end

data/spec/requests/delete_sales_order_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#delete_sales_order" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.delete_sales_order(50069)
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.DeleteSORq {
+              xml.SONumber 50069
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.DeleteSORs(statusCode: '1000', statusMessage: "Success!") {
+            #TODO figure out what goes here!
+          }
+        }
+      end
+    end
+  end
+end

data/spec/requests/export_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#export" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.export("ExportPartCost")
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.ExportRq {
+              xml.Type "ExportPartCost"
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.ExportRs(statusCode: '1000', statusMessage: "Success!") {
+            #TODO figure out what goes here!
+          }
+        }
+      end
+    end
+  end
+end

data/spec/requests/get_account_balance_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Fishbowl::Requests do
+  describe "#get_account_balance" do
+    before :each do
+      mock_tcp_connection
+      mock_login_response
+      Fishbowl::Connection.connect(host: 'localhost')
+      Fishbowl::Connection.login(username: 'johndoe', password: 'secret')
+    end
+
+    let(:connection) { FakeTCPSocket.instance }
+
+    it "sends proper request" do
+      mock_the_response(expected_response)
+      Fishbowl::Requests.get_account_balance("Accounts Payable")
+      connection.last_write.should be_equivalent_to(expected_request)
+    end
+
+    it "returns the balance of the requested account"
+
+    def expected_request
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml.FbiXml {
+          xml.Ticket
+          xml.FbiMsgsRq {
+            xml.GetAccountBalanceRq {
+              xml.Account "Accounts Payable"
+            }
+          }
+        }
+      end
+
+      request.to_xml
+    end
+
+    def expected_response
+      Nokogiri::XML::Builder.new do |xml|
+        xml.response {
+          xml.GetAccountBalanceRs(statusCode: '1000', statusMessage: "Success!") {
+            xml.Account {
+              xml.Name          "Demo Account"
+              xml.AccountingID  "DEMO"
+              xml.AccountType   9
+              xml.Balance       "1200.00"
+            }
+          }
+        }
+      end
+    end
+  end
+end