landslider 0.4.5 → 0.4.7

data/README.rdoc

@@ -32,7 +32,7 @@ This gem requires the following gems:
 	LS_API_KEY =  Digest::MD5.hexdigest(LS_API_PASSWORD + LS_INSTANCE_NAME)
 	LS_API_ENDPOINT = {
 	  :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
-	  :version => 2
+	  :version => 1
 	}
 	
 	response = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
@@ -49,13 +49,19 @@ This gem requires the following gems:
 	* getApiVersion
 	* getAccounts
 	* getAccountById
+	* getAccountCustomFields
 	* getAccountContacts
 	* getAccountNotes
 	* getAccountOpportunities
+	* getContacts
+	* getContactCustomFields
 	* getContactNotes
 	* getInstanceInformation
 	* getLeads
+	* getLeadCustomFields
 	* getLeadNotes
+	* getOpportunities
+	* getOpportunityCustomFields
 	* getOpportunityNotes
 	* getUserInformation
 	* getUserInformationById

data/VERSION.yml

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

data/landslider.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.4.5"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]

data/lib/landslider.rb

@@ -20,6 +20,13 @@ class Landslider < Handsoap::Service
 			sh.add('urn:sessionId', self.session_id)
 		}
 	end
+	
+	def on_after_create_http_request(http_request)
+		http_request.headers.merge!({'user-agent' => ["landslider-ruby-gem-version-0.4.6"]})
+		
+		# TODO: use cookies to maintain session state
+		# http_request.headers.merge!({'cookie' => ["JSESSIONID=#{self.session_id}"]})
+	end
 
 	def on_http_error(response)
 		puts response.inspect
@@ -83,9 +90,15 @@ class Landslider < Handsoap::Service
 		response = invoke("getAccountContacts", :soap_action => :none) do |message|
 			message.add 'accountId', account_id
 		end
-		
+
 		node = response.document.xpath('//ns:getAccountContactsResponse', ns)
-		parse_get_account_contacts_result(node) 
+		parse_get_account_contacts_result(node)
+	end
+	
+	def get_account_custom_fields(session_id)
+		response = invoke("getAccountCustomFields")
+		node = response.document.xpath('//ns:getAccountCustomFieldsResponse', ns)
+		parse_get_entity_custom_fields_result(node)
 	end
 		
 	def get_account_notes(session_id, account_id, first_result_position=1, total_results_requested=25)
@@ -117,7 +130,28 @@ class Landslider < Handsoap::Service
 		end
 		
 		node = response.document.xpath('//ns:getAccountOpportunitiesResponse', ns)
-		parse_get_account_opportunities_result(node)	
+		parse_get_account_opportunities_result(node)
+	end
+	
+	def get_contacts(session_id, first_result_position=1, total_results_requested=25)
+		self.session_id = session_id
+		
+		response = invoke("getContacts", :soap_action => :none) do |message|
+			message.add('contactsRequest') { |c|
+				c.add 'firstResultPosition', first_result_position
+				c.add 'totalResultsRequested', total_results_requested
+			}
+		end
+		node = response.document.xpath('//ns:getContactsResponse', ns)
+		parse_get_contacts_result(node)
+	end
+	
+	def get_contact_custom_fields(session_id)
+		self.session_id = session_id
+	
+		response = invoke("getContactCustomFields")
+		node = response.document.xpath('//ns:getContactCustomFieldsResponse', ns)
+		parse_get_entity_custom_fields_result(node)
 	end
 
 	def get_contact_notes(session_id, contact_id, first_result_position=1, total_results_requested=25)
@@ -154,11 +188,18 @@ class Landslider < Handsoap::Service
 				lr.add 'firstResultPosition', first_result_position
 				lr.add 'totalResultsRequested', total_results_requested
 			}
-		end		
+		end
+
 		node = response.document.xpath('//ns:getLeadsResponse', ns)
 		parse_get_leads_result(node)
 	end
 	
+	def get_lead_custom_fields(session_id)
+		response = invoke("getLeadCustomFields")
+		node = response.document.xpath('//ns:getLeadCustomFieldsResponse', ns)
+		parse_get_entity_custom_fields_result(node)
+	end
+	
 	def get_lead_notes(session_id, lead_id, first_result_position=1, total_results_requested=25)
 		self.session_id = session_id
 	
@@ -173,7 +214,27 @@ class Landslider < Handsoap::Service
 		node = response.document.xpath('//ns:getLeadNotesResponse', ns)
 		parse_get_lead_notes_result(node)
 	end
