rufus-verbs 0.9 → 0.10

data/README.txt

@@ -288,6 +288,12 @@ the resource (or the middle) of a full resource path (see :base)
 * <b>:ssl_verify_peer</b> (boolean, RE)
 by default, rufus-verbs doesn't verify ssl certificates. With this option set to true, it will.
 
+* <b>:timeout</b> (integer, RE)
+sets the timeout (both open_ and read_timeout) for the request (and the endpoint), expects a value expressed in seconds.
+
+* <b>:to</b> (integer, RE)
+shortcut for :timeout
+
 * <b>:u</b> (uri, string, RE)
 the short version of :uri
 

data/lib/rufus/verbs.rb

@@ -8,10 +8,10 @@
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

data/lib/rufus/verbs/conditional.rb

@@ -32,7 +32,7 @@
 # 2008/01/16
 #
 
-require 'rubygems'
+#require 'rubygems'
 require 'rufus/lru'
 
 

data/lib/rufus/verbs/cookies.rb

@@ -34,7 +34,7 @@
 
 require 'webrick/cookie'
 
-require 'rubygems'
+#require 'rubygems'
 require 'rufus/lru'
 
 

data/lib/rufus/verbs/endpoint.rb

@@ -8,10 +8,10 @@
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -49,12 +49,12 @@ module Verbs
     USER_AGENT = "Ruby rufus-verbs #{VERSION}"
 
     #
-    # An EndPoint can be used to share common options among a set of 
+    # An EndPoint can be used to share common options among a set of
     # requests.
     #
     #     ep = EndPoint.new(
-    #         :host => "restful.server", 
-    #         :port => 7080, 
+    #         :host => "restful.server",
+    #         :port => 7080,
     #         :resource => "inventory/tools")
     #
     #     res = ep.get :id => 1
@@ -63,7 +63,7 @@ module Verbs
     #     res = ep.get :id => 0
     #         # where did the hammer go ?
     #
-    # When a request gets prepared, the option values will be looked up 
+    # When a request gets prepared, the option values will be looked up
     # in (1) its local (request) options, then (2) in the EndPoint options.
     #
     class EndPoint
@@ -83,7 +83,7 @@ module Verbs
 
             compute_target @opts
 
-            @opts[:http_basic_authentication] = 
+            @opts[:http_basic_authentication] =
                 opts[:http_basic_authentication] || opts[:hba]
 
             @opts[:user_agent] ||= USER_AGENT
@@ -126,7 +126,7 @@ module Verbs
         #
         # This is the method called by the module methods verbs.
         #
-        # For example, 
+        # For example,
         #
         #     RufusVerbs.get(args)
         #
@@ -264,10 +264,10 @@ module Verbs
                 elsif u
 
                     u = URI.parse u.to_s unless u.is_a?(URI)
