landslider 0.5.4 → 0.5.5

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 5
-:patch: 4
+:patch: 5
 :build: 

data/landslider.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.4"
+  s.version = "0.5.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
@@ -31,6 +31,10 @@ Gem::Specification.new do |s|
     "lib/landslider.rb",
     "test/landslider_test.rb",
     "test/test_helper.rb",
+    "test/ws_account_note_search_test.rb",
+    "test/ws_contact_note_search_test.rb",
+    "test/ws_lead_note_search_test.rb",
+    "test/ws_opportunity_note_search_test.rb",
     "test/ws_search_test.rb"
   ]
   s.homepage = %q{https://github.com/j4y/landslider}
@@ -41,6 +45,10 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/landslider_test.rb",
     "test/test_helper.rb",
+    "test/ws_account_note_search_test.rb",
+    "test/ws_contact_note_search_test.rb",
+    "test/ws_lead_note_search_test.rb",
+    "test/ws_opportunity_note_search_test.rb",
     "test/ws_search_test.rb"
   ]
 

data/lib/landslider.rb

@@ -8,6 +8,10 @@ class Landslider < Handsoap::Service
 	  :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
 	  :version => 1
 	}
+	
+	DEFAULT_FIRST_RESULT_POSITION=1
+	DEFAULT_TOTAL_RESULTS_REQUESTED=25
+	
 	endpoint LS_API_ENDPOINT
 	
 	attr_accessor :session_id
@@ -88,16 +92,11 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 		
-	def get_account_notes(session_id, account_id, first_result_position=1, total_results_requested=25)
+	def get_account_notes(session_id, search)
 		self.session_id = session_id
 
 		response = invoke('getAccountNotes', :soap_action => :none) do |message|
-			message.add('accountNoteSearch') { |ans|
-		
-				ans.add 'accountId', account_id
-				ans.add 'firstResultPosition', first_result_position
-				ans.add 'totalResultsRequested', total_results_requested
-			}
+			search.soapify_for(message)
 		end
 		node = response.document.xpath('//ns:getAccountNotesResponse', ns)
 		parse_get_account_notes_result(node)
@@ -146,15 +145,11 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 
-	def get_contact_notes(session_id, contact_id, first_result_position=1, total_results_requested=25)
+	def get_contact_notes(session_id, search)
 		self.session_id = session_id
 		
 		response = invoke('getContactNotes', :soap_action => :none) do |message|
-			message.add('contactNote') { |ans|
-				ans.add 'contactId', contact_id
-				ans.add 'firstResultPosition', first_result_position
-				ans.add 'totalResultsRequested', total_results_requested
-			}
+			search.soapify_for(message)
 		end
 		node = response.document.xpath('//ns:getContactNotesResponse', ns)
 		parse_get_contact_notes_result(node)
@@ -194,15 +189,11 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 	
-	def get_lead_notes(session_id, lead_id, first_result_position=1, total_results_requested=25)
+	def get_lead_notes(session_id, search)
 		self.session_id = session_id
 	
 		response = invoke('getLeadNotes', :soap_action => :none) do |message|
-			message.add('leadNote') { |ans|
-				ans.add 'leadId', lead_id
-				ans.add 'firstResultPosition', first_result_position
-				ans.add 'totalResultsRequested', total_results_requested
-			}
+			search.soapify_for(message)
 		end
 		node = response.document.xpath('//ns:getLeadNotesResponse', ns)
 		parse_get_lead_notes_result(node)
@@ -232,16 +223,11 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 
-	def get_opportunity_notes(session_id, opportunity_id, first_result_position=1, total_results_requested=25)
+	def get_opportunity_notes(session_id, search)
 		self.session_id = session_id
 	
 		response = invoke('getOpportunityNotes', :soap_action => :none) do |message|
-			message.add('opportunityNote') { |ans|
-		
-				ans.add 'opportunityId', opportunity_id
-				ans.add 'firstResultPosition', first_result_position
-				ans.add 'totalResultsRequested', total_results_requested
-			}
+			search.soapify_for(message)
 		end
 		node = response.document.xpath('//ns:getOpportunityNotesResponse', ns)
 		parse_get_opportunity_notes_result(node)
