landslider 0.5.16 → 0.5.17

data/Gemfile

@@ -4,6 +4,7 @@ gem "jeweler"
 gem "handsoap", ">= 1.1.8"
 
 group :development do
+	gem "yard"
 	gem "shoulda"
 	gem "rcov"
 end

data/README.md

@@ -88,6 +88,7 @@ API methods
 * getAccountNotes
 * getAccountOpportunities
 * getAccountTypes
+* getContactById
 * getContacts
 * getContactCustomFields
 * getContactNotes
@@ -107,6 +108,6 @@ TODO
 
 * Modify configuration to be rails 3 friendly.  The configuation was needed before the environment finished loading. See landslide-rails
 * add more API calls
-* use HTTP cookies to maintain session state. maybe something like http_request.headers.merge!({'cookie' => ["JSESSIONID=#{self.session_id}"]})
+* use HTTP cookies to maintain session state
 * eliminate slow inefficient XPath queries
 * eliminate test data dependency on the jaytest instance

data/Rakefile

@@ -16,7 +16,7 @@ begin
 	end
 	Jeweler::GemcutterTasks.new
 rescue LoadError
-	puts "Jeweler not available.  Please install the jeweler gem"
+	puts 'Jeweler not available.  Please install the jeweler gem'
 end
 
 # Load any rake files that exist
@@ -31,3 +31,9 @@ Rake::TestTask.new(:test) do |test|
 	test.verbose = false
 end
 
+begin
+	require 'yard'
+	YARD::Rake::YardocTask.new
+rescue LoadError
+	puts 'Yard not available. Please install the yard gem'
+end

data/VERSION.yml

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

