rspec-http 0.0.2 → 0.9.0

data/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
 
+gem "rack", "~> 1.0"
 gem "ruby-debug", :platforms => [:ruby_18, :jruby]
 gem "ruby-debug19", :platforms => :ruby_19
 gem "rcov", :platforms => :ruby_18

data/README.rdoc

@@ -1,11 +1,11 @@
-= RSpec HTTP 0.0.2
+= RSpec HTTP 0.9.0
 
 (c) Copyright 2010-2011 {C42 Engineering}[http://c42.in]. All Rights Reserved.
 
 RSpec HTTP is a RSpec extension library that adds support for writing specs that cover HTTP based API (or more popularly, RESTful APIs). 
 
 To use this library, first add the rspec-http gem to your Gemfile like so:
-  gem 'rspec-http', '~> 0.0.1'
+  gem 'rspec-http', '~> 0.9'
 
 Then add the following line to your spec_helper.rb:
   require 'rspec/http'
@@ -19,15 +19,21 @@ This will make matchers such as the ones listed below available to you in your s
   response.should be_http_unprocessable_entity
   
   response.should be_http_im_a_teapot
+  
+  response.should have_header('Content-Type')
+
+  response.should have_header('Content-Type' => 'application/json')
+  
+  response.should have_header('Content-Type' => /json/)
 
 == Rails
 
-If you're using Rails (and implicitly, rspec-rails), the same matchers will also be available in your controller specs '''without''' the <code>http</code> namespace. In other words, in your controller specs you can do:
+If you're using Rails (and implicitly, rspec-rails), the same http code matchers will also be available in your controller specs *without* the <code>http</code> namespace. In other words, in your controller specs you can do:
 
-response.should be_ok
+  response.should be_ok
 
-response.should be_created
+  response.should be_created
 
-response.should be_unprocessable_entity
+  response.should be_unprocessable_entity
 
-response.should be_im_a_teapot
+  response.should be_im_a_teapot

data/lib/rspec/http.rb

@@ -3,9 +3,11 @@ require 'rspec/core'
 require 'rspec/http/status_codes'
 require 'rspec/http/response_code_matcher'
 require 'rspec/http/response_code_matchers'
+require 'rspec/http/header_matchers'
 
-require 'rspec/http/rails'# if Kernel.const_defined?('Rails')
+require 'rspec/http/rails'
 
 RSpec::configure do |config|
   config.include(RSpec::Http::ResponseCodeMatchers)
+  config.include(RSpec::Http::HeaderMatchers)
 end

data/lib/rspec/http/header_matchers.rb

@@ -0,0 +1,118 @@
+module RSpec
+  module Http
+    class HeaderMatcher
+      attr_reader :header, :expected_value, :response
+      NO_VALUE = Object.new
+      
+      def initialize(expected)
+        @header, @expected_value = expected.kind_of?(String) ? [expected, NO_VALUE] : expected.first
+      end
+      
+      def matches?(response)
+        if response[header]
+          @matcher = case expected_value
+            when String then HeaderStringMatcher.new(header, expected_value)
+            when Regexp then HeaderRegexpMatcher.new(header, expected_value)
+            when NO_VALUE then HeaderPresenceMatcher.new(header)
+            else raise RSpec::Matchers::MatcherError.new("The value for a header should be either a String or a Regexp and not of type #{expected_value.class}")
+          end
+        else
+          @matcher = HeaderPresenceMatcher.new(header)
+        end
+        @matcher.matches?(response)
+      end
+      
+      def description
+        @matcher.description
+      end
+      
+      def failure_message
+        @matcher.failure_message
+      end
+      
+      def negative_failure_message
+        @matcher.negative_failure_message
+      end
+    end
+    
+    class HeaderPresenceMatcher
+      attr_reader :header, :expected_value, :response
+      def initialize(header)
+        @header = header
+      end
+      
+      def matches?(response)
+        @response = response
+        validate
+      end
+      
+      def validate
+        response[header]
+      end
+      
+      def description
+        "Verify the presence of '#{header}' among the response headers"
+      end
+
+      def failure_message
+        "The header '#{header}' was not found"
+      end
+
+      def negative_failure_message
+        "The header '#{header}' should not have been found, but it was and it has a value of '#{response[header]}'"
+      end
+    end
+    
+    class HeaderStringMatcher < HeaderPresenceMatcher
+      def initialize(header, expected_value)
+        super(header)
+        @expected_value = expected_value
+      end
+
+      def validate
+        expected_value == response[header]
+      end
+
+      def description
+        "Verify that the value associated with '#{header}' is '#{expected_value}'"
+      end
+
+      def failure_message
+        "Expected the response header '#{header}' to have a value of '#{expected_value}' but it was '#{@response[header]}'"
+      end
+
+      def negative_failure_message
+        "Expected the response header '#{header}' to have a value that is not '#{expected_value}'"
+      end
+    end
+    
+    class HeaderRegexpMatcher < HeaderPresenceMatcher
+      def initialize(header, expected_value)
+        super(header)
+        @expected_value =  expected_value
+      end
+
+      def validate
+        expected_value =~ response[header]
+      end
+
+      def description
+        "Verify the value associated with '#{header}' matches '#{expected_value}"
+      end
+
+      def failure_message
+        "Expected the response header '#{header}' to have a value that matched #{expected_value.inspect} but it was '#{@response[header]}'"
+      end
+
+      def negative_failure_message
+        "Expected the response header '#{header}' to have a value that does not match #{expected_value.inspect} but it was '#{@response[header]}'"
+      end
+    end
+    
+    module HeaderMatchers
+      def have_header(expected)
+        HeaderMatcher.new(expected)
+      end
+    end
+  end
+end

data/lib/rspec/http/version.rb

@@ -1,7 +1,7 @@
 module RSpec # :nodoc:
   module Http # :nodoc:
     module Version # :nodoc:
-      STRING = '0.0.2'
+      STRING = '0.9.0'
     end
   end
 end

data/spec/rspec/http/header_matchers_spec.rb

@@ -0,0 +1,115 @@
+require "spec_helper"
+
+module RSpec::Http
+  describe HeaderMatchers do
+    let(:response) { Rack::Response.new }
+    before(:each) { response["Content-Type"] = "text/plain"}
+    
+    context "checking for the presence of a header" do
+      it "passes if the header is set" do
+        response.should have_header("Content-Type")
+      end
+      
+      it "fails if the header is not set" do
+        response.should_not have_header("Foobar")
+      end
+      
+      it "returns an appropriate failure message in the positive case" do
+        lambda {
+          response.should have_header("Foobar")
+        }.should fail_with("The header 'Foobar' was not found")
+      end
+
+      it "returns an appropriate failure message in the negative case" do
+        lambda {
+          response.should_not have_header("Content-Type")
+        }.should fail_with("The header 'Content-Type' should not have been found, but it was and it has a value of 'text/plain'")
+      end
+      
+      it "should be case insensitive" do
+        response.should have_header("Content-Type")
+        response.should have_header("content-type")
+        response.should have_header("Content-type")
+        response.should have_header("CONTENT-TYPE")
+      end
+    end
+    
+    context "checking the value of the header" do
+      it "passes if the value is set correctly" do
+        response.should have_header("Content-Type" => "text/plain")
+      end
+      
+      context "incorrect value" do
+        it "fails if the value is incorrect" do
+          response.should_not have_header("Content-Type" => "text/csv")
+        end
+        
+        it "returns an appropriate failure message in the positive case" do
+          lambda {
+            response.should have_header("Content-Type" => "text/csv")
+          }.should fail_with("Expected the response header 'Content-Type' to have a value of 'text/csv' but it was 'text/plain'")
+        end
+
+        it "returns an appropriate failure message in the negative case" do
+          lambda {
+            response.should_not have_header("Content-Type" => "text/plain")
+          }.should fail_with("Expected the response header 'Content-Type' to have a value that is not 'text/plain'")
+        end
+      end
+      
+      context "missing header" do
+        it "fails if the header is missing" do
+          response.should_not have_header("Foobar" => "text/csv")
+        end
+        
+        it "returns an appropriate failure message in the positive case" do
+          lambda {
+            response.should have_header("Foobar" => "text/csv")
+          }.should fail_with("The header 'Foobar' was not found")
+        end
+      end
+    end
+    
+    context "comparing the value to a regex" do
+      it "passes if the value is set correctly" do
+        response.should have_header("Content-Type" => /plain/)
+      end
+      
+      context "incorrect value" do
+        it "fails if the value is incorrect" do
+          response.should_not have_header("Content-Type" => /csv/)
+        end
+        
+        it "returns an appropriate failure message in the positive case" do
+          lambda {
+            response.should have_header("Content-Type" => /csv/)
+          }.should fail_with("Expected the response header 'Content-Type' to have a value that matched /csv/ but it was 'text/plain'")
+        end
+
+        it "returns an appropriate failure message in the negative case" do
+          lambda {
+            response.should_not have_header("Content-Type" => /plain/)
+          }.should fail_with("Expected the response header 'Content-Type' to have a value that does not match /plain/ but it was 'text/plain'")
+        end
+      end
+      
+      context "missing header" do
+        it "fails if the header is missing" do
+          response.should_not have_header("Foobar" => /csv/)
+        end
+        
+        it "returns an appropriate failure message in the positive case" do
+          lambda {
+            response.should have_header("Foobar" => "text/csv")
+          }.should fail_with("The header 'Foobar' was not found")
+        end
+      end
+      
+      it "fails if the value is something other than a String or Regexp" do
+        lambda {
+          response.should have_header("Content-Type" => [])
+        }.should raise_error(RSpec::Matchers::MatcherError, 'The value for a header should be either a String or a Regexp and not of type Array')
+      end
+    end
+  end
+end

data/spec/rspec/http/response_code_matchers_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module RSpec::Http
-  describe 'API matchers' do
+  describe ResponseCodeMatchers do
     include ResponseCodeMatchers
 
     let(:response) { mock('HTTP Response') }

data/spec/spec_helper.rb

@@ -1 +1,8 @@
-require 'rspec/http'
+require 'rspec/http'
+require 'rack'
+
+Dir['./spec/support/**/*'].each {|f| require f}
+
+RSpec::configure do |config|
+  config.color_enabled = true
+end

data/spec/support/matchers.rb

@@ -0,0 +1,8 @@
+module RSpec
+  module Matchers
+    def fail_with(message)
+      raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+    end
+  end
+end
+

metadata

@@ -1,45 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rspec-http
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.9.0
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Sidu Ponnappa
 - Niranjan Paranjape
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-21 00:00:00 +05:30
+date: 2011-08-18 00:00:00.000000000 +05:30
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152429900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
-description: RSpec HTTP is an extension library that makes it easier to write specs for HTTP/REST APIs
+  prerelease: false
+  version_requirements: *2152429900
+description: RSpec HTTP is an extension library that makes it easier to write specs
+  for HTTP/REST APIs
 email: ckponnappa@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - CHANGELOG
 - Gemfile
 - LICENCE
 - README.rdoc
 - Rakefile
 - lib/rspec/http.rb
+- lib/rspec/http/header_matchers.rb
 - lib/rspec/http/rails.rb
 - lib/rspec/http/rails/controller_example_group.rb
 - lib/rspec/http/rails/response_code_matchers.rb
@@ -48,35 +47,35 @@ files:
 - lib/rspec/http/status_codes.rb
 - lib/rspec/http/version.rb
 - rspec-http.gemspec
+- spec/rspec/http/header_matchers_spec.rb
 - spec/rspec/http/response_code_matchers_spec.rb
 - spec/spec_helper.rb
+- spec/support/matchers.rb
 has_rdoc: true
 homepage: http://c42.in/open_source
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: RSpec HTTP is an extension library that makes it easier to write specs for HTTP/REST APIs
+summary: RSpec HTTP is an extension library that makes it easier to write specs for
+  HTTP/REST APIs
 test_files: []
-