assert-response 1.0.0 → 1.1.0

data/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
 gem "rack-test"
+gem "json"
 group :development do
   gem "yard"
   gem "bundler", "~> 1.0.0"

data/README.md

@@ -32,6 +32,7 @@ or in rvm:
 
 Examples
 --------
+
     require 'minitest'
     require 'rack/test'
     require 'assert-reponse'
@@ -45,6 +46,7 @@ Examples
 _(for usage without the inclusion of Rack::Test::Methods or with Test::Unit, see AssertResponse::Methods)_
 
 And then in your test something like this:
+
     get '/myroute'
     assert_response_html 'my body'
 
@@ -58,10 +60,12 @@ This will
 
 But you may also want to...
 check just the mime type:
+
     get '/myroute'
     assert_response_is_html
 
 check for a 404 page:
+
     get '/myroute'
     assert_response_not_found_html "Not found!"
 
@@ -95,9 +99,9 @@ There is some additional sugar like
     assert_response_not_found
     assert_response_ok
 
-Everything after _assert\_response\__ is the called method of _AssertResponse_, look them up in the documentation.
+Everything after *assert\_response\_* is the called method of _AssertResponse_, look them up in the documentation.
 
-When using the _assert\_response\__ methods always the the *last_response* object is checked.
+When using the *assert\_response\_* methods always the *last_response* object is checked.
 
 If you want to check a saved response instead, you may use the little DSL
 
@@ -111,6 +115,11 @@ If you want to check a saved response instead, you may use the little DSL
 
 Now inside the code block you may use the methods of _AssertResponse_ (but without the *assert\_response\_* prefixes).
 
+TODO
+----
+
+Maybe add some sugar for cookie testing.
+
 
 Contributing to assert-response
 -------------------------------

data/Rakefile

@@ -20,6 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.email = "Base64.decode64('bGludXhAbWFyY3JlbmVhcm5zLmRl\n')"
   gem.authors = ["Marc Rene Arns"]
   gem.add_runtime_dependency 'rack-test'
+  gem.add_runtime_dependency 'json'
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/assert-response.rb

@@ -1,7 +1,71 @@
+require 'json'
+
 class AssertResponse
+
+  # to allow checking against a parsed json object
+  # the code is instance_exec'd in the context of this 
+  # object. you may call the assert- methods here (even without assert-
+  # prefix and you have the json object by calling the json method
+  class AssertJSON
+    def initialize(test_obj, json_string)
+      @test_obj = test_obj
+      @json_obj = JSON.parse(json_string)
+    end
+
+    def json
+      @json_obj
+    end
+
+    def method_missing(meth, *args, &code)
+      if @test_obj.respond_to? meth
+        @test_obj.send meth, *args, &code
+      elsif @test_obj.respond_to? :"assert_#{meth}"
+        @test_obj.send :"assert_#{meth}", *args, &code
+      else
+        @test_obj.send :method_missing, *args.unshift(meth), &code
+      end
+    end
+  end
   
   # error class, raised when a 404 status but another status was expected
-  class Status404 < Exception ; end
+  class HttpError < Exception ; end
+  class Status404 < HttpError ; end
+
+  # Hash with names for the http 1.1 status codes
+  HTTP_STATUS_CODES = {
+    :ok => 200,
+    :not_found => 404,
+    :created => 201,
+    :bad_request => 400,
+    :unauthorized => 401,
+    :forbidden => 403,
+    :timeout => 408,
+    :gateway_timeout => 504,
+    :bad_gateway => 502,
+    :conflict => 409,
+    :gone => 410,
+    :too_many_requests => 429,
+    :upgrade_required => 426,
+    :teapot => 418,
+    :no_response  => 444,
+    :bandwidth_limit_exceeded => 509,
+    :maintenance => 503,
+    :insufficient_storage => 507,
+    :http_version_not_supported => 505,
+    :payment_required  => 402,
+    :not_modified => 304,
+    :see_other => 303,
+    :found => 302,
+    :moved => 301,
+    :reset => 205,
+    :reload => 205,
+    :no_content => 204,
+    :too_large => 413,
+    :uri_too_long => 414,
+    :unsupported_media_type => 415,
+    :not_implemented => 501,
+    :error => 500
+  }
 
   # Hash to collection available content-types (prefilled with the Rack::Mime::MIME_TYPES)
   #
