fishbowl 0.0.1 → 0.0.2

data/lib/fishbowl/objects/user.rb

@@ -0,0 +1,15 @@
+module Fishbowl::Objects
+  class User < BaseObject
+    attr_accessor :db_id, :user_name, :first_name, :last_name, :initials, :active
+
+    def self.attributes
+      %w{ID UserName FirstName LastName Initials Active}
+    end
+
+    def initialize(user_xml)
+      @xml = user_xml
+      parse_attributes
+      self
+    end
+  end
+end

data/lib/fishbowl/requests.rb

@@ -0,0 +1,6 @@
+module Fishbowl; module Requests; end; end
+
+require 'fishbowl/requests/add_inventory'
+require 'fishbowl/requests/add_sales_order_item'
+require 'fishbowl/requests/adjust_inventory'
+require 'fishbowl/requests/get_carrier_list'

data/lib/fishbowl/requests/add_inventory.rb

@@ -0,0 +1,34 @@
+module Fishbowl::Requests
+  def self.add_inventory(options = {})
+    options = options.symbolize_keys
+
+    %w{part_number quantity uom_id cost location_tag_number tag_number}.each do |required_field|
+      raise ArgumentError if options[required_field.to_sym].nil?
+    end
+
+    raise ArgumentError unless options[:tracking].nil? || options[:tracking].is_a?(Fishbowl::Object::Tracking)
+
+    request = format_add_inventory_request(options)
+    Fishbowl::Objects::BaseObject.new.send_request(request, 'AddInventoryRs')
+  end
+
+private
+
+  def self.format_add_inventory_request(options)
+    Nokogiri::XML::Builder.new do |xml|
+      xml.request {
+        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 options[:location_tag_number]
+          xml.TagNum options[:tag_number]
+        }
+      }
+    end
+  end
+
+end

data/lib/fishbowl/requests/add_sales_order_item.rb

