rack-test 0.1.0 → 0.2.0

data/History.txt

@@ -1,5 +1,22 @@
+== 0.2.0 / 2009-04-26
+
+Because #last_response is now a MockResponse instead of a Rack::Response,
+#last_response.body now returns a string instead of an array.
+
+* Major enhancements
+
+  * Support multipart requests via the UploadedFile class (thanks, Rails)
+
+* Minor enhancements
+
+  * Updated for Rack 1.0
+  * Don't require rubygems (See http://gist.github.com/54177)
+  * Support HTTP Digest authentication with the #digest_authorize method
+  * #last_response returns a MockResponse instead of a Response
+    (Michael Fellinger)
+
 == 0.1.0 / 2009-03-02
 
 * 1 major enhancement
 
-  * Birthday!
+  * Birthday!

data/Rakefile

@@ -30,7 +30,7 @@ spec = Gem::Specification.new do |s|
   s.summary      = "Simple testing API built on Rack"
   s.description  = s.summary
   s.files        = %w[History.txt Rakefile README.rdoc] + Dir["lib/**/*"]
-  
+
   # rdoc
   s.has_rdoc         = true
   s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
@@ -53,6 +53,10 @@ end
 desc 'Install the package as a gem.'
 task :install => [:clean, :package] do
   gem = Dir['pkg/*.gem'].first
-  sh "sudo gem install --local #{gem}"
+  sh "sudo gem install --no-rdoc --no-ri --local #{gem}"
 end
 
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/lib/rack/test.rb

@@ -1,5 +1,3 @@
-require "rubygems"
-
 unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__) + "/.."))
   $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/.."))
 end
@@ -9,16 +7,40 @@ require "rack"
 require "rack/test/cookie_jar"
 require "rack/test/utils"
 require "rack/test/methods"
+require "rack/test/uploaded_file"
 
 module Rack
   module Test
-    
-    VERSION = "0.1.0"
-    
-    # The common base class for exceptions raised by Rack::Test
-    class Error < StandardError
+
+    class MockDigestRequest
+      def initialize(params)
+        @params = params
+      end
+
+      def method_missing(sym)
+        if @params.has_key? k = sym.to_s
+          return @params[k]
+        end
+
+        super
+      end
+
+      def method
+        @params['method']
+      end
+
+      def response(password)
+        Rack::Auth::Digest::MD5.new(nil).send :digest, self, password
+      end
     end
-    
+
+    VERSION = "0.2.0"
+
+    MULTIPART_BOUNDARY = "----------XnJLe9ZIbbGUYtzPQJ16u1"
+
+    # The common base class for exceptions raised by Rack::Test
+    class Error < StandardError; end
+
     class Session
       include Rack::Test::Utils
 
@@ -27,50 +49,50 @@ module Rack
         raise ArgumentError.new("app must respond_to?(:call)") unless app.respond_to?(:call)
 
         @headers = {}
-        @app = app
+        @app     = app
       end
-      
+
       # Issue a GET request for the given URI with the given params and Rack
       # environment. Stores the issues request object in #last_request and
       # the app's response in #last_response. Yield #last_response to a block
       # if given.
-      # 
+      #
       # Example:
       #   get "/"
       def get(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "GET", :params => params))
         process_request(uri, env, &block)
       end
-      
+
       # Issue a POST request for the given URI. See #get
-      # 
+      #
       # Example:
       #   post "/signup", "name" => "Bryan"
       def post(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "POST", :params => params))
         process_request(uri, env, &block)
       end
-      
+
       # Issue a PUT request for the given URI. See #get
-      # 
+      #
       # Example:
       #   put "/"
       def put(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "PUT", :params => params))
         process_request(uri, env, &block)
       end
-      
+
       # Issue a DELETE request for the given URI. See #get
-      # 
+      #
       # Example:
       #   delete "/"
       def delete(uri, params = {}, env = {}, &block)
         env = env_for(uri, env.merge(:method => "DELETE", :params => params))
         process_request(uri, env, &block)
       end
-      
+
       # Issue a HEAD request for the given URI. See #get
-      # 
+      #
       # Example:
       #   head "/"
       def head(uri, params = {}, env = {}, &block)
@@ -82,7 +104,7 @@ module Rack
       # environment. Stores the issues request object in #last_request and
       # the app's response in #last_response. Yield #last_response to a block
       # if given.
-      # 
+      #
       # Example:
       #   request "/"
       def request(uri, env = {}, &block)