data/landslider.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.16"
+  s.version = "0.5.17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
-  s.date = %q{2011-05-23}
+  s.date = %q{2011-05-25}
   s.description = %q{Landslider is a ruby interface to the Landslide SOAP-based API}
   s.email = %q{jay@j4y.net}
   s.extra_rdoc_files = [
@@ -68,6 +68,7 @@ Gem::Specification.new do |s|
     "tasks/landslider.rake",
     "test/get_account_types_test.rb",
     "test/get_accounts_test.rb",
+    "test/get_contact_test.rb",
     "test/landslider_test.rb",
     "test/run_mylist_by_id_test.rb",
     "test/test_helper.rb",
@@ -85,6 +86,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/get_account_types_test.rb",
     "test/get_accounts_test.rb",
+    "test/get_contact_test.rb",
     "test/landslider_test.rb",
     "test/run_mylist_by_id_test.rb",
     "test/test_helper.rb",
@@ -101,17 +103,20 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<jeweler>, [">= 0"])
       s.add_runtime_dependency(%q<handsoap>, [">= 1.1.8"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<handsoap>, [">= 1.1.8"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<handsoap>, [">= 1.1.8"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

data/lib/landslider/entities/ws_contact.rb

@@ -1,11 +1,13 @@
 class Landslider
+	
+	# represents a contact
 	class WsContact < WsEntity
 		
 		# @return [Integer]
 		attr_reader :contact_id, :owner_id, :create_by, :update_by, :archived_by
 		
 		# @return [String]
-		attr_reader :namae, :account_name, :description, :source_system_id
+		attr_reader :name, :account_name, :description, :source_system_id
 
 		# @return [Date]
 		attr_reader :archived_on, :created_on, :updated_on

data/lib/landslider/entities/ws_product.rb

@@ -25,6 +25,7 @@ class Landslider
 
 		# @param [Handsoap::XmlMason::Node] msg
 		# @return [Handsoap::XmlMason::Node]
+		# @todo implementation
 		def soapify_for(msg)
 		end
 		

data/lib/landslider.rb

@@ -1,21 +1,12 @@
-
 require 'handsoap'
 
-# 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
+# landslider gem main class
 class Landslider < Handsoap::Service
 
 	require 'landslider/entities'
 
 	LS_API_NAMESPACE='http://www.landslide.com/webservices/SoapService'
-	LS_API_ENDPOINT = {
+	LS_API_ENDPOINT ||= {
 	  :uri => "https://#{LS_INSTANCE_NAME}.api.landslide.com/webservices/SoapService",
 	  :version => 1
 	}
@@ -41,6 +32,7 @@ class Landslider < Handsoap::Service
 		http_request.headers.merge!({'user-agent' => ['landslider-ruby-gem-version-0.4.6']})
 	end
 
+	# @param [Object] response
 	def on_http_error(response)
 		puts response.inspect
 	end
@@ -76,6 +68,7 @@ class Landslider < Handsoap::Service
 	end
 
 	# @param [String] session_id
+	# @param [Integer] account_id
 	# @return [Hash]
 	def get_account_by_id(session_id, account_id)
 		self.session_id = session_id
@@ -89,7 +82,7 @@ class Landslider < Handsoap::Service
 	end
 
 	# @param [String] session_id
-	# @param [String] account_id
+	# @param [Integer] account_id
 	# @param [Boolean] is_primary
 	# @return [Hash]
 	def get_account_contacts(session_id, account_id, is_primary=false)
@@ -157,6 +150,19 @@ class Landslider < Handsoap::Service
 		parse_api_version_result(node)
 	end
 
+	# @param [String] session_id
+	# @param [Integer] contact_id
+	# @return [Hash]
+	def get_contact_by_id(session_id, contact_id)
+		self.session_id = session_id
+
+		response = invoke('getContactById', :soap_action => :none) do |message|
+			message.add 'contactId', contact_id
+		end
+
+		node = response.document.xpath('//ns:getContactByIdResponse', ns)
+		parse_get_contact_by_id_result(node)
+	end
 
 	# @param [String] session_id
 	# @param [WsContactSearch] search
@@ -408,8 +414,15 @@ class Landslider < Handsoap::Service
 	
 	def parse_get_account_types_result(node)
 		{
-			:account_types => node.xpath('AccountTypes/accountTypes', ns).map { |child| parse_account_type(child) },
-			:error => xml_to_bool(node, 'AccountTypes/error/text()')
+		:account_types => node.xpath('AccountTypes/accountTypes', ns).map { |child| parse_account_type(child) },
+		:error => xml_to_bool(node, 'AccountTypes/error/text()')
+		}
+	end
+	
+	def parse_get_contact_by_id_result(node)
+		{
+		:contact => parse_contact(node.xpath('Contact/contact')),	
+		:error => xml_to_bool(node, 'Contact/error/text()')
 		}
 	end
 

data/test/get_contact_test.rb

@@ -0,0 +1,15 @@
+
+require 'test_helper'
+
+class GetContactTest < Test::Unit::TestCase
+
+	def setup
+		$ss ||= Landslider.login('LOGINTOKEN=' + LS_INSTANCE_NAME)[:session_id]
+	end
+
+	def test_get_contact_by_id
+		result = Landslider.get_contact_by_id($ss, 62813411)
+		assert_equal false, result[:error]
+	end
+
+end	

metadata

@@ -2,7 +2,7 @@
 name: landslider
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.16
+  version: 0.5.17
 platform: ruby
 authors: 
 - Jay Prall
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-23 00:00:00 -04:00
+date: 2011-05-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,7 +36,7 @@ dependencies:
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: yard
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -47,7 +47,7 @@ dependencies:
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: shoulda
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,6 +57,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: Landslider is a ruby interface to the Landslide SOAP-based API
 email: jay@j4y.net
 executables: []
@@ -118,6 +129,7 @@ files:
 - tasks/landslider.rake
 - test/get_account_types_test.rb
 - test/get_accounts_test.rb
+- test/get_contact_test.rb
 - test/landslider_test.rb
 - test/run_mylist_by_id_test.rb
 - test/test_helper.rb
@@ -157,6 +169,7 @@ summary: Landslide Ruby
 test_files: 
 - test/get_account_types_test.rb
 - test/get_accounts_test.rb
+- test/get_contact_test.rb
 - test/landslider_test.rb
 - test/run_mylist_by_id_test.rb
 - test/test_helper.rb