ns_connector 0.0.6 → 0.0.7

data/CHANGELOG

@@ -0,0 +1,4 @@
+v0.0.7:
+	* SubList creation support on new records (and only new records)
+	* Record transformation via transform!
+	* New resource type: CustomerPayment

data/README.rdoc

@@ -21,13 +21,16 @@ How is this different to the other netsuite connector gems out there?
 * Multithreaded chunked searching for retrieving large datasets
 * ActiveRecord (vaguely) alike interface
 * Read only sublist support.
+* SubList item creation on creating new records only. (>= v0.0.7)
 * Attaching and detaching records 
 * Invoice PDF generation.
+* Record transformations.
 
 == Supported NetSuite types
 It's pretty trivial to add a new one yourself. These have been tested to work:
 * Contact
 * Customer
+* CustomerPayment
 * Invoice
 
 == Installation
@@ -107,6 +110,23 @@ Example:
   c.lastname
   => 'Abc'
 
+SubLists can be added to a record on creation. Here is how that works:
+
+	include NSConnector
+	c = Contact.new(:firstname => 'name')
+	c.sublists
+	=> {:addressbook=>
+	  [:addr1,
+	  ...
+
+	c.addressbook << c.new_addressbook_item({
+		:addr1 => 'address line 1',
+		:city => 'unicorn valley'
+	})
+
+	c.save!
+	=> true
+
 === Reading
 You can find by any field or by internalId.
 Example:
@@ -170,6 +190,19 @@ Example:
 2. By Record
   c = Contact.find(42)
   c.delete!
+
+== Record transformations
+You can transform records into other records as per the supported transformation types in NetSuite [2]
+
+e.g.
+	Invoice.find(2106).transform!(CustomerPayment) do |payment|
+		payment.ccnumber = '4222222222222'
+	end
+	=> {"id"=>"2107",
+	"account"=>"",
+	"allowemptycards"=>nil,
+	"applied"=>"99.99" ...
+
   
 === Troubleshooting note:
 Should you run into an error something like:
@@ -189,3 +222,4 @@ MIT
 
 == References
 [1] {SuiteScript Records Browser}[https://system.netsuite.com/help/helpcenter/en_US/RecordsBrowser/2013_1/index.html]
+[2] {Supported Transformation Types}[https://system.netsuite.com/help/helpcenter/en_US/Output/Help/SuiteFlex/SuiteScript/SSAPI_RecordAPIs.html#N1030776904-18]

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/ns_connector/resource.rb

@@ -6,6 +6,7 @@ require 'ns_connector/hash'
 require 'ns_connector/sublist'
 require 'ns_connector/sublist_item'
 require 'ns_connector/attaching'
+require 'ns_connector/transforming'
 
 # This is a 'meta' class that all our useful NetSuite classes inherit from,
 # overriding what they may need to. For example:
@@ -17,6 +18,7 @@ class NSConnector::Resource
 	include NSConnector::FieldStore
 	extend NSConnector::ChunkedSearching
 	extend NSConnector::Attaching
+	extend NSConnector::Transforming
 
 	attr_accessor :store
 
@@ -97,6 +99,16 @@ class NSConnector::Resource
 		self.class.detach!(klass, id, ids)
 	end
 
+	# Transform this instance into target klass
+	# Arguments::
+	#   klass:: Target class, e.g. CustomerPayment
+	#   &block:: optional block, will recieve an instance of target klass
+	#     to perform optional modifications to the object before it is
+	#     saved in NetSuite, like setting payment details.
+	def transform!(klass, &block)
+		self.class.transform!(klass, id, &block)
+	end
+
 	# Format an object like: '#<NSConnector::PseudoResource:1>'
 	def inspect
 		"#<NSConnector::#{self.class}:#{id.inspect}>"
@@ -115,13 +127,21 @@ class NSConnector::Resource
 	# Raises:: NSConnector::Errors various errors if something explodes
 	# Returns:: true
 	def save!
+		# Convert all of our sublist objects to hashes
+		sublists = Hash[@sublist_store.map {|sublist_id, objects|
+			[sublist_id, objects.map {|object|
+				object.to_hash
+			}]
+		}]
+
 		@store = NSConnector::Restlet.execute!(
 			:action => in_netsuite? ? 'update' : 'create',
 			:type_id => type_id,
 			:fields => fields,
-			:data => @store
+			:data => @store,
+			:sublists => sublists,
 		)
-		# If we got this far, we're definitely in NetSuite
+		# If we got this far, we're probably in NetSuite
 		@in_netsuite = true
 
 		return true
@@ -282,6 +302,17 @@ class NSConnector::Resource
 
 					@sublist_store[sublist_name] ||= []
 				end
+
+				define_method(
+					"new_#{sublist_name}_item"
+				) do |upstream_store = nil|
+					NSConnector::SubListItem.new(
+						sublist_name,
+						fields,
+						self,
+						upstream_store
+					)
+				end
 			end
 		end
 	end

data/lib/ns_connector/resources.rb

@@ -1,3 +1,4 @@
 require 'ns_connector/resources/contact'
 require 'ns_connector/resources/customer'
+require 'ns_connector/resources/customer_payment'
 require 'ns_connector/resources/invoice'

data/lib/ns_connector/resources/customer_payment.rb

@@ -0,0 +1,204 @@
+require 'ns_connector/resource'
+
+# == CustomerPayment resource
+# === Fields
+# * account
+# * allowemptycards
+# * applied
+# * aracct
+# * authcode
+# * autoapply
+# * balance
+# * ccapproved
+# * ccavsstreetmatch
+# * ccavszipmatch
+# * ccexpiredate
+# * cchold
+# * ccholdetails
+# * cciavsmatch
+# * ccispurchasecardbin
+# * ccname
+# * ccnumber
+# * ccprocessoraccount
+# * ccsecuritycode
+# * ccsecuritycodematch
+# * ccstreet
+# * cczipcode
+# * chargeit
+# * checknum
+# * consolidatebalance
+# * createddate
+# * creditcard
+# * creditcardprocessor
+# * currency
+# * currencyname
+# * currencysymbol
+# * customer
+# * customercode
+# * customform
+# * debitcardissueno
+# * department
+# * entitynexus
+# * exchangerate
+# * externalid
+# * ignoreavs
+# * ignorecsc
+# * isbasecurrency
+# * ispurchasecard
+# * lastmodifieddate
+# * location
+# * memo
+# * nexus
+# * overridehold
+# * overrideholdchecked
+# * payment
+# * paymenteventdate
+# * paymenteventholdreason
+# * paymenteventpurchasedatasent
+# * paymenteventresult
+# * paymenteventtype
+# * paymenteventupdatedby
+# * paymentmethod
+# * pending
+# * pnrefnum
+# * postingperiod
+# * softdescriptor
+# * status
+# * statusRef
+# * subsidiary
+# * threedstatuscode
+# * tobeemailed
+# * total
+# * trandate
+# * tranid
+# * unapplied
+# * undepfunds
+# * validfrom
+#
+# === SubLists
+# * apply (invoices)
+# * credit
+# * deposit
+
+class NSConnector::CustomerPayment < NSConnector::Resource
+	@type_id = 'customerpayment'
+	@fields = [
+		:id,
+		:account,
+		:allowemptycards,
+		:applied,
+		:aracct,
+		:authcode,
+		:autoapply,
+		:balance,
+		:ccapproved,
+		:ccavsstreetmatch,
+		:ccavszipmatch,
+		:ccexpiredate,
+		:cchold,
+		:ccholdetails,
+		:cciavsmatch,
+		:ccispurchasecardbin,
+		:ccname,
+		:ccnumber,
+		:ccprocessoraccount,
+		:ccsecuritycode,
+		:ccsecuritycodematch,
+		:ccstreet,
+		:cczipcode,
+		:chargeit,
+		:checknum,
+		:consolidatebalance,
+		:createddate,
+		:creditcard,
+		:creditcardprocessor,
+		:currency,
+		:currencyname,
+		:currencysymbol,
+		:customer,
+		:customercode,
+		:customform,
+		:debitcardissueno,
+		:department,
+		:entitynexus,
+		:exchangerate,
+		:externalid,
+		:ignoreavs,
+		:ignorecsc,
+		:isbasecurrency,
+		:ispurchasecard,
+		:lastmodifieddate,
+		:location,
+		:memo,
+		:nexus,
+		:overridehold,
+		:overrideholdchecked,
+		:payment,
+		:paymenteventdate,
+		:paymenteventholdreason,
+		:paymenteventpurchasedatasent,
+		:paymenteventresult,
+		:paymenteventtype,
+		:paymenteventupdatedby,
+		:paymentmethod,
+		:pending,
+		:pnrefnum,
+		:postingperiod,
+		:softdescriptor,
+		:status,
+		:statusRef,
+		:subsidiary,
+		:threedstatuscode,
+		:tobeemailed,
+		:total,
+		:trandate,
+		:tranid,
+		:unapplied,
+		:undepfunds,
+		:validfrom,
+	]
+	@sublists = {
+		:apply => [
+			:amount,
+			:apply,
+			:applydate,
+			:createdfrom,
+			:disc,
+			:discamt,
+			:discdate,
+			:doc,
+			:due,
+			:duedate,
+			:internalid,
+			:job,
+			:line,
+			:refnum,
+			:total,
+			:url,
+		],
+		:credit => [
+			:amount,
+			:apply,
+			:createdfrom,
+			:creditdate,
+			:doc,
+			:due,
+			:duedate,
+			:internalid,
+			:line,
+			:refnum,
+			:total,
+			:url,
+		],
+		:deposit => [
+			:amount,
+			:apply,
+			:currency,
+			:depositdate,
+			:doc,
+			:remaining,
+			:total,
+			:url,
+		]
+	}
+end

data/lib/ns_connector/sublist_item.rb

@@ -22,4 +22,8 @@ class NSConnector::SubListItem
 	def inspect
 		"#<NSConnector::#{self.class}:#{name}>"
 	end
+
+	def to_hash
+		@store
+	end
 end

data/lib/ns_connector/transforming.rb

@@ -0,0 +1,34 @@
+# Provide a transform! method
+module NSConnector::Transforming
+	# Transform record to target class, given id.
+	# Optionally set fields on the target record before saving if passed
+	# block.
+	# Arguments:: 
+	#   klass:: target class to transform into, e.g. CustomerPayment
+	#   id:: internal id of source record to transform
+	#   &block:: optional block, passed a newly created object of target
+	#   	klass, anything you set on this class will be set in netsuite
+	#   	before saving the newly created object.
+	# Example::
+	# 	Invoice.transform!(CustomerPayment, 500) do |payment|
+	# 		payment.ccnumber = '422222222'
+	# 		payment.ccexpiry = 'invalid'
+	# 	end
+	# 	=> #<NSConnector::NSConnector::CustomerPayment:"123">
+	def transform!(klass, id, &block)
+		target = klass.new
+		if block_given? then
+			# User sets what they want on the target
+			yield target
+		end
+
+		NSConnector::Restlet.execute!(
+			:action => 'transform',
+			:source_type_id => type_id,
+			:target_type_id => klass.type_id,
+			:source_id => id,
+			:fields => klass.fields,
+			:data => target.store
+		)
+	end
+end

data/spec/resource_spec.rb

@@ -84,13 +84,19 @@ describe PseudoResource do
 			}
 
 			@p.firstname = 'name'
+			@p.notes << @p.new_notes_item(:line => 'line1')
 
 			Restlet.should_receive(:execute!).
 				with({
 					:action => 'create',
 					:type_id => 'pseudoresource',
 					:fields => ['id', 'firstname', 'lastname'],
-					:data => {'firstname' => 'name'}
+					:data => {'firstname' => 'name'},
+					:sublists => { 
+						:notes => [
+							{'line' => 'line1'}
+						]
+					},
 				}).
 				once.
 				and_return(ns_reply)
@@ -241,7 +247,8 @@ describe PseudoResource do
 						'firstname' => 'new',
 						'lastname' => 'orig',
 						'id' => '1'
-					}
+					},
+					:sublists => {}
 				}).
 				once.
 				and_return({'firstname' => 'New'})
