netsuite 0.0.10 → 0.0.11

data/lib/netsuite/support/record_refs.rb

@@ -0,0 +1,33 @@
+module NetSuite
+  module Support
+    module RecordRefs
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def record_refs(*names)
+          names.each do |name|
+            record_ref name
+          end
+        end
+
+        def record_ref(name)
+          name_sym = name.to_sym
+          fields << name_sym
+          define_method "#{name}=" do |attrs|
+            attributes[name_sym] = NetSuite::Records::RecordRef.new(attrs)
+          end
+
+          define_method name_sym do
+            attributes[name_sym]
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/netsuite/support/records.rb

@@ -0,0 +1,40 @@
+module NetSuite
+  module Support
+    module Records
+      include Attributes
+      include Namespaces::PlatformCore
+
+      def to_record
+        attributes.reject { |k,v| self.class.read_only_fields.include?(k) }.inject({}) do |hash, (k,v)|
+          kname = if k == :klass
+                    "#{record_namespace}:class"
+                  else
+                    "#{record_namespace}:#{k.to_s.lower_camelcase}"
+                  end
+          if v.respond_to?(:internal_id) && v.internal_id
+            hash[:attributes!] ||= {}
+            hash[:attributes!][kname] ||= {}
+            hash[:attributes!][kname]['internalId'] = v.internal_id
+          end
+          if v.kind_of?(NetSuite::Records::RecordRef) && v.type
+            hash[:attributes!] ||= {}
+            hash[:attributes!][kname] ||= {}
+            hash[:attributes!][kname]['type'] = v.type.lower_camelcase
+          end
+          if Array === v
+            v = v.map { |i| i.respond_to?(:to_record) ? i.to_record : i }
+          else
+            v = v.to_record if v.respond_to?(:to_record)
+          end
+          hash[kname] = v
+          hash
+        end
+      end
+
+      def record_type
+        "#{record_namespace}:#{self.class.to_s.split('::').last}"
+      end
+
+    end
+  end
+end

data/lib/netsuite/{savon_support.rb → support/requests.rb}

@@ -1,6 +1,6 @@
 module NetSuite
-  module Actions
-    module SavonSupport
+  module Support
+    module Requests
 
       def self.included(base)
         base.send(:extend, ClassMethods)

data/lib/netsuite/version.rb

@@ -1,3 +1,3 @@
 module Netsuite
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/spec/netsuite/records/bill_address_spec.rb

@@ -12,4 +12,41 @@ describe NetSuite::Records::BillAddress do
     end
   end
 
+  describe '#to_record' do
+    before do
+      bill_address.bill_attention = 'Mr. Smith'
+      bill_address.bill_addressee = 'Mr. Robert Smith'
+      bill_address.bill_phone     = '1234567890'
+      bill_address.bill_addr1     = '123 Happy Lane'
+      bill_address.bill_addr2     = '#4'
+      bill_address.bill_addr3     = 'Box 6'
+      bill_address.bill_city      = 'Los Angeles'
+      bill_address.bill_state     = 'CA'
+      bill_address.bill_zip       = '90007'
+      bill_address.bill_country   = '_unitedStates'
+    end
+
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'platformCommon:billAttention' => 'Mr. Smith',
+        'platformCommon:billAddressee' => 'Mr. Robert Smith',
+        'platformCommon:billPhone'     => '1234567890',
+        'platformCommon:billAddr1'     => '123 Happy Lane',
+        'platformCommon:billAddr2'     => '#4',
+        'platformCommon:billAddr3'     => 'Box 6',
+        'platformCommon:billCity'      => 'Los Angeles',
+        'platformCommon:billState'     => 'CA',
+        'platformCommon:billZip'       => '90007',
+        'platformCommon:billCountry'   => '_unitedStates'
+      }
+      bill_address.to_record.should eql(record)
+    end
+  end
+
+  describe 'record_namespace' do
+    it 'belongs to the platformCommon namespace' do
+      bill_address.record_namespace.should eql('platformCommon')
+    end
+  end
+
 end

