README.md in yieldmanager-0.8.6 vs README.md in yieldmanager-0.9.0
- old
+ new
@@ -5,11 +5,11 @@
Currently it generates a fresh wsdl from the api.yieldmanager.com site the
first time you use a service (in the future it will use locally-cached
copies) and re-uses that wsdl for the life of the Yieldmanager::Client object.
-This version implements API version 1.33.
+The current API version is stored in the API_VERSION file.
### Installation
Yieldmanager is available as a gem for easy installation.
@@ -136,10 +136,34 @@
rpt.headers = ["first","second"]
rpt.add_row([1,2])
rpt.data.first.by_name("first").should == 1
rpt.data.first.by_name("second").should == 2
+### Wiredumps (SOAP logging)
+
+To see the nitty-gritty of what's going over the wire (Yahoo tech support often asks for this),
+you can activate a "wiredump" on a per-service basis. Typically you just echo it to standard out.
+For instance:
+
+ client.entity.wiredump_dev = $stdout # on
+ adv = client.entity.get(token,12345)
+ client.entity.wiredump_dev = nil # off
+
+For Rails in a passenger environment, standard out doesn't end up in the logfiles.
+Instead, redirect to a file:
+
+ wiredump = File.new("#{Rails.root}/log/wiredump_entity_#{Time.new.strftime('%H%M%S')}.log",'w')
+ client.entity.wiredump_dev = wiredump # on
+
+ adv = client.entity.get(token,12345)
+
+ wiredump.flush # make sure everything gets in there before it closes
+ client.entity.wiredump_dev = nil # off
+
+The last 2 lines belong in an ensure block, so the file is created even
+when there's an error (which is probably why you're doing this).
+
### session vs. start_session/end_session
The **session** method opens a session, gives you a token to use in your service
calls, then closes the session when the block ends, even if an exception is
raised during processing. It's the recommended method to ensure you don't
@@ -169,6 +193,6 @@
* manlycode[https://github.com/manlycode] (Chris Rittersdorf)
* KarateCode[https://github.com/KarateCode] (Michael Schneider)
## Copyright
-Copyright (c) 2009-2011 Bill Gathen. See LICENSE for details.
+Copyright (c) 2009-2012 Bill Gathen. See LICENSE for details.