rufus-verbs 0.5 → 0.6

data/README.txt

@@ -25,6 +25,7 @@ currently :
 * request body built via a block (post and put)
 * cookie-aware (if :cookies option is explicitely set to true)
 * http digest authentication (rfc 2617) (auth ok, auth-int not tested)
+* query parameters are automatically escaped (disable with :no_escape => true)
 
 maybe later :
 
@@ -199,6 +200,12 @@ the short version of :form_data
 * <b>:form_data</b>
 this option expects a hash. The (post or put) request body will then be built with this hash.
 
+* <b>:h</b> (a hash String => String, RE) 
+short for :headers
+
+* <b>:headers</b> (a hash String => String, RE) 
+A Hash of additional request headers to pass
+
 * <b>:hba</b> (pair of strings, RE) 
 short for :http_basic_authentication
 
@@ -214,6 +221,9 @@ the id part of a full resource path (see :base)
 * <b>:max_redirections</b> (integer, RE)
 by default, rufus-verbs will follow any number of redirections. A limit can be set via this option
 
+* <b>:no_escape</b> (boolean, RE)
+by default, query parameters are escaped. When this option is set to true, no escaping will be performed before the request[s].
+
 * <b>:no_redirections</b> (boolean, RE)
 when set to 'true', redirections will not be followed, the server response will be returned directly, even if it's a redirection notification.
 
@@ -223,6 +233,9 @@ the short version for :no_redirections.
 * <b>:nozip</b> (boolean, RE)
 if set to true will prevent gzip encoding (advertising) when GETting content
 
+* <b>:params</b> (hash or string, RE)
+a hash of parameters that will get appended to the URI of the request. A string like "a=b?x=y" can be given as well (equivalent to :query)
+
 * <b>:path</b> (string, RE)
 the path (between port and the query string)
 
@@ -233,7 +246,7 @@ the port for the request
 by default, rufus-verbs will try to use the proxy given in the HTTP_PROXY environment variable (URI). If this :proxy option is set to false, no proxy will be used. It can take the value of a URI (String or URI instance) as well.
 
 * <b>:query</b> (hash or string, R)
-a hash of parameters that will get appended to the URI of the request. A string like "a=b?x=y" can be given as well
+a hash of parameters that will get appended to the URI of the request. A string like "a=b?x=y" can be given as well (equivalent to :params)
 
 * <b>:raw_response</b> (boolean, RE)
 the request will be executed and the HTTP response will be returned immediately, no redirection following, content decompression or eventual caching (conditional GET) will take place

data/lib/rufus/verbs/endpoint.rb

@@ -243,7 +243,7 @@ module Verbs
                       opts[:host],
                       opts[:port]  || 80,
                       opts[:path] || '/',
-                      opts[:query] || {} ]
+                      opts[:query] || opts[:params] || {} ]
 
                 elsif u
 
@@ -262,7 +262,7 @@ module Verbs
                 opts[:host] = r[1] || @opts[:host]
                 opts[:port] = r[2] || @opts[:port]
                 opts[:path] = r[3] || @opts[:path]
-                opts[:query] = r[4] || @opts[:query]
+                opts[:query] = r[4] || @opts[:query] || @opts[:params]
 
                 opts.delete :path if opts[:path] == ""
 
@@ -435,7 +435,7 @@ module Verbs
 
                 return path if not query or query.size < 1
 
-                path + '?' + h_to_query(query)
+                path + '?' + h_to_query(query, opts)
             end
 
             #
@@ -455,9 +455,15 @@ module Verbs
             #
             #     { "a" => "A", "b" => "B" } -> "a=A&b=B" 
             #
-            def h_to_query (h)
+            def h_to_query (h, opts)
 
-                h.entries.collect { |e| e.join("=") }.join("&")
+                h.entries.collect { |k, v| 
+                    unless o(opts, :no_escape)
+                        k = URI.escape k.to_s
+                        v = URI.escape v.to_s
+                    end
+                    "#{k}=#{v}"
+                }.join("&")
             end
 
             #

data/lib/rufus/verbs/version.rb

@@ -39,7 +39,7 @@ module Verbs
     #
     # The version of this rufus-verbs [gem]
     #
-    VERSION = '0.5'
+    VERSION = '0.6'
 end
 end
 

data/test/dryrun_test.rb

@@ -24,19 +24,19 @@ class DryRunTest < Test::Unit::TestCase
             :uri => "http://localhost:7777/items/1", 
             :params => { "a" => "A", :b => :B })
 
-        assert "/items/1?a=A&b=B", req.path
+        assert_equal "/items/1?a=A&b=B", req.path
 
         req = put(
             :dry_run => true, 
             :uri => "http://localhost:7777/items/1", 
             :query => { "a" => "A", :b => :B })
 
-        assert "/items/1?a=A&b=B", req.path
+        assert_equal "/items/1?a=A&b=B", req.path
 
         req = put(
             "http://localhost:7777/items/1?a=A", :d => "toto", :dry_run => true)
 
-        assert "/items/1?a=A", req.path
-        assert "toto", req.body
+        assert_equal "/items/1?a=A", req.path
+        assert_equal "toto", req.body
     end
 end

data/test/escape_test.rb

@@ -0,0 +1,38 @@
+
+#
+# Testing rufus-verbs
+#
+# jmettraux@gmail.com
+#
+# Tue Feb 12 23:10:54 JST 2008
+#
+
+require 'test/unit'
+
+require 'rufus/verbs'
+
+
+class EscapeTest < Test::Unit::TestCase
+
+    include Rufus::Verbs
+
+
+    def test_0
+
+        req = put(
+            :dry_run => true, 
+            :uri => "http://localhost:7777/items/1", 
+            :query => { "a" => "hontou ni ?" })
+
+        assert_equal "/items/1?a=hontou%20ni%20?", req.path
+
+        req = put(
+            :dry_run => true, 
+            :uri => "http://localhost:7777/items/1", 
+            :params => { "a" => "hontou ni ?" },
+            :no_escape => true)
+
+        assert_equal "/items/1?a=hontou ni ?", req.path
+            # would fail anyway...
+    end
+end

data/test/test.rb

@@ -16,3 +16,5 @@ require 'conditional_test'
 require 'cookie0_test'
 require 'cookie1_test'
 
+require 'escape_test'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-verbs
 version: !ruby/object:Gem::Version 
-  version: "0.5"
+  version: "0.6"
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-01 00:00:00 +09:00
+date: 2008-02-13 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - test/cookie0_test.rb
 - test/cookie1_test.rb
 - test/dryrun_test.rb
+- test/escape_test.rb
 - test/https_test.rb
 - test/iconditional_test.rb
 - test/items.rb