landslider 0.5.7 → 0.5.9

data/lib/landslider.rb

@@ -1,117 +1,20 @@
 
+# Landslider is a soap client to the Landslide CRM SOAP-based API
+# Example:
+#
+# require 'landslider'
+# response = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
+# response = Landslider.get_accounts(response[:session_id])
+# response[:accounts].each do |account| 
+# 	puts "id: #{account[:account_id]} name: #{account[:account_name]}"
+# end
+#
+
 require 'handsoap'
 
 class Landslider < Handsoap::Service
 	
-	class WsSearch
-		attr_writer :first_result_position, :total_results_requested, :updated_on
-		attr_writer :search_criteria
-		
-		def initialize
-		end
-		
-		# @param [Handsoap::XmlMason::Node] msg
-		# @return [Handsoap::XmlMason::Node]
-		def soapify_for(msg)
-			msg.add 'firstResultPosition', @first_result_position || DEFAULT_FIRST_RESULT_POSITION
-			msg.add 'totalResultsRequested', @total_results_requested || DEFAULT_TOTAL_RESULTS_REQUESTED
-			msg.add 'updatedOn', @updated_on unless @updated_on.nil?
-			unless @search_criteria.nil?
-				@search_criteria.soapify_for(msg)
-			end
-			
-		end
-	
-	end
-	
-	class WsSearchCriterion
-		attr_reader :field_id, :operator, :query_value
-    
-		def initialize(field_id, operator, query_value)
-			@field_id = field_id
-			@operator = operator
-			@query_value = query_value
-		end
-		
-		# @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 < WsSearch
-		attr_reader :account_id
-		
-		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
-				super(crit)
-			}
-		end
-	end
-	
-	class WsContactNoteSearch < WsSearch
-		attr_reader :contact_id
-
-		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
-				super(crit)
-			}
-		end
-	end
-	
-	class WsLeadNoteSearch < WsSearch
-		attr_reader :lead_id
-
-		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
-				super(crit)
-			}
-		end
-		
-	end
-	
-	class WsOpportunityNoteSearch < WsSearch
-		attr_reader :opportunity_id
-
-		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
-				super(crit)
-			}
-		end
-	end
+	require 'landslider/entities'
 
 	LS_API_NAMESPACE='http://www.landslide.com/webservices/SoapService'
 	LS_API_ENDPOINT = {
@@ -119,13 +22,14 @@ class Landslider < Handsoap::Service
 	  :version => 1
 	}
 	
-	DEFAULT_FIRST_RESULT_POSITION=1
-	DEFAULT_TOTAL_RESULTS_REQUESTED=25
+	DEFAULT_FIRST_RESULT_POSITION = 1
+	DEFAULT_TOTAL_RESULTS_REQUESTED = 25
 	
 	endpoint LS_API_ENDPOINT
 	
 	attr_accessor :session_id
 
+	# @param [Handsoap::XmlMason::Document] doc
 	def on_create_document(doc)
 		doc.alias 'urn', LS_API_NAMESPACE
 		header = doc.find('Header')
@@ -134,17 +38,17 @@ class Landslider < Handsoap::Service
 		}
 	end
 	
+	# @param [Handsoap::Http::Request] http_request
 	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
 	end
 
+	# @param [String] session_id
+	# @return [Hash]
 	def login(session_id)
 		self.session_id = session_id
 		response = invoke('login', :soap_action => :none) do |message|
@@ -158,6 +62,9 @@ class Landslider < Handsoap::Service
 		parse_login_result(node)
 	end
 	
+	# @param [WsAccountSearch] search
+	# @param [String] session_id
+	# @return [Hash]
 	def get_accounts(session_id, search=WsSearch.new)
 		self.session_id = session_id
 		response = invoke('getAccounts', :soap_action => :none) do |message|
@@ -170,6 +77,8 @@ class Landslider < Handsoap::Service
 		parse_get_accounts_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	def get_account_by_id(session_id, account_id)
 		self.session_id = session_id
 		
@@ -181,6 +90,10 @@ class Landslider < Handsoap::Service
 		parse_get_account_by_id_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [String] account_id
+	# @param [Boolean] is_primary
+	# @return [Hash]
 	def get_account_contacts(session_id, account_id, is_primary=false)
 		self.session_id = session_id
 		response = invoke('getAccountContacts', :soap_action => :none) do |message|
@@ -192,12 +105,17 @@ class Landslider < Handsoap::Service
 		parse_get_account_contacts_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	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
-		
+	
+	# @param [String] session_id
+	# @param [WsSearch] search
+	# @return [Hash]
 	def get_account_notes(session_id, search)
 		self.session_id = session_id
 