@@ -622,14 +608,93 @@ class Landslider < Handsoap::Service
 		# @param [Handsoap::XmlMason::Node] msg
 		# @return [Handsoap::XmlMason::Node]
 		def soapify_for(msg)
-			
 			msg.add('searchCriteria') { |crit|
 				crit.add 'fieldId', @field_id
 				crit.add 'operator', @operator
 				crit.add 'queryValue', @query_value unless @query_value.nil?
 			}
 		end
+	end
 
+	class WsAccountNoteSearch
+		attr_reader :account_id
+		attr_writer :first_result_position, :total_results_requested, :updated_on
+
+		def initialize(account_id)
+			@account_id = account_id
+		end
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('accountNoteSearch') { |crit|
+				crit.add 'accountId', @account_id
+				crit.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
+				crit.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
+				crit.add 'updatedOn', @updated_on unless @updated_on.nil?
+			}
+		end
+	end
+	
+	class WsContactNoteSearch
+		attr_reader :contact_id
+		attr_writer :first_result_position, :total_results_requested, :updated_on
+
+		def initialize(contact_id)
+			@contact_id = contact_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('contactNote') { |crit|
+				crit.add 'contactId', @contact_id
+				crit.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
+				crit.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
+				crit.add 'updatedOn', @updated_on unless @updated_on.nil?
+			}
+		end
+	end
+	
+	class WsLeadNoteSearch
+		attr_reader :lead_id
+		attr_writer :first_result_position, :total_results_requested, :updated_on
+
+		def initialize(lead_id)
+			@lead_id = lead_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('leadNote') { |crit|
+				crit.add 'leadId', @lead_id
+				crit.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
+				crit.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
+				crit.add 'updatedOn', @updated_on unless @updated_on.nil?
+			}
+		end
+		
+	end
+	
+	class WsOpportunityNoteSearch
+		attr_reader :opportunity_id
+		attr_writer :first_result_position, :total_results_requested, :updated_on
+
+		def initialize(opportunity_id)
+			@opportunity_id = opportunity_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('opportunityNote') { |crit|
+				crit.add 'opportunityId', @opportunity_id
+				crit.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
+				crit.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
+				crit.add 'updatedOn', @updated_on unless @updated_on.nil?
+			}
+		end
 	end
 
 end

data/test/landslider_test.rb

@@ -86,14 +86,7 @@ class LandsliderTest < Test::Unit::TestCase
 		assert_not_nil result[:custom_fields]
 		assert_not_nil result[:custom_fields].first[:custom_field_id]
 	end
-	
-	def test_landslider_get_account_notes
-		result = Landslider.get_account_notes($sid, JAYTEST_ACCOUNT_ID)
 		
-		validate_standard_api_result result
-		validate_at_least_one_note_returned result
-	end
-	
 	def test_landslider_get_account_opportunities
 		# exists on jaytest
 		result = Landslider.get_account_opportunities($sid, 51858821)
@@ -122,13 +115,6 @@ class LandsliderTest < Test::Unit::TestCase
 		assert_not_nil result[:custom_fields].first[:custom_field_id]
 	end
 	
-	def test_landslider_get_contact_notes
-		result = Landslider.get_contact_notes($sid, 62813411)
-		
-		validate_standard_api_result result
-		validate_at_least_one_note_returned result
-	end
-	
 	def test_landslider_get_instance_information
 		# Landslide API doc bug..  integer user_id doesn't work
 		result = Landslider.get_instance_information($sid, 'jayp@landslide.com')
@@ -160,27 +146,11 @@ class LandsliderTest < Test::Unit::TestCase
 		assert_not_nil result[:custom_fields].first[:custom_field_id]
 	end
 	
-	def test_landslider_get_lead_notes
-		# exists on jaytest
-		result = Landslider.get_lead_notes($sid, 33592028)
-		
-		validate_standard_api_result result
-		validate_at_least_one_note_returned result
-	end
-	
 	def test_landslider_get_opportunities
 		result = Landslider.get_opportunities($sid)
 		assert_not_nil result[:opportunities]
 	end
 	
-	def test_landslider_get_opportunity_notes
-		# exists on jaytest
-		result = Landslider.get_opportunity_notes($sid, 55952453)
-		
-		validate_standard_api_result result
-		validate_at_least_one_note_returned result
-	end
-	
 	def test_landslider_get_user_information
 		result = Landslider.get_user_information($sid, 'jayp@landslide.com')
 		

