wrest 1.0.0-universal-java-1.6 → 1.0.1-universal-java-1.6

data/CHANGELOG

@@ -9,7 +9,7 @@ Features under a numbered section are complete and available in the Wrest gem.
  * Multi-part post support on curl
  
 == In progress
- * 304/ETag response caching
+ * 304/ETag response caching 
  * Keep-alive support for libcurl
  * Explicit cookie helpers - #cookie=, #cookie?
  * Response code checkers: ok?, redirect?, created? etc.
@@ -17,13 +17,19 @@ Features under a numbered section are complete and available in the Wrest gem.
  * Ensure Components::Container is ActiveModel compliant
 
 == Current
+ * GH#61 Option propogate while converting uri to UriTemplate and back.
+ * GH#64 Removed Caching.
+ * GH#32 Callback for response status codes.
+
+== 1.0.0
  * GH#56 Detailed Net::HTTP debug output option added to Wrest::Native:Request.
  * GH#60 Wrest debug log arrow direction changed to be consistent with Net::HTPP debug log
  * GH#59 follow_redirects_limit is off by one
  * GH#24 Add support for xpath based filtering of xml response bodies to the response chain
  * GH#46 Response.deserialise for Json responses
  * GH#52 Wrest console (bin/wrest) fails on 1.9.2
-
+ * GH#55 Fix connection.verify_mode for Net::HTTP https connection to VERIFY_PEER
+ * GH#57 Feature #24 doesn't autoload correctly
 == 1.0.0.beta7
  * GH#46 Response.deserialise for Json responses
 

data/README.rdoc

@@ -4,7 +4,7 @@
 
 Wrest is a ruby REST/HTTP client library which
 
-* Allows allows you to quickly build object oriented wrappers around any web service 
+* 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
@@ -101,6 +101,20 @@ To find out what actions are permitted on a URI:
 
  'http://www.yahoo.com'.to_uri.options.headers['allow']
 
+==== Callbacks
+
+You can define a Hash of {response code -> action} to be executed after a request is completed.
+
+  logger=Logger.new("wrest_callbacks.log")
+
+  actions = { 200 => lambda {|response| logger.info "Ok." },
+              400..499 => lambda {|response| logger.error "Invalid. #{response.body}"},
+              300..302 => lambda {|response| logger.debug "Redirected. #{response.message}" }
+            }
+
+  "http://google.com".to_uri(:callback => actions).get
+
+Please note that Wrest is a synchronous library. All requests are blocking, and will not return till the request is completed and appropriate callbacks executed.
 
 === Other useful stuff
 

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.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

data/lib/wrest/core_ext/hash/conversions.rb

@@ -38,6 +38,7 @@ module Wrest
             self.each{|tuple| mutated_hash.store(*mutator.mutate(tuple))}
           mutated_hash
         end
+
       end
     end
   end

data/lib/wrest/native/connection_factory.rb

@@ -9,14 +9,14 @@
 
 module Wrest::Native
   module ConnectionFactory
-    def create_connection(options = {:timeout => 60, :verify_mode => 'VERIFY_PEER'})
+    def create_connection(options = {:timeout => 60, :verify_mode => OpenSSL::SSL::VERIFY_NONE})
       options[:timeout] ||= 60
       connection = Net::HTTP.new(self.host, self.port)
       connection.read_timeout = options[:timeout]
       if self.https?
         connection.use_ssl     = true
-        connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE if options[:verify_mode] == 'VERIFY_NONE'
+        connection.verify_mode = options[:verify_mode]? options[:verify_mode] : OpenSSL::SSL::VERIFY_PEER 
+        
       end
       connection
     end

data/lib/wrest/native/get.rb

@@ -21,30 +21,5 @@ module Wrest::Native
             options
           )
     end
-
-    def invoke_with_cache_check
-      cached_response = get_cached_response
-      if cached_response.nil? then
-        response = invoke_without_cache_check
-        cache_response(response) if !response.nil? && response.cacheable?
-        response
-      else
-        cached_response
-      end
-    end
-
-    def get_cached_response
-      response = nil
-      if cache_store.has_key?(@uri)
-        response = cache_store.fetch(@uri)
-      end
-      response
-    end
-
-    def cache_response(response)
-      cache_store[@uri] = response
-    end
-
-    alias_method_chain :invoke, :cache_check
   end
 end

data/lib/wrest/native/request.rb

@@ -31,8 +31,12 @@ module Wrest::Native
     #               in the event of a connection failing to open. Defaulted to 60 by Uri#create_connection.
     #   :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
     #                  used for multiple requests.
-    #   :cache_store => The object which should be used as cache store for cacheable responses
+    #   :verify_mode => The  verification mode to be used for Net::HTTP https connections. Defaults to OpenSSL::SSL::VERIFY_PEER
+    #   :cache_store => The object which should be used as cache store for cacheable responses (caching is not supported in this version)
     #   :detailed_http_logging => nil/$stdout/$stderr or File/Logger/IO object. Defaults to nil (recommended).
+    #   :callback => A Hash whose keys are the response codes (or Range of response codes),
+    #                        and the values are the callback functions to be executed.
+    #                        eg: { <response code> => lambda { |response| some_operation } }
     #   
     # *WARNING* : detailed_http_logging causes serious security hole. Never use it in production code.
     #
@@ -51,10 +55,14 @@ module Wrest::Native
       @connection = @options[:connection]
       @http_request = self.build_request(http_request_klass, @uri, @parameters, @headers)
       @cache_store = options[:cache_store]
+      @verify_mode = @options[:verify_mode]
       @detailed_http_logging = options[:detailed_http_logging]
+      @callback = key_ranges_to_array(@options[:callback] || {})
     end
 