@@ -24,13 +88,23 @@ class AssertResponse
   # add content_type 'text/plain' as :text
   AssertResponse.add_content_type :text, 'text/plain'
 
+  # Adds custom http code to 
+  # {AssertResponse::HTTP_STATUS_CODES}. We would then have all the test methods for the status code 
+  # @param [Symbol] name name of the http status code
+  # @param [Integer] code code number (eg. 404)
+  def AssertResponse.add_http_status_code(name, code)
+    raise "invalid code" unless code =~ /^[1-9][0-9]{2}$/
+    HTTP_STATUS_CODES.update(name => code)
+  end
+
   # Creates a new {AssertResponse} Object. Usually you will want to +instance_exec+ some code on it.
   #
   # @param [Object] delegate_to the test object that has all the +assert_equal+, +assert_match+ and +assert+ methods that we need
   # @param [MockResponse, Response] response the response object that is checked
-  def initialize(delegate_to, response, &code)
+  def initialize(delegate_to, response, request, &code)
     @delegate_to = delegate_to
     @response = response
+    @request = request
     @error = nil
     check_for_error()
   end
@@ -50,43 +124,105 @@ class AssertResponse
     when /^not_found_(.+)$/ # not_found_[content_type] methods
       if ctype = CONTENT_TYPES[$1.to_sym]
         content_type ctype
-        return body(args.first, 404)
+        return body(args.first, :not_found)
       end
     else
-      if ctype = CONTENT_TYPES[meth] # [content_type] methods
-        ok()
+      if ctype = CONTENT_TYPES[meth] # [content_type] methods        
         content_type ctype
-        return body(args.first)
+        return body(*args)
+      elsif HTTP_STATUS_CODES[meth]
+        return status HTTP_STATUS_CODES[meth]
       end
     end
     @delegate_to.send meth, *args, &code
   end
 
-  # Checks if status is 200.
+  # Checks if status is some of the ok-codes.
   def ok()
-    status 200
+    status /^20[0-9]$/
+  end
+
+  # shortcut to the path of the last request
+  def path_info
+    @request.env['PATH_INFO']
+  end
+
+  # shortcut to the url of the last request
+  def url
+    @request.url
+  end
+
+  # shortcut to the query string of the last request
+  def query_string
+    @request.env['QUERY_STRING']
+  end
+
+  # this method checks for content_type json and then it has 2 modes
+  # if no code block is given, it acts as "body"
+  # if a code block is given, arg1 is the status and arg2 is ignored
+  # the code is executed in the context of a AssertJSON object, where
+  # you can use the usual assert- methods (even without assert prefix)
+  # and the json method gives you the parsed json object to test against
+  def json(arg1=nil, arg2=nil, &code)
+    content_type CONTENT_TYPES[:json]
+    if code
+      status arg1
+      file, line, rest = caller[0].split(':', 3)
+      AssertJSON.new(@delegate_to, @response.body).instance_exec(file, line.to_i, &code)
+    elsif arg1      
+      body arg1, arg2
+    end
   end
 
   # Checks if the status is +status+. For status other then 5xx and error is raised if the response has an error.
   # For status other than 404 an error Status404 is thrown if response status is 404
+  # If we do not check for a 4xx or 5xx code an StatusError is raised if such a code is found and the body is given as error message
   #
-  # @params [Integer] status the expected status
+  # @params [Integer, Regexp, Symbol] status the expected status (if it's a symbol it is looked up in HTTP_STATUS_CODES
   def status(status)
