landslider 0.5.26 → 0.5.28

data/README.md

@@ -79,6 +79,7 @@ API methods
 
 	Here is a list of API methods that have been added:
 
+* addTask
 * login
 * getApiVersion
 * getAccounts
@@ -99,6 +100,7 @@ API methods
 * getOpportunities
 * getOpportunityCustomFields
 * getOpportunityNotes
+* getTasks
 * getUserInformation
 * getUserInformationById
 * runMyListbyId

data/VERSION.yml

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

data/landslider.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.26"
+  s.version = "0.5.28"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
-  s.date = %q{2011-10-11}
+  s.date = %q{2011-12-15}
   s.description = %q{Landslider is a ruby interface to the Landslide SOAP-based API}
   s.email = %q{jay@j4y.net}
   s.extra_rdoc_files = [
@@ -64,12 +64,15 @@ Gem::Specification.new do |s|
     "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_task.rb",
+    "lib/landslider/entities/ws_task_search.rb",
     "lib/landslider/entities/ws_user.rb",
     "lib/landslider/entities/ws_user_search.rb",
     "tasks/landslider.rake",
     "test/get_account_types_test.rb",
     "test/get_accounts_test.rb",
     "test/get_contact_test.rb",
+    "test/get_tasks_test.rb",
     "test/landslider_test.rb",
     "test/run_mylist_by_id_test.rb",
     "test/test_helper.rb",
@@ -89,6 +92,7 @@ Gem::Specification.new do |s|
     "test/get_account_types_test.rb",
     "test/get_accounts_test.rb",
     "test/get_contact_test.rb",
+    "test/get_tasks_test.rb",
     "test/landslider_test.rb",
     "test/run_mylist_by_id_test.rb",
     "test/test_helper.rb",

data/lib/landslider.rb

@@ -51,6 +51,18 @@ class Landslider < Handsoap::Service
 		node = response.document.xpath('//ns:loginResponse/loginResponse', ns)
 		parse_login_result(node)
 	end
+	
+	def add_task(session_id, task)
+		self.session_id = session_id
+		response = invoke('urn:addTask', :soap_action => :none) do |message|
+			message.add('task') { |req|
+				task.soapify_for(req)
+			}
+		end
+		node = response.document.xpath('//ns:addTaskResponse/Status', ns)
+		parse_add_task_result(node)
+
+	end
 
 	# @param [WsAccountSearch] search
 	# @param [String] session_id
@@ -292,6 +304,20 @@ class Landslider < Handsoap::Service
 		parse_get_opportunity_notes_result(node)
 	end
 
+	# @param [String] session_id
+	# @return [Hash]
+	def get_tasks(session_id, search)
+		self.session_id = session_id
+
+		response = invoke('urn:getTasks', :soap_action => :none) do |message|
+			message.add('taskSearch') { |req|
+				search.soapify_for(req)
+			}
+		end
+		node = response.document.xpath('//ns:getTasksResponse', ns)
+		parse_get_tasks_result(node)
+	end
+
 	# @param [String] session_id
 	# @param [String] user_id usually in the form of user@example.com
 	# @return [Hash]
@@ -347,6 +373,14 @@ class Landslider < Handsoap::Service
 		:session_id => xml_to_str(node, './sessionId/text()')
 		}
 	end
+	
+	def parse_add_task_result(node)
+		{
+		:error => xml_to_bool(node, './error/text()'),
+		:error_code => xml_to_int(node, './errorCode/text()'),
+		:created => xml_to_bool(node, './created/text()')
+		}
+	end
 
 	def parse_api_version_result(node)
 		{
@@ -523,7 +557,19 @@ class Landslider < Handsoap::Service
 		:total_results_available => xml_to_int(node, './*/totalResultsAvailable/text()')
 		}.merge(notes)
 	end
-
+	
+	def parse_get_tasks_result(node)
+		tasks = parse_tasks(node)
+		{
+		: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()')
+		}.merge(tasks)
+	end
+	
 	def parse_get_user_information_by_id_result(node)
 		{
 		:employee => parse_employee(node.xpath('./WsEmployee/employee')),
@@ -718,6 +764,25 @@ class Landslider < Handsoap::Service
 		:start_date => xml_to_date(node, './startDate/text()')
 		}
 	end
+	
+	def parse_tasks(node)
+		{
+		:tasks => node.xpath('./*/taskList', ns).map { |child| parse_task(child) }
+		}
+	end
+	
+	# WsTask
+	def parse_task(node)
+		{
+		:created_by => xml_to_int(node, './task/createdBy/text()'),
+		:created_on => xml_to_date(node, './task/createdOn/text()'),
+		:completed => xml_to_bool(node, './task/completed/text()'),
+		:description => xml_to_str(node, './task/description/text()'),
+		:due_date => xml_to_date(node, './task/dueDate/text()'),
+		:assigned_to => xml_to_int(node, './task/assignedTo/text()'),
+		:updated_on => xml_to_date(node, './task/updatedOn/text()'),
+		}
+	end
 
 end
 

data/lib/landslider/entities.rb

@@ -38,6 +38,9 @@ require 'landslider/entities/ws_product'
 require 'landslider/entities/ws_product_family'
 require 'landslider/entities/ws_product_result'
 
+require 'landslider/entities/ws_task_search'
+require 'landslider/entities/ws_task'
+
 
 require 'landslider/entities/ws_search'
 require 'landslider/entities/ws_selling_process'

data/lib/landslider/entities/ws_entity.rb

@@ -8,6 +8,9 @@ class Landslider
 		# @return [String]
 		attr_reader :entity_type, :entity_name
 		
+		def soapify_for(msg)
+			msg.add 'entityId', @entity_id unless @entity_id.nil?
+		end
 	end
 	
 end

data/lib/landslider/entities/ws_task.rb

@@ -0,0 +1,36 @@
+
+class Landslider
+
+	class WsTask < WsEntity
+		
+		# @return [Integer]
+		attr_reader :task_id, :created_by, :archived_by, :associated_contact_id, :associated_entity_id, :updated_by
+		
+		# Required
+		# @return [String]
+		attr_writer :task_name
+		
+		# @return [Date]
+		attr_writer :due_date
+		
+		# @return [Integer]
+		attr_writer :assigned_to
+		
+		# @return [Boolean]
+		attr_reader :completed
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			super(msg)
+			msg.add 'taskName', @task_name unless @task_name.nil?
+			msg.add 'dueDate', @due_date unless @due_date.nil?
+			msg.add 'assignedTo', @assigned_to.to_i unless @assigned_to.nil?
+
+			msg.add 'completed', @completed
+
+		end
+		
+	end
+
+end

data/lib/landslider/entities/ws_task_search.rb

@@ -0,0 +1,26 @@
+
+class Landslider
+
+	# search criteria for getTasks
+	class WsTaskSearch < WsSearch
+		
+		# @return [Integer]
+		attr_writer :assigned_to, :created_by, :task_type_id, :associated_entity_id, :associated_contact_id
+
+		# @return [Date]
+		attr_writer :updated_on
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			super(msg)
+			msg.add 'assignedTo', @assigned_to unless @assigned_to.nil?
+			msg.add 'createdBy', @created_by unless @created_by.nil?
+			msg.add 'taskTypeId', @task_type_id unless @task_type_id.nil?
+			msg.add 'associatedContactId', @associated_contact_id unless @associated_contact_id.nil?
+			msg.add 'associatedEntityId', @associated_entity_id unless @associated_entity_id.nil?
+		end
+		
+	end
+	
+end

data/test/get_accounts_test.rb

@@ -16,7 +16,7 @@ class GetAccountsTest < Test::Unit::TestCase
 		assert_not_nil result
 		assert_equal false, result[:error]
 		assert_kind_of Array, result[:accounts]
-		assert_equal 12, result[:accounts].size
+		assert_equal 16, result[:accounts].size
 		
 	end
 	
@@ -46,4 +46,4 @@ class GetAccountsTest < Test::Unit::TestCase
 	end
 	
 	
-end
+end