+	
+	def get_opportunities(session_id, first_result_position=1, total_results_requested=25)
+		self.session_id = session_id
+		
+		response = invoke("getOpportunities", :soap_action => :none) do |message|
+			message.add('opportunityRequest') { |req|
+				req.add 'firstResultPosition', first_result_position
+				req.add 'totalResultsRequested', total_results_requested
+			}
+		end
+		node = response.document.xpath('//ns:getOpportunitiesResponse', ns)
+		parse_get_opportunities_result(node)
+	end
 
+	def get_opportunity_custom_fields(session_id)
+		self.session_id = session_id
+
+		response = invoke("getOpportunityCustomFields")
+		node = response.document.xpath('//ns:getOpportunityCustomFieldsResponse', ns)
+		parse_get_entity_custom_fields_result(node)
+	end
 
 	def get_opportunity_notes(session_id, opportunity_id, first_result_position=1, total_results_requested=25)
 		self.session_id = session_id
@@ -291,6 +352,16 @@ class Landslider < Handsoap::Service
 		}
 	end
 	
+	def parse_get_contacts_result(node)
+		{
+		:contacts => node.xpath('./*/contactList', ns).map { |child| parse_contact(child) },
+		
+		:error => xml_to_bool(node, './*/error/text()'),
+		:results_returned => xml_to_int(node, './*/resultsReturned/text()'),
+		:total_results_available => xml_to_int(node, './*/totalResultsAvailable/text()')
+		}
+	end
+	
 	def parse_get_contact_notes_result(node)
 		notes = parse_notes(node)
 		{
@@ -304,6 +375,17 @@ class Landslider < Handsoap::Service
 		}.merge(notes)
 	end
 	
+	def parse_get_entity_custom_fields_result(node)
+		{
+		:custom_fields => node.xpath('./*/customFields', ns).map { |child| parse_custom_field(child) },
+			
+		:error => xml_to_bool(node, './*/error/text()'),
+		:error_code => xml_to_int(node, './*/errorCode/text()'),
+		:result_msg => xml_to_str(node, './*/resultMsg/text()'),
+		:status_code => xml_to_int(node, './*/statusCode/text()')
+		}
+	end
+	
 	def parse_get_instance_information_result(node)
 		{
 		:address => parse_address(node.xpath('./*/address')),
@@ -317,7 +399,6 @@ class Landslider < Handsoap::Service
 		}
 	end
 	
-	
 	def parse_get_leads_result(node)
 		leads = parse_leads(node)
 		{
@@ -343,6 +424,19 @@ class Landslider < Handsoap::Service
 		}.merge(notes)
 	end
 	
+	def parse_get_opportunities_result(node)
+		{
+		:opportunities => node.xpath('./*/opportunityList', ns).map { |child| parse_opportunity(child) },
+			
+		:error => xml_to_bool(node, './*/error/text()'),
+		:error_code => xml_to_int(node, './*/errorCode/text()'),
+		:result_msg => xml_to_str(node, './*/resultMsg/text()'),
+		:status_code => xml_to_int(node, './*/statusCode/text()'),
+		:results_returned => xml_to_int(node, './*/resultsReturned/text()'),
+		:total_results_available => xml_to_int(node, './*/totalResultsAvailable/text()')
+		}
+	end
+	
 	def parse_get_opportunity_notes_result(node)
 		notes = parse_notes(node)
 		{
@@ -396,9 +490,6 @@ class Landslider < Handsoap::Service
 	# WsAccountType
 	def parse_account_type(node)
 		{
-		#:entity_id => xml_to_str(node, './entityId/text()'),
-		#:entity_type => xml_to_str(node, './entityType/text()')
-		#:account_type_id => xml_to_str(node, './accountTypeId/text()'),
 		:account_type => xml_to_str(node, './accountType/text()')
 		}
 	end
@@ -406,9 +497,6 @@ class Landslider < Handsoap::Service
 	# WsAddress 
 	def parse_address(node)
 		{
-		#:entity_id => xml_to_str(node, './entityId/text()'),
-		#:entity_type => xml_to_str(node, './entityType/text()'),
-		#:address_id => xml_to_str(node, './addressId/text()'),
 		:address => xml_to_str(node, './address1/text()'),
 		:city => xml_to_str(node, './city/text()'),
 		:state => xml_to_str(node, './state/text()'),
@@ -427,7 +515,11 @@ class Landslider < Handsoap::Service
 		:work_phone => xml_to_str(node, './workPhone/text()'),
 		:home_phone => xml_to_str(node, './homePhone/text()'),
 		:email => xml_to_str(node, './email/text()'),
-		:owner_id => xml_to_str(node, './ownerId/text()')
+		:title => xml_to_str(node, './homePhone/text()'),
+		:reports_to => xml_to_str(node, './reportsTo/text()'),
+		:owner_id => xml_to_int(node, './ownerId/text()'),
+		:contact_id => xml_to_int(node, './contactId/text()'),
+		:custom_fields => node.xpath('./customFields', ns).map { |child| parse_custom_field(child) }
 		}
 	end
 	
@@ -461,18 +553,16 @@ class Landslider < Handsoap::Service
 		:notes => node.xpath('./*/notes', ns).map { |child| parse_note(child) }
 		}
 	end
