landslider 0.5.1 → 0.5.2

data/README.rdoc

@@ -4,20 +4,17 @@ Ruby interface to Landslide's SOAP based API
 
 == Pre-requisites
 
-An account with Landslide that has the API enabled. (www.landslide.com)  Contact support@landslide.com to have the API enabled.
+== Dependencies
 
-== Resources
+=== Landslide account
 
-=== Dependencies
+An account with Landslide that has the API enabled. (www.landslide.com)  Contact support@landslide.com to have the API enabled.
 
-This gem requires the following gems:
-	
-	jeweler
-	handsoap >= 1.1.8
-	
-	You also need to have either curb or httpclient on the load path.
+=== Ruby gem dependencies
+
+	gem install jeweler curb handsoap
 
-== Install
+== Installation
 
 	gem install landslider
 
@@ -41,7 +38,22 @@ This gem requires the following gems:
 		puts "id: #{account[:account_id]} name: #{account[:account_name]}"
 	end
 
-=== Supported API methods
+== 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

data/VERSION.yml

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

data/landslider.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
-  s.date = %q{2011-05-03}
+  s.date = %q{2011-05-06}
   s.default_executable = %q{generate_api_key.rb}
   s.description = %q{Landslider is a ruby interface to the Landslide SOAP-based API}
   s.email = %q{jay@j4y.net}
@@ -30,7 +30,8 @@ Gem::Specification.new do |s|
     "landslider.gemspec",
     "lib/landslider.rb",
     "test/landslider_test.rb",
-    "test/test_helper.rb"
+    "test/test_helper.rb",
+    "test/ws_search_test.rb"
   ]
   s.homepage = %q{https://github.com/j4y/landslider}
   s.licenses = ["MIT"]
@@ -39,7 +40,8 @@ Gem::Specification.new do |s|
   s.summary = %q{Landslide Ruby}
   s.test_files = [
     "test/landslider_test.rb",
-    "test/test_helper.rb"
+    "test/test_helper.rb",
+    "test/ws_search_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/landslider.rb

@@ -54,18 +54,19 @@ class Landslider < Handsoap::Service
 		parse_api_version_result(node)
 	end
 	
-	def get_accounts(session_id, first_result_position=1, total_results_requested=25)
+	def get_accounts(session_id, first_result_position=1, total_results_requested=25, search_criteria=nil)
 		self.session_id = session_id
 		response = invoke('getAccounts', :soap_action => :none) do |message|
 			message.add('accountsRequest') { |ar|
 				ar.add 'firstResultPosition', first_result_position
 				ar.add 'totalResultsRequested', total_results_requested
-				# ar.add('searchCriteria') { |sc|
-				# 	# just find accounts with an empty main city
-				# 	
-				# 	sc.add 'fieldId', 'MainAddressCity'
-				# 	sc.add 'operator', 'Empty'
-				# }
+				unless search_criteria.nil?
+					ar.add('searchCriteria') { |sc|
+						sc.add 'fieldId', search_criteria.field_id
+						sc.add 'operator', search_criteria.operator
+						sc.add 'queryValue', search_criteria.query_value
+					}
+				end
 			}
 		end
 		
@@ -110,13 +111,6 @@ class Landslider < Handsoap::Service
 				ans.add 'accountId', account_id
 				ans.add 'firstResultPosition', first_result_position
 				ans.add 'totalResultsRequested', total_results_requested
-				
-				# ans.add('searchCriteria') { |sc|
-				# 	# just find accounts with an empty main city
-				# 	
-				# 	sc.add 'fieldId', 'MainAddressCity'
-				# 	sc.add 'operator', 'Empty'
-				# }
 			}
 		end
 		node = response.document.xpath('//ns:getAccountNotesResponse', ns)
@@ -213,7 +207,7 @@ class Landslider < Handsoap::Service
 		parse_get_lead_notes_result(node)
 	end
 	
-	def get_opportunities(session_id, first_result_position=1, total_results_requested=25)
+	def get_opportunities(session_id, first_result_position=1, total_results_requested=25, search_criteria=nil)
 		self.session_id = session_id
 		
 		response = invoke('getOpportunities', :soap_action => :none) do |message|
@@ -412,7 +406,6 @@ class Landslider < Handsoap::Service
 	
 	def parse_get_lead_notes_result(node)
 		
-		puts node.inspect
 		notes = parse_notes(node)
 		{
 		:error => xml_to_bool(node, './Notes/error/text()'),
@@ -612,5 +605,15 @@ class Landslider < Handsoap::Service
 		:start_date => xml_to_date(node, './startDate/text()')
 		}
 	end
+	
+	class WsSearch
+		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
+	end
 
 end

data/test/landslider_test.rb

@@ -60,7 +60,7 @@ class LandsliderTest < Test::Unit::TestCase
 		assert_not_nil result[:account]
 		
 		assert_not_nil result[:account][:custom_fields]
-		assert_equal Array, result[:account][:custom_fields].class
+		assert_kind_of Array, result[:account][:custom_fields]
 		assert_operator result[:account][:custom_fields].length, :>=, 2
 		
 	end
@@ -70,7 +70,7 @@ class LandsliderTest < Test::Unit::TestCase
 
 		assert_equal 3, result[:results_returned]
 		validate_standard_api_result result
-		assert_equal Array, result[:contacts].class
+		assert_kind_of Array, result[:contacts]
 		assert_not_nil result[:contacts].first[:contact_id]
 		assert result[:contacts].all? { |con| !con[:last_name].nil? }, "last name required"
 	end
@@ -103,7 +103,7 @@ class LandsliderTest < Test::Unit::TestCase
 		result = Landslider.get_account_opportunities($sid, 51858821)
 
 		assert_equal false, result[:error]
-		assert_equal Array, result[:opportunities].class
+		assert_kind_of Array, result[:opportunities]
 		
 		assert result[:opportunities].all? { |opp| 
 			!opp[:account_name].nil? && 
@@ -155,7 +155,7 @@ class LandsliderTest < Test::Unit::TestCase
 		
 		validate_standard_api_result result
 		assert_not_nil result[:leads]
-		assert_equal Array, result[:leads].class
+		assert_kind_of Array, result[:leads]
 	end
 	
 	def test_landslider_get_lead_custom_fields
@@ -207,7 +207,7 @@ class LandsliderTest < Test::Unit::TestCase
 	private
 	
 	def validate_standard_api_result(result) 
-		assert_equal Hash, result.class, "api method should return a hash"
+		assert_kind_of Hash, result
 		assert_not_nil result[:results_returned], ":results_returned missing"
 		assert_operator result[:results_returned], :>=, 0
 		assert_not_nil result[:total_results_available], ":total_results_available missing"
@@ -219,7 +219,7 @@ class LandsliderTest < Test::Unit::TestCase
 	def validate_at_least_one_note_returned(result)
 		assert_operator result[:results_returned], :>=, 1
 		assert_not_nil result[:notes], "at least one note should be returned"
-		assert_equal Array, result[:notes].class
+		assert_kind_of Array, result[:notes]
 	end
 
 end

data/test/ws_search_test.rb

@@ -0,0 +1,36 @@
+
+require 'test_helper'
+
+class WsSearchTest < Test::Unit::TestCase
+
+	def setup
+		if $sid2.nil?
+			# only get a session once
+			result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
+			$sid2 = result[:session_id]
+		end
+	end
+	
+	def test_ws_search_object
+		search = Landslider::WsSearch.new('AccountName', 'Equals', 'Boston')
+		assert_equal 'AccountName', search.field_id
+		assert_equal 'Equals', search.operator
+		assert_equal 'Boston', search.query_value
+	end
+
+	def test_get_accounts_without_search_criteria
+		result = Landslider.get_accounts($sid2, 1, 25)
+
+		assert_equal false, result[:error]
+		assert_equal 6, result[:results_returned]
+	end
+
+	def test_get_accounts_with_search_criteria
+		search = Landslider::WsSearch.new('AccountName', 'Equals', 'Boston')
+		result = Landslider.get_accounts($sid2, 1, 25, 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.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Jay Prall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 -04:00
+date: 2011-05-06 00:00:00 -04:00
 default_executable: generate_api_key.rb
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ files:
 - lib/landslider.rb
 - test/landslider_test.rb
 - test/test_helper.rb
+- test/ws_search_test.rb
 has_rdoc: true
 homepage: https://github.com/j4y/landslider
 licenses: 
@@ -110,3 +111,4 @@ summary: Landslide Ruby
 test_files: 
 - test/landslider_test.rb
 - test/test_helper.rb
+- test/ws_search_test.rb