data/spec/netsuite/records/classification_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Classification do
+  let(:classification) { NetSuite::Records::Classification.new }
+
+  it 'has all the right fields' do
+    [
+      :name, :include_children, :is_inactive, :class_translation_list, :subsidiary_list, :custom_field_list
+    ].each do |field|
+      classification.should have_field(field)
+    end
+  end
+
+  describe '.get' do
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :name => 'Retail' }) }
+
+      it 'returns an Invoice instance populated with the data from the response object' do
+        NetSuite::Actions::Get.should_receive(:call).with(10, NetSuite::Records::Classification).and_return(response)
+        invoice = NetSuite::Records::Classification.get(10)
+        invoice.should be_kind_of(NetSuite::Records::Classification)
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+
+      it 'raises a RecordNotFound exception' do
+        NetSuite::Actions::Get.should_receive(:call).with(10, NetSuite::Records::Classification).and_return(response)
+        lambda {
+          NetSuite::Records::Classification.get(10)
+        }.should raise_error(NetSuite::RecordNotFound, 'NetSuite::Records::Classification with ID=10 could not be found')
+      end
+    end
+  end
+
+end

data/spec/netsuite/records/customer_addressbook_list_spec.rb

@@ -19,53 +19,78 @@ describe NetSuite::Records::CustomerAddressbookList do
       }
     }
   end
-  let(:record) { NetSuite::Records::CustomerAddressbookList.new(attributes) }
+  let(:list) { NetSuite::Records::CustomerAddressbookList.new(attributes) }
 
   it 'has all the right fields' do
     [
       :default_shipping, :default_billing, :is_residential, :label, :attention, :addressee,
       :phone, :addr1, :addr2, :addr3, :city, :zip, :country, :addr_text, :override, :state
     ].each do |field|
-      record.should have_field(field)
+      list.should have_field(field)
     end
   end
 
   describe '#initialize' do
     context 'when taking in a hash of attributes' do
       it 'sets the attributes for the object given the attributes hash' do
-        record.addr1.should eql('123 Happy Lane')
-        record.addr_text.should eql("123 Happy Lane\nLos Angeles CA 90007")
-        record.city.should eql('Los Angeles')
-        record.country.should eql('_unitedStates')
-        record.default_billing.should be_true
-        record.default_shipping.should be_true
-        record.is_residential.should be_false
-        record.label.should eql('123 Happy Lane')
-        record.override.should be_false
-        record.state.should eql('CA')
-        record.zip.should eql('90007')
-        record.internal_id.should eql('567')
+        list.addr1.should eql('123 Happy Lane')
+        list.addr_text.should eql("123 Happy Lane\nLos Angeles CA 90007")
+        list.city.should eql('Los Angeles')
+        list.country.should eql('_unitedStates')
+        list.default_billing.should be_true
+        list.default_shipping.should be_true
+        list.is_residential.should be_false
+        list.label.should eql('123 Happy Lane')
+        list.override.should be_false
+        list.state.should eql('CA')
+        list.zip.should eql('90007')
+        list.internal_id.should eql('567')
       end
     end
 
     context 'when taking in a CustomerAddressbookList instance' do
       it 'sets the attributes for the object given the record attributes' do
-        old_record = NetSuite::Records::CustomerAddressbookList.new(attributes)
-        record     = NetSuite::Records::CustomerAddressbookList.new(old_record)
-        record.addr1.should eql('123 Happy Lane')
-        record.addr_text.should eql("123 Happy Lane\nLos Angeles CA 90007")
-        record.city.should eql('Los Angeles')
-        record.country.should eql('_unitedStates')
-        record.default_billing.should be_true
-        record.default_shipping.should be_true
-        record.is_residential.should be_false
-        record.label.should eql('123 Happy Lane')
-        record.override.should be_false
-        record.state.should eql('CA')
-        record.zip.should eql('90007')
-        record.internal_id.should eql('567')
+        old_list = NetSuite::Records::CustomerAddressbookList.new(attributes)
+        list     = NetSuite::Records::CustomerAddressbookList.new(old_list)
+        list.addr1.should eql('123 Happy Lane')
+        list.addr_text.should eql("123 Happy Lane\nLos Angeles CA 90007")
+        list.city.should eql('Los Angeles')
+        list.country.should eql('_unitedStates')
+        list.default_billing.should be_true
+        list.default_shipping.should be_true
+        list.is_residential.should be_false
+        list.label.should eql('123 Happy Lane')
+        list.override.should be_false
+        list.state.should eql('CA')
+        list.zip.should eql('90007')
+        list.internal_id.should eql('567')
       end
     end
   end
 