data/test/ws_account_note_search_test.rb

@@ -0,0 +1,33 @@
+
+require 'test_helper'
+
+class WsAccountNoteSearchTest < Test::Unit::TestCase
+
+	def setup
+		$sid3 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_account_note_search
+		search = Landslider::WsAccountNoteSearch.new(55647822)
+		result = Landslider.get_account_notes($sid3, search)
+		assert_equal false, result[:error]
+		assert_equal 7, result[:results_returned]
+	end
+	
+	def test_account_note_search_limit_by_updated_on
+		search = Landslider::WsAccountNoteSearch.new(55647822)
+		search.updated_on = '2011-04-21'
+		result = Landslider.get_account_notes($sid3, search)
+		assert_equal false, result[:error]
+		assert_equal 2, result[:results_returned]
+	end
+	
+	def test_account_note_search_limit_by_results_requested
+		search = Landslider::WsAccountNoteSearch.new(55647822)
+		search.total_results_requested = 4
+		result = Landslider.get_account_notes($sid3, search)
+		assert_equal false, result[:error]
+		assert_equal 4, result[:results_returned]
+	end
+	
+end

data/test/ws_contact_note_search_test.rb

@@ -0,0 +1,27 @@
+
+require 'test_helper'
+
+class WsContactNoteSearchTest < Test::Unit::TestCase
+
+	def setup
+		$sid4 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_contact_note_search
+		search = Landslider::WsContactNoteSearch.new(62813411)
+		result = Landslider.get_contact_notes($sid4, search)
+
+		assert_equal false, result[:error]
+		assert_equal 2, result[:results_returned]
+	end
+	
+	def test_contact_note_search_limit_by_results_requested
+		search = Landslider::WsContactNoteSearch.new(62813411)
+		search.total_results_requested = 1
+		result = Landslider.get_contact_notes($sid4, search)
+		
+		assert_equal false, result[:error]
+		assert_equal 1, result[:results_returned]
+	end
+	
+end

data/test/ws_lead_note_search_test.rb

@@ -0,0 +1,19 @@
+
+require 'test_helper'
+
+class WsLeadNoteSearchTest < Test::Unit::TestCase
+
+	def setup
+		$sid5 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_opportunity_note_search
+		search = Landslider::WsLeadNoteSearch.new(33592028)
+		result = Landslider.get_lead_notes($sid5, search)
+		
+		assert_equal false, result[:error]
+		assert_equal 1, result[:results_returned]
+	end
+
+	
+end

data/test/ws_opportunity_note_search_test.rb

@@ -0,0 +1,25 @@
+
+require 'test_helper'
+
+class WsOpportunityNoteSearchTest < Test::Unit::TestCase
+
+	def setup
+		$sid0 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_opportunity_note_search
+		search = Landslider::WsOpportunityNoteSearch.new(55952453)
+		result = Landslider.get_opportunity_notes($sid0, search)
+		assert_equal false, result[:error]
+		assert_equal 2, result[:results_returned]
+	end
+	
+	def test_opportunity_note_search_limit_by_results_requested
+		search = Landslider::WsOpportunityNoteSearch.new(55952453)
+		search.total_results_requested = 1
+		result = Landslider.get_opportunity_notes($sid0, search)
+		assert_equal false, result[:error]
+		assert_equal 1, result[:results_returned]
+	end
+	
+end

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Jay Prall
@@ -79,6 +79,10 @@ files:
 - lib/landslider.rb
 - test/landslider_test.rb
 - test/test_helper.rb
+- test/ws_account_note_search_test.rb
+- test/ws_contact_note_search_test.rb
+- test/ws_lead_note_search_test.rb
+- test/ws_opportunity_note_search_test.rb
 - test/ws_search_test.rb
 has_rdoc: true
 homepage: https://github.com/j4y/landslider
@@ -111,4 +115,8 @@ summary: Landslide Ruby
 test_files: 
 - test/landslider_test.rb
 - test/test_helper.rb
+- test/ws_account_note_search_test.rb
+- test/ws_contact_note_search_test.rb
+- test/ws_lead_note_search_test.rb
+- test/ws_opportunity_note_search_test.rb
 - test/ws_search_test.rb