josh-rack-test 0.4.1

data/.document

@@ -0,0 +1,4 @@
+README.rdoc
+lib/**/*.rb
+History.txt
+MIT-LICENSE.txt

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+doc
+coverage

data/History.txt

@@ -0,0 +1,75 @@
+== Git
+
+* Minor enhancements
+
+  * Stringify and upcase request method (e.g. :post => "POST") (Josh Peek)
+
+* Bug fixes
+
+  * Requiring Rack-Test never modifies the Ruby load path anymore (Josh Peek)
+  * Fixed using multiple cookies in a string on Ruby 1.8 (Tuomas Kareinen and Hermanni Hyytiälä)
+
+== 0.4.1 / 2009-08-06
+
+* Minor enhancements
+
+  * Support initializing a Rack::Test::Session with an app in addition to
+    a Rack::MockSession
+  * Allow CONTENT_TYPE to be specified in the env and not overwritten when
+    sending a POST or PUT
+
+== 0.4.0 / 2009-06-25
+
+* Minor enhancements
+
+  * Expose hook for building Rack::MockSessions for frameworks that need
+    to configure them before use
+  * Support passing in arrays of raw cookies in addition to a newline
+    separated string
+  * Support after_request callbacks in MockSession for things like running
+    background jobs
+  * Allow multiple named sessions using with_session
+  * Initialize Rack::Test::Sessions with Rack::MockSessions instead of apps.
+    This change should help integration with other Ruby web frameworks
+    (like Merb).
+  * Support sending bodies for PUT requests (Larry Diehl)
+
+== 0.3.0 / 2009-05-17
+
+* Major enhancements
+
+  * Ruby 1.9 compatible (Simon Rozet, Michael Fellinger)
+
+* Minor enhancements
+
+  * Add CookieJar#[] and CookieJar#[]= methods
+  * Make the default host configurable
+  * Use Rack::Lint and fix errors (Simon Rozet)
+  * Extract Rack::MockSession from Rack::Test::Session to handle tracking
+    the last request and response and the cookie jar
+  * Add #set_cookie and #clear_cookies methods
+  * Rename #authorize to #basic_authorize (#authorize remains as an alias)
+    (Simon Rozet)
+
+== 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!

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2009 Bryan Helmkamp, Engine Yard Inc.
+
+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.

data/README.rdoc

@@ -0,0 +1,57 @@
+= Rack::Test
+
+- http://gitrdoc.com/brynary/rack-test
+- http://github.com/brynary/rack-test
+
+== Description
+
+Rack::Test is a small, simple testing API for Rack apps. It can be used on its
+own or as a reusable starting point for Web frameworks and testing libraries
+to build on. Most of its initial functionality is an extraction of Merb 1.0's
+request helpers feature.
+
+== Features
+
+* Maintains a cookie jar across requests
+* Easily follow redirects when desired
+* Set request headers to be used by all subsequent requests
+* Small footprint. Approximately 200 LOC
+
+== Example
+
+  require "rack/test"
+  
+  class HomepageTest < Test::Unit::TestCase
+    include Rack::Test::Methods
+    
+    def app
+      MyApp.new
+    end
+    
+    def test_redirect_logged_in_users_to_dashboard
+      authorize "bryan", "secret"
+      get "/"
+      follow_redirect!
+      
+      assert_equal "http://example.org/redirected", last_request.url
+      assert last_response.ok?
+    end
+    
+  end
+
+== Install
+
+To install the latest release as a gem:
+
+  sudo gem install rack-test
+
+== Authors
+
+- Maintained by {Bryan Helmkamp}[mailto:bryan@brynary.com]
+- Contributions from Simon Rozet and Pat Nakajima
+- Much of the original code was extracted from Merb 1.0's request helper
+
+== License
+
+Copyright (c) 2008-2009 Bryan Helmkamp, Engine Yard Inc.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,53 @@
+require "rubygems"
+require "rake/rdoctask"
+require "spec/rake/spectask"
+
+begin
+  require "jeweler"
+
+  Jeweler::Tasks.new do |s|
+    s.name      = "rack-test"
+    s.author    = "Bryan Helmkamp"
+    s.email     = "bryan" + "@" + "brynary.com"
+    s.homepage  = "http://github.com/brynary/rack-test"
+    s.summary   = "Simple testing API built on Rack"
+    # s.description = "TODO"
+    s.rubyforge_project = "rack-test"
+    s.extra_rdoc_files = %w[README.rdoc MIT-LICENSE.txt]
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.libs << 'lib'
+  t.libs << 'spec'
+end
+
+desc "Run all specs in spec directory with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines(File.dirname(__FILE__) + "/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+desc "Generate RDoc"
+task :docs do
+  FileUtils.rm_rf("doc")
+  system "hanna --title 'Rack::Test #{Rack::Test::VERSION} API Documentation'"
+end
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end
+
+task :spec => :check_dependencies if defined?(Jeweler)
+
+desc "Run the specs"
+task :default => :spec

data/lib/rack/mock_session.rb