@@ -92,7 +114,7 @@ module Rack
 
       # Set a header to be included on all subsequent requests through the
       # session. Use a value of nil to remove a previously configured header.
-      # 
+      #
       # Example:
       #   header "User-Agent", "Firefox"
       def header(name, value)
@@ -102,17 +124,22 @@ module Rack
           @headers[name] = value
         end
       end
-      
+
       # Set the username and password for HTTP Basic authorization, to be
       # included in subsequent requests in the HTTP_AUTHORIZATION header.
-      # 
+      #
       # Example:
       #   authorize "bryan", "secret"
       def authorize(username, password)
         encoded_login = ["#{username}:#{password}"].pack("m*")
         header('HTTP_AUTHORIZATION', "Basic #{encoded_login}")
       end
-      
+
+      def digest_authorize(username, password)
+        @digest_username = username
+        @digest_password = password
+      end
+
       # Rack::Test will not follow any redirects automatically. This method
       # will follow the redirect returned in the last response. If the last
       # response was not a redirect, an error will be raised.
@@ -120,7 +147,7 @@ module Rack
         unless last_response.redirect?
           raise Error.new("Last response was not a redirect. Cannot follow_redirect!")
         end
-        
+
         get(last_response["Location"])
       end
 
@@ -142,28 +169,34 @@ module Rack
 
     private
 
-      
       def env_for(path, env)
         uri = URI.parse(path)
         uri.host ||= "example.org"
 
         env = default_env.merge(env)
 
-        if URI::HTTPS === uri
-          env.update("HTTPS" => "on")
-        end
+        env.update("HTTPS" => "on")                if URI::HTTPS === uri
+        env["X-Requested-With"] = "XMLHttpRequest" if env[:xhr]
 
-        if env[:xhr]
-          env["X-Requested-With"] = "XMLHttpRequest"
-        end
-        
         if (env[:method] == "POST" || env["REQUEST_METHOD"] == "POST") && !env.has_key?(:input)
           env["CONTENT_TYPE"] = "application/x-www-form-urlencoded"
-          env[:input] = params_to_string(env.delete(:params))
+
+          multipart = (env[:params] || {}).any? do |k, v|
+            UploadedFile === v
+          end
+
+          if multipart
+            env[:input] = multipart_body(env.delete(:params))
+            env["CONTENT_LENGTH"] ||= env[:input].length.to_s
+            env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
+          else
+            env[:input] = params_to_string(env.delete(:params))
+          end
         end
 
         params = env[:params] || {}
         params.update(parse_query(uri.query))
+
         uri.query = requestify(params)
 
         if env.has_key?(:cookie)
@@ -175,7 +208,7 @@ module Rack
 
         Rack::MockRequest.env_for(uri.to_s, env)
       end
-      
+
       def cookie_jar
         @cookie_jar || Rack::Test::CookieJar.new
       end
@@ -187,12 +220,47 @@ module Rack
         @last_request = Rack::Request.new(env)
 
         status, headers, body = @app.call(@last_request.env)
-        @last_response = Rack::Response.new(body, status, headers)
+        @last_response = MockResponse.new(status, headers, body, env["rack.errors"])
+
         @cookie_jar = cookie_jar.merge(uri, last_response.headers["Set-Cookie"])
 
-        yield @last_response if block_given?
-        
-        @last_response
+        if retry_with_digest_auth?(env)
+          auth_env = env.merge("HTTP_AUTHORIZATION" => digest_auth_header,
+                    "rack-test.digest_auth_retry" => true)
+          auth_env.delete('rack.request')
+          process_request(uri.path, auth_env)
+        else
+          yield @last_response if block_given?
+
+          @last_response
+        end
+      end
+
+      def digest_auth_header
+        challenge = @last_response["WWW-Authenticate"].split(" ", 2).last
+        params = Rack::Auth::Digest::Params.parse(challenge)
+
+        params.merge!({
+          "username"  => @digest_username,
+          "nc"        => "00000001",
+          "cnonce"    => "nonsensenonce",
+          "uri"       => @last_request.path_info,
+          "method"    => @last_request.env["REQUEST_METHOD"],
+        })
+
+        params["response"] = MockDigestRequest.new(params).response(@digest_password)
+
+        return "Digest #{params}"
+      end
+
+      def retry_with_digest_auth?(env)
+        @last_response.status == 401 &&
+        digest_auth_configured? &&
+        !env["rack-test.digest_auth_retry"]
+      end
+
+      def digest_auth_configured?
+        @digest_username
       end
 
       def default_env