-    raise_error() unless status =~ /^5/ or @response.errors.empty?
-    Kernel.raise(Status404, "not found") unless status == 404 or @response.status != 404
-    assert_equal(status, @response.status)
-  end
-
-  # Checks if the response status is 404.
-  def not_found()
-    status 404
+    return ok() if status.nil?
+    if status.is_a?(Symbol)
+      raise "unknown status #{status}" unless HTTP_STATUS_CODES[status]
+      status = HTTP_STATUS_CODES[status]
+    end
+    look_for_5xx = case status
+    when Regexp
+      ((50.to_s =~ status) || (51.to_s =~ status))? true : false
+    else
+      (status.to_s =~ /^5/) ? true : false
+    end
+    look_for_404 = case status
+    when Regexp
+      (404.to_s =~ status) ? true : false
+    else
+      (status.to_s == "404") ? true : false
+    end
+    look_for_4xx = case status
+    when Regexp
+      ((40.to_s =~ status) || (41.to_s =~ status))? true : false
+    else
+      (status.to_s =~ /^4/) ? true : false
+    end
+    raise_error() unless look_for_5xx or @response.errors.empty?
+    Kernel.raise(Status404, "(#{url}) not found") unless look_for_404 or @response.status != 404    
+    
+    case status
+    when Regexp
+      raise_http_error() if @response.status.to_s =~ /^5/ and !look_for_5xx
+      raise_http_error() if @response.status.to_s =~ /^4/ and !look_for_4xx
+      assert_match(status, @response.status.to_s)
+    else
+      raise_http_error() if @response.status.to_s =~ /^5/ and status.to_s !~ /^5/
+      raise_http_error() if @response.status.to_s =~ /^4/ and status.to_s !~ /^4/
+      assert_equal(status, @response.status)
+    end
   end
 
   # Checks if the status is 302, and the header "Location" matches the +pattern+
   # 
   # @param [String,Regexp] pattern the pattern to match against.  
   def redirect(pattern)
-    status 302
+    status /^30(2|3|7)$/
     header 'Location', pattern
   end    
 
@@ -97,8 +233,10 @@ class AssertResponse
   def header(key, pattern=:exists)
     if pattern == :exists
       assert !@response.headers[key].to_s.empty?, "Header '#{key}' not found"
-    else
+    elsif pattern.is_a? Regexp
       assert_match normalize_pattern(pattern), @response.headers[key].to_s
+    else
+      assert_equal pattern.to_s, @response.headers[key].to_s
     end
   end
 
@@ -106,14 +244,14 @@ class AssertResponse
   #
   # @param [String,Regexp] pattern the pattern to match against.
   def content_type(pattern)
-    header 'Content-Type', pattern
+    header 'Content-Type', normalize_pattern(pattern)
   end
 
   # Check if body matches +pattern+ and status is +status+.
   #
   # @param [String,Regexp] pattern the pattern to match against.
   # @params [Integer] status the expected status (default 200, see {#ok})
-  def body(pattern, status=200)
+  def body(pattern, status=nil)
     status(status)
     assert_match normalize_pattern(pattern), @response.body
   end
@@ -128,10 +266,28 @@ class AssertResponse
     assert !@error.nil?
   end
 
+  # redirect to get
+  def see_other(pattern)
+    status 303
+    header 'Location', pattern
+  end
+
+  # temporary move
+  def found(pattern)
+    status 302
+    header 'Location', pattern
+  end
+
+  # permanent move
+  def moved(pattern)
+    status 301
+    header 'Location', pattern
+  end
+
   private
 
   def normalize_pattern(pattern)
-    pattern.is_a?(Regexp) ? pattern : /#{Regexp.escape(pattern.to_s)}/
+    pattern.is_a?(Regexp) ? pattern : /#{Regexp.escape(pattern.to_s)}/i
   end
 
   def check_for_error
@@ -139,6 +295,7 @@ class AssertResponse
   end
 
   def normalize_error