@@ -0,0 +1,57 @@
+module Rack
+
+  class MockSession
+    attr_writer :cookie_jar
+    attr_reader :last_response
+    attr_reader :default_host
+
+    def initialize(app, default_host = Rack::Test::DEFAULT_HOST)
+      @app = app
+      @after_request = []
+      @default_host = default_host
+    end
+
+    def after_request(&block)
+      @after_request << block
+    end
+
+    def clear_cookies
+      @cookie_jar = Rack::Test::CookieJar.new([], @default_host)
+    end
+
+    def set_cookie(cookie, uri = nil)
+      cookie_jar.merge(cookie, uri)
+    end
+
+    def request(uri, env)
+      env["HTTP_COOKIE"] ||= cookie_jar.for(uri)
+      @last_request = Rack::Request.new(env)
+      status, headers, body = @app.call(@last_request.env)
+      @last_response = MockResponse.new(status, headers, body, env["rack.errors"].flush)
+      cookie_jar.merge(last_response.headers["Set-Cookie"], uri)
+
+      @after_request.each { |hook| hook.call }
+      @last_response
+    end
+
+    # Return the last request issued in the session. Raises an error if no
+    # requests have been sent yet.
+    def last_request
+      raise Rack::Test::Error.new("No request yet. Request a page first.") unless @last_request
+      @last_request
+    end
+
+    # Return the last response received in the session. Raises an error if
+    # no requests have been sent yet.
+    def last_response
+      raise Rack::Test::Error.new("No response yet. Request a page first.") unless @last_response
+      @last_response
+    end
+
+    def cookie_jar
+      @cookie_jar ||= Rack::Test::CookieJar.new([], @default_host)
+    end
+
+  end
+
+end

data/lib/rack/test.rb

@@ -0,0 +1,245 @@
+require "uri"
+require "rack"
+require "rack/mock_session"
+require "rack/test/cookie_jar"
+require "rack/test/mock_digest_request"
+require "rack/test/utils"
+require "rack/test/methods"
+require "rack/test/uploaded_file"
+
+module Rack
+  module Test
+    VERSION = "0.4.1"
+
+    DEFAULT_HOST = "example.org"
+    MULTIPART_BOUNDARY = "----------XnJLe9ZIbbGUYtzPQJ16u1"
+
+    # The common base class for exceptions raised by Rack::Test
+    class Error < StandardError; end
+
+    class Session
+      extend Forwardable
+      include Rack::Test::Utils
+
+      def_delegators :@rack_mock_session, :clear_cookies, :set_cookie, :last_response, :last_request
+
+      # Initialize a new session for the given Rack app
+      def initialize(mock_session)
+        @headers = {}
+
+        if mock_session.is_a?(MockSession)
+          @rack_mock_session = mock_session
+        else
+          @rack_mock_session = MockSession.new(mock_session)
+        end
+
+        @default_host = @rack_mock_session.default_host
+      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)
+        env = env_for(uri, env.merge(:method => "HEAD", :params => params))
+        process_request(uri, env, &block)
+      end
+
+      # Issue a request to the Rack app for the given URI and optional 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)
+        env = env_for(uri, env)
+        process_request(uri, env, &block)
+      end
+
+      # 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)
+        if value.nil?
+          @headers.delete(name)
+        else
+          @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:
+      #   basic_authorize "bryan", "secret"
+      def basic_authorize(username, password)
+        encoded_login = ["#{username}:#{password}"].pack("m*")
+        header('HTTP_AUTHORIZATION', "Basic #{encoded_login}")
+      end
+
+      alias_method :authorize, :basic_authorize
+
+      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.
+      def follow_redirect!
+        unless last_response.redirect?
+          raise Error.new("Last response was not a redirect. Cannot follow_redirect!")
+        end
+
+        get(last_response["Location"])
+      end
+
+    private
+
+      def env_for(path, env)
+        uri = URI.parse(path)
+        uri.host ||= @default_host
+
+        env = default_env.merge(env)
+
+        env.update("HTTPS" => "on")                if URI::HTTPS === uri
+        env["X-Requested-With"] = "XMLHttpRequest" if env[:xhr]
+
+        # TODO: Remove this after Rack 1.1 has been released.
+        # Stringifying and upcasing methods has be commit upstream
+        env["REQUEST_METHOD"] ||= env[:method] ? env[:method].to_s.upcase : "GET"
+
+        if env["REQUEST_METHOD"] == "GET"
+          params = env[:params] || {}
+          params.update(parse_query(uri.query))
+
+          uri.query = build_nested_query(params)
+        elsif !env.has_key?(:input)
+          env["CONTENT_TYPE"] ||= "application/x-www-form-urlencoded"
+
+          if env[:params].is_a?(Hash)
+            if data = build_multipart(env[:params])
+              env[:input] = data
+              env["CONTENT_LENGTH"] ||= data.length.to_s
+              env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}"
+            else
+              env[:input] = params_to_string(env[:params])
+            end
+          else
+            env[:input] = env[:params]
+          end
+        end
+
+        if env.has_key?(:cookie)
+          set_cookie(env.delete(:cookie), uri)
+        end
+
+        Rack::MockRequest.env_for(uri.to_s, env)
+      end
+
+      def process_request(uri, env)
+        uri = URI.parse(uri)
+        uri.host ||= @default_host
+
+        @rack_mock_session.request(uri, env)
+
+        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)
+
+        "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
+        { "rack.test" => true, "REMOTE_ADDR" => "127.0.0.1" }.merge(@headers)
+      end
+
+      def params_to_string(params)
+        case params
+        when Hash then build_nested_query(params)
+        when nil  then ""
+        else params
+        end
+      end
+
+    end
+
+  end
+end