+  describe '#to_record' do
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'listRel:addr1'           => '123 Happy Lane',
+        'listRel:addrText'        => "123 Happy Lane\nLos Angeles CA 90007",
+        'listRel:city'            => 'Los Angeles',
+        'listRel:country'         => '_unitedStates',
+        'listRel:defaultBilling'  => true,
+        'listRel:defaultShipping' => true,
+        'listRel:isResidential'   => false,
+        'listRel:label'           => '123 Happy Lane',
+        'listRel:override'        => false,
+        'listRel:state'           => 'CA',
+        'listRel:zip'             => '90007'
+      }
+      list.to_record.should eql(record)
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string of the record SOAP type' do
+      list.record_type.should eql('listRel:CustomerAddressbookList')
+    end
+  end
+
 end

data/spec/netsuite/records/invoice_item_list_spec.rb

@@ -2,23 +2,23 @@ require 'spec_helper'
 
 describe NetSuite::Records::InvoiceItemList do
   let(:list) { NetSuite::Records::InvoiceItemList.new }
+  let(:item) { NetSuite::Records::InvoiceItem.new }
 
-  it 'has the right fields' do
-    [
-      :amount, :amount_ordered, :bin_numbers, :cost_estimate, :cost_estimate_type, :current_percent, :custom_field_list, :defer_rev_rec, :description, :gift_cert_from, :gift_cert_message, :gift_cert_number, :gift_cert_recipient_email, :gift_cert_recipient_name, :gross_amt, :inventory_detail, :is_taxable, :item_is_fulfilled, :license_code, :line, :options, :order_line, :percent_complete, :quantity, :quantity_available, :quantity_fulfilled, :quantity_on_hand, :quantity_ordered, :quantity_remaining, :rate, :rev_rec_end_date, :rev_rec_start_date, :serial_numbers, :ship_group, :tax1_amt, :tax_rate1, :tax_rate2, :vsoe_allocation, :vsoe_amount, :vsoe_deferral, :vsoe_delivered, :vsoe_permit_discount, :vsoe_price
-    ].each do |field|
-      list.should have_field(field)
-    end
+  it 'can have items be added to it' do
+    list.add_item(item)
+    item_list = list.send(:items)
+    item_list.should be_kind_of(Array)
+    item_list.length.should eql(1)
+    item_list.each { |i| i.should be_kind_of(NetSuite::Records::InvoiceItem) }
   end
 
-  it 'has the right record_refs' do
-    [
-      :department, :item, :job, :location, :price, :rev_rec_schedule, :ship_address, :ship_method, :tax_code, :units
-    ].each do |record_ref|
-      list.should have_record_ref(record_ref)
+  describe '#to_record' do
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'tranSales:item' => []
+      }
+      list.to_record.should eql(record)
     end
   end
 
-  # :class RecordRef
-
 end

