landslider 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011, Jay Prall
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,39 @@
+= Landslider
+
+Ruby interface to Landslide's SOAP based API
+
+== Pre-requisites
+
+An account with Landslide that has the API enabled. (www.landslide.com)
+
+== Resources
+
+=== Dependencies
+
+This gem requires the following gems:
+	handsoap (1.1.8)
+
+== Install
+
+	landslider requires the handsoap gem
+
+	gem install handsoap landslider
+
+== Usage
+
+	Configuration:
+
+	# constants to be set by rails environment config files
+	LS_INSTANCE_NAME = 'jaytest'
+	LS_API_USERNAME = 'XXXXXXXX@landslide.com'
+	LS_API_PASSWORD = 'XXXXXXXX'
+	LS_API_KEY =  Digest::MD5.hexdigest(LS_API_PASSWORD + LS_INSTANCE_NAME)
+	LS_API_NAMESPACE = "http://www.landslide.com/webservices/SoapService"
+	LS_API_ENDPOINT = {
+	  :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
+	  :version => 2
+	}
+	
+	
+	
+	more here later..

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gemspec|
+		gemspec.name = "landslider"
+		gemspec.homepage = "https://github.com/j4y/landslider"
+		gemspec.summary = "Ruby interface to Landslide SOAP API"
+		gemspec.description = "Ruby interface to Landslide SOAP API. "
+		gemspec.email = "jayprall@gmail.com"
+		gemspec.authors = ['Jay Prall']
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler not available.  Please install the jeweler gem"
+end
+
+# Load any rake files that exist
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |f| load f } 

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:patch: 0
+:major: 0
+:minor: 1

data/init.rb

@@ -0,0 +1,2 @@
+# can be used as a rails plugin
+require 'landslider'

data/landslider.gemspec