@@ -207,7 +125,9 @@ class Landslider < Handsoap::Service
 		node = response.document.xpath('//ns:getAccountNotesResponse', ns)
 		parse_get_account_notes_result(node)
 	end
-	
+
+	# @param [String] session_id
+	# @return [Hash]
 	def get_account_opportunities(session_id, account_id)
 		self.session_id = session_id
 		response = invoke('getAccountOpportunities', :soap_action => :none) do |message|
@@ -218,6 +138,8 @@ class Landslider < Handsoap::Service
 		parse_get_account_opportunities_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	def get_api_version(session_id)
 		self.session_id = session_id
 		
@@ -227,9 +149,14 @@ class Landslider < Handsoap::Service
 		parse_api_version_result(node)
 	end
 	
+	
+	# @param [String] session_id
+	# @param [WsContactSearch] search
+	# @return [Hash]
 	def get_contacts(session_id, search=WsSearch.new)
 		self.session_id = session_id
 		
+		# public WsContactResultSet getContacts(WsContactSearch request) 
 		response = invoke('getContacts', :soap_action => :none) do |message|
 			message.add('contactsRequest') { |req|
 				search.soapify_for(req)
@@ -239,6 +166,8 @@ class Landslider < Handsoap::Service
 		parse_get_contacts_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	def get_contact_custom_fields(session_id)
 		self.session_id = session_id
 	
@@ -247,6 +176,9 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [WsSearch] search
+	# @return [Hash]
 	def get_contact_notes(session_id, search)
 		self.session_id = session_id
 		
@@ -258,6 +190,9 @@ class Landslider < Handsoap::Service
 
 	end
 
+	# @param [String] user_id
+	# @param [String] session_id
+	# @return [Hash]
 	def get_instance_information(session_id, user_id)
 		self.session_id = session_id
 		
@@ -268,6 +203,9 @@ class Landslider < Handsoap::Service
 		parse_get_instance_information_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [WsLeadSearch] search
+	# @return [Hash]
 	def get_leads(session_id, search=WsSearch.new)
 		self.session_id = session_id
 	
@@ -281,12 +219,17 @@ class Landslider < Handsoap::Service
 		parse_get_leads_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	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
 	
+	# @param [String] session_id
+	# @param [WsSearch] search
+	# @return [Hash]
 	def get_lead_notes(session_id, search)
 		self.session_id = session_id
 	
@@ -297,6 +240,9 @@ class Landslider < Handsoap::Service
 		parse_get_lead_notes_result(node)
 	end
 	
+	# @param [WsOpportunitySearch] search
+	# @param [String] session_id
+	# @return [Hash]
 	def get_opportunities(session_id, search=WsSearch.new)
 		self.session_id = session_id
 		
@@ -309,6 +255,8 @@ class Landslider < Handsoap::Service
 		parse_get_opportunities_result(node)
 	end
 
+	# @param [String] session_id
+	# @return [Hash]
 	def get_opportunity_custom_fields(session_id)
 		self.session_id = session_id
 
@@ -317,6 +265,9 @@ class Landslider < Handsoap::Service
 		parse_get_entity_custom_fields_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [WsSearch] search
+	# @return [Hash]
 	def get_opportunity_notes(session_id, search)
 		self.session_id = session_id
 	
@@ -327,6 +278,8 @@ class Landslider < Handsoap::Service
 		parse_get_opportunity_notes_result(node)
 	end
 	
+	# @param [String] session_id
+	# @return [Hash]
 	def get_user_information(session_id, user_id)
 
 		self.session_id = session_id
@@ -337,6 +290,8 @@ class Landslider < Handsoap::Service
 		parse_get_user_information_by_id_result(node)
 	end
 
+	# @param [String] session_id
+	# @return [Hash]
 	def get_user_information_by_id(session_id, user_id)
 		self.session_id = session_id
 		

data/test/ws_search_test.rb

@@ -51,5 +51,18 @@ class WsSearchTest < Test::Unit::TestCase
 		assert_equal target_phase_name, result[:opportunities][2][:current_phase_name]
 	end
 
+	def test_ws_search_initialized_with_attrs
+		search = Landslider::WsSearch.new
+		search.first_result_position = 2
+		search.total_results_requested = 4
+		assert_equal 2, search.instance_variable_get(:@first_result_position)
+		assert_equal 4, search.instance_variable_get(:@total_results_requested)
+	end
 
+	def test_ws_search_initialized_with_params
+		search = Landslider::WsSearch.new({:first_result_position => 25, :total_results_requested => 50})
+		assert_equal 25, search.instance_variable_get(:@first_result_position)
+		assert_equal 50, search.instance_variable_get(:@total_results_requested)
+	end
+	
 end

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.7
+  version: 0.5.9
 platform: ruby
 authors: 
 - Jay Prall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-07 00:00:00 -04:00
+date: 2011-05-11 00:00:00 -04:00
 default_executable: generate_api_key.rb
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,18 +65,54 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
-- CHANGELOG.markdown
 - Gemfile
+- HISTORY.md
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION.yml
 - bin/generate_api_key.rb
 - init.rb
 - landslider.gemspec
 - lib/landslider.rb
+- lib/landslider/entities.rb
+- lib/landslider/entities/ws_account.rb
+- lib/landslider/entities/ws_account_note.rb
+- lib/landslider/entities/ws_account_note_search.rb
+- lib/landslider/entities/ws_address.rb
+- lib/landslider/entities/ws_contact.rb
+- lib/landslider/entities/ws_contact_note.rb
+- lib/landslider/entities/ws_contact_note_search.rb
+- lib/landslider/entities/ws_contact_search.rb
+- lib/landslider/entities/ws_employee.rb
+- lib/landslider/entities/ws_entity.rb
+- lib/landslider/entities/ws_lead.rb
+- lib/landslider/entities/ws_lead_contact.rb
+- lib/landslider/entities/ws_lead_note.rb
+- lib/landslider/entities/ws_lead_note_search.rb
+- lib/landslider/entities/ws_lead_search.rb
+- lib/landslider/entities/ws_my_list.rb
+- lib/landslider/entities/ws_note.rb
+- lib/landslider/entities/ws_opportunity.rb
+- lib/landslider/entities/ws_opportunity_note.rb
+- lib/landslider/entities/ws_opportunity_note_search.rb
+- lib/landslider/entities/ws_opportunity_status.rb
+- lib/landslider/entities/ws_payment_term.rb
+- lib/landslider/entities/ws_pick_list_item.rb
+- lib/landslider/entities/ws_primary_entity.rb
+- lib/landslider/entities/ws_product.rb
+- lib/landslider/entities/ws_product_family.rb
+- lib/landslider/entities/ws_product_result.rb
+- lib/landslider/entities/ws_record_upsert_result.rb
+- lib/landslider/entities/ws_result.rb
+- lib/landslider/entities/ws_search.rb
+- lib/landslider/entities/ws_search_criterion.rb
+- lib/landslider/entities/ws_search_operator.rb
+- lib/landslider/entities/ws_selling_process.rb
+- lib/landslider/entities/ws_user.rb
+- lib/landslider/entities/ws_user_search.rb
 - test/landslider_test.rb
 - test/test_helper.rb
 - test/ws_account_note_search_test.rb

data/README.rdoc

@@ -1,77 +0,0 @@
-= Landslider
-
-Ruby interface to Landslide's SOAP based API
-
-== Pre-requisites
-
-== Dependencies
-
-=== Landslide account
-
-An account with Landslide that has the API enabled. (www.landslide.com)  Contact support@landslide.com to have the API enabled.
-
-=== Ruby gem dependencies
-
-	gem install jeweler curb handsoap
-
-== Installation
-
-	gem install landslider
-
-== Usage
-
-
-	Configuration:
-
-	# constants to be set by rails environment config files
-	
-	LS_INSTANCE_NAME = 'jaytest'
-	LS_API_USERNAME = 'jayp@landslide.com'
-
-	# see bin/generate_api_key.rb for details on how to generate this key
-	LS_API_KEY = '53308ccbdcb7f23fbd81a0b2ebcf12a4' 
-	
-	require 'landslider'
-	response = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
-	response = Landslider.get_accounts(response[:session_id])
-	response[:accounts].each do |account| 
-		puts "id: #{account[:account_id]} name: #{account[:account_name]}"
-	end
-
-== Testing
-
-	The default rake task is set to run the tests.
-	
-	$ rake
-	
-	Tests are needed here because the API uses a specific XML structure for requests and responses.
-	
-== Contributing
-
-	Read the github doc on forking:
-	http://help.github.com/forking/
-	
-== API methods
-
-	These are the api methods that can be called.  There are plenty of others to map out.
-
-	* login
-	* getApiVersion
-	* getAccounts
-	* getAccountById
-	* getAccountCustomFields
-	* getAccountContacts
-	* getAccountNotes
-	* getAccountOpportunities
-	* getContacts
-	* getContactCustomFields
-	* getContactNotes
-	* getInstanceInformation
-	* getLeads
-	* getLeadCustomFields
-	* getLeadNotes
-	* getOpportunities
-	* getOpportunityCustomFields
-	* getOpportunityNotes
-	* getUserInformation
-	* getUserInformationById