data/spec/netsuite/records/invoice_item_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe NetSuite::Records::InvoiceItem do
+  let(:list) { NetSuite::Records::InvoiceItem.new }
+
+  it 'has the right fields' do
+    [
+      :amount, :amount_ordered, :bin_numbers, :cost_estimate, :cost_estimate_type, :current_percent, :custom_field_list,
+      :defer_rev_rec, :description, :gift_cert_from, :gift_cert_message, :gift_cert_number, :gift_cert_recipient_email,
+      :gift_cert_recipient_name, :gross_amt, :inventory_detail, :is_taxable, :item_is_fulfilled, :license_code, :line, :options,
+      :order_line, :percent_complete, :quantity, :quantity_available, :quantity_fulfilled, :quantity_on_hand, :quantity_ordered,
+      :quantity_remaining, :rate, :rev_rec_end_date, :rev_rec_start_date, :serial_numbers, :ship_group, :tax1_amt, :tax_rate1,
+      :tax_rate2, :vsoe_allocation, :vsoe_amount, :vsoe_deferral, :vsoe_delivered, :vsoe_permit_discount, :vsoe_price
+    ].each do |field|
+      list.should have_field(field)
+    end
+  end
+
+  it 'has the right record_refs' do
+    [
+      :department, :item, :job, :location, :price, :rev_rec_schedule, :ship_address, :ship_method, :tax_code, :units
+    ].each do |record_ref|
+      list.should have_record_ref(record_ref)
+    end
+  end
+
+  it 'can initialize from a record' do
+    record = NetSuite::Records::InvoiceItem.new(:amount => 123, :cost_estimate => 234)
+    list   = NetSuite::Records::InvoiceItem.new(record)
+    list.should be_kind_of(NetSuite::Records::InvoiceItem)
+    list.amount.should eql(123)
+    list.cost_estimate.should eql(234)
+  end
+
+  # :class RecordRef
+
+  describe '#to_record' do
+    before do
+      list.amount      = '7'
+      list.description = 'Some thingy'
+    end
+
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'tranSales:amount'      => '7',
+        'tranSales:description' => 'Some thingy'
+      }
+      list.to_record.should eql(record)
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string of the SOAP record type' do
+      list.record_type.should eql('tranSales:InvoiceItem')
+    end
+  end
+
+end

data/spec/netsuite/records/invoice_spec.rb

@@ -10,31 +10,39 @@ describe NetSuite::Records::Invoice do
       :alt_handling_cost, :alt_shipping_cost, :amount_paid, :amount_remaining, :balance, :bill_address,
       :billing_schedule, :contrib_pct, :created_date, :created_from, :currency_name, :custom_field_list,
       :deferred_revenue, :department, :discount_amount, :discount_date, :discount_item, :discount_rate,
-      :discount_total, :due_date, :email, :end_date, :est_gross_profit, :est_gross_profit_percent, :exchange_rate,
+      :due_date, :email, :end_date, :est_gross_profit, :est_gross_profit_percent, :exchange_rate,
       :exclude_commission, :exp_cost_disc_amount, :exp_cost_disc_print, :exp_cost_disc_rate, :exp_cost_disc_tax_1_amt,
       :exp_cost_disc_taxable, :exp_cost_discount, :exp_cost_list, :exp_cost_tax_code, :exp_cost_tax_rate_1,
       :exp_cost_tax_rate_2, :fax, :fob, :gift_cert_applied, :gift_cert_redemption_list, :handling_cost, :handling_tax_1_rate,
       :handling_tax_2_rate, :handling_tax_code, :is_taxable, :item_cost_disc_amount, :item_cost_disc_print,
       :item_cost_disc_rate, :item_cost_disc_tax_1_amt, :item_cost_disc_taxable, :item_cost_discount, :item_cost_list,
-      :item_cost_tax_code, :item_cost_tax_rate_1, :item_cost_tax_rate_2, :job, :klass, :last_modified_date,
+      :item_cost_tax_code, :item_cost_tax_rate_1, :item_cost_tax_rate_2, :job, :last_modified_date,
       :lead_source, :linked_tracking_numbers, :location, :memo, :message, :message_sel, :on_credit_hold, :opportunity,
       :other_ref_name, :partner, :partners_list, :promo_code, :recognized_revenue, :rev_rec_end_date,
       :rev_rec_on_rev_commitment, :rev_rec_schedule, :rev_rec_start_date, :revenue_status, :sales_effective_date,
       :sales_group, :sales_rep, :sales_team_list, :ship_address, :ship_date, :ship_group_list,
       :ship_method, :shipping_cost, :shipping_tax_1_rate, :shipping_tax_2_rate, :shipping_tax_code, :source, :start_date,
-      :status, :sub_total, :subsidiary, :sync_partner_teams, :sync_sales_teams, :tax_2_total, :tax_item, :tax_rate,
+      :status, :subsidiary, :sync_partner_teams, :sync_sales_teams, :tax_2_total, :tax_item, :tax_rate,
       :tax_total, :terms, :time_disc_amount, :time_disc_print, :time_disc_rate, :time_disc_tax_1_amt, :time_disc_taxable,
       :time_discount, :time_list, :time_tax_code, :time_tax_rate_1, :time_tax_rate_2, :to_be_emailed, :to_be_faxed,