-	
+
 	# WsNote
 	def parse_note(node)
 		{
-		#:entity_id => xml_to_str(node, './entityId/text()'),
-		#:entity_type => xml_to_str(node, './entityType/text()'),
-		:archived_by => xml_to_int(node, './archivedBy/text()'),
 		:created_by => xml_to_int(node, './createdBy/text()'),
 		:created_on => xml_to_date(node, './createdOn/text()'),
 		:latest => xml_to_bool(node, './latest/text()'),
+		:note_html => xml_to_str(node, './note/text()'),
 		:note_id => xml_to_int(node, './noteId/text()'),
-		:note_html => xml_to_str(node, './note/text()')
+		:updated_on => xml_to_date(node, './updatedOn/text()'),
 		}
 	end
 	
@@ -485,16 +575,20 @@ class Landslider < Handsoap::Service
 	# WsLead
 	def parse_lead(node)
 		{
-		:name => xml_to_str(node, './name/text()'),
-		:lead_source => xml_to_str(node, './leadSource/source/text()'),
+		:account_id => xml_to_int(node, './accountId/text()'),
+		:converted => xml_to_bool(node, './converted/text()'),
+		:created_by => xml_to_int(node, './createdBy/text()'),
+		:created_on => xml_to_date(node, './createdOn/text()'),
+		:hot => xml_to_bool(node, './hot/text()'),
+		:lead_id => xml_to_int(node, './leadId/text()'),
 		:lead_rating => xml_to_str(node, './leadRating/rating/text()'),
+		:lead_source => xml_to_str(node, './leadSource/source/text()'),
 		:lead_status => xml_to_str(node, './leadStatus/status/text()'),
-		:account_id => xml_to_int(node, './accountId/text()'),
-		:primary_owner_id => xml_to_int(node, './primaryOwnerId/text()'),
+		:name => xml_to_str(node, './name/text()'),
 		:ok_to_call => xml_to_bool(node, './okToCall/text()'),
 		:ok_to_email => xml_to_bool(node, './okToEmail/text()'),
-		:hot => xml_to_bool(node, './hot/text()'),
-		:converted => xml_to_bool(node, './converted/text()')
+		:primary_owner_id => xml_to_int(node, './primaryOwnerId/text()'),
+		:custom_fields => node.xpath('./customFields', ns).map { |child| parse_custom_field(child) }
 		
 		}
 	end
@@ -502,19 +596,20 @@ class Landslider < Handsoap::Service
 	# WsOpportunity
 	def parse_opportunity(node)
 		{
-		#:entity_id => xml_to_str(node, './entityId/text()'),
-		#:entity_type => xml_to_str(node, './entityType/text()'),
 		:account_id => xml_to_int(node, './accountId/text()'),
 		:account_name => xml_to_str(node, './accountName/text()'),
-		:opportunity_id => xml_to_int(node, './opportunityId/text()'),
-		:name => xml_to_str(node, './name/text()'),
-		:deal_value => xml_to_str(node, './dealValue/text()'),
 		:confidence => xml_to_str(node, './confidence/text()'),
+		:current_phase_name => xml_to_str(node, './currentPhaseName/text()'),
+		:deal_value => xml_to_str(node, './dealValue/text()'),
+		:description => xml_to_str(node, './description/text()'),
+		:hot => xml_to_bool(node, './hot/text()'),
+		:name => xml_to_str(node, './name/text()'),
+		:opportunity_id => xml_to_int(node, './opportunityId/text()'),
 		:opportunity_status => xml_to_str(node, './opportunityStatus/status/text()'),
+		:primary_owner_id => xml_to_int(node, './primaryOwnerId/text()'),
 		:selling_process => xml_to_str(node, './sellingProcess/sellingProcess/text()'),
 		:selling_process_id => xml_to_int(node, './sellingProcess/sellingProcessId/text()'),
-		:primary_owner_id => xml_to_int(node, './primaryOwnerId/text()'),
-		:current_phase_name => xml_to_str(node, './currentPhaseName/text()')
+		:start_date => xml_to_date(node, './startDate/text()')
 		}
 	end
 

