rack-test 0.6.3 → 0.8.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98d93b9da867444521efc5c2d82d14b37c2b5743324865f96d2f6c0603ad8256
+  data.tar.gz: 3f78a90b58f6de6582088185f995195841995e9b2a0a9518a93ecee081eb8416
+SHA512:
+  metadata.gz: 3bd23e7ffcfa4ab19ad2966f36bcab31f49f3ea7f819fb81f15ce874437d8c6b96c6844f40499512042166b007d940b819b44e8d978ba4001f77fe515225f529
+  data.tar.gz: 9d0479de503ae1a74f2aa9263b39dfdabf1745c17bed3fc18e6aaf757bf0b7428510f26a08c0021090ec98f8125eca74fb19e9f7f19eef41a94dd9847a441472

data/History.md

@@ -0,0 +1,229 @@
+## 0.8.3 / 2018-02-27
+
+* Bug fixes:
+  * Do not set Content-Type if params are explicitly set to nil
+    (Bartek Bułat #212). Fixes #200.
+  * Fix `UploadedFile#new` regression
+    (Per Lundberg #215)
+
+* Minor enhancements
+  * [CI] Test against Ruby 2.5 (Nicolas Leger #217)
+
+## 0.8.2 / 2017-11-21
+
+* Bug fixes:
+  * Bugfix for `UploadedFile.new` unintended API breakage.
+    (Per Lundberg #210)
+
+## 0.8.0 / 2017-11-20
+
+* Known Issue
+  * In `UploadedFile.new`, when passing e.g. a `Pathname` object,
+    errors can be raised (eg. `ArgumentError: Missing original_filename
+    for IO`, or `NoMethodError: undefined method 'size'`) See #207, #209.
+* Minor enhancements
+  * Add a required_ruby_version of >= 2.2.2, similar to rack 2.0.1.
+    (Samuel Giddins #194)
+  * Remove new line from basic auth. (Felix Kleinschmidt #185)
+  * Rubocop fixes (Per Lundberg #196)
+  * Add how to install rack-test from github to README. (Jun Aruga #189)
+  * Update CodeClimate badges (Toshimaru #195)
+  * Add the ability to create Test::UploadedFile instances without
+    the file system (Adam Milligan #149)
+  * Add custom_request, remove duplication (Johannes Barre #184)
+  * README.md: Added note about how to post JSON (Per Lundberg #198)
+  * README.md: Added version badge (Per Lundberg #199)
+* Bug fixes
+  * Bugfix for Cookies with multiple paths (Kyle Welsby #197)
+
+## 0.7.0 / 2017-07-10
+
+* Major enhancements
+  * The project URL changed to https://github.com/rack-test/rack-test
+    (Per Lundberg, Dennis Sivia, Jun Aruga)
+  * Rack 2 compatible. (Trevor Wennblom #81, Vít Ondruch, Jun Aruga #151)
+* Minor enhancements
+  * Port to RSpec 3. (Murahashi [Matt] Kenichi #70, Antonio Terceiro #134)
+  * Add Travis CI (Johannes Barre #108, Jun Aruga #161)
+  * Don't append an ampersand when params are empty (sbilharz, #157)
+  * Allow symbol access to cookies (Anorlondo448 #156)
+  * README: Added Travis badge (Olivier Lacan, Per Lundberg #146)
+  * `Rack::Test::Utils#build_multipart`: Allow passing a third parameter
+    to force multipart (Koen Punt #142)
+  * Allow better testing of cookies (Stephen Best #133)
+  * make `build_multipart` work without mixing in `Rack::Test::Utils`
+    (Aaron Patterson #131)
+  * Add license to gemspec (Jordi Massaguer Pla #72, Anatol Pomozov #89,
+    Anatol Pomozov #90, Johannes Barre #109, Mandaryn #115,
+    Chris Marshall #120, Robert Reiz #126, Nic Benders #127, Nic Benders #130)
+  * Feature/bulk pr for readme updates (Patrick Mulder #65,
+    Troels Knak-Nielsen #74, Jeff Casimir #76)
+  * Switch README format to Markdown (Dennis Sivia #176)
+  * Convert History.txt to Markdown (Dennis Sivia #179)
+  * Stop generating gemspec file. (Jun Aruga #181)
+  * Fix errors at rake docs and whitespace. (Jun Aruga #183)
+  * Ensure Rack::Test::UploadedFile closes its tempfile file descriptor
+    on GC (Michael de Silva #180)
+  * Change codeclimate URL correctly. (Jun Aruga #186)
+* Bug fixes
+  * Initialize digest_username before using it. (Guo Xiang Tan #116,
+    John Drago #124, Mike Perham #154)
+  * Do not set Content-Type for DELETE requests (David Celis #132)
+  * Adds support for empty arrays in params. (Cedric Röck, Tim Masliuchenko
+    #125)
+  * Update README code example quotes to be consistent. (Dmitry Gritsay #112)
+  * Update README not to recommend installing gem with sudo. (T.J. Schuck #87)
+  * Set scheme when using ENV to enable SSL (Neil Ang #155)
+  * Reuse request method and parameters on HTTP 307 redirect. (Martin Mauch
+    #138)
+
+## 0.6.3 / 2015-01-09
+
+* Minor enhancements
+  * Expose an env helper for persistently configuring the env as needed
+    (Darío Javier Cravero #80)
+  * Expose the tempfile of UploadedFile (Sytse Sijbrandij #67)
+* Bug fixes
+  * Improve support for arrays of hashes in multipart forms (Murray Steele #69)
+  * Improve test for query strings (Paul Grayson #66)
+
+## 0.6.2 / 2012-09-27
+
+* Minor enhancements
+  * Support HTTP PATCH method (Marjan Krekoten' #33)
+  * Preserve the exact query string when possible (Paul Grayson #63)
+  * Add a #delete method to CookieJar (Paul Grayson #63)
+* Bug fixes
+  * Fix HTTP Digest authentication when the URI has query params
+  * Don't append default ports to HTTP_HOST (David Lee #57)
+
+## 0.6.1 / 2011-07-27
+
+* Bug fixes
+  * Fix support for params with arrays in multipart forms (Joel Chippindale)
+  * Add `respond_to?` to `Rack::Test::UploadedFile` to match `method_missing` (Josh Nichols)
+  * Set the Referer header on requests issued by follow_redirect! (Ryan Bigg)
+
+## 0.6.0 / 2011-05-03
+
+* Bug fixes
+  * Add support for HTTP OPTIONS verb (Paolo "Nusco" Perrotta)
+  * Call #finish on MockResponses if it's available (Aaron Patterson)
+  * Allow HTTP_HOST to be set via #header (Geoff Buesing)
+
+## 0.5.7 / 2011-01-01
+* Bug fixes
+  * If no URI is present, include all cookies (Pratik Naik)
+
+## 0.5.6 / 2010-09-25
+
+* Bug fixes
+  * Use parse_nested_query for parsing URI like Rack does (Eugene Bolshakov)
+  * Don't depend on ActiveSupport extension to String (Bryan Helmkamp)
+  * Do not overwrite HTTP_HOST if it is set (Krekoten' Marjan)
+
+## 0.5.5 / 2010-09-22
+
+* Bug fixes
+  * Fix encoding of file uploads on Ruby 1.9 (Alan Kennedy)
+  * Set env["HTTP_HOST"] when making requests (Istvan Hoka)
+
+## 0.5.4 / 2010-05-26
+
+* Bug fixes
+  * Don't stomp on Content-Type's supplied via #header (Bryan Helmkamp)
+  * Fixed build_multipart to allow for arrays of files (Louis Rose)
+  * Don't raise an error if raw cookies contain a blank line (John Reilly)
+  * Handle parameter names with brackets properly (Tanner Donovan)
+
+## 0.5.3 / 2009-11-27
+
+* Bug fixes
+  * Fix cookie matching for subdomains (Marcin Kulik)
+
+## 0.5.2 / 2009-11-13
+
+* Bug fixes
+  * Call close on response body after iteration, not before (Simon Rozet)
+  * Add missing require for time in cookie_jar.rb (Jerry West)
+
+## 0.5.1 / 2009-10-27
+
+* Bug fixes
+  * Escape cookie values (John Pignata)
+  * Close the response body after each request, as per the Rack spec (Elomar França)
+
+## 0.5.0 / 2009-09-19
+
+* Bug fixes
+  * Set HTTP_X_REQUESTED_WITH in the Rack env when a request is made with :xhr => true (Ben Sales)
+  * Set headers in the Rack env in HTTP_USER_AGENT form
+  * Rack::Test now generates no Ruby warnings
+
+## 0.4.2 / 2009-09-01
+
+* Minor enhancements
+  * Merge in rack/master's build_multipart method which covers additional cases
+  * Accept raw :params string input and merge it with the query string
+  * Stringify and upcase request method (e.g. :post => "POST") (Josh Peek)
+* Bug fixes
+  * Properly convert hashes with nil values (e.g. :foo => nil becomes simply "foo", not "foo=")
+  * Prepend a slash to the URI path if it doesn't start with one (Josh Peek)
+  * 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/README.md

@@ -0,0 +1,140 @@
+# Rack::Test
+[![Gem Version](https://badge.fury.io/rb/rack-test.svg)](https://badge.fury.io/rb/rack-test)
+[<img src="https://travis-ci.org/rack-test/rack-test.svg?branch=master" />](https://travis-ci.org/rack-test/rack-test)
+[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate)
+[![Test Coverage](https://codeclimate.com/github/codeclimate/codeclimate/badges/coverage.svg)](https://codeclimate.com/github/codeclimate/codeclimate/coverage)
+
+Code: https://github.com/rack-test/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.
+
+## 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
+
+## Supported platforms
+
+* 2.2.2+
+* 2.3
+* 2.4
+* JRuby 9.1.+
+
+If you are using Ruby 1.8, 1.9 or JRuby 1.7, use rack-test 0.6.3.
+
+## Examples
+(The examples use `Test::Unit` but it's equally possible to use `rack-test` with other testing frameworks like `rspec`.)
+
+```ruby
+require "test/unit"
+require "rack/test"
+
+class HomepageTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All responses are OK']] }
+    builder = Rack::Builder.new
+    builder.run app
+  end
+
+  def test_response_is_ok
+    get '/'
+
+    assert last_response.ok?
+    assert_equal last_response.body, 'All responses are OK'
+  end
+
+  def set_request_headers
+    header 'Accept-Charset', 'utf-8'
+    get '/'
+
+    assert last_response.ok?
+    assert_equal last_response.body, 'All responses are OK'
+  end
+
+  def test_response_is_ok_for_other_paths
+    get '/other_paths'
+
+    assert last_response.ok?
+    assert_equal last_response.body, 'All responses are OK'
+  end
+
+  def post_with_json
+    # No assertion in this, we just demonstrate how you can post a JSON-encoded string.
+    # By default, Rack::Test will use HTTP form encoding if you pass in a Hash as the
+    # parameters, so make sure that `json` below is already a JSON-serialized string.
+    post(uri, json, { 'CONTENT_TYPE' => 'application/json' })
+  end
+end
+```
+
+If you want to test one app in isolation, you just return that app as shown above. But if you want to test the entire app stack, including middlewares, cascades etc. you need to parse the app defined in config.ru.
+
+```ruby
+OUTER_APP = Rack::Builder.parse_file("config.ru").first
+
+class TestApp < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    OUTER_APP
+  end
+
+  def test_root
+    get "/"
+    assert last_response.ok?
+  end
+end
+```
+
+
+## Install
+
+To install the latest release as a gem:
+
+```
+gem install rack-test
+```
+
+Or via Bundler:
+
+```
+gem 'rack-test', require: 'rack/test'
+```
+
+Or to install unreleased version via Bundler:
+
+```
+gem 'rack-test', github: 'rack-test', branch: 'master'
+```
+
+## Authors
+
+- Contributions from Bryan Helmkamp, Simon Rozet, Pat Nakajima and others
+- Much of the original code was extracted from Merb 1.0's request helper
+
+## License
+`rack-test` is released under the [MIT License](MIT-LICENSE.txt).
+
+## Contribution
+
+Contributions are welcome. Please make sure to:
+
+* Use a regular forking workflow
+* Write tests for the new or changed behaviour
+* Provide an explanation/motivation in your commit message / PR message
+* Ensure History.txt is updated
+
+## Releasing
+
+* Ensure `History.md` is up-to-date
+* Bump VERSION in lib/rack/test/version.rb
+* bundle exec thor :release
+* Updated the [GitHub releases page](https://github.com/rack-test/rack-test/releases)

data/lib/rack/mock_session.rb

@@ -1,5 +1,4 @@
 module Rack
-
   class MockSession # :nodoc:
     attr_writer :cookie_jar
     attr_reader :default_host
@@ -25,16 +24,16 @@ module Rack
     end
 
     def request(uri, env)
-      env["HTTP_COOKIE"] ||= cookie_jar.for(uri)
+      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)
+      @last_response = MockResponse.new(status, headers, body, env['rack.errors'].flush)
       body.close if body.respond_to?(:close)
 
-      cookie_jar.merge(last_response.headers["Set-Cookie"], uri)
+      cookie_jar.merge(last_response.headers['Set-Cookie'], uri)
 
-      @after_request.each { |hook| hook.call }
+      @after_request.each(&:call)
 
       if @last_response.respond_to?(:finish)
         @last_response.finish
@@ -46,21 +45,19 @@ module Rack
     # 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
+      raise Rack::Test::Error, '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
+      raise Rack::Test::Error, '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/cookie_jar.rb

@@ -1,9 +1,8 @@
-require "uri"
-require "time"
+require 'uri'
+require 'time'
 
 module Rack
   module Test
-
     class Cookie # :nodoc:
       include Rack::Utils
 
@@ -21,8 +20,8 @@ module Rack
         @name, @value = parse_query(@name_value_raw, ';').to_a.first
         @options = parse_query(options, ';')
 
-        @options["domain"]  ||= (uri.host || default_host)
-        @options["path"]    ||= uri.path.sub(/\/[^\/]*\Z/, "")
+        @options['domain']  ||= (uri.host || default_host)
+        @options['path']    ||= uri.path.sub(/\/[^\/]*\Z/, '')
       end
 
       def replaces?(other)
@@ -41,21 +40,25 @@ module Rack
 
       # :api: private
       def domain
-        @options["domain"]
+        @options['domain']
       end
 
       def secure?
-        @options.has_key?("secure")
+        @options.key?('secure')
+      end
+
+      def http_only?
+        @options.key?('HttpOnly')
       end
 
       # :api: private
       def path
-        @options["path"].strip || "/"
+        ([*@options['path']].first.split(',').first || '/').strip
       end
 
       # :api: private
       def expires
-        Time.parse(@options["expires"]) if @options["expires"]
+        Time.parse(@options['expires']) if @options['expires']
       end
 
       # :api: private
@@ -67,19 +70,17 @@ module Rack
       def valid?(uri)
         uri ||= default_uri
 
-        if uri.host.nil?
-          uri.host = @default_host
-        end
+        uri.host = @default_host if uri.host.nil?
 
         real_domain = domain =~ /^\./ ? domain[1..-1] : domain
-        (!secure? || (secure? && uri.scheme == "https")) &&
-        uri.host =~ Regexp.new("#{Regexp.escape(real_domain)}$", Regexp::IGNORECASE) &&
-        uri.path =~ Regexp.new("^#{Regexp.escape(path)}")
+        (!secure? || (secure? && uri.scheme == 'https')) &&
+          uri.host =~ Regexp.new("#{Regexp.escape(real_domain)}$", Regexp::IGNORECASE) &&
+          uri.path =~ Regexp.new("^#{Regexp.escape(path)}")
       end
 
       # :api: private
       def matches?(uri)
-        ! expired? && valid?(uri)
+        !expired? && valid?(uri)
       end
 
       # :api: private
@@ -88,16 +89,23 @@ module Rack
         [name, path, domain.reverse] <=> [other.name, other.path, other.domain.reverse]
       end
 
-    protected
+      def to_h
+        @options.merge(
+          'value'    => @value,
+          'HttpOnly' => http_only?,
+          'secure'   => secure?
+        )
+      end
+      alias to_hash to_h
+
+      protected
 
       def default_uri
-        URI.parse("//" + @default_host + "/")
+        URI.parse('//' + @default_host + '/')
       end
-
     end
 
     class CookieJar # :nodoc:
-
       # :api: private
       def initialize(cookies = [], default_host = DEFAULT_HOST)
         @default_host = default_host
@@ -108,13 +116,17 @@ module Rack
       def [](name)
         cookies = hash_for(nil)
         # TODO: Should be case insensitive
-        cookies[name] && cookies[name].value
+        cookies[name.to_s] && cookies[name.to_s].value
       end
 
       def []=(name, value)
         merge("#{name}=#{Rack::Utils.escape(value)}")
       end
 
+      def get_cookie(name)
+        hash_for(nil).fetch(name, nil)
+      end
+
       def delete(name)
         @cookies.reject! do |cookie|
           cookie.name == name
@@ -126,7 +138,7 @@ module Rack
 
         if raw_cookies.is_a? String
           raw_cookies = raw_cookies.split("\n")
-          raw_cookies.reject!{|c| c.empty? }
+          raw_cookies.reject!(&:empty?)
         end
 
         raw_cookies.each do |raw_cookie|
@@ -146,7 +158,7 @@ module Rack
 
       # :api: private
       def for(uri)
-        hash_for(uri).values.map { |c| c.raw }.join(';')
+        hash_for(uri).values.map(&:raw).join(';')
       end
 
       def to_hash
@@ -156,10 +168,10 @@ module Rack
           cookies[name] = cookie.value
         end
 
-        return cookies
+        cookies
       end
 
-    protected
+      protected
 
       def hash_for(uri = nil)
         cookies = {}
@@ -173,10 +185,8 @@ module Rack
           cookies[cookie.name] = cookie if !uri || cookie.matches?(uri)
         end
 
-        return cookies
+        cookies
       end
-
     end
-
   end
 end

data/lib/rack/test/methods.rb

@@ -1,8 +1,7 @@
-require "forwardable"
+require 'forwardable'
 
 module Rack
   module Test
-
     # This module serves as the primary integration point for using Rack::Test
     # in a testing environment. It depends on an app method being defined in the
     # same context, and provides the Rack::Test API methods (see Rack::Test::Session
@@ -56,26 +55,27 @@ module Rack
         @_current_session_names ||= [:default]
       end
 
-      METHODS = [
-        :request,
-        :get,
-        :post,
-        :put,
-        :patch,
-        :delete,
-        :options,
-        :head,
-        :follow_redirect!,
-        :header,
-        :env,
-        :set_cookie,
-        :clear_cookies,
-        :authorize,
-        :basic_authorize,
-        :digest_authorize,
-        :last_response,
-        :last_request
-      ]
+      METHODS = %i[
+        request
+        get
+        post
+        put
+        patch
+        delete
+        options
+        head
+        custom_request
+        follow_redirect!
+        header
+        env
+        set_cookie
+        clear_cookies
+        authorize
+        basic_authorize
+        digest_authorize
+        last_response
+        last_request
+      ].freeze
 
       def_delegators :current_session, *METHODS
     end

data/lib/rack/test/mock_digest_request.rb

@@ -1,14 +1,12 @@
 module Rack
   module Test
-
     class MockDigestRequest # :nodoc:
-
       def initialize(params)
         @params = params
       end
 
       def method_missing(sym)
-        if @params.has_key? k = sym.to_s
+        if @params.key? k = sym.to_s
           return @params[k]
         end
 
@@ -22,8 +20,6 @@ module Rack
       def response(password)
         Rack::Auth::Digest::MD5.new(nil).send :digest, self, password
       end
-
     end
-
   end
 end