@@ -314,6 +321,26 @@ describe PseudoResource do
 		end
 	end
 
+	context 'transform' do
+		include_context 'found_resource'
+		it 'transform! s' do
+			Restlet.should_receive(:execute!).
+				with({
+					:action=>"transform",
+					:source_type_id=>"pseudoresource",
+					:target_type_id=>"otherresource",
+					:source_id=>"1", 
+					:fields=>["id", "fax"],
+					:data=>{"fax"=>"123"}
+				})
+
+			@found_resource.transform!(OtherResource) do |o|
+				expect(o).to be_a(OtherResource)
+				o.fax = '123'
+			end
+		end
+	end
+
 	context 'link aliases' do
 		include_context 'found_resource'
 

data/spec/resources/customer_payment_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+include NSConnector
+describe CustomerPayment do
+	it 'should not explode on creation' do
+		CustomerPayment.new
+	end
+end

data/spec/transforming_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+class MagicResource 
+	extend NSConnector::Transforming 
+	def initialize 
+	end
+	def self.type_id
+		'magic'
+	end
+end
+
+class MagicTarget 
+	attr_reader :store
+	extend NSConnector::Transforming
+	def initialize 
+		@store = {}
+	end
+	def field1=(v)
+		@store[:field1] = v
+	end
+	class << self
+		def type_id
+			'target'
+		end
+		def fields
+			[:field1]
+		end
+	end
+end
+
+describe NSConnector::Transforming do
+	it 'transform! with no block works' do
+		NSConnector::Restlet.should_receive(:execute!).with({
+			:action => 'transform',
+			:source_type_id => 'magic',
+			:target_type_id => 'target',
+			:source_id => 42,
+			:data => {},
+			:fields => [:field1]
+		})
+
+		MagicResource.transform!(MagicTarget, 42)
+	end
+	it 'transform! with no block works' do
+		NSConnector::Restlet.should_receive(:execute!).with({
+			:action => 'transform',
+			:source_type_id => 'magic',
+			:target_type_id => 'target',
+			:source_id => 42,
+			:data => {:field1 => 'value'},
+			:fields => [:field1]
+		})
+
+		MagicResource.transform!(MagicTarget, 42) do |magic_target|
+			magic_target.field1 = 'value'
+		end
+	end
+end

