typhoeus_spec_cache 0.1.1 → 0.1.2

data/.gitignore

@@ -20,3 +20,5 @@ pkg
 
 ## PROJECT::SPECIFIC
 typhoeus_spec_cache.gemspec
+
+README.markdown.html

data/README.markdown

@@ -0,0 +1,78 @@
+typhoeus\_spec\_cache
+-------------------
+
+Typhoeus is a great frontend to Curl/Curl::Multi. However, if you have a large spec suite that hits a number of external HTTP resources, you will quickly find yourself getting tired of caching all those resources by hand! Trust me. No seriously, I hate doing this by hand.
+
+Thanks to [Paul Dix](http://github.com/pauldix) for writing Typhoeus!
+
+Usage
+-----
+
+In any specs that hit HTTP via `Typhoeus::Hydra`, wrap them in a `typhoeus_spec_cache` block:
+
+    describe "making 30 expensive HTTP calls" do
+      typhoeus_spec_cache("spec/cache/mycache") do |hydra|
+        it "should get 10 URLs" do
+          result = fetch_urls(10)
+          result.should have(10).things
+        end
+
+        it "should get 20 URLs" do
+          result = fetch_urls(20)
+          result.should have(20).things
+        end
+      end
+    end
+
+Create the cache directory:
+
+    mkdir -p spec/cache/mycache
+
+On the first run of these two specs, Typhoeus will make 30 live HTTP requests. These will then be dumped out to `.cache` files in `spec/cache/mycache`, and used on subsequent runs, avoiding any future HTTP calls.
+
+Auto-stubbing of Hydra
+----------------------
+
+Calling `typhoeus_spec_cache` automatically stubs out calls to Typhoeus::Hydra.new with a single shared Hydra object.
+
+Auto-managing of cache files
+----------------------------
+
+If the URLs your code hits ever changes, the `typhoeus_spec_cache` wrapper is smart about handling your cache. It will:
+
+* Only download new URLs it hasn't seen.
+* Remove any `.cache` files that aren't needed anymore.
+
+This way, your cache directory will contain exactly the `.cache` files you need, and no more.
+
+Installation
+------------
+
+    sudo gem install typhoeus_spec_cache
+
+Then, add the following to your spec/spec_helper.rb
+
+    require 'typhoeus_spec_cache'
+
+And add these two lines to your `Spec::Runner.configure` block in `spec/spec_helper.rb`:
+
+    Spec::Runner.configure do |config|
+      config.include(Typhoeus::SpecCacheMacros::InstanceMethods)
+      config.extend(Typhoeus::SpecCacheMacros::ClassMethods)
+    end
+
+Note on Patches/Pull Requests
+-----------------------------
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 David Balatero. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - David Balatero
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 -07:00
+date: 2010-04-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,12 +39,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
+- README.markdown.html
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/typhoeus/response_marshalling.rb
@@ -55,6 +56,7 @@ files:
 - spec/spec_helper.rb
 - spec/typhoeus/spec_cache_macros_spec.rb
 - spec/typhoeus/spec_cache_spec.rb
+- README.markdown.html
 has_rdoc: true
 homepage: http://github.com/dbalatero/typhoeus_spec_cache
 licenses: []

data/README.rdoc

@@ -1,17 +0,0 @@
-= typhoeus_spec_cache
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 David Balatero. See LICENSE for details.