-      :to_be_printed, :total, :total_cost_estimate, :tracking_numbers, :tran_date, :tran_id, :tran_is_vsoe_bundle,
+      :to_be_printed, :total_cost_estimate, :tracking_numbers, :tran_date, :tran_id, :tran_is_vsoe_bundle,
       :vat_reg_num, :vsoe_auto_calc
     ].each do |field|
       invoice.should have_field(field)
     end
   end
 
+  it 'has all the right read_only_fields' do
+    [
+      :sub_total, :discount_total, :total
+    ].each do |field|
+      NetSuite::Records::Invoice.should have_read_only_field(field)
+    end
+  end
+
   it 'has the right record_refs' do
     [
-      :account, :bill_address_list, :custom_form, :entity, :posting_period, :ship_address_list
+      :account, :bill_address_list, :custom_form, :entity, :klass, :posting_period, :ship_address_list
     ].each do |record_ref|
       invoice.should have_record_ref(record_ref)
     end
@@ -43,89 +51,11 @@ describe NetSuite::Records::Invoice do
   describe 'item_list' do
     context 'when the attributes constitute an Array of items' do
       it 'builds an InvoiceItemList for each list item_list field' do
-        invoice.item_list = {
-          :item => [
-            {
-              :amount => '15993.6',
-              :item   => {
-                :@internal_id           => '217',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => 'Dummy Item For Import'
-              },
-              :line  => '1',
-              :price => {
-                :@internal_id           => '-1',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => ' '
-              },
-              :quantity => '1.0',
-              :tax_code => {
-                :@internal_id           => '-8',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => '-Not Taxable-'
-              }
-            },
-            {
-              :amount        => '499.0',
-              :defer_rev_rec => false,
-              :item          => {
-                :@internal_id           => '111',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => 'SAT Prep Course'
-              },
-              :line  => '2',
-              :price => {
-                :@internal_id           => '1',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => 'Base Price'
-              },
-              :quantity => '1.0',
-              :rate     => '499.00',
-              :tax_code => {
-                :@internal_id           => '-8',
-                :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-                :name                   => '-Not Taxable-'
-              }
-            }
-          ]
-        }
-        invoice.item_list.should be_kind_of(Array)
-        invoice.item_list.each { |il| il.should be_kind_of(NetSuite::Records::InvoiceItemList) }
-      end
-    end
-
-    context 'when the attributes constitute a single item' do
-      it 'builds an InvoiceItemList for the item_list field' do
-        invoice.item_list = {
-          :item => {
-            :amount => '15993.6',
-            :item   => {
-              :@internal_id           => '217',
-              :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-              :name                   => 'Dummy Item For Import'
-            },
-            :line  => '1',
-            :price => {
-              :@internal_id           => '-1',
-              :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-              :name                   => ' '
-            },
-            :quantity => '1.0',
-            :tax_code => {
-              :@internal_id           => '-8',
-              :"@xmlns:platform_core" => 'urn:core_2011_2.platform.webservices.netsuite.com',
-              :name                   => '-Not Taxable-'
-            }
-          }
-        }
         invoice.item_list.should be_kind_of(NetSuite::Records::InvoiceItemList)
       end
     end
   end
 
-  it 'handles the "klass" field correctly'
-  # This field maps to 'class' but cannot be set as such in Ruby as it will cause runtime errors.
-
   describe '.get' do
     context 'when the response is successful' do
       let(:response) { NetSuite::Response.new(:success => true, :body => { :is_person => true }) }
@@ -220,4 +150,24 @@ describe NetSuite::Records::Invoice do
     end
   end
 
+  describe '#to_record' do
+    before do
+      invoice.email   = 'something@example.com'
+      invoice.tran_id = '4'
+    end
+    it 'can represent itself as a SOAP record' do
+      record = {
+        'tranSales:email'  => 'something@example.com',
+        'tranSales:tranId' => '4'
+      }
+      invoice.to_record.should eql(record)
+    end
+  end
+
+  describe '#record_type' do
+    it 'returns a string representation of the SOAP type' do
+      invoice.record_type.should eql('tranSales:Invoice')
+    end
+  end
+
 end