data/test/landslider_test.rb

@@ -6,16 +6,15 @@ class LandsliderTest < Test::Unit::TestCase
 	JAYTEST_ACCOUNT_ID = 55647822
 	
 	def setup
-		# TODO: fetch a session_id once
-		# if $sid.nil?
+		if $sid.nil?
+			# only get a session once
 			result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
 			$sid = result[:session_id]
-		# end
-		#puts "using #{$sid} to login"
+		end
 	end
 
 	def test_landslider_login
-		# other tests should use $sid for authenticatoin
+		# other tests should use $sid for authentication
 		result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
 		
 		assert_not_nil result
@@ -72,11 +71,17 @@ class LandsliderTest < Test::Unit::TestCase
 		
 		validate_standard_api_result result
 		assert_equal Array, result[:contacts].class
+		assert_not_nil result[:contacts].first[:contact_id]
 		assert result[:contacts].all? { |con| !con[:last_name].nil? }, "last name required"
 	end
 	
+	def test_landslider_get_account_custom_fields
+		result = Landslider.get_account_custom_fields($sid)
+		assert_not_nil result[:custom_fields]
+		assert_not_nil result[:custom_fields].first[:custom_field_id]
+	end
+	
 	def test_landslider_get_account_notes
-		# exists on jaytest
 		result = Landslider.get_account_notes($sid, JAYTEST_ACCOUNT_ID)
 		
 		validate_standard_api_result result
@@ -86,7 +91,7 @@ class LandsliderTest < Test::Unit::TestCase
 	def test_landslider_get_account_opportunities
 		# exists on jaytest
 		result = Landslider.get_account_opportunities($sid, 51858821)
-	  
+
 		assert_equal false, result[:error]
 		assert_equal Array, result[:opportunities].class
 		
@@ -98,8 +103,20 @@ class LandsliderTest < Test::Unit::TestCase
 		}, "opportunities require a name, account, deal value and selling process"
 	end
 	
+	def test_landslider_get_contacts
+		result = Landslider.get_contacts($sid)
+		assert_not_nil result
+		assert_not_nil result[:contacts]
+		assert_not_nil result[:contacts].first[:custom_fields]
+	end
+	
+	def test_landslider_get_contact_custom_fields
+		result = Landslider.get_contact_custom_fields($sid)
+		assert_not_nil result[:custom_fields]
+		assert_not_nil result[:custom_fields].first[:custom_field_id]
+	end
+	
 	def test_landslider_get_contact_notes
-		# exists on jaytest
 		result = Landslider.get_contact_notes($sid, 62813411)
 		
 		validate_standard_api_result result
@@ -117,14 +134,25 @@ class LandsliderTest < Test::Unit::TestCase
 		assert_not_nil result[:instance_url]
 	end
 	
+	def test_landslider_get_opportunity_custom_fields
+		result = Landslider.get_opportunity_custom_fields($sid)
+		assert_not_nil result[:custom_fields]
+		assert_not_nil result[:custom_fields].first[:custom_field_id]
+	end
+	
 	def test_landslider_get_leads
 		result = Landslider.get_leads($sid, 51857822)
-				
+		
 		validate_standard_api_result result
 		assert_not_nil result[:leads]
 		assert_equal Array, result[:leads].class
 	end
 	
+	def test_landslider_get_lead_custom_fields
+		result = Landslider.get_lead_custom_fields($sid)
+		assert_not_nil result[:custom_fields]
+		assert_not_nil result[:custom_fields].first[:custom_field_id]
+	end
 	
 	def test_landslider_get_lead_notes
 		# exists on jaytest
@@ -134,6 +162,10 @@ class LandsliderTest < Test::Unit::TestCase
 		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

data/test/test_helper.rb

@@ -7,7 +7,7 @@ LS_API_PASSWORD = 'Applogin1'
 LS_API_KEY =  Digest::MD5.hexdigest(LS_API_PASSWORD + LS_INSTANCE_NAME)
 LS_API_ENDPOINT = {
   :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
-  :version => 2
+  :version => 1
 }
 
 require 'test/unit'

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors: 
 - Jay Prall