+    #p [:l, last_request] #@response
     message, backtrace = @response.errors.split "\n", 2
     backtrace = backtrace.split
     err_klass, message = message.split '-', 2
@@ -151,6 +308,10 @@ class AssertResponse
     Kernel.raise @error
   end      
 
+  def raise_http_error()
+    raise HttpError, "#{@response.status} (#{url}) #{@response.body}"
+  end
+
   # these methods are included in Rack::Test::Methods to be used in a Test Class
   #
   # call assert_response with a code block to use the DSL (methods from {AssertResponse})
@@ -237,7 +398,7 @@ class AssertResponse
     # @see AssertResponse
     def method_missing(meth, *args, &code)
       if meth.to_s =~ /^assert_response_(.+)$/
-        AssertResponse.new(self, last_response).send($1.to_sym, *args)
+        AssertResponse.new(self, last_response, last_request).send($1.to_sym, *args, &code)
       else
         super
       end
@@ -245,9 +406,9 @@ class AssertResponse
 
     # creates an {AssertResponse} Object and +instance_exec+ the code (DSL) in it  
     # @see AssertResponse
-    def assert_response(response=last_response, &code) 
+    def assert_response(response=last_response, request=last_request, &code) 
       file, line, rest = caller[0].split(':', 3)
-      AssertResponse.new(self, response).instance_exec(file, line.to_i, &code)
+      AssertResponse.new(self, response, request).instance_exec(file, line.to_i, &code)
     end
   end
 end

data/test/test_assert-response.rb

@@ -2,6 +2,8 @@ require 'backports' if RUBY_VERSION =~ /1.8/
 require_relative "helper.rb"
 require_relative File.join("..", "lib", "assert-response.rb")
 
+ENV['RACK_ENV'] = 'test'
+
 include Rack::Test::Methods
 
 def handle_exception(env)
@@ -32,6 +34,13 @@ def app
     when '/json'
       headers['Content-Type'] = 'application/json' 
       body = '{"response":"ok"}'
+    when '/create_with_json'
+      headers['Content-Type'] = 'application/json' 
+      body = '{"id":"new_id"}'
+      status = 201
+    when '/bad_request'
+      body = 'you are so bad!'
+      status = 400
     when '/text'
       headers['Content-Type'] = 'text/plain'
       body = 'foo-bar and others' 
@@ -43,11 +52,17 @@ def app
     when '/redirect'
       headers['Location'] = '/target'
       status = 302
+    when '/moved'
+      headers['Location'] = '/target'
+      status = 301
     when '/arg_error'
       handle_exception(env) do
         tester 234
       end
       status = 500
+    when '/error_code'
+      status = 500
+      body = "some error message"
     when '/not_found'
       status = 404
       body = "<body>Not found</body>"
@@ -58,9 +73,18 @@ def app
   }
 end
 
+describe "without assert-response" do
+  it "should raise no error" do
+    get '/error'
+    assert_equal 500, last_response.status
+  end
+  
+end
+
 describe "assert-response" do
   it "should check json" do
     get '/json'
+    assert_response_body /ok/, :ok
     assert_response_json /ok/
   end
 
@@ -69,6 +93,32 @@ describe "assert-response" do
     assert_response_html '<body>'
   end
 
+  it "should check for status regex" do
+    get '/html'
+    assert_response_status /200/
+  end
+
+  it "should check for json body content" do
+    get '/json'
+    assert_response_json do
+      assert_equal "ok", json["response"]
+    end
+  end
+
+  it "should check for json body content for a created ressource" do
+    get '/create_with_json'
+    assert_response_json :created do
+      assert_equal "new_id", json["id"]
+    end
+  end
+
+  it "should check for json body content without assert prefix" do
+    get '/create_with_json'
+    assert_response_json :created do
+      equal "new_id", json["id"]
+    end
+  end
+
   it "should check css" do
     get '/css'
     assert_response_css 'color'
@@ -92,6 +142,11 @@ describe "assert-response" do
     assert_response_redirect '/target'
   end
 