@@ -0,0 +1,32 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{landslider}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jay Prall"]
+  s.date = %q{2011-04-22}
+  s.description = %q{Ruby interface to Landslide SOAP API. }
+  s.email = %q{jayprall@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby interface to Landslide SOAP API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/landslider.rb

@@ -0,0 +1,303 @@
+
+require 'handsoap'
+require 'curb'
+
+class Landslider < Handsoap::Service
+
+	endpoint ::LS_API_ENDPOINT
+
+	def session_id
+		@session_id
+	end
+
+	def session_id=(session_id)
+		@session_id = session_id
+	end
+
+	def on_create_document(doc)
+		doc.alias 'urn', ::LS_API_NAMESPACE
+		header = doc.find('Header')
+		header.add('urn:SessionHeader') { |sh|
+			sh.add('urn:sessionId', self.session_id)
+		}
+	end
+
+	def on_http_error(response)
+		puts response.inspect
+	end
+
+	def login(session_id)
+		self.session_id = session_id
+		
+		response = invoke("login", :soap_action => :none) do |message|
+			message.add('wsUser') { |u|
+				u.add 'username', ::LS_API_USERNAME 
+				u.add 'password', ::LS_API_KEY
+			}
+		end
+		
+		node = response.document.xpath('//ns:loginResponse/loginResponse', ns)
+		parse_login_result(node)
+	end
+	
+	def get_api_version(session_id)
+		self.session_id = session_id
+		
+		response = invoke("urn:getApiVersion", :soap_action => :none)
+		
+		node = response.document.xpath('//ns:getApiVersionResponse', ns)
+		parse_api_version_result(node)
+	end
+	
+	def get_accounts(session_id)
+		self.session_id = session_id
+		response = invoke("getAccounts", :soap_action => :none) do |message|
+			message.add('accountsRequest') { |ar|
+				ar.add 'firstResultPosition', 1
+				ar.add 'totalResultsRequested', 10
+				ar.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:getAccountsResponse', ns)
+		parse_get_accounts_result(node)
+	end
+	
+	def get_account_opportunities(session_id, account_id)
+		self.session_id = session_id
+		response = invoke("getAccountOpportunities", :soap_action => :none) do |message|
+			message.add 'accountId', account_id
+		end
+		puts response.document.inspect
+		
+		node = response.document.xpath('//ns:getAccountOpportunitiesResponse', ns)
+		parse_get_account_opportunities_result(node)	
+	end
+	
+
+	
+	def get_account_contacts(session_id, account_id)
+		self.session_id = session_id
+		response = invoke("getAccountContacts", :soap_action => :none) do |message|
+			message.add 'accountId', account_id
+		end
+		puts response.document.inspect
+		
+		node = response.document.xpath('//ns:getAccountContactsResponse', ns)
+		parse_get_account_contacts_result(node) 
+	end
+	
+	def get_account_notes(session_id, account_id)
+		self.session_id = session_id
+
+		response = invoke("getAccountNotes", :soap_action => :none) do |message|
+			message.add('accountNoteSearch') { |ans|
+		
+				ans.add 'accountId', account_id
+				ans.add 'firstResultPosition', 1
+				ans.add 'totalResultsRequested', 10
+
+				# search criteria doesn't seem to work
+				# ans.add('searchCriteria') { |sc|
+				#	sc.add 'fieldId', 'note'
+				#	sc.add 'operator', 'Contains'
+				#	sc.add 'queryValue', 'BLAH'
+				# }
+			}
+		end
+		puts response.document.inspect
+	
+	end
+	
+	
+	def get_contact_notes(session_id, contact_id)
+		self.session_id = session_id
+		
+		response = invoke("getContactNotes", :soap_action => :none) do |message|
+			message.add('contactNote') { |ans|
+				ans.add 'contactId', contact_id
+				ans.add 'firstResultPosition', 1
+				ans.add 'totalResultsRequested', 10
+			}
+		end
+		puts response.document.inspect
+	
+	end
+	
+	
+	def get_opportunity_notes(session_id, opportunity_id)
+		self.session_id = session_id
+	
+		response = invoke("getOpportunityNotes", :soap_action => :none) do |message|
+			message.add('opportunityNote') { |ans|
+		
+				ans.add 'opportunityId', opportunity_id
+				ans.add 'firstResultPosition', 1
+				ans.add 'totalResultsRequested', 10
+			}
+		end
+		puts response.document.inspect
+
+	end
+	
+	def get_lead_notes(session_id, lead_id)
+		self.session_id = session_id
+	
+		response = invoke("getLeadNotes", :soap_action => :none) do |message|
+			message.add('leadNote') { |ans|
+		
+				ans.add 'leadId', lead_id
+				ans.add 'firstResultPosition', 1
+				ans.add 'totalResultsRequested', 10
+			}
+		end
+		puts response.document.inspect
+	
+	end
+	
+
+	private
+
+	def ns
+		{ 'ns' => LS_API_NAMESPACE }
+	end
+
+	def parse_login_result(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()'),
+		:password_expired => xml_to_bool(node, './passwordExpired/text()'),
+		:session_id => xml_to_str(node, './sessionId/text()')
+		}
+	end
+	
+	def parse_api_version_result(node)
+		{
+		:internal_name => xml_to_str(node, '//ApiVersion/internalName/text()'),
+		:label => xml_to_str(node, '//ApiVersion/label/text()'),
+		:major_version => xml_to_int(node, '//ApiVersion/majorVersion/text()'),
+		:minor_version => xml_to_int(node, '//ApiVersion/minorVersion/text()'),
+		:revision_version => xml_to_int(node, '//ApiVersion/revisionVersion/text()')
+		}
+	end
+
+	def parse_get_accounts_result(node)
+		{
+		:accounts => node.xpath('//Accounts/accountList', ns).map { |child| parse_account(child) },
+		:error => xml_to_bool(node, '//Accounts/error/text()'),
+		:error_code => xml_to_int(node, '//Accounts/errorCode/text()'),
+		:result_msg => xml_to_str(node, '//Accounts/resultMsg/text()'),
+		:results_returned => xml_to_int(node, '//Accounts/resultsReturned/text()'),
+		:total_results_available => xml_to_int(node, '//Accounts/totalResultsAvailable/text()')
+		}
+	end
+	
+	def parse_get_account_opportunities_result(node)
+		{
+		:opportunities => node.xpath('./*/opportunityList', ns).map { |child| parse_opportunity(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_account_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
+	
+	# WsAccount
+	def parse_account(node)
+		{
+		:entity_id => xml_to_str(node, './entityId/text()'),
+		:entity_type => xml_to_str(node, './entityType/text()'),
+		:parent_account_id => xml_to_str(node, './parentAccountId/text()'),
+		:account_id => xml_to_str(node, './accountId/text()'),
+		:account_name => xml_to_str(node, './accountName/text()'),
+		:account_owner => xml_to_str(node, './accountOwner/text()'),
+		:url => xml_to_str(node, './url/text()'),
+		:phone => xml_to_str(node, './phone/text()'),
+		:main_address => parse_address(node.xpath('./mainAddress')),
+		:shipping_address => parse_address(node.xpath('./shippingAddress')),
+		:billing_address => parse_address(node.xpath('./billingAddress')),
+		:updated_by => xml_to_int(node, './updatedBy/text()'),
+		:updated_on => xml_to_str(node, './updatedOn/text()'),
+		:created_by => xml_to_int(node, './createdBy/text()'),
+		:created_on => xml_to_str(node, './createdOn/text()'),
+		:archived_by => xml_to_str(node, './archivedBy/text()'),
+		:sync_with_quickbooks => xml_to_str(node, './isSyncWithQuickbooks/text()')
+		}
+		
+	end
+	
+	# 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
+	
+	# 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()'),
+		:zip => xml_to_str(node, './zipPostal/text()'),
+		:country => xml_to_str(node, './country/text()')
+		}
+	end
+	
+	# WsContact
+	def parse_contact(node)
+		{
+		:first_name => xml_to_str(node, './firstName/text()'),
+		:middle_initials => xml_to_str(node, './middleInitials/text()'),
+		:last_name => xml_to_str(node, './lastName/text()'),
+		:cell_phone => xml_to_str(node, './cellPhone/text()'),
+		: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()')
+		}
+	end
+	
+	# 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()'),
+		:opportunity_status => xml_to_str(node, './opportunityStatus/status/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()')
+		}
+	end
+
+end
+
+

data/test/landslider_test.rb

@@ -0,0 +1,44 @@
+
+require 'test_helper'
+
+class LandsliderTest < Test::Unit::TestCase
+
+	def test_landslider_login
+		result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
+		
+		assert_not_nil result
+		assert_equal false, result[:error]
+		assert_not_nil result[:session_id]
+	end
+	
+	def test_landslider_get_api_version
+		result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
+		result = Landslider.get_api_version(result[:session_id])
+		
+		assert_not_nil result
+		assert_operator result[:major_version], :>=, 2
+		assert_operator result[:minor_version], :>=, 0
+		assert_operator result[:revision_version], :>=, 0
+	end
+	
+	def test_get_accounts
+		result = Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)
+		result = Landslider.get_accounts(result[:session_id])
+		assert_equal false, result[:error]
+		assert_not_nil result[:accounts]
+		assert result[:accounts].all? { |a| !a[:account_name].nil? }, "account name required"
+		assert_operator result[:results_returned], :>=, 0
+		assert_operator result[:total_results_available], :>=, 0
+		assert_not_nil result[:result_msg]
+	end
+	
+
+	private
+
+	def login(session_id)
+		Landslider.login(session_id)
+	end
+	
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'digest/md5'
+
+# constants to be set by rails environment config files
+LS_INSTANCE_NAME = 'jaytest'
+LS_API_USERNAME = 'XXXXXXXX@landslide.com'
+LS_API_PASSWORD = 'XXXXXXXX'
+LS_API_KEY =  Digest::MD5.hexdigest(LS_API_PASSWORD + LS_INSTANCE_NAME)
+LS_API_NAMESPACE = "http://www.landslide.com/webservices/SoapService"
+LS_API_ENDPOINT = {
+  :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
+  :version => 2
+}
+
+require 'test/unit'
+require 'landslider'
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: landslider
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jay Prall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: "Ruby interface to Landslide SOAP API. "
+email: jayprall@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- init.rb
+- landslider.gemspec
+- lib/landslider.rb
+- test/landslider_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/j4y/landslider
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to Landslide SOAP API
+test_files: 
+- test/landslider_test.rb
+- test/test_helper.rb