data/test/get_tasks_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+require 'date'
+
+class GetTasksTest < Test::Unit::TestCase
+
+	def setup
+		# uncomment this line to debug
+		# Landslider.logger = $stdout
+		$sesson_idt7 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_get_tasks_with_default_search
+		search = Landslider::WsTaskSearch.new
+		result = Landslider.get_tasks($sesson_idt7, search)
+		assert_not_nil result
+		assert_equal false, result[:error]
+		assert_kind_of Array, result[:tasks]
+	end
+	
+	
+	def test_add_task
+		
+		user_info = Landslider.get_user_information($sesson_idt7, LS_API_USERNAME)
+		
+		# TODO: come up with a better way for constructing objects
+		task = Landslider::WsTask.new
+		dt = DateTime.strptime("2011-12-25T11:25:56-05:00")
+		task.task_name='task for ' + dt.to_s
+		task.due_date= dt
+		task.assigned_to = user_info[:employee][:employee_id]
+		
+		result = Landslider.add_task($sesson_idt7, task)
+		assert_not_nil result
+		assert_equal false, result[:error]
+		assert_equal true, result[:created]
+	end
+	
+end

data/test/landslider_test.rb

@@ -138,7 +138,6 @@ class LandsliderTest < Test::Unit::TestCase
 		
 	def test_landslider_get_user_information
 		result = Landslider.get_user_information($sid, 'jayp@landslide.com')
-		
 		assert_not_nil result
 		assert_equal false, result[:error]
 		assert_not_nil result[:employee]

data/test/ws_account_contact_search_test.rb

@@ -8,14 +8,14 @@ class WsAccountContactSearchTest < Test::Unit::TestCase
 		$sess4 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
 	end
 	
-	def test_ws_account_contact_search
-		search = Landslider::WsAccountContactSearch.new(55647822)
-		
-		result = Landslider.get_account_contacts($sess4, search)
+	#def test_ws_account_contact_search
+		#search = Landslider::WsAccountContactSearch.new(55647822)
+		#
+		#result = Landslider.get_account_contacts($sess4, search)
 
-		assert_equal false, result[:error]
+		#assert_equal false, result[:error]
 		# assert_equal 2, result[:results_returned]
-	end
+	#end
 	
 	# def test_contact_note_search_limit_by_results_requested
 	# 	search = Landslider::WsContactNoteSearch.new(62813411)
@@ -26,4 +26,4 @@ class WsAccountContactSearchTest < Test::Unit::TestCase
 	# 	assert_equal 1, result[:results_returned]
 	# end
 	
-end
+end

data/test/ws_search_test.rb

@@ -19,7 +19,7 @@ class WsSearchTest < Test::Unit::TestCase
 		result = Landslider.get_accounts($sid2)
 
 		assert_equal false, result[:error]
-		assert_equal 12, result[:results_returned]
+		assert_equal 16, result[:results_returned]
 	end
 
 	def test_get_accounts_with_search_criteria
@@ -46,7 +46,7 @@ class WsSearchTest < Test::Unit::TestCase
 		result = Landslider.get_opportunities($sid2)
 	
 		assert_equal false, result[:error]
-		assert_equal 7, result[:results_returned]
+		assert_equal 17, result[:results_returned]
 	end
 	
 	def test_get_opportunities_with_search_criteria
@@ -76,4 +76,4 @@ class WsSearchTest < Test::Unit::TestCase
 		assert_equal 50, search.instance_variable_get(:@total_results_requested)
 	end
 	
-end
+end

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.26
+  version: 0.5.28
 platform: ruby
 authors: 
 - Jay Prall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-11 00:00:00 -04:00
+date: 2011-12-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -125,12 +125,15 @@ files:
 - 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_task.rb
+- lib/landslider/entities/ws_task_search.rb
 - lib/landslider/entities/ws_user.rb
 - lib/landslider/entities/ws_user_search.rb
 - tasks/landslider.rake
 - test/get_account_types_test.rb
 - test/get_accounts_test.rb
 - test/get_contact_test.rb
+- test/get_tasks_test.rb
 - test/landslider_test.rb
 - test/run_mylist_by_id_test.rb
 - test/test_helper.rb
@@ -172,6 +175,7 @@ test_files:
 - test/get_account_types_test.rb
 - test/get_accounts_test.rb
 - test/get_contact_test.rb
+- test/get_tasks_test.rb
 - test/landslider_test.rb
 - test/run_mylist_by_id_test.rb
 - test/test_helper.rb