-                    [ u.scheme, 
-                      u.host, 
-                      u.port, 
-                      u.path, 
+                    [ u.scheme,
+                      u.host,
+                      u.port,
+                      u.path,
                       query_to_h(u.query) ]
                 else
 
@@ -279,18 +279,18 @@ module Verbs
                 opts[:port] = r[2] || @opts[:port]
                 opts[:path] = r[3] || @opts[:path]
 
-                opts[:query] = 
-                    r[4] || 
+                opts[:query] =
+                    r[4] ||
                     opts[:params] || opts[:query] ||
-                    @opts[:query] || @opts[:params] || 
+                    @opts[:query] || @opts[:params] ||
                     {}
 
                 opts.delete :path if opts[:path] == ""
 
-                opts[:c_uri] = [ 
-                    opts[:scheme], 
-                    opts[:host], 
-                    opts[:port], 
+                opts[:c_uri] = [
+                    opts[:scheme],
+                    opts[:host],
+                    opts[:port],
                     opts[:path],
                     opts[:query] ].inspect
                         #
@@ -303,7 +303,7 @@ module Verbs
             # Creates the Net::HTTP request instance.
             #
             # If :fake_put is set, will use Net::HTTP::Post
-            # and make sure the query string contains '_method=put' (or 
+            # and make sure the query string contains '_method=put' (or
             # '_method=delete').
             #
             # This call will also advertise this rufus-verbs as
@@ -311,7 +311,7 @@ module Verbs
             #
             def create_request (method, opts)
 
-                if (o(opts, :fake_put) and 
+                if (o(opts, :fake_put) and
                     (method == :put or method == :delete))
 
                     opts[:query][:_method] = method.to_s
@@ -362,7 +362,7 @@ module Verbs
             end
 
             #
-            # In that base class, it's empty. 
+            # In that base class, it's empty.
             # It's implemented in ConditionalEndPoint.
             #
             # Only called for a GET.
@@ -381,10 +381,12 @@ module Verbs
                 compute_proxy opts
 
                 http = Net::HTTP.new(
-                    opts[:host], opts[:port], 
+                    opts[:host], opts[:port],
                     opts[:proxy_host], opts[:proxy_port],
                     opts[:proxy_user], opts[:proxy_pass])
 
+                set_timeout http, opts
+
                 return http unless opts[:scheme] == 'https'
 
                 require 'net/https'
@@ -393,9 +395,9 @@ module Verbs
                 http.enable_post_connection_check = true
 
                 http.verify_mode = if o(opts, :ssl_verify_peer)
-                    OpenSSL::SSL::VERIFY_NONE
-                else
                     OpenSSL::SSL::VERIFY_PEER
+                else
+                    OpenSSL::SSL::VERIFY_NONE
                 end
 
                 store = OpenSSL::X509::Store.new
@@ -405,6 +407,21 @@ module Verbs
                 http
             end
 
+            #
+            # Sets both the open_timeout and the read_timeout for the http
+            # instance
+            #
+            def set_timeout (http, opts)
+
+                to = o(opts, :timeout) || o(opts, :to)
+                to = to.to_i
+
+                return if to == 0
+
+                http.open_timeout = to
+                http.read_timeout = to
+            end
+
             #
             # Makes sure the request opts hold the proxy information.
             #
@@ -466,7 +483,7 @@ module Verbs
 
                 return nil unless q
 
-                q.split("&").inject({}) do |r, e| 
+                q.split("&").inject({}) do |r, e|
                     s = e.split("=")
                     r[s[0]] = s[1]
                     r
@@ -474,11 +491,11 @@ module Verbs
             end
 
             #
-            #     { "a" => "A", "b" => "B" } -> "a=A&b=B" 
+            #     { "a" => "A", "b" => "B" } -> "a=A&b=B"
             #
             def h_to_query (h, opts)
 
-                h.entries.collect { |k, v| 
+                h.entries.collect { |k, v|
                     unless o(opts, :no_escape)
                         k = URI.escape k.to_s
                         v = URI.escape v.to_s
@@ -502,7 +519,7 @@ module Verbs
                     req.set_form_data fd, sep
                 elsif block
                     req.body = block.call req
-                else 
+                else
                     req.body = ""
                 end
             end
@@ -544,7 +561,7 @@ module Verbs
                         opts[:path], opts[:query] = location.split "?"
                     end
 
-                    if (authentication_is_on?(opts) and 
+                    if (authentication_is_on?(opts) and
                         [ opts[:scheme], opts[:host] ] != prev_host)
 
                         raise(

data/lib/rufus/verbs/version.rb

@@ -8,10 +8,10 @@
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -39,7 +39,7 @@ module Verbs
     #
     # The version of this rufus-verbs [gem]
     #
-    VERSION = '0.9'
+    VERSION = '0.10'
 end
 end
 

data/test/items.rb

@@ -58,6 +58,7 @@ end
 class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
 
     @@items = {}
+    @@last_item_id = -1
 
     @@lastmod = LastModifiedHash.new
 
@@ -80,7 +81,7 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
 
             WEBrick::HTTPAuth.basic_auth(req, res, "items") do |u, p|
                 (u != nil and u == p)
-            end 
+            end
 
         elsif @auth == :digest
 
@@ -127,6 +128,9 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
         return do_DELETE(req, res) if m == 'delete'
 
         i = item_id req
+
+        i = (@@last_item_id += 1) unless i
+
         items[i] = req.body
         lastmod.touch i
 
@@ -138,7 +142,7 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
 
         i = item_id req
 
-        return reply(res, 404, "no item '#{i}'") unless items[i] 
+        return reply(res, 404, "no item '#{i}'") unless items[i]
 
         items[i] = req.body
         lastmod.touch i
@@ -150,7 +154,7 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
 
         i = item_id req
 
-        return reply(res, 404, "no item '#{i}'") unless items[i] 
+        return reply(res, 404, "no item '#{i}'") unless items[i]
 
         items.delete i
         lastmod.delete i
@@ -172,7 +176,7 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
         def items
             @@items
         end
-        
+
         def lastmod
             @@lastmod
         end
@@ -202,7 +206,7 @@ class ItemServlet < WEBrick::HTTPServlet::AbstractServlet
                 items
             end
 
-            [ representation, 
+            [ representation,
               representation.inspect.hash.to_s,
               lastmod.last_modified(key) ]
         end
@@ -230,7 +234,7 @@ class ThingServlet < WEBrick::HTTPServlet::AbstractServlet
     def do_GET (req, res)
 
         res.set_redirect(
-            WEBrick::HTTPStatus[303], 
+            WEBrick::HTTPStatus[303],
             "http://localhost:7777/items")
     end
 end
@@ -271,6 +275,17 @@ class CookieServlet < WEBrick::HTTPServlet::AbstractServlet
         end
 end
 
+#
+# a servlet that doesn't reply (for timeout testing)
+#
+class LostServlet < WEBrick::HTTPServlet::AbstractServlet
+
+    def do_GET (req, res)
+
+        sleep 200
+    end
+end
+
 #
 # Serving items, a dummy resource...
 # Also serving things, which just redirect to items...
@@ -281,7 +296,7 @@ class ItemServer
 
         port = args[:port] || 7777
 
-        #al = [ 
+        #al = [
         #    [ "", WEBrick::AccessLog::COMMON_LOG_FORMAT ],
         #    [ "", WEBrick::AccessLog::REFERER_LOG_FORMAT ]]
 
@@ -296,9 +311,10 @@ class ItemServer
         @server.mount "/items", ItemServlet
         @server.mount "/things", ThingServlet
         @server.mount "/cookie", CookieServlet
+        @server.mount "/lost", LostServlet
 
         [ 'INT', 'TERM' ].each do |signal|
-            trap(signal) { shutdown } 
+            trap(signal) { shutdown }
         end
     end
 

data/test/simple_test.rb

@@ -7,6 +7,8 @@
 # Sun Jan 13 12:33:03 JST 2008
 #
 
+require 'rubygems'
+
 require 'test/unit'
 require 'testbase'
 
@@ -47,6 +49,23 @@ class SimpleTest < Test::Unit::TestCase
         expect 200, { 0 => "Toto3" }, get(:uri => "http://localhost:7777/items")
     end
 
+    def test_0b
+
+        expect 200, {}, get(:uri => "http://localhost:7777/items")
+
+        res = post :uri => "http://localhost:7777/items", :d => "Toto"
+        assert_equal 201, res.code.to_i
+        assert_equal "http://localhost:7777/items/0", res['Location']
+
+        expect 200, "\"Toto\"", get(:uri => "http://localhost:7777/items/0")
+
+        res = post :uri => "http://localhost:7777/items", :d => "Smurf"
+        assert_equal 201, res.code.to_i
+        assert_equal "http://localhost:7777/items/1", res['Location']
+
+        expect 200, "\"Smurf\"", get(:uri => "http://localhost:7777/items/1")
+    end
+
     def test_1
 
         ep = EndPoint.new(:host => "localhost", :port => 7777)

data/test/test.rb

@@ -1,4 +1,7 @@
 
+require 'rubygems'
+
+
 require 'dryrun_test'
 require 'iconditional_test'
 
@@ -21,3 +24,5 @@ require 'escape_test'
 require 'uri_test'
 require 'fopen_test'
 
+require 'timeout_test'
+

data/test/timeout_test.rb

@@ -0,0 +1,38 @@
+
+#
+# Testing rufus-verbs
+#
+# jmettraux@gmail.com
+#
+# Mon May 26 17:04:25 JST 2008
+#
+
+require 'rubygems'
+
+require 'test/unit'
+require 'testbase'
+
+require 'rufus/verbs'
+
+
+class TimeoutTest < Test::Unit::TestCase
+    include TestBaseMixin
+
+    include Rufus::Verbs
+
+
+    def test_0
+
+        error = nil
+        t = Time.now
+
+        begin
+            get :uri => "http://localhost:7777/lost", :to => 1
+        rescue Timeout::Error => e
+            error = e
+        end
+
+        assert_not_nil error
+        assert (Time.now - t < 2)
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-verbs
 version: !ruby/object:Gem::Version 
-  version: "0.9"
+  version: "0.10"
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-10 00:00:00 +09:00
+date: 2008-05-28 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,7 @@ files:
 - test/test.htdigest
 - test/test.rb
 - test/testbase.rb
+- test/timeout_test.rb
 - test/uri_test.rb
 - README.txt
 has_rdoc: true