data/support/restlet.js

@@ -34,6 +34,33 @@ function get_record_by_id(type_id, fields, id)
 	return(response);
 }
 
+// Transfrom from a record type, to another, given ID. The set a bunch of
+// fields on that new record type.
+// Arguments::
+// 	source_id:: source record internal id
+// 	source_type_id:: source record type, e.g. invoice
+// 	target_type_id:: target record type, e.g. customerpayment
+// 	data:: hash of key/values to set before saving the new deferred record
+// 	fields:: array of fields for target type
+function transform(request) 
+{
+	var deferred = nlapiTransformRecord(
+		request.source_type_id,
+		request.source_id,
+		request.target_type_id
+	);
+
+	for(var field in request.data) {
+		deferred.setFieldValue(field, request.data[field]);
+	}
+
+	return(get_record_by_id(
+		request.target_type_id,
+		request.fields,
+		nlapiSubmitRecord(deferred, true)
+	));
+}
+
 // In order to update an item, we create a diff of what has actually changed,
 // then commit just those changes.
 function update(request)
@@ -42,6 +69,8 @@ function update(request)
 		argument_error('update action requires an id');
 	}
 
+	return(nlapiSubmitRecord(newrec, true));
+
 	var diff = {};
 	var record = nlapiLoadRecord(request.type_id, request.data.id);
 
@@ -225,16 +254,31 @@ function delete_id(request)
 function create(request)
 {
 	var record = nlapiCreateRecord(request.type_id);
-	var response = {};
 
 	for(var field in request.data) {
 		record.setFieldValue(field, request.data[field]);
 	}
 
-	for(var i = 0; i < request.fields.length; i++ ) {
-		response[request.fields[i]] = record.getFieldValue(
-			request.fields[i]
-		);
+	// request.sublists is a hash that looks like this:
+	// {'addressbook' => [{'addr1' => 'line 1 of address'}]
+	//
+	// Note: For some reason when you try to commit the line item, as the
+	// documentation says you *must*, the item is not saved.
+	//
+	// So, we don't. And it works.
+	for(var sublist_id in request.sublists) {
+		for(var i = 0; i < request.sublists[sublist_id].length; i++) {
+			var item = request.sublists[sublist_id][i];
+			record.insertLineItem(sublist_id, i + 1);
+			for(var subfield in item) {
+				record.setLineItemValue(
+					sublist_id,
+					subfield,
+					i + 1,
+					item[subfield]
+				);
+			}
+		}
 	}
 
 	return(get_record_by_id(
@@ -374,6 +418,7 @@ function main(request)
 		'attach'   	: attach,
 		'detach'   	: detach,
 		'raw_search'   	: raw_search,
+		'transform'   	: transform
 	}
 
 	if(!(request.action in actions)) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns_connector
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -149,6 +149,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -168,10 +169,12 @@ files:
 - lib/ns_connector/resources.rb
 - lib/ns_connector/resources/contact.rb
 - lib/ns_connector/resources/customer.rb
+- lib/ns_connector/resources/customer_payment.rb
 - lib/ns_connector/resources/invoice.rb
 - lib/ns_connector/restlet.rb
 - lib/ns_connector/sublist.rb
 - lib/ns_connector/sublist_item.rb
+- lib/ns_connector/transforming.rb
 - misc/failed_sublist_saving_patch
 - scripts/run_restlet
 - scripts/test_shell
@@ -180,6 +183,7 @@ files:
 - spec/config_spec.rb
 - spec/resource_spec.rb
 - spec/resources/contact_spec.rb
+- spec/resources/customer_payment_spec.rb
 - spec/resources/customer_spec.rb
 - spec/resources/invoice_spec.rb
 - spec/restlet_spec.rb
@@ -187,6 +191,7 @@ files:
 - spec/sublist_item_spec.rb
 - spec/sublist_spec.rb
 - spec/support/mock_data.rb
+- spec/transforming_spec.rb
 - support/read_only_test
 - support/restlet.js
 - support/super_dangerous_write_test
@@ -205,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2425652984816094111
+      hash: 3862389985768265126
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: