rufus-verbs 0.8 → 0.9

data/README.txt

@@ -163,6 +163,8 @@ The Rufus::Verbs module provides as well a <tt>fopen</tt> method, which mostly f
 
 But it follows redirections (has all the rufus-verbs features). It's provided for when targets are local files or URIs.
 
+This fopen() method makes sure to return an object that has a read() method (like a File instance has).
+
 
 The tests may provide good intel as on 'rufus-verbs' usage as well : http://rufus.rubyforge.org/svn/trunk/verbs/test/
 
@@ -295,6 +297,13 @@ the URI for the request (or the endpoint)
 * <b>:user_agent</b> (string, RE)
 for setting a custom 'User-Agent' HTTP header
 
+* <b>:v</b> (string/boolean/IO, RE)
+the short version of :verbose
+
+* <b>:verbose</b> (string/boolean/IO, RE)
+can be set to true or to an IO instance. If set to true, messages will be directed to STDOUT. Can be set to any IO instance.
+Will produces verbose messages similar to those of the fine cURL utility.
+
 
 == dependencies
 
@@ -315,7 +324,9 @@ On the Rufus-Ruby list[http://groups.google.com/group/rufus-ruby] :
 
 == source
 
-    svn checkout http://rufus.rubyforge.org/svn/trunk/verbs
+http://github.com/jmettraux/rufus-verbs
+
+    git clone git://github.com/jmettraux/rufus-verbs.git
 
 
 == author
@@ -324,6 +335,11 @@ John Mettraux, jmettraux@gmail.com,
 http://jmettraux.wordpress.com
 
 
+== the rest of Rufus
+
+http://rufus.rubyforge.org
+
+
 == license
 
 MIT

data/lib/rufus/verbs.rb

@@ -96,6 +96,8 @@ module Rufus::Verbs
     #
     def fopen (uri, *args, &block)
 
+        # should I really care about blocks here ? ...
+
         u = URI.parse uri.to_s
 
         return File.open(uri.to_s, &block) \
@@ -111,9 +113,15 @@ module Rufus::Verbs
             if block
                 block.call r
                 return
-            else
-                return r
             end
+
+            class << r
+                def read
+                    self.body
+                end
+            end unless r.respond_to?(:read)
+
+            return r
         end
 
         raise "can't handle scheme '#{u.scheme}' for #{u.to_s}"

data/lib/rufus/verbs/cookies.rb

@@ -48,6 +48,11 @@ module Verbs
     #
     module CookieMixin
 
+        #
+        # making the cookie jar available
+        #
+        attr_reader :cookies
+
         protected
 
             #
@@ -103,7 +108,7 @@ module Verbs
                     path = opts[:path]
                     cpath = c.path || "/"
 
-                    next unless cookie_acceptable?(opts, c)
+                    next unless cookie_acceptable?(opts, response, c)
 
                     domain = c.domain || host
 
@@ -119,7 +124,7 @@ module Verbs
             # Checks if the cookie is acceptable in the context of 
             # the request that sent it.
             #
-            def cookie_acceptable? (opts, cookie)
+            def cookie_acceptable? (opts, response, cookie)
 
                 # reject if :
                 #
@@ -144,7 +149,9 @@ module Verbs
                     return false if d != cdomain
                 end
 
-                path = opts[:path]
+                #path = opts[:path]
+                path = response.request.path
+
                 cpath = cookie.path || "/"
 
                 return false if path[0..cpath.length-1] != cpath

data/lib/rufus/verbs/endpoint.rb

@@ -40,6 +40,7 @@ require 'zlib'
 require 'rufus/verbs/version'
 require 'rufus/verbs/cookies'
 require 'rufus/verbs/digest'
+require 'rufus/verbs/verbose'
 
 
 module Rufus
@@ -69,6 +70,7 @@ module Verbs
 
         include CookieMixin
         include DigestAuthMixin
+        include VerboseMixin
 
         #
         # The endpoint initialization opts (Hash instance)
@@ -163,12 +165,16 @@ module Verbs
                 # if the :cookies option is disabled (the default)
                 # will have no effect
 
+            vlog_request opts, req
+
             return req if o(opts, :dry_run) == true
 
             # trigger request
 
             http = prepare_http opts
 
+            vlog_http opts, http
+
             res = nil
 
             http.start do
@@ -177,6 +183,13 @@ module Verbs
 
             # handle response
 
+            class << res
+                attr_accessor :request
+            end
+            res.request = req
+
+            vlog_response opts, res
+
             register_cookies res, opts
                 # if the :cookies option is disabled (the default)
                 # will have no effect
@@ -246,7 +259,7 @@ module Verbs
                       opts[:host],
                       opts[:port]  || 80,
                       opts[:path] || '/',
-                      opts[:query] || opts[:params] || {} ]
+                      opts[:query] || opts[:params] ]
 
                 elsif u
 
@@ -265,7 +278,12 @@ 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[:params]
+
+                opts[:query] = 
+                    r[4] || 
+                    opts[:params] || opts[:query] ||
+                    @opts[:query] || @opts[:params] || 
+                    {}
 
                 opts.delete :path if opts[:path] == ""
 
@@ -432,7 +450,9 @@ module Verbs
                     path += "/#{i}" if i
                 end
 
-                query = opts[:query]
+                path = path[1..-1] if path[0..1] == '//'
+
+                query = opts[:query] || opts[:params]
 
                 return path if not query or query.size < 1
 

data/lib/rufus/verbs/verbose.rb

@@ -0,0 +1,114 @@
+#
+#--
+# Copyright (c) 2008, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# 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
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# (MIT license)
+#++
+#
+
+#
+# John Mettraux
+#
+# Made in Japan
+#
+# 2008/03/31
+#
+
+module Rufus
+module Verbs
+
+    #
+    # Methods for the verbose mode
+    #
+    module VerboseMixin
+
+        protected
+
+            #
+            # logs a unique message to the verbose channel (if any).
+            #
+            def vlog (opts, msg)
+
+                channel = get_channel(opts) or return
+
+                channel << msg
+            end
+
+            #
+            # logs the outgoing request
+            #
+            def vlog_request (opts, req)
+
+                channel = get_channel(opts) or return
+
+                channel << "> #{req.method} #{req.path}\n"
+
+                req.each do |k, v|
+                    channel << "> #{k}: #{v}\n"
+                end
+
+                channel << ">\n"
+            end
+
+            def vlog_http (opts, http)
+
+                channel = get_channel(opts) or return
+
+                channel << "* #{http.address}:#{http.port}\n"
+                channel << "*\n"
+            end
+
+            #
+            # logs the incoming response
+            #
+            def vlog_response (opts, res)
+
+                channel = get_channel(opts) or return
+
+                channel << "< #{res.code} #{res.message}\n"
+                channel << "<\n"
+
+                res.each do |k, v|
+                    channel << "< #{k}: #{v}\n"
+                end
+
+                channel << "<\n"
+            end
+
+        private
+
+            def get_channel (opts)
+
+                v = o(opts, [ :verbose, :v ])
+
+                return nil if (not v) or (v.to_s == 'false')
+
+                v = $stdout if v.to_s == 'true'
+
+                return nil unless v.is_a?(IO)
+
+                v
+            end
+    end
+
+end
+end
+

data/lib/rufus/verbs/version.rb

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

data/test/cookie0_test.rb

@@ -65,32 +65,37 @@ class Cookie0Test < Test::Unit::TestCase
 
         opts = { :host => 'rufus.rubyforge.org', :path => '/' }
         c = TestCookie.new '.rubyforge.org', '/'
-        assert cookie_acceptable?(opts, c)
+        r = TestResponse.new opts
+        assert cookie_acceptable?(opts, r, c)
 
         # * The value for the Domain attribute contains no embedded dots
         #   or does not start with a dot.
 
         opts = { :host => 'rufus.rubyforge.org', :path => '/' }
         c = TestCookie.new 'rufus.rubyforge.org', '/'
-        assert ! cookie_acceptable?(opts, c)
+        r = TestResponse.new opts
+        assert ! cookie_acceptable?(opts, r, c)
 
         opts = { :host => 'rufus.rubyforge.org', :path => '/' }
         c = TestCookie.new 'org', '/'
-        assert ! cookie_acceptable?(opts, c)
+        r = TestResponse.new opts
+        assert ! cookie_acceptable?(opts, r, c)
 
         # * The value for the Path attribute is not a prefix of the 
         #   request-URI.
 
         opts = { :host => 'rufus.rubyforge.org', :path => '/this' }
         c = TestCookie.new '.rubyforge.org', '/that'
-        assert ! cookie_acceptable?(opts, c)
+        r = TestResponse.new opts
+        assert ! cookie_acceptable?(opts, r, c)
 
         # * The value for the request-host does not domain-match the 
         #   Domain attribute.
 
         opts = { :host => 'rufus.rubyforg.org', :path => '/' }
         c = TestCookie.new '.rubyforge.org', '/'
-        assert ! cookie_acceptable?(opts, c)
+        r = TestResponse.new opts
+        assert ! cookie_acceptable?(opts, r, c)
 
         # * The request-host is a FQDN (not IP address) and has the form
         #   HD, where D is the value of the Domain attribute, and H is a
@@ -119,4 +124,22 @@ class Cookie0Test < Test::Unit::TestCase
                 @name = name
             end
         end
+
+        class TestResponse
+
+            def initialize (opts)
+
+                @path = opts[:path]
+            end
+
+            def request
+
+                r = Object.new
+                class << r
+                    attr_accessor :path
+                end
+                r.path = @path
+                r
+            end
+        end
 end

data/test/dryrun_test.rb

@@ -26,6 +26,13 @@ class DryRunTest < Test::Unit::TestCase
 
         assert_equal "/items/1?a=A&b=B", req.path
 
+        req = post(
+            :dry_run => true, 
+            :uri => "http://localhost:7777/items/1", 
+            :params => { "a" => "A", :b => :B })
+
+        assert_equal "/items/1?a=A&b=B", req.path
+
         req = put(
             :dry_run => true, 
             :uri => "http://localhost:7777/items/1", 
@@ -39,4 +46,25 @@ class DryRunTest < Test::Unit::TestCase
         assert_equal "/items/1?a=A", req.path
         assert_equal "toto", req.body
     end
+
+    def test_1
+
+        ep = Rufus::Verbs::EndPoint.new(
+            :host => 'localhost',
+            :resource => 'whatever')
+
+        req = ep.get(
+            :dry_run => true,
+            :resource => 'other',
+            :params => { 'a' => 'A', 'b' => 'B' })
+
+        assert_equal "/other?a=A&b=B", req.path
+
+        req = ep.post(
+            :dry_run => true,
+            :resource => 'other',
+            :query => { 'a' => 'A', 'b' => 'B' })
+        
+        assert_equal "/other?a=A&b=B", req.path
+    end
 end

data/test/fopen_test.rb

@@ -50,4 +50,11 @@ class UriTest < Test::Unit::TestCase
             assert_equal "{}", res.body.strip
         end
     end
+
+    def test_1
+
+        assert_kind_of String, fopen("CHANGELOG.txt").read
+        assert_kind_of String, fopen("file:CHANGELOG.txt").read
+        assert_kind_of String, fopen("http://localhost:7777/items").read
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-verbs
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: "0.9"
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-18 00:00:00 +09:00
+date: 2008-04-10 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,6 +36,7 @@ files:
 - lib/rufus/verbs/cookies.rb
 - lib/rufus/verbs/digest.rb
 - lib/rufus/verbs/endpoint.rb
+- lib/rufus/verbs/verbose.rb
 - lib/rufus/verbs/version.rb
 - lib/rufus/verbs.rb
 - test/auth0_test.rb
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: 
 - rufus-lru
 rubyforge_project: 
-rubygems_version: 0.9.5
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: GET, POST, PUT, DELETE, with something around