landslider 0.5.12 → 0.5.15

data/HISTORY.md

@@ -1,12 +1,15 @@
 
-# landslider 0.5.7 2011-05-07
+# landslider 0.5.13 2011-05-22
+ * add support for the runMyListbyId api call
+
+# landslider 0.5.7  2011-05-07
  * added support for WsSearch, WsSearchCriterion, Ws*NoteSearch
 
-# landslider 0.3.2 2011-04-28
+# landslider 0.3.2  2011-04-28
 
  * add in custom field data for accounts
  * new api methods: getInstanceInformation, getUserInformationById
 
-# landslider 0.2.5 2011-04-27
+# landslider 0.2.5  2011-04-27
 
  * remove curb dependency

data/README.md

@@ -1,14 +1,14 @@
 Landslider
 ==========
 
-Ruby interface to Landslide's SOAP-based API
+A Ruby library for interacting with Landslide’s SOAP-based API
 
 Introduction
 ------------
 
 This gem can be used to communicate with Landslide's SOAP-based API using ruby code.
 	
-[WSDL](https://jaytest.api.landslide.com/webservices/SoapService?wsdl) endpoint url: [https://jaytest.api.landslide.com/webservices/SoapService?wsdl](https://jaytest.api.landslide.com/webservices/SoapService?wsdl)
+[WSDL](https://instance_name.api.landslide.com/webservices/SoapService?wsdl) endpoint url: [https://instance_name.api.landslide.com/webservices/SoapService?wsdl](https://instance_name.api.landslide.com/webservices/SoapService?wsdl)
 
 If you already have a landslide account, contact support to enable the API.  You can also start a 30-day trial account [here](http://www.landslide.com/~jayp/en/trial).  
 
@@ -31,8 +31,12 @@ Read the [ruby doc](http://rdoc.info/github/j4y/landslider).
 Configuration
 -------------
 
-See bin/genarate_api_key.rb for details on generating your API key
-	
+There is a rake task to generate the configuration settings.
+
+	$ rake landslider:gen_config
+
+Example config:
+
 	LS_INSTANCE_NAME = 'jaytest'
 	LS_API_USERNAME = 'jayp@landslide.com'
 	LS_API_KEY = '53308ccbdcb7f23fbd81a0b2ebcf12a4'
@@ -41,7 +45,7 @@ Usage
 -----
 
 This is calling login to get a session id which is then used to get a list of accounts.
-		
+
 	require 'landslider'
 	response = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
 	response = Landslider.get_accounts(response[:session_id])
@@ -50,8 +54,6 @@ This is calling login to get a session id which is then used to get a list of ac
 	end
 
 
-
-
 Testing
 -------
 
@@ -60,7 +62,7 @@ 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
 ------------
@@ -98,6 +100,7 @@ API methods
 * getOpportunityNotes
 * getUserInformation
 * getUserInformationById
+* runMyListbyId
 
 TODO
 ----

data/VERSION.yml

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

data/landslider.gemspec

@@ -5,15 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.12"
+  s.version = "0.5.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
-  s.date = %q{2011-05-18}
-  s.default_executable = %q{generate_api_key.rb}
+  s.date = %q{2011-05-22}
   s.description = %q{Landslider is a ruby interface to the Landslide SOAP-based API}
   s.email = %q{jay@j4y.net}
-  s.executables = ["generate_api_key.rb"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -26,7 +24,6 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION.yml",
-    "bin/generate_api_key.rb",
     "init.rb",
     "landslider.gemspec",
     "lib/landslider.rb",
@@ -34,6 +31,7 @@ Gem::Specification.new do |s|
     "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_account_search.rb",
     "lib/landslider/entities/ws_address.rb",
     "lib/landslider/entities/ws_contact.rb",
     "lib/landslider/entities/ws_contact_note.rb",
@@ -51,6 +49,7 @@ Gem::Specification.new do |s|
     "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_search.rb",
     "lib/landslider/entities/ws_opportunity_status.rb",
     "lib/landslider/entities/ws_payment_term.rb",
     "lib/landslider/entities/ws_pick_list_item.rb",
@@ -66,9 +65,11 @@ Gem::Specification.new do |s|
     "lib/landslider/entities/ws_selling_process.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/landslider_test.rb",
+    "test/run_mylist_by_id_test.rb",
     "test/test_helper.rb",
     "test/ws_account_note_search_test.rb",
     "test/ws_contact_note_search_test.rb",
@@ -81,17 +82,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.6.2}
   s.summary = %q{Landslide Ruby}
-  s.test_files = [
-    "test/get_account_types_test.rb",
-    "test/get_accounts_test.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"
-  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/landslider/entities/ws_account_search.rb

@@ -0,0 +1,7 @@
+class Landslider
+
+	# @deprecated Use {#WsSearchCriterion} instead.
+	class WsAccountSearch < WsSearch
+	end
+	
+end

data/lib/landslider/entities/ws_opportunity_search.rb

@@ -0,0 +1,7 @@
+class Landslider
+
+	# @deprecated Use {#WsSearchCriterion} instead.
+	class WsOpportunitySearch < WsSearch
+	end
+	
+end

data/lib/landslider.rb

@@ -1,4 +1,6 @@
 
+require 'handsoap'
+
 # Landslider is a soap client to the Landslide CRM SOAP-based API
 # Example:
 #
@@ -8,10 +10,6 @@
 # response[:accounts].each do |account|
 # 	puts "id: #{account[:account_id]} name: #{account[:account_name]}"
 # end
-#
-
-require 'handsoap'
-
 class Landslider < Handsoap::Service
 
 	require 'landslider/entities'
@@ -289,6 +287,7 @@ class Landslider < Handsoap::Service
 	end
 
 	# @param [String] session_id
+	# @param [String] user_id usually in the form of user@example.com
 	# @return [Hash]
 	def get_user_information(session_id, user_id)
 
@@ -301,6 +300,7 @@ class Landslider < Handsoap::Service
 	end
 
 	# @param [String] session_id
+	# @param [Integer] user_id
 	# @return [Hash]
 	def get_user_information_by_id(session_id, user_id)
 		self.session_id = session_id
@@ -312,10 +312,23 @@ class Landslider < Handsoap::Service
 		parse_get_user_information_by_id_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [Integer] mylist_id
+	# @return [Hash]
+	def run_mylist_by_id(session_id, mylist_id)
+		self.session_id = session_id
+	
+		response = invoke('runMyListbyId', :soap_action => :none) do |message|
+			message.add 'myListId', mylist_id
+		end
+		node = response.document.xpath('//ns:runMyListbyIdResponse', ns)
+		parse_run_mylist_by_id_result(node)
+	end
+
 	private
 
 	def ns
-		{ 'ns' => LS_API_NAMESPACE }
+		{ 'ns' => LS_API_NAMESPACE, 'xsi' => 'http://www.w3.org/2001/XMLSchema-instance' }
 	end
 
 	def parse_login_result(node)
@@ -509,6 +522,16 @@ class Landslider < Handsoap::Service
 		}
 	end
 
+	def parse_run_mylist_by_id_result(node)
+		{
+		:results => node.xpath('MyListQueryResultSet/myList', ns).map { |child| parse_mylist_result(child) },
+			
+		:error => xml_to_bool(node, 'MyListQueryResultSet/error/text()'),
+		:results_returned => xml_to_int(node, 'MyListQueryResultSet/resultsReturned/text()'),
+		:total_results_available => xml_to_int(node, 'MyListQueryResultSet/totalResultsAvailable/text()')
+		}
+	end
+
 	# WsAccount
 	def parse_account(node)
 		{
@@ -642,6 +665,23 @@ class Landslider < Handsoap::Service
 		}
 	end
 
+	# There are two dynamic pieces of the mylist results
+	# 1) A mylist result has type which is either WsAccount, WsContact, WsOpportunity, WsLead, WsNote, etc.
+	# 2) The fields available in the mylist result are selected as fields to display when the user builds the mylist
+	def parse_mylist_result(node)
+		result_type = xml_to_str(node, '@xsi:type')
+		case result_type
+		when "ns2:wsContact"
+			parse_contact(node)
+		when "ns2:wsLead"
+			parse_lead(node)
+		when "ns2:wsOpportunity"
+			parse_opportunity(node)
+		else
+			raise NotImplementedError.new result_type
+		end
+	end	
+
 	# WsOpportunity
 	def parse_opportunity(node)
 		{

data/tasks/landslider.rake

@@ -0,0 +1,27 @@
+require 'digest/md5'
+
+namespace :landslider do
+
+	desc "generate configuration for the landslide api"
+	task :gen_config do
+
+		# TODO: refactor and test
+		def get_input
+			$stdin.gets.to_s.chomp
+		end
+
+		print "Enter a Landslide instance name: "
+		instance_name = get_input
+
+		print "Enter your api username:"
+		api_user = get_input
+
+		print "Enter your api password:"
+		api_password = get_input
+
+		puts "LS_INSTANCE_NAME = '#{instance_name}'"
+		puts "LS_API_USERNAME = '#{api_user}'"
+		# api key is just an md5 hash of the api password and instance name
+		puts "LS_API_KEY = '#{Digest::MD5.hexdigest(api_password + instance_name)}'"
+	end
+end

data/test/landslider_test.rb

@@ -135,7 +135,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_user_information
 		result = Landslider.get_user_information($sid, 'jayp@landslide.com')
 		

data/test/run_mylist_by_id_test.rb

@@ -0,0 +1,22 @@
+
+require 'test_helper'
+
+class RunMylistByIdTest < Test::Unit::TestCase
+
+	# this test depends on data in the jaytest instance
+	JAYTEST_MYLIST_ID = 10293817
+
+	def setup
+		$sid7 ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+	
+	def test_landslider_run_mylist_by_id
+		
+		result = Landslider.run_mylist_by_id($sid7, JAYTEST_MYLIST_ID)
+		assert_equal false, result[:error]
+		
+		assert_operator result[:results_returned], :>=, 0
+		assert_kind_of Array, result[:results]
+	end
+	
+end

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.12
+  version: 0.5.15
 platform: ruby
 authors: 
 - Jay Prall
@@ -10,8 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
-default_executable: generate_api_key.rb
+date: 2011-05-22 00:00:00 -04:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jeweler
@@ -59,8 +59,8 @@ dependencies:
   version_requirements: *id004
 description: Landslider is a ruby interface to the Landslide SOAP-based API
 email: jay@j4y.net
-executables: 
-- generate_api_key.rb
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -74,7 +74,6 @@ files:
 - README.md
 - Rakefile
 - VERSION.yml
-- bin/generate_api_key.rb
 - init.rb
 - landslider.gemspec
 - lib/landslider.rb
@@ -82,6 +81,7 @@ files:
 - 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_account_search.rb
 - lib/landslider/entities/ws_address.rb
 - lib/landslider/entities/ws_contact.rb
 - lib/landslider/entities/ws_contact_note.rb
@@ -99,6 +99,7 @@ files:
 - 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_search.rb
 - lib/landslider/entities/ws_opportunity_status.rb
 - lib/landslider/entities/ws_payment_term.rb
 - lib/landslider/entities/ws_pick_list_item.rb
@@ -114,9 +115,11 @@ files:
 - lib/landslider/entities/ws_selling_process.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/landslider_test.rb
+- test/run_mylist_by_id_test.rb
 - test/test_helper.rb
 - test/ws_account_note_search_test.rb
 - test/ws_contact_note_search_test.rb
@@ -151,13 +154,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Landslide Ruby
-test_files: 
-- test/get_account_types_test.rb
-- test/get_accounts_test.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
+test_files: []
+

data/bin/generate_api_key.rb

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-require 'digest/md5'
-
-LS_INSTANCE_NAME = 'jaytest'
-LS_API_PASSWORD = 'letmein52`'
-
-# the api key is an md5 hash of the user password + instance name
-puts "LS_API_KEY = '#{Digest::MD5.hexdigest(LS_API_PASSWORD + LS_INSTANCE_NAME)}'"