landslider 0.5.7 → 0.5.9

data/{CHANGELOG.markdown → HISTORY.md}

@@ -1,3 +1,7 @@
+
+# landslider 0.5.7 2011-05-07
+ * added support for WsSearch, WsSearchCriterion, Ws*NoteSearch
+
 # landslider 0.3.2 2011-04-28
 
  * add in custom field data for accounts

data/README.md

@@ -0,0 +1,108 @@
+Landslider
+==========
+
+Ruby interface to 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)
+
+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).  
+
+Dependencies
+------------
+
+	$ gem install jeweler curb handsoap
+
+Installation
+------------
+
+
+	$ gem install landslider
+
+Documentation
+-------------
+
+	Read the [ruby doc](http://www.rubydoc.info/github/j4y/landslider/master/frames).
+
+Configuration
+-------------
+
+See bin/genarate_api_key.rb for details on generating your API key
+	
+	LS_INSTANCE_NAME = 'jaytest'
+	LS_API_USERNAME = 'jayp@landslide.com'
+	LS_API_KEY = '53308ccbdcb7f23fbd81a0b2ebcf12a4'
+
+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])
+	response[:accounts].each do |account| 
+		puts "id: #{account[:account_id]} name: #{account[:account_name]}"
+	end
+
+
+
+
+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
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_markup`)
+3. Commit your changes (`git commit -am "Added Snarkdown"`)
+4. Push to the branch (`git push origin my_markup`)
+5. Create an [Issue][1] with a link to your branch
+6. Enjoy a refreshing Diet Coke and wait
+	
+API methods
+-----------
+
+	Here is a list of API methods that have been added:
+
+* login
+* getApiVersion
+* getAccounts
+* getAccountById
+* getAccountCustomFields
+* getAccountContacts
+* getAccountNotes
+* getAccountOpportunities
+* getContacts
+* getContactCustomFields
+* getContactNotes
+* getInstanceInformation
+* getLeads
+* getLeadCustomFields
+* getLeadNotes
+* getOpportunities
+* getOpportunityCustomFields
+* getOpportunityNotes
+* getUserInformation
+* getUserInformationById
+
+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}"]})
+* eliminate slow inefficient XPath queries
+* eliminate test data dependency on the jaytest instance

data/VERSION.yml

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

data/bin/generate_api_key.rb

@@ -2,7 +2,7 @@
 require 'digest/md5'
 
 LS_INSTANCE_NAME = 'jaytest'
-LS_API_PASSWORD = 'Applogin1'
+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)}'"

data/landslider.gemspec

@@ -5,30 +5,66 @@
 
 Gem::Specification.new do |s|
   s.name = %q{landslider}
-  s.version = "0.5.7"
+  s.version = "0.5.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jay Prall"]
-  s.date = %q{2011-05-07}
+  s.date = %q{2011-05-11}
   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}
   s.executables = ["generate_api_key.rb"]
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
-    "CHANGELOG.markdown",
     "Gemfile",
+    "HISTORY.md",
     "LICENSE",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION.yml",
     "bin/generate_api_key.rb",
     "init.rb",
     "landslider.gemspec",
     "lib/landslider.rb",
+    "lib/landslider/entities.rb",
+    "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_address.rb",
+    "lib/landslider/entities/ws_contact.rb",
+    "lib/landslider/entities/ws_contact_note.rb",
+    "lib/landslider/entities/ws_contact_note_search.rb",
+    "lib/landslider/entities/ws_contact_search.rb",
+    "lib/landslider/entities/ws_employee.rb",
+    "lib/landslider/entities/ws_entity.rb",
+    "lib/landslider/entities/ws_lead.rb",
+    "lib/landslider/entities/ws_lead_contact.rb",
+    "lib/landslider/entities/ws_lead_note.rb",
+    "lib/landslider/entities/ws_lead_note_search.rb",
+    "lib/landslider/entities/ws_lead_search.rb",
+    "lib/landslider/entities/ws_my_list.rb",
+    "lib/landslider/entities/ws_note.rb",
+    "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_status.rb",
+    "lib/landslider/entities/ws_payment_term.rb",
+    "lib/landslider/entities/ws_pick_list_item.rb",
+    "lib/landslider/entities/ws_primary_entity.rb",
+    "lib/landslider/entities/ws_product.rb",
+    "lib/landslider/entities/ws_product_family.rb",
+    "lib/landslider/entities/ws_product_result.rb",
+    "lib/landslider/entities/ws_record_upsert_result.rb",
+    "lib/landslider/entities/ws_result.rb",
+    "lib/landslider/entities/ws_search.rb",
+    "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_user.rb",
+    "lib/landslider/entities/ws_user_search.rb",
     "test/landslider_test.rb",
     "test/test_helper.rb",
     "test/ws_account_note_search_test.rb",

data/lib/landslider/entities/ws_account.rb

@@ -0,0 +1,32 @@
+
+class Landslider
+
+	class WsAccount < WsEntity
+		
+		# @return [Integer]
+		attr_reader :account_id, :account_owner, :archived_by, :create_by, :update_by, :parent_account_id
+		
+		# @return [String]
+		attr_reader :account_name, :account_number, :division, :fax
+		
+		# @return [String]
+		attr_reader :phone, :source_id, :url
+
+		# @return [Date]
+		attr_reader :created_on, :updated_on
+		
+		# @return [WsAccountType]
+		attr_reader :account_type
+		
+		# @return [WsAddress]
+		attr_reader :billing_address, :main_address, :shipping_address
+		
+		# @return [WsContact]
+		attr_reader :primary_contact
+		
+		# @return WsAccountCustomField[]
+		attr_reader :custom_fields
+				
+	end
+	
+end

data/lib/landslider/entities/ws_account_note.rb

@@ -0,0 +1,13 @@
+
+class Landslider
+
+	class WsAccountNote < WsEntity
+		
+		# @return [Integer]
+		attr_reader :account_id
+		
+		# @return [WsNote]
+		attr_reader :note
+	end
+	
+end

data/lib/landslider/entities/ws_account_note_search.rb

@@ -0,0 +1,23 @@
+class Landslider
+
+	class WsAccountNoteSearch < WsSearch
+		
+		# @return [Integer]
+		attr_reader :account_id
+		
+		# @param [Integer] account_id an account id
+		def initialize(account_id)
+			@account_id = account_id
+		end
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('accountNoteSearch') { |crit|
+				crit.add 'accountId', @account_id
+				super(crit)
+			}
+		end
+	end
+	
+end

data/lib/landslider/entities/ws_address.rb

@@ -0,0 +1,17 @@
+
+class Landslider
+
+	class WsAddress < WsEntity
+		
+		# @return [Integer]
+		attr_reader :address_id
+		
+		# @return [String]
+		attr_reader :address1, :address2, :address3, :address_node, :city
+
+		# @return [String]
+		attr_reader :country, :state, :zip_postal
+
+	end
+	
+end

data/lib/landslider/entities/ws_contact.rb

@@ -0,0 +1,38 @@
+class Landslider
+	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
+
+		# @return [Date]
+		attr_reader :archived_on, :created_on, :updated_on
+		
+		# @return [Boolean]
+		attr_reader :buyer
+		
+		# @return [String]
+		attr_reader :cell_phone, :comments, :company_name
+
+		# @return [String]
+		attr_reader :department, :email, :fax, :first_name
+
+		# @return [String]
+		attr_reader :home_phone, :last_name, :middle_initials, :suffix
+
+		# @return [String]
+		attr_reader :source_system_id
+
+		# @return [WsContactType]
+		attr_reader :contact_type
+		
+		# @return [WsAddress]
+		attr_reader :work_address
+	
+		# @return [WsAccountContact]
+		attr_reader :account_contact
+		
+	end
+end

data/lib/landslider/entities/ws_contact_note.rb

@@ -0,0 +1,13 @@
+
+class Landslider
+
+	class WsContactNote < WsEntity
+		
+		# @return [Integer]
+		attr_reader :contact_id
+		
+		# @return [WsNote]
+		attr_reader :note
+	end
+	
+end

data/lib/landslider/entities/ws_contact_note_search.rb

@@ -0,0 +1,23 @@
+class Landslider
+	
+	class WsContactNoteSearch < WsSearch
+		
+		# @return [Integer]
+		attr_reader :contact_id
+
+		# @param [Integer] contact_id a contact id
+		def initialize(contact_id)
+			@contact_id = contact_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('contactNote') { |crit|
+				crit.add 'contactId', @contact_id
+				super(crit)
+			}
+		end
+	end
+	
+end

data/lib/landslider/entities/ws_contact_search.rb

@@ -0,0 +1,28 @@
+
+class Landslider
+
+	# search criteria for getContacts
+	class WsContactSearch < WsSearch
+		
+		# @return [String]
+		attr_writer :city, :company_name, :email, :title, :first_name
+		
+		# @return [String]
+		attr_writer :middle_initial, :last_name, :home_phone, :work_phone, :cell_phone
+		
+		# @return [String]
+		attr_writer :other_phone, :state, :postal_code, :country
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			super(crit)
+			crit.add 'firstName', @first_name unless @first_name.nil?
+			crit.add 'lastName', @last_name unless @last_name.nil?
+			crit.add 'email', @email unless @email.nil?
+			crit.add 'state', @state unless @state.nil?
+		end
+		
+	end
+	
+end

data/lib/landslider/entities/ws_employee.rb

@@ -0,0 +1,23 @@
+
+class Landslider
+
+	class WsEmployee < WsEntity
+		
+		# @return [Integer]
+		attr_reader :employee_id
+		
+		# @return [String]
+		attr_reader :cell_phone, :company_name, :email_address, :fax
+
+		# @return [String]
+		attr_reader :first_name, :home_phone, :last_name, :office_phone
+		
+		# @return [String]
+		attr_reader :title, :user_id
+		
+		# @return [Boolean]
+		attr_reader :administrator
+		
+	end
+	
+end

data/lib/landslider/entities/ws_entity.rb

@@ -0,0 +1,15 @@
+class Landslider
+
+	class WsEntity
+		
+		# @return [Integer]
+		attr_reader :entity_id
+		
+		# @return [String]
+		attr_reader :entity_type, :entity_name
+		
+	end
+	
+end
+
+	

data/lib/landslider/entities/ws_lead.rb

@@ -0,0 +1,35 @@
+
+class Landslider
+
+	class WsLead < WsEntity
+		
+		# @return [Integer]
+		attr_reader :lead_id, :account_id, :target_id, :created_by, :primary_owner_id
+		
+		# @return [String]
+		attr_reader :name, :account_name, :description, :source_system_id
+
+		# @return [Boolean]
+		attr_reader :hot, :ok_to_call, :ok_to_email
+		
+		# @return [WsLeadTarget]
+		attr_reader :lead_target
+
+		# @return [WsContact]
+		attr_reader :lead_contact
+		
+		# @return [WsLeadRating]
+		attr_reader :lead_rating
+		
+		# @return [WsLeadStatus]
+		attr_reader :lead_status
+				
+		# @return [WsLeadSource]
+		attr_reader :lead_source
+		
+		# @return [WsSellingProcess]
+		attr_reader :lead_selling_process
+		
+	end
+	
+end

data/lib/landslider/entities/ws_lead_contact.rb

@@ -0,0 +1,14 @@
+
+class Landslider
+
+	class WsLeadContact < WsEntity
+		
+		# @return [Integer]
+		attr_reader :contact_id, :lead_id, :modified_by
+		
+		# @return [Boolean]
+		attr_reader :primary_contact
+		
+	end
+	
+end

data/lib/landslider/entities/ws_lead_note.rb

@@ -0,0 +1,14 @@
+
+class Landslider
+
+	class WsLeadNote < WsEntity
+		
+		# @return [Integer]
+		attr_reader :lead_id
+		
+		# @return [WsNote]
+		attr_reader :note
+
+	end
+	
+end

data/lib/landslider/entities/ws_lead_note_search.rb

@@ -0,0 +1,24 @@
+class Landslider
+	
+	class WsLeadNoteSearch < WsSearch
+		
+		# @return [Integer]
+		attr_reader :lead_id
+
+		# @param [Integer] lead_id a lead id
+		def initialize(lead_id)
+			@lead_id = lead_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('leadNote') { |crit|
+				crit.add 'leadId', @lead_id
+				super(crit)
+			}
+		end
+		
+	end
+	
+end

data/lib/landslider/entities/ws_lead_search.rb

@@ -0,0 +1,31 @@
+
+class Landslider
+
+	# search criteria for getLeads
+	class WsLeadSearch < WsSearch
+		
+		# @return [Integer]
+		attr_writer :account_id, :company_id, :primary_owner_id, :status_id
+		
+		# @return [Boolean]
+		attr_writer :hot
+
+		# @return [Date]
+		attr_writer :updated_on
+
+		# @return [String]
+		attr_writer :name
+		
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			super(msg)
+			msg.add 'name', @name unless @name.nil?
+			msg.add 'accountId', @account_id unless @account_id.nil?
+			msg.add 'companyId', @company_id unless @company_id.nil?
+			msg.add 'primaryOwnerId', @primary_owner_id unless @primary_owner_id.nil?
+		end
+		
+	end
+	
+end

data/lib/landslider/entities/ws_my_list.rb

@@ -0,0 +1,20 @@
+
+class Landslider
+
+	class WsMyList < Object
+		
+		# @return [Integer]
+		attr_reader :my_list_id, :created_by
+		
+		# @return [String]
+		attr_reader :title, :description, :base_table
+		
+		# @return [Date]
+		attr_reader :created_on
+		
+		# @return [Boolean]
+		attr_reader :is_shared
+		
+	end
+	
+end

data/lib/landslider/entities/ws_note.rb

@@ -0,0 +1,21 @@
+
+class Landslider
+
+	# @todo Expose note type
+	class WsNote < WsEntity
+		
+		# @return [Integer]
+		attr_reader :note_id, :archived_by, :created_by
+		
+		# @return [String]
+		attr_reader :note, :source_id
+		
+		# @return [Boolean]
+		attr_reader :latest
+		
+		# @return [Date]
+		attr_reader :created_on, :updated_on
+		
+	end
+	
+end

data/lib/landslider/entities/ws_opportunity.rb

@@ -0,0 +1,38 @@
+
+class Landslider
+
+	class WsOpportunity < WsPrimaryEntity
+		
+		# @return [Integer]
+		attr_reader :opportunity_id, :created_by, :archived_by, :current_phase_id
+		
+		# @return [Integer]
+		attr_reader :confidence, :primary_owner_id
+		
+		# @return [String]
+		attr_reader :name, :account_name, :description, :current_phase_name
+
+		# @return [String]
+		attr_reader :description, :source_system_id
+
+		# @return [WsLeadSource]
+		attr_reader :lead_source
+		
+		# @return [WsSellingProcess]
+		attr_reader :selling_process
+		
+		# @return [WsOpportunityStatus]
+		attr_reader :opportunity_status
+		
+		# @return [WsOpportunityStatusReason]
+		attr_reader :opportunity_status_reason
+		
+		# @return [Boolean]
+		attr_reader :hot
+		
+		# @return [Date]
+		attr_reader :created_on, :updated_on
+		
+	end
+	
+end

data/lib/landslider/entities/ws_opportunity_note.rb

@@ -0,0 +1,13 @@
+
+class Landslider
+
+	class WsOpportunityNote < WsEntity
+		
+		# @return [Integer]
+		attr_reader :opportunity_id
+		
+		# @return [WsNote]
+		attr_reader :note
+	end
+	
+end

data/lib/landslider/entities/ws_opportunity_note_search.rb

@@ -0,0 +1,23 @@
+class Landslider
+	
+	class WsOpportunityNoteSearch < WsSearch
+		
+		# @return [Integer]
+		attr_reader :opportunity_id
+
+		# @param [Integer] opportunity_id an opportunity id
+		def initialize(opportunity_id)
+			@opportunity_id = opportunity_id
+		end
+
+		# @param [Handsoap::XmlMason::Node] msg
+		# @return [Handsoap::XmlMason::Node]
+		def soapify_for(msg)
+			msg.add('opportunityNote') { |crit|
+				crit.add 'opportunityId', @opportunity_id
+				super(crit)
+			}
+		end
+	end
+	
+end