README.md in landslider-0.5.12 vs README.md in landslider-0.5.15

- old
+ new

@@ -1,16 +1,16 @@ 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). Dependencies ------------ @@ -29,41 +29,43 @@ 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' 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`) @@ -96,9 +98,10 @@ * getOpportunities * getOpportunityCustomFields * getOpportunityNotes * getUserInformation * getUserInformationById +* runMyListbyId TODO ---- * Modify configuration to be rails 3 friendly. The configuation was needed before the environment finished loading. See landslide-rails