-    # Makes a request and returns a Wrest::Native::Response. 
+    # Makes a request, runs the appropriate callback if any and
+    # returns a Wrest::Native::Response.
+    # 
     # Data about the request is and logged to Wrest.logger
     # The log entry contains the following information:
     #
@@ -62,7 +70,7 @@ module Wrest::Native
     #   <-- indicates a response
     #
     # The type of request is mentioned in caps, followed by a hash 
-    # uniquely uniquely identifying a particular request/response pair.
+    # uniquely identifying a particular request/response pair.
     # In a multi-process or multi-threaded scenario, this can be used
     # to identify request-response pairs.
     #
@@ -73,10 +81,8 @@ module Wrest::Native
     # This is followed by the response code, the payload size and the time taken.
     def invoke
       response = nil
-      
-      @connection ||= @uri.create_connection({:timeout => timeout})
+      @connection ||= @uri.create_connection({:timeout => timeout, :verify_mode => @verify_mode})
       @connection.set_debug_output @detailed_http_logging
-      
       http_request.basic_auth username, password unless username.nil? || password.nil?
 
       prefix = "#{http_request.method} #{http_request.hash} #{@connection.hash}"
@@ -85,6 +91,8 @@ module Wrest::Native
       time = Benchmark.realtime { response = Wrest::Native::Response.new( do_request ) }
       Wrest.logger.debug "-> (#{prefix}) %d %s (%d bytes %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
 
+      execute_callback_if_any(response)
+      
       @follow_redirects ? response.follow(@options) : response
     rescue Timeout::Error => e
       raise Wrest::Exceptions::Timeout.new(e)
@@ -101,5 +109,41 @@ module Wrest::Native
     def do_request
       @connection.request(@http_request, @body)
     end
+
+    private
+
+    def execute_callback_if_any(actual_response)
+      @callback.each do |callback_response_range, action|
+        action.call(actual_response) if callback_response_range.include?(actual_response.code.to_i)
+      end
+    end
+
+    # Returns a new Hash with all the keys converted into an Array.
+    # Keys who are of type Range are expanded, existing Arrays are kept as such.
+    #
+    # Use case:
+    # Converts Wrest#Uri callback array from
+    #   { 200 => lambda { xyz }, 500..502 => lambda { abc } }
+    #       into
+    #   { [200] => lambda { xyz }, [500, 501, 502] => lambda { abc } }
+    #
+    def key_ranges_to_array(callback_hash)
+      result = {}
+
+      callback_hash.each do |key, value|
+        new_key =
+          if key.is_a?(Range)
+          key.to_a
+        elsif key.is_a?(Array)
+          key
+        else
+          [key]
+        end
+
+        result[new_key] = value
+      end
+
+      result
+    end
   end
 end

data/lib/wrest/uri.rb

@@ -22,7 +22,7 @@ module Wrest #:nodoc:
   #
   # You can find examples that use real APIs (like delicious) under the wrest/examples directory.
   class Uri
-    attr_reader :uri, :username, :password, :uri_string, :uri_path, :query
+    attr_reader :uri, :username, :password, :uri_string, :uri_path, :query 
         
     # See Wrest::Native::Request for the available options and their default values.
     def initialize(uri_string, options = {})
@@ -39,7 +39,7 @@ module Wrest #:nodoc:
     
     def to_template(pattern)
       template_pattern = URI.join(uri_string,pattern).to_s
-      UriTemplate.new(template_pattern)
+      UriTemplate.new(template_pattern, @options)
     end
         
     # Build a new Wrest::Uri by appending _path_ to

data/lib/wrest/uri_template.rb

@@ -10,8 +10,9 @@
 module Wrest
   class UriTemplate
     attr_reader :uri_pattern
-    def initialize(uri_pattern)
+    def initialize(uri_pattern, options = {})
       @uri_pattern = uri_pattern.clone
+      @options = options.clone
     end
     
     # Builds a new Wrest::Uri from this uri template 
@@ -29,7 +30,6 @@ module Wrest
     #
     # Note that beacuse because both HTTP Auth and UriTemplate
     # use ':' as a delimiter, the pattern does look slightly weird, but it still works.
-    #
     # Example:
     # template = UriTemplate.new("http://:username::password@coathangers.com/:resource/:id.:format")
     # template.to_uri(
@@ -40,10 +40,11 @@ module Wrest
     # )
     #  => #<Wrest::Uri:0x18e0bec @uri=#<URI::HTTP:0x18e09a8 URL:http://kaiwren:fupuppies@coathangers.com/portal/1>>
     def to_uri(options = {})
-      Wrest::Uri.new(options.inject(uri_pattern.clone) do |uri_string, tuple| 
+     merged_options = @options.merge(options) 
+      Wrest::Uri.new(merged_options.inject(uri_pattern.clone) do |uri_string, tuple| 
         key, value = tuple
         uri_string.gsub(":#{key.to_s}", value.to_s)
-      end)
+      end , @options)
     end
 
     def [](path)

data/lib/wrest/version.rb

@@ -12,7 +12,7 @@ module Wrest
     unless defined? MAJOR
       MAJOR  = 1
       MINOR  = 0
-      TINY   = 0
+      TINY   = 1
       BUILD = nil
       
       STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 1
     - 0
-    - 0
-  version: 1.0.0
+    - 1
+  version: 1.0.1
 platform: universal-java-1.6
 authors: 
   - Sidu Ponnappa
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-24 00:00:00 +05:30
+date: 2011-01-04 00:00:00 +05:30
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -102,7 +102,9 @@ extensions: []
 extra_rdoc_files: 
   - README.rdoc
 files: 
+  - bin/wrest.compiled.rbc
   - bin/wrest_shell.rb
+  - bin/wrest_shell.rbc
   - bin/wrest
   - lib/wrest_no_ext.rb
   - lib/wrest.rb