@@ -206,8 +274,8 @@ module Rack
         else params
         end
       end
-      
+
     end
-    
+
   end
 end

data/lib/rack/test/methods.rb

@@ -1,45 +1,34 @@
+require "forwardable"
+
 module Rack
   module Test
-    
     module Methods
-      
-      def self.delegate_to_rack_test_session(*meths)
-        meths.each do |meth|
-          self.class_eval <<-RUBY
-            def #{meth}(*args, &blk)
-              rack_test_session.#{meth}(*args, &blk)
-            end
-          RUBY
-        end
-      end
-      
+      extend Forwardable
+
       def rack_test_session
         @_rack_test_session ||= Rack::Test::Session.new(app)
       end
-      
-      delegate_to_rack_test_session \
+
+      METHODS = [
         :request,
-        
         # HTTP verbs
         :get,
         :post,
         :put,
         :delete,
         :head,
-        
         # Redirects
         :follow_redirect!,
-        
         # Header-related features
         :header,
         :authorize,
-
+        :digest_authorize,
         # Expose the last request and response
         :last_response,
         :last_request
-        
-        
+      ]
+
+      def_delegators :rack_test_session, *METHODS
     end
-    
   end
-end
+end

data/lib/rack/test/uploaded_file.rb

@@ -0,0 +1,36 @@
+require "tempfile"
+
+module Rack
+  module Test
+
+    class UploadedFile
+      # The filename, *not* including the path, of the "uploaded" file
+      attr_reader :original_filename
+
+      # The content type of the "uploaded" file
+      attr_accessor :content_type
+
+      def initialize(path, content_type = "text/plain", binary = false)
+        raise "#{path} file does not exist" unless ::File.exist?(path)
+        @content_type = content_type
+        @original_filename = ::File.basename(path)
+        @tempfile = Tempfile.new(@original_filename)
+        @tempfile.set_encoding(Encoding::BINARY) if @tempfile.respond_to?(:set_encoding)
+        @tempfile.binmode if binary
+        FileUtils.copy_file(path, @tempfile.path)
+      end
+
+      def path
+        @tempfile.path
+      end
+
+      alias_method :local_path, :path
+
+      def method_missing(method_name, *args, &block) #:nodoc:
+        @tempfile.__send__(method_name, *args, &block)
+      end
+
+    end
+
+  end
+end

data/lib/rack/test/utils.rb

@@ -1,9 +1,9 @@
 module Rack
   module Test
-    
+
     module Utils
       include Rack::Utils
-      
+
       def requestify(value, prefix = nil)
         case value
         when Array
@@ -18,10 +18,58 @@ module Rack
           "#{prefix}=#{escape(value)}"
         end
       end
-      
+
       module_function :requestify
-      
+
+      def multipart_requestify(params, first=true)
+        p = Hash.new
+
+        params.each do |key, value|
+          k = first ? key.to_s : "[#{key}]"
+
+          if Hash === value
+            multipart_requestify(value, false).each do |subkey, subvalue|
+              p[k + subkey] = subvalue
+            end
+          else
+            p[k] = value
+          end
+        end
+
+        return p
+      end
+
+      module_function :multipart_requestify
+
+      def multipart_body(params)
+        multipart_requestify(params).map do |key, value|
+          if value.respond_to?(:original_filename)
+            ::File.open(value.path, "rb") do |f|
+              f.set_encoding(Encoding::BINARY) if f.respond_to?(:set_encoding)
+
+              <<-EOF
+--#{MULTIPART_BOUNDARY}\r
+Content-Disposition: form-data; name="#{key}"; filename="#{escape(value.original_filename)}"\r
+Content-Type: #{value.content_type}\r
+Content-Length: #{::File.stat(value.path).size}\r
+\r
+#{f.read}\r
+EOF
+            end
+          else
+<<-EOF
+--#{MULTIPART_BOUNDARY}\r
+Content-Disposition: form-data; name="#{key}"\r
+\r
+#{value}\r
+EOF
+          end
+        end.join("")+"--#{MULTIPART_BOUNDARY}--\r"
+      end
+
+      module_function :multipart_body
+
     end
-    
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-test
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-04 00:00:00 -05:00
+date: 2009-04-26 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ files:
 - lib/rack/test
 - lib/rack/test/cookie_jar.rb
 - lib/rack/test/methods.rb
+- lib/rack/test/uploaded_file.rb
 - lib/rack/test/utils.rb
 - lib/rack/test.rb
 - MIT-LICENSE.txt