README.md in sucker-0.4.0 vs README.md in sucker-0.5.0
- old
+ new
@@ -1,9 +1,9 @@
Sucker
======
-Sucker is a thin Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html). It runs on Curb and Crack and supports __everything__ in the API.
+Sucker is a thin Ruby wrapper to the [Amazon Product Advertising API](https://affiliate-program.amazon.co.uk/gp/advertising/api/detail/main.html). It runs on Curb and XmlSimple and supports __everything__ in the API.
Examples
--------
@@ -31,35 +31,37 @@
response = worker.get
p response.code
p response.time
p response.body
- response.to_h["ItemLookupResponse"]["Items"]["Item"].each { ... }
+ response.to_h["Items"]["Item"].each { ... }
Hit Amazon again.
worker << {
"ItemId" => 10.more.asins }
response = worker.get
-For more examples, check the integration specs.
+Check the integration specs for more examples.
Testing
-------
To fake web requests, I do the following:
-In a file such as `spec/support/sucker.rb`, I prep things:
+In a file such as `spec/support/sucker.rb`, I prep:
require "sucker/stub"
Sucker.fixtures_path = File.dirname(__FILE__) + "/../fixtures"
-Then, in the spec, I set up a worker and stub the worker:
+In the spec, I set up a worker and then stub it:
Sucker.stub(@worker)
The first time you run the spec, the worker will perform the actual web request and cache the response. Subsequent requests are then mocked with the cached response.
-Specs
+Notes
-----
-The unit specs should run out of the box after you `bundle install`, but the integration specs require you to create [an amazon.yml file with valid credentials](http://github.com/papercavalier/sucker/blob/master/spec/support/amazon.yml.example) in the spec/support folder.
+* The unit specs should run out of the box after you `bundle install`, but the integration specs require you to create [an amazon.yml file with valid credentials](http://github.com/papercavalier/sucker/blob/master/spec/support/amazon.yml.example) in `spec/support`.
+
+* Version 0.5.0 replaces Crack with XmlSimple, which results in a slightly different hash output. Fix up your code accordingly.