@@ -0,0 +1,42 @@
+module Fishbowl::Requests
+  def self.add_sales_order_item(options = {})
+    options = options.symbolize_keys
+
+    %w{order_number id product_number sales_order_id description taxable
+       quantity product_price total_price uom_code item_type status
+       quickbooks_class_name new_item_flag}.each do |required_field|
+      raise ArgumentError if options[required_field.to_sym].nil?
+    end
+
+    request = format_add_sales_order_item_request(options)
+    Fishbowl::Objects::BaseObject.new.send_request(request, 'AddSOItemRs')
+  end
+
+private
+
+  def self.format_add_sales_order_item_request(options)
+    Nokogiri::XML::Builder.new do |xml|
+      xml.request {
+        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
+  end
+
+end

data/lib/fishbowl/requests/adjust_inventory.rb

@@ -0,0 +1,28 @@
+module Fishbowl::Requests
+  def self.adjust_inventory(options = {})
+    options = options.symbolize_keys
+
+    %w{tag_number quantity}.each do |required_field|
+      raise ArgumentError if options[required_field.to_sym].nil?
+    end
+
+    raise ArgumentError unless options[:tracking].nil? || options[:tracking].is_a?(Fishbowl::Object::Tracking)
+
+    request = format_adjust_inventory_request(options)
+    Fishbowl::Objects::BaseObject.new.send_request(request, 'AdjustInventoryRs')
+  end
+
+private
+
+  def self.format_adjust_inventory_request(options)
+    Nokogiri::XML::Builder.new do |xml|
+      xml.request {
+        xml.AdjustInventoryRq {
+          xml.TagNum options[:tag_number]
+          xml.Quantity options[:quantity]
+          xml.Tracking options[:tracking] unless options[:tracking].nil?
+        }
+      }
+    end
+  end
+end

data/lib/fishbowl/requests/get_carrier_list.rb

@@ -0,0 +1,12 @@
+module Fishbowl::Requests
+  def self.get_carrier_list
+    _, _, response = Fishbowl::Objects::BaseObject.new.send_request('CarrierListRq', 'CarrierListRs')
+
+    results = []
+    response.xpath("//Carrier").each do |carrier_xml|
+      results << Fishbowl::Objects::Carrier.new(carrier_xml)
+    end
+
+    results
+  end
+end

data/lib/fishbowl/version.rb

@@ -1,3 +1,3 @@
 module Fishbowl # :nodoc:
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/examples/account.xml

@@ -0,0 +1,6 @@
+<Account>
+  <Name>Cost Variance</Name>
+  <AccountingID>8000001B-1310422643</AccountingID>
+  <AccountType>12</AccountType>
+  <Balance>0</Balance>
+</Account>

data/spec/examples/address.xml

@@ -0,0 +1,30 @@
+<Address>
+  <Temp-Account>
+    <Type>10</Type>
+  </Temp-Account>
+  <Name>Main Office</Name>
+  <Attn>Attn</Attn>
+  <Street>123 Neverland dr.</Street>
+  <City>Murray</City>
+  <Zip>84121</Zip>
+  <Default>true</Default>
+  <Residential>false</Residential>
+  <Type>Main Office</Type>
+  <State>
+    <Name>Utah</Name>
+    <Code>UT</Code>
+    <CountryID>2</CountryID>
+  </State>
+  <Country>
+    <Name>United States</Name>
+    <Code>US</Code>
+  </Country>
+  <AddressInformationList>
+    <AddressInformation>
+      <Name>Main Office</Name>
+      <Data>Address Data</Data>
+      <Default>true</Default>
+      <Type>Home</Type>
+    </AddressInformation>
+  </AddressInformationList>
+</Address>

data/spec/examples/carrier.xml

@@ -0,0 +1,3 @@
+<Carrier>
+  <Name>Will Call</Name>
+</Carrier>

data/spec/examples/carton.xml

@@ -0,0 +1,93 @@
+<Carton>
+  <ID>64</ID>
+  <ShipID>63</ShipID>
+  <CartonNum>1</CartonNum>
+  <TrackingNum/>
+  <FreightWeight>1.2</FreightWeight>
+  <FreightAmount>0</FreightAmount>
+  <ShippingItems>
+    <ShippingItem>
+      <ShipItemID>169</ShipItemID>
+      <ProductNumber>B201</ProductNumber>
+      <ProductDescription>Heavy Duty Brake Cables</ProductDescription>
+      <QtyShipped>1</QtyShipped>
+      <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>
+      <Cost>0</Cost>
+      <SKU/>
+      <UPC/>
+      <OrderItemID>160</OrderItemID>
+      <OrderLineItem>1</OrderLineItem>
+      <CartonName>1</CartonName>
+      <CartonID>64</CartonID>
+      <TagNum>694</TagNum>
+      <Weight>1.2</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>
+      <DisplayWeight>1.2</DisplayWeight>
+      <DisplayWeightUOM>
+        <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>
+      </DisplayWeightUOM>
+      <Tracking/>
+    </ShippingItem>
+  </ShippingItems>
+</Carton>

data/spec/examples/contact_information.xml

@@ -0,0 +1,5 @@
+<ContactInformation>
+  <ContactName>Josh Anderson</ContactName>
+  <Type>Web</Type>
+  <Data>http://www.joshanderson.com</Data>
+</ContactInformation>

data/spec/examples/contacts.xml

@@ -0,0 +1,7 @@
+<Contacts>
+  <ContactInformation>
+    <ContactName>Josh Anderson</ContactName>
+    <Type>Web</Type>
+    <Data>http://www.joshanderson.com</Data>
+  </ContactInformation>
+</Contacts>

data/spec/examples/credit_card.xml

@@ -0,0 +1,10 @@
+<CreditCard>
+  <CardNumber>411111111111111</CardNumber>
+  <CardExpMonth>02</CardExpMonth>
+  <CardExpYear>19</CardExpYear>
+  <SecurityCode>523</SecurityCode>
+  <NameOnCard>John Doe</NameOnCard>
+  <CardAddress>123 S Riverdale Road</CardAddress>
+  <CardZipCode>84172</CardZipCode>
+  <CardCountryCode>US</CardCountryCode>
+</CreditCard>

data/spec/examples/customer.xml

@@ -0,0 +1,54 @@
+<Customer>
+  <Status>Normal</Status>
+  <DefPaymentTerms>COD</DefPaymentTerms>
+  <DefShipTerms>Prepaid</DefShipTerms>
+  <TaxRate>None</TaxRate>
+  <Name>Sam Ball</Name>
+  <CreditLimit>1000000.00</CreditLimit>
+  <TaxExempt>true</TaxExempt>
+  <TaxExemptNumber>12345</TaxExemptNumber>
+  <Note>Hello World</Note>
+  <ActiveFlag>true</ActiveFlag>
+  <DefaultSalesman>jen</DefaultSalesman>
+  <DefaultCarrier>USPS</DefaultCarrier>
+  <JobDepth>1</JobDepth>
+  <Addresses>
+    <Address>
+      <Temp-Account>
+        <Type>10</Type>
+      </Temp-Account>
+      <Name>Main Office</Name>
+      <Attn>Attention</Attn>
+      <Street>123 Neverland dr.</Street>
+      <City>Murray</City>
+      <Zip>84121</Zip>
+      <Default>true</Default>
+      <Residential>false</Residential>
+      <Type>Main Office</Type>
+      <State>
+        <Name>Utah</Name>
+        <Code>UT</Code>
+        <CountryID>2</CountryID>
+      </State>
+      <Country>
+        <Name>United States</Name>
+        <Code>US</Code>
+      </Country>
+      <AddressInformationList>
+        <AddressInformation>
+          <Name>Main Office</Name>
+          <Data>Address Data</Data>
+          <Default>true</Default>
+          <Type>Home</Type>
+        </AddressInformation>
+      </AddressInformationList>
+    </Address>
+  </Addresses>
+  <CustomFields>
+    <CustomField>
+      <Type>CFT_TEXT</Type>
+      <Name>Custom1</Name>
+      <Info>Custom Data</Info>
+    </CustomField>
+  </CustomFields>
+</Customer>

data/spec/examples/location.xml

@@ -0,0 +1,14 @@
+<Location>
+  <LocationID>0</LocationID>
+  <TypeID>0</TypeID>
+  <Name/>
+  <Description/>
+  <CountedAsAvailable>true</CountedAsAvailable>
+  <Active>true</Active>
+  <Pickable>true</Pickable>
+  <Receivable>true</Receivable>
+  <LocationGroupID>0</LocationGroupID>
+  <LocationGroupName/>
+  <TagID>-1</TagID>
+  <TagNumber>-1</TagNumber>
+</Location>

data/spec/examples/location_group.xml

@@ -0,0 +1,5 @@
+<LocationGroup>
+  <LocationGroupID>1</LocationGroupID>
+  <LocationGroupName>SLC</LocationGroupName>
+  <DefaultQBClassID>2</DefaultQBClassID>
+</LocationGroup>

data/spec/examples/location_group_string.xml

@@ -0,0 +1 @@
+<LocationGroup>SLC</LocationGroup>

data/spec/examples/order_history.xml

@@ -0,0 +1,8 @@
+<OrderHistory>
+  <ID>314</ID>
+  <UserName>admin</UserName>
+  <DateCreated>2011-08-08T11:15:16</DateCreated>
+  <Comment>Receipt Created</Comment>
+  <TableID>-2001398668</TableID>
+  <RecordID>91</RecordID>
+</OrderHistory>

data/spec/examples/part.xml

@@ -0,0 +1,105 @@
+<Part>
+  <PartID>60</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>BB2005</Num>
+  <Description>Custom Value Bike</Description>
+  <Details/>
+  <StandardCost>0</StandardCost>
+  <HasBOM>false</HasBOM>
+  <Configurable>true</Configurable>
+  <ActiveFlag>true</ActiveFlag>
+  <SerializedFlag>true</SerializedFlag>
+  <TrackingFlag>true</TrackingFlag>
+  <Weight>0</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>
+</Part>