wrest 1.0.2 → 1.1.0

data/CHANGELOG

@@ -2,10 +2,13 @@ Features under the section marked 'Current' are completed but pending release as
 
 Features under a numbered section are complete and available in the Wrest gem.
 
+== 1.1
+ * Caching support introduced. Includes Memcached support for the cache store. (GH# 69, 83, 87)
+ 
 == 1.0.2
  * GH#12 Post Multipart support when using the Patron adapter
  * GH#72 Response code checkers: ok?, redirect?, created? etc.
- * GH#85 Do not autoload Nokogiri/Libxml, and remove warnings.
+ * GH#85 Do not auto-load Nokogiri/libxml-ruby and remove warnings at startup
  * GH#79 Update Patron version.
 
 == 1.0.1

data/README.rdoc

@@ -1,14 +1,14 @@
-= Wrest 1.0.2
+= Wrest 1.1.0
 
-(c) Copyright 2009-2010 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
+(c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
 Wrest is a ruby REST/HTTP client library which
 
 * Allows you to quickly build object oriented wrappers around any web service 
 * Designed to be used as a library, not just a command line REST client (fewer class/static methods, more object oriented)
 * Is spec driven, strongly favours immutable objects and avoids class methods and setters making it better suited for use as a library, especially in multi-threaded environments 
-* Runs on Ruby 1.8, Ruby 1.9.2, JRuby and Rubinius with MacRuby and IronRuby support on the way
-* Provides convenient HTTP wrappers, redirect handling, serialisation and deserialisation with response caching in the works
+* Runs on Ruby 1.8, Ruby 1.9.2, JRuby and Rubinius with MacRuby and IronRuby support on the way ({Continuous Integration server}[http://ci.c42.in])
+* Provides convenient HTTP wrappers, redirect handling, serialisation, deserialisation and response {caching}[https://github.com/kaiwren/wrest/blob/caching/Caching.markdown]
 * Supports using either Net::HTTP or libcurl as the underlying HTTP library
 
 To receive notifications whenever new features are added to Wrest, please subscribe to my {twitter feed}[http://twitter.com/ponnappa].
@@ -36,7 +36,7 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
     'http://google.com'.to_uri(:follow_redirects_limit => 1).get
 
   :follow_redirects_limit defaults to 5 if not specified.
-
+    
 * Deserialise with XPath filtering
   
     ActiveSupport::XmlMini.backend = 'REXML'
@@ -101,6 +101,31 @@ To find out what actions are permitted on a URI:
 
  'http://www.yahoo.com'.to_uri.options.headers['allow']
 
+==== Caching
+
+Wrest supports caching with pluggable back-ends.
+
+    Wrest.always_cache_using_hash!     # Hash should NEVER be used in a production environment. It is unbounded and will keep increasing in size.
+    c42 = "http://c42.in".to_uri.get
+
+A Memcached based caching back-end is available in Wrest. You can get instructions on how to install Memcached on your system {here}[http://code.google.com/p/memcached/wiki/NewInstallFromPackage].
+The Dalli gem is used by Wrest to interface with Memcached. Install dalli using 'gem install dalli'.
+
+Use the following method to enable caching for all requests, and set Memcached as the default back-end.
+  
+    Wrest.always_cache_using_memcached!
+
+For fine-grained control over the cache store (or to use multiple cache stores in the same codebase), you can use this API:
+    memcache_store = Wrest::Components::CacheStore::Memcached.new("localhost:11211")
+    hash_store = {}
+    
+    r1 = "http://c42.in".to_uri(:cache_store => memcache_store).get
+    r2 = "http://c42.in".to_uri(:cache_store => hash_store).get
+
+A detailed writeup regarding caching as defined by RFC 2616, and how Wrest implements caching is at {Wrest Caching Doc}[https://github.com/kaiwren/wrest/blob/master/Caching.markdown]
+
+You can create your own back-ends for Wrest caching by implementing the interface implemented in https://github.com/kaiwren/wrest/blob/master/lib/wrest/components/cache_store/memcached.rb
+
 ==== Callbacks
 
 You can define a set of callbacks that are invoked based on the http code of the response.

data/bin/wrest.compiled.rbc

@@ -0,0 +1,78 @@
+!RBIX
+0
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+23
+5
+45
+0
+1
+65
+49
+2
+0
+49
+3
+1
+7
+4
+64
+81
+5
+47
+49
+6
+1
+15
+2
+11
+I
+3
+I
+0
+I
+0
+I
+0
+n
+p
+7
+x
+4
+File
+n
+x
+11
+active_path
+x
+7
+dirname
+s
+15
+/wrest_shell.rb
+x
+1
++
+x
+4
+load
+p
+3
+I
+0
+I
+3
+I
+17
+x
+31
+/home/jasim/C42/wrest/bin/wrest
+p
+0

data/bin/wrest_shell.rb

@@ -17,5 +17,5 @@ libs =  " -r irb/completion"
 libs << " -r #{entry_point}"
 
 require version
-puts "Loading Wrest #{Wrest::VERSION::STRING}"
+puts "Loading Wrest #{Wrest::VERSION}"
 exec "#{options[:irb]} #{libs} --simple-prompt"

data/bin/wrest_shell.rbc

@@ -0,0 +1,659 @@
+!RBIX
+0
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+245
+5
+7
+0
+45
+1
+2
+47
+49
+3
+0
+7
+4
+45
+5
+6
+47
+49
+3
+0
+7
+4
+45
+7
+8
+47
+49
+3
+0
+63
+6
+47
+49
+9
+1
+15
+45
+10
+11
+45
+10
+12
+65
+49
+13
+0
+49
+14
+1
+47
+49
+3
+0
+7
+15
+63
+2
+49
+16
+1
+19
+0
+15
+45
+10
+17
+45
+10
+18
+65
+49
+13
+0
+49
+14
+1
+47
+49
+3
+0
+7
+19
+63
+2
+49
+16
+1
+19
+1
+15
+45
+7
+20
+7
+21
+13
+70
+9
+110
+15
+44
+43
+22
+7
+23
+78
+49
+24
+2
+6
+21
+49
+25
+1
+9
+120
+7
+26
+64
+8
+123
+7
+27
+64
+19
+2
+15
+5
+7
+28
+64
+47
+49
+29
+1
+15
+44
+43
+30
+79
+49
+31
+1
+13
+7
+32
+20
+2
+49
+33
+2
+15
+19
+3
+15
+45
+34
+35
+56
+36
+50
+24
+0
+15
+7
+37
+64
+19
+4
+15
+20
+4
+7
+38
+20
+0
+47
+49
+3
+0
+63
+2
+49
+39
+1
+15
+5
+20
+1
+47
+49
+29
+1
+15
+5
+7
+40
+45
+41
+42
+43
+43
+43
+44
+47
+49
+3
+0
+63
+2
+47
+49
+9
+1
+15
+5
+20
+3
+7
+32
+49
+45
+1
+47
+49
+3
+0
+7
+46
+20
+4
+47
+49
+3
+0
+7
+47
+63
+4
+47
+49
+48
+1
+15
+2
+11
+I
+c
+I
+5
+I
+0
+I
+0
+n
+p
+49
+s
+5
+Ruby 
+x
+12
+RUBY_VERSION
+n
+x
+4
+to_s
+s
+2
+, 
+x
+17
+RUBY_RELEASE_DATE
+n
+x
+13
+RUBY_PLATFORM
+n
+x
+4
+puts
+x
+4
+File
+n
+n
+x
+11
+active_path
+x
+7
+dirname
+s
+16
+/../lib/wrest.rb
+x
+11
+expand_path
+n
+n
+s
+24
+/../lib/wrest/version.rb
+n
+n
+x
+6
+Regexp
+s
+15
+(:?mswin|mingw)
+x
+3
+new
+x
+2
+=~
+s
+7
+irb.bat
+s
+3
+irb
+s
+8
+optparse
+x
+7
+require
+x
+4
+Hash
+x
+16
+new_from_literal
+x
+3
+irb
+x
+3
+[]=
+x
+12
+OptionParser
+n
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+50
+57
+19
+0
+15
+20
+0
+7
+0
+64
+13
+18
+2
+49
+1
+1
+15
+15
+20
+0
+7
+2
+21
+1
+2
+47
+49
+3
+0
+7
+4
+63
+3
+7
+5
+64
+56
+6
+50
+7
+2
+15
+20
+0
+45
+8
+9
+49
+10
+1
+11
+I
+6
+I
+1
+I
+1
+I
+1
+n
+p
+11
+s
+24
+Usage: console [options]
+x
+7
+banner=
+s
+7
+--irb=[
+x
+4
+to_s
+s
+1
+]
+s
+23
+Invoke a different irb.
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+19
+57
+19
+0
+15
+21
+2
+3
+7
+0
+20
+0
+13
+18
+3
+49
+1
+2
+15
+11
+I
+6
+I
+1
+I
+1
+I
+1
+n
+p
+2
+x
+3
+irb
+x
+3
+[]=
+p
+3
+I
+0
+I
+c
+I
+13
+x
+40
+/home/jasim/C42/wrest/bin/wrest_shell.rb
+p
+1
+x
+1
+v
+x
+2
+on
+x
+4
+ARGV
+n
+x
+6
+parse!
+p
+9
+I
+0
+I
+a
+I
+4
+I
+b
+I
+11
+I
+c
+I
+29
+I
+d
+I
+32
+x
+40
+/home/jasim/C42/wrest/bin/wrest_shell.rb
+p
+1
+x
+3
+opt
+s
+18
+ -r irb/completion
+s
+4
+ -r 
+x
+2
+<<
+s
+14
+Loading Wrest 
+x
+5
+Wrest
+n
+x
+7
+VERSION
+x
+6
+STRING
+x
+2
+[]
+s
+1
+ 
+s
+16
+ --simple-prompt
+x
+4
+exec
+p
+25
+I
+0
+I
+1
+I
+23
+I
+3
+I
+3e
+I
+4
+I
+59
+I
+6
+I
+7e
+I
+8
+I
+87
+I
+9
+I
+9a
+I
+a
+I
+a3
+I
+10
+I
+a9
+I
+11
+I
+b9
+I
+13
+I
+c1
+I
+14
+I
+d6
+I
+15
+I
+f5
+x
+40
+/home/jasim/C42/wrest/bin/wrest_shell.rb
+p
+5
+x
+11
+entry_point
+x
+7
+version
+x
+3
+irb
+x
+7
+options
+x
+4
+libs