+  it "should check moved" do
+    get '/moved'
+    assert_response_moved '/target'
+  end
+
   it "should not find missing pages" do
     get '/settings'
     assert_response_not_found
@@ -107,6 +162,12 @@ describe "assert-response" do
     assert_response_raises ArgumentError
   end
 
+  it "check server-error without a raised error" do
+    get '/error_code'
+    assert_response_error
+    assert_response_body "some error message", :error
+  end
+
   it "should raise errors for some other sinatra errors" do
     get '/error'
     assert_raises RuntimeError do
@@ -133,3 +194,99 @@ describe "assert-response" do
     assert_response_not_found_html "<body>Not found</body>"
   end
 end
+
+describe "status tests" do
+  it "should check for ok status (20x) if asked to do, or if nil is passed to status" do
+    get '/html'
+    assert_response_ok
+    assert_response_status nil
+    assert_response_status 200
+
+    get '/create_with_json'
+    assert_response_ok
+    assert_response_status nil
+    assert_response_status 201
+
+    get '/not_found'
+    assert_raises AssertResponse::Status404 do
+      assert_response_ok
+    end
+
+    assert_raises AssertResponse::Status404 do
+      assert_response_status nil
+    end
+
+    assert_raises AssertResponse::Status404 do
+      assert_response_status 201
+    end
+  end
+
+  it "check for a named status if asked to do so" do
+    get '/create_with_json'
+    assert_response_created
+    assert_response_status :created
+    assert_response_status 201
+
+    get '/not_found'
+  end
+
+  it "check for a regexp status if asked to do so" do
+    get '/create_with_json'
+    assert_response_created
+    assert_response_status /20/
+
+    get '/html'
+    assert_response_status 200
+    assert_response_status /20/
+  end
+
+  it "should raise an error if asked for a non 4xx/5xx code and a 4xx/5xx code is returned" do
+
+    { 
+      '/error_code' => AssertResponse::HttpError, 
+      '/error' => RuntimeError, 
+      '/not_found' => AssertResponse::Status404
+    }.each do |url,error|
+
+      get url
+
+      assert_raises error do
+        assert_response_ok
+      end
+      
+      assert_raises error do
+        assert_response_status nil
+      end
+   
+      assert_raises error do
+        assert_response_created
+      end
+
+      assert_raises error do
+        assert_response_status :moved
+      end
+
+      assert_raises error do
+        assert_response_status /^3/
+      end      
+    end    
+    
+  end
+
+  it "should raise no error if asked for a 4xx/5xx code and a 4xx/5xx code is returned" do
+
+    get '/error_code'
+
+    assert_response_status 500
+    assert_response_status /^5/
+    assert_response_status :error
+
+    get '/not_found'
+
+    assert_response_status 404
+    assert_response_status /^4/
+    assert_response_status :not_found
+  
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assert-response
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000Z
+date: 2011-12-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &16339740 !ruby/object:Gem::Requirement
+  requirement: &22354580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16339740
+  version_requirements: *22354580
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &22354100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22354100
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &16337540 !ruby/object:Gem::Requirement
+  requirement: &22353580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16337540
+  version_requirements: *22353580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16336000 !ruby/object:Gem::Requirement
+  requirement: &22353100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *16336000
+  version_requirements: *22353100
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &16333600 !ruby/object:Gem::Requirement
+  requirement: &22352580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *16333600
+  version_requirements: *22352580
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &16332240 !ruby/object:Gem::Requirement
+  requirement: &22352100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16332240
+  version_requirements: *22352100
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &16329940 !ruby/object:Gem::Requirement
+  requirement: &22351620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22351620
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &22351140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16329940
+  version_requirements: *22351140
 description: 
 email: ! 'Base64.decode64(''bGludXhAbWFyY3JlbmVhcm5zLmRl
 
@@ -111,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -850628618767669317
+      hash: 2830934270081401981
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: