ns_connector 0.0.14 → 0.0.15

data/spec/resource_spec.rb

@@ -84,7 +84,16 @@ describe PseudoResource do
 			}
 
 			@p.firstname = 'name'
-			@p.notes << @p.new_notes_item(:line => 'line1')
+
+			note_item1 = @p.new_notes_item(:line => 'line 1')
+			note_item2 = @p.new_notes_item(:line => 'line 2')
+
+			@p.notes << note_item1
+			@p.notes << note_item2
+
+			# Replace them, backways to test.
+			SubList.should_receive(:save!).
+				and_return([note_item2, note_item1])
 
 			Restlet.should_receive(:execute!).
 				with({
@@ -94,7 +103,8 @@ describe PseudoResource do
 					:data => {'firstname' => 'name'},
 					:sublists => { 
 						:notes => [
-							{'line' => 'line1'}
+							{'line' => 'line 1'},
+							{'line' => 'line 2'}
 						]
 					},
 				}).
@@ -106,6 +116,9 @@ describe PseudoResource do
 			expect(@p.firstname).to eql('Name')
 			expect(@p.lastname).to eql('nothing')
 			expect(@p.id).to eql('42')
+
+			# Backwards now
+			expect(@p.notes.first.line).to eql('line 2')
 		end
 
 		it 'has a pretty inspect' do
@@ -299,6 +312,16 @@ describe PseudoResource do
 			p = PseudoResource.new
 			expect(p.notes).to be_empty
 		end
+
+		it 'can append a new list to blank object' do
+			p = PseudoResource.new
+			expect(p.new_notes_item).to be_a(NSConnector::SubListItem)
+			p.notes << p.new_notes_item(:line => 'line 1')
+			p.notes << p.new_notes_item(:line => 'line 2')
+
+			expect(p.notes.pop.line).to eql('line 2')
+			expect(p.notes.pop.line).to eql('line 1')
+		end
 	end
 
 	context 'raw search' do

data/spec/sublist_spec.rb

@@ -42,4 +42,33 @@ describe SubList do
 		expect(sublist.first.field1).to eql('new')
 		expect(sublist.last.field2).to eql('new2')
 	end
+
+	it 'saves' do
+		Restlet.should_receive(:execute!).
+			with({
+				:action => 'update_sublist',
+				:type_id => 'contact',
+				:parent_id => '42',
+				:sublist_id => 'sublist',
+				:fields => ['field1', 'field2'],
+				:data => [
+					{'field1' => 'data'},
+					{'field2' => 'otherdata'}
+				]
+			}).and_return(
+				'true'
+			)
+
+		SubList.should_receive(:fetch).and_return('hai')
+		# Duplicates should be ignored, I figure? I'll be a little
+		# confused if duplicates ever appear in NetSuite
+		saved = SubList.save!(
+			[@item1, @item1, @item2],
+			@parent, 
+			'sublist',
+			['field1', 'field2']
+		)
+
+		expect(saved).to eql('hai')
+	end
 end

data/support/restlet.js

@@ -14,12 +14,29 @@ function apply_constructor(klass, opts) {
 	return new applicator();
 }
 
+// Asserts that the current request object has a particular property.
+// If it doesn't, it raises a 400 error.
+function assert_property(request, property_name)
+{
+	if(!request.hasOwnProperty(property_name)) {
+		argument_error("Missing mandatory argument: " + property_name);
+	}
+}
+
 // Stops execution, sending a HTTP 400 response
 function argument_error(message)
 {
 	throw nlapiCreateError('400', message);
 }
 
+// Implements a simple non-prototyped indexOf for objects.
+function object_index_of(current_obj, value) {
+	for (var key in current_obj) {
+	    if (current_obj[key] == value) return key;
+	}
+	return null;
+}
+
 
 // Returns a simple record as an associative array
 function get_record_by_id(type_id, fields, id)
@@ -319,6 +336,197 @@ function fetch_sublist(request)
 	return(get_sublist(record, request.sublist_id, request.fields));
 }
 
+// Before we can update sublists, we must determine first what operations
+// we are about to perform on it.
+//
+// Arguments::
+//   type_id: The type of the parent entity
+//   parent_id: The ID of the entity to get the sublist from
+//   sublist_id: The identifier for the current sublist
+//   data: The data which we are sending to update the sublist with
+//
+// Returns:: An object representing the changes that the current request is
+// about to perform on the sublist.  This object contains three keys:
+// add, update, and del (for delete). Each key points to an array of changes.
+//
+// Raises:: A 400 Missing mandatory argument exception if we missed a
+//          required argument.
+//
+// Each change item is an object that can contain the following keys:
+//  * downstream_index: The index of the sublist item in the changes that we
+//                      are pushing up. You'll only see this on add and update
+//                      operations.
+function get_sublist_changes(request)
+{
+	assert_property(request, 'parent_id');
+	assert_property(request, 'sublist_id');
+
+	var record = nlapiLoadRecord(request.type_id, request.parent_id);
+	var upstream_item_count = record.getLineItemCount(request.sublist_id);
+	var downstream_items = request.data;
+
+	// Start out by checking downstream data to see if we need to add new records.
+	var downstream_identifiers = {}, add_downstream = [];
+
+	for (var i = 0; i < downstream_items.length; i++) {
+		downstream_identifiers[i] = null;
+
+		if (downstream_items[i].hasOwnProperty('id')) {
+			downstream_identifiers[i] = downstream_items[i].id;
+		}
+		else {
+			add_downstream.push({
+				downstream_index: i
+			});
+		}
+	}
+
+	// Mark existing records that have been changed or deleted.
+
+	var update_upstream = [], delete_upstream = []; // Indices of upstream items to update & delete.
+
+	for (var i = 1; i <= upstream_item_count; i++) {
+		var upstream_id = record.getLineItemValue(
+			request.sublist_id, 'id', i
+		);
+
+		var corresponding_downstream = object_index_of(downstream_identifiers, upstream_id);
+
+		if (corresponding_downstream) {
+			// Mark for update.
+			update_upstream.push({
+				downstream_index: corresponding_downstream,
+				upstream_index: i,
+				id: upstream_id
+			});
+		}
+		else {
+			// Mark for deletion.
+			delete_upstream.push({
+				upstream_index: i,
+				id: upstream_id
+			});
+		}
+	}
+
+	return {
+		add: add_downstream,
+		update: update_upstream,
+		del: delete_upstream
+	}
+}
+
+// Commits changes to a given sublist.
+//
+// Arguments::
+//   type_id: The type of the parent entity
+//   parent_id: The ID of the entity to get the sublist from
+//   sublist_id: The identifier for the current sublist
+//   data: The data which we are sending to update the sublist with
+//
+// Returns:: An empty array. You'll need to re-fetch the sublist yourself
+//           later.
+//
+// Raises:: A 400 Missing mandatory argument exception if we missed a
+//          required argument.
+//
+// Each change item is an object that can contain the following keys:
+//  * downstream_index: The index of the sublist item in the changes that we
+//                      are pushing up. You'll only see this on add and update
+//  
+function update_sublist(request)
+{
+	var changes = get_sublist_changes(request);
+
+	var has_changes = (changes.add.length > 0 || changes.update.length > 0 || changes.del.length > 0);
+
+	var change_log = [];
+
+	if (has_changes) {
+
+		var record = nlapiLoadRecord(request.type_id, request.parent_id);
+		var upstream_item_count = record.getLineItemCount(request.sublist_id);
+		var dirty = false;
+
+		// 1. Update
+
+		for (var i = 0; i < changes.update.length; i++) {
+			var change = changes.update[i];
+			var downstream_item = request.data[change.downstream_index];
+
+			for (var field in downstream_item) {
+				var downstream_value = downstream_item[field];
+
+				var upstream_value = record.getLineItemValue(
+					request.sublist_id, field, change.upstream_index
+				);
+
+				if (upstream_value != downstream_value) {
+					dirty = true;
+
+					record.setLineItemValue(
+						request.sublist_id,
+						field,
+						change.upstream_index,
+						downstream_value
+					);
+				}
+			}
+		}
+
+		// 2. Delete
+
+		for (var i = 0; i < changes.del.length; i++) {
+			var change = changes.del[i];
+
+			dirty = true;
+
+			record.removeLineItem(
+				request.sublist_id,
+				change.upstream_index
+			);
+
+			--upstream_item_count;
+		}
+
+		// 3. Add
+
+		for (var i = 0; i < changes.add.length; i++) {
+			var change = changes.add[i];
+			var downstream_item = request.data[change.downstream_index];
+
+			dirty = true;
+
+			var new_upstream_index = ++upstream_item_count;
+
+			record.insertLineItem(request.sublist_id, new_upstream_index);
+
+			for (var field in downstream_item) {
+				var downstream_value = downstream_item[field];
+
+				record.setLineItemValue(
+					request.sublist_id,
+					field,
+					new_upstream_index,
+					downstream_value
+				);
+			}
+		}
+
+		// 4. Save
+
+		// NetSuite explodes if we try to commit a sublist without altering it
+		// in any way, so we have to make sure that the data needs to be saved
+		// before actually trying to save it.
+		if (dirty) {
+			nlapiCommitLineItem(request.sublist_id);
+			nlapiSubmitRecord(record, true);
+		}
+	};
+
+	return([]);
+}
+
 // Make sure we have the required arguments in our request object
 function pre_flight_check(request)
 {
@@ -412,6 +620,7 @@ function main(request)
 		'search'        : search,
 		'update'        : update,
 		'fetch_sublist' : fetch_sublist,
+		'update_sublist' : update_sublist,
 		'invoice_pdf'   : invoice_pdf,
 		'attach'   	: attach,
 		'detach'   	: detach,

data/support/type_scraper.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+require "nokogiri"
+require "uri"
+require "erb"
+require "ostruct"
+require "open-uri"
+
+page = ARGV[0]
+class_name = ARGV[1]
+
+# NB: Index of types is at
+# https://system.netsuite.com/help/helpcenter/en_US/RecordsBrowser/2012_2/index.html
+
+url = "https://system.netsuite.com/help/helpcenter/en_US/RecordsBrowser/2012_2/Records/#{page}.html"
+bogus_ua = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5) AppleWebKit/537.73.11 (KHTML, like Gecko) Version/6.1.1 Safari/537.73.11"
+
+raw = []
+
+open(url, "User-Agent" => bogus_ua) {|f|
+	f.each_line {|line|
+		raw << line
+	}
+}
+
+html_doc = Nokogiri::HTML(raw.join("\n"))
+
+record_id = nil
+fields = [:id]
+sublists = {}
+
+record_ident = html_doc.css('.record_id').first.content.gsub('Internal ID: ', '')
+
+# Fields
+
+fields_table = html_doc.css('table.record_table').first
+
+fields_table.css('tr').each_with_index do |row, i|
+	next if i == 0
+
+	record_cell = row.css('td').first
+	fields << record_cell.content.gsub(/^\s+/, '').gsub(/\s+$/, '').to_sym
+end
+
+# Record shit
+
+html_doc.css('.record_item').each do |r|
+	if r.content.downcase == "sublists"
+		row_table = r.parent.parent.parent
+		row_table.next_element.css('tr').each_with_index do |row, i|
+			next if i == 0
+
+			record_cell = row.css('td').first.css('a').first
+			sublist_name = record_cell.content.downcase.to_sym
+			sublists[sublist_name] = []
+		end
+	end
+end
+
+html_doc.css('body > div.sublist').each do |r|
+	if r.content.downcase =~ / sublist fields$/
+		sublist_name = nil
+
+		r.next_element.css('tr').each_with_index do |row, i|
+			next if i == 0
+
+			record_cell = row.css('td').first
+
+			if i == 1
+				sublist_name = row.css('td').first.content.downcase.to_sym
+				record_cell = row.css('td')[1]
+			end
+
+			sublist_value = record_cell.content.downcase.to_sym
+			sublists[sublist_name] << sublist_value
+		end
+	end
+
+	
+end
+
+ns = OpenStruct.new({
+	resource_type: class_name,
+	resource_type_ident: record_ident,
+	fields: fields,
+	sublists: sublists
+})
+
+class_content = ERB.new(
+	File.read(File.join(
+		File.dirname(__FILE__), "type_scraper.tpl.erb"
+	)),
+	nil,
+	'-'
+).result(
+	ns.instance_eval { binding }
+)
+
+puts class_content

data/support/type_scraper.tpl.erb

@@ -0,0 +1,29 @@
+require 'ns_connector/resource'
+
+# == <%= resource_type %> resource
+# === Fields
+<% fields.each do |f| -%>
+# * <%= f.to_s %>
+<% end -%>
+# === Sublists
+<% sublists.each do |k, v| -%>
+# * <%= k.to_s %>
+<% end -%>
+
+class NSConnector::<%= resource_type %> < NSConnector::Resource
+	@type_id = '<%= resource_type_ident %>'
+	@fields = [
+<% fields.each do |f| -%>
+		:<%= f.to_s %>,
+<% end -%>
+	]
+	@sublists = {
+<% sublists.each do |k, v| -%>
+		:<%= k.to_s %> => [
+<% v.each do |_v| -%>
+			:<%= _v.to_s %>,
+<% end -%>
+		]<% if k == @sublists.keys.last %>,<% end %>
+<% end -%>
+	}
+end