New matchers for status, content_type, page links

Also rename matchers/matchers to matchers/dsl for clarity
and require all the matchers to be called on a response object

Author: claudiob

Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'debugger'
-
 gemspec

Gemfile.lock

@@ -8,19 +8,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    columnize (0.3.6)
     coveralls (0.7.0)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    debugger (1.6.2)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.3)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.4)
     mime-types (2.0)
     multi_json (1.8.2)
@@ -51,6 +44,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   coveralls
-  debugger
   rake
   rspec-api-matchers!

README.md

@@ -3,11 +3,11 @@ RSpec API Matchers
 
 RSpecApi::Matchers lets you express outcomes on the response of web APIs.
 
-    expect(404).to match_status(:not_found)
+    expect(response).to have_status(:not_found)
 
 More documentation and examples about RSpec Api are available at [http://rspec-api.github.io](http://rspec-api.github.io)
 
-[![Build Status](https://travis-ci.org/rspec-api/rspec-api-matchers.png)](https://travis-ci.org/rspec-api/rspec-api-matchers)
+[![Build Status](https://travis-ci.org/rspec-api/rspec-api-matchers.png?branch=master)](https://travis-ci.org/rspec-api/rspec-api-matchers)
 [![Code Climate](https://codeclimate.com/github/rspec-api/rspec-api-matchers.png)](https://codeclimate.com/github/rspec-api/rspec-api-matchers)
 [![Coverage Status](https://coveralls.io/repos/rspec-api/rspec-api-matchers/badge.png)](https://coveralls.io/r/rspec-api/rspec-api-matchers)
 [![Dependency Status](https://gemnasium.com/rspec-api/rspec-api-matchers.png)](https://gemnasium.com/rspec-api/rspec-api-matchers)
@@ -21,7 +21,9 @@ Or install yourself by running `gem install rspec-api-matchers`.
 Available matchers
 ------------------
 
-    expect(http_status_code).to match_status(http_status)
+    expect(response).to have_status(:ok)
+    expect(response).to include_content_type(:json)
+    expect(response).to have_prev_page_link
 
 How to contribute
 =================

lib/rspec-api/matchers.rb

@@ -1,3 +1,6 @@
 require 'rspec-api/matchers/version'
-require 'rspec-api/matchers/matchers'
-require 'rspec-api/matchers/match_status'
+require 'rspec-api/matchers/dsl'
+
+require 'rspec-api/matchers/status'
+require 'rspec-api/matchers/content_type'
+require 'rspec-api/matchers/prev_page_link'

lib/rspec-api/matchers/content_type.rb

@@ -0,0 +1,31 @@
+require 'rack/utils'
+
+module RSpecApi
+  module Matchers
+    class ContentType
+      def initialize(content_type)
+        @content_type = content_type
+      end
+
+      def matches?(response)
+        @headers = response.headers
+        if @headers.key? 'Content-Type'
+          @headers['Content-Type'] == @content_type
+        end
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected headers to #{description}, but got #{@headers}"
+      end
+
+      def failure_message_for_should_not
+        "expected headers not to #{description}, but was found"
+      end
+
+      def description
+        "include 'Content-Type': '#{@content_type}'"
+      end
+    end
+  end
+end

lib/rspec-api/matchers/dsl.rb

@@ -0,0 +1,53 @@
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response has the given HTTP status code.
+      #
+      # @example
+      #
+      #   # Passes if the status is 200 OK (passed as a symbol)
+      #   expect(OpenStruct.new status: 200).to match_status :ok
+      #
+      #   # Passes if the status is 200 OK (passed as a number)
+      #   expect(OpenStruct.new status: 200).to match_status 200
+      def have_status(status)
+        RSpecApi::Matchers::Status.new status
+      end
+
+      # Passes if response includes the given Content-Type JSON in the headers
+      #
+      # @example
+      #
+      #   # Passes if the headers specify that Content-Type is JSON
+      #   headers ={'Content-Type' => 'application/json; charset=utf-8'}
+      #   expect(OpenStruct.new headers: headers).to include_content_type(:json)
+      def include_content_type(type = nil)
+        content_type = case type
+        when :json then 'application/json; charset=utf-8'
+        end
+        RSpecApi::Matchers::ContentType.new content_type
+      end
+
+      # Passes if response includes the pagination Link rel=prev in the headers
+      #
+      # @example
+      #
+      #   # Passes if the headers specify the pagination link for Prev
+      #   headers = {'Link' => '<https://example.com/1>; rel="prev"'}
+      #   expect(OpenStruct.new headers: headers).to have_prev_page_link
+      def have_prev_page_link
+        RSpecApi::Matchers::PrevPageLink.new
+      end
+    end
+  end
+end
+
+require 'rspec/matchers'
+module RSpec
+  module Matchers
+    # Make RSpecApi::Matchers::DSL methods available inside RSpec
+    include ::RSpecApi::Matchers::DSL
+  end
+end

lib/rspec-api/matchers/matchers.rb

@@ -0,0 +1,26 @@
+require 'rack/utils'
+
+module RSpecApi
+  module Matchers
+    class PrevPageLink
+      def matches?(response)
+        @headers = response.headers
+        links = @headers['Link'] || '' # see http://git.io/CUz3-Q
+        links =~ %r{<.+?>. rel\="prev"}
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected headers to #{description}, but got #{@headers}"
+      end
+
+      def failure_message_for_should_not
+        "expected headers not to #{description}, but one was found"
+      end
+
+      def description
+        %Q{include a link to the previous page}
+      end
+    end
+  end
+end

lib/rspec-api/matchers/prev_page_link.rb

@@ -2,27 +2,27 @@
 
 module RSpecApi
   module Matchers
-    class MatchStatus
-      def initialize(expected_status)
-        @expected_status = expected_status
+    class Status
+      def initialize(status)
+        @expected_status = status
       end
 
-      def matches?(actual_code)
-        @actual_code = actual_code
-        actual_code == expected_code
+      def matches?(response)
+        @status = response.status
+        @status == expected_code
       end
       alias == matches?
 
       def failure_message_for_should
-        "expected #{@actual_code} to #{description}"
+        "expected HTTP status code #{expected_code}, got #{@status}"
       end
 
       def failure_message_for_should_not
-        "expected #{@actual_code} not to #{description}"
+        "expected HTTP status code not to be #{expected_code}, but it was"
       end
 
       def description
-        "be #{@expected_status}"
+        "be HTTP status code #{expected_code}"
       end
 
     private
@@ -36,7 +36,7 @@ def expected_code
       # @example
       # status_to_code(:ok) # => 200
       # status_to_code(200) # => 200
-      # status_to_code(987) # => raise
+      # status_to_code(987) # => raise ArgumentError
       def status_to_numeric_code(status)
         code = status.is_a?(Symbol) ? Rack::Utils.status_code(status) : status
         validate_status_code! code
@@ -47,7 +47,7 @@ def status_to_numeric_code(status)
       #
       # @example
       # validate_status_code!(200) # => (no error)
-      # validate_status_code!(999) # => raise
+      # validate_status_code!(999) # => raise ArgumentError
       def validate_status_code!(code)
         valid_codes = Rack::Utils::SYMBOL_TO_STATUS_CODE.values
         message = "#{code} must be a valid HTTP status code: #{valid_codes}"

lib/rspec-api/matchers/match_status.rb renamed to lib/rspec-api/matchers/status.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'include_content_type matcher' do
+  let(:response) { OpenStruct.new headers: {} }
+
+  describe 'expect(response).to include_content_type(...)' do
+    it 'passes if the response headers include the given content type' do
+      response.headers = {'Content-Type' => 'application/json; charset=utf-8'}
+      expect(response).to include_content_type(:json)
+    end
+
+    it 'fails if the response headers include a different content type' do
+      response.headers = {'Content-Type' => 'application/xml; charset=utf-8'}
+      expect {
+        expect(response).to include_content_type(:json)
+      }.to fail_with %r{expected headers to include 'Content-Type': 'application/json; charset=utf-8', but got}
+    end
+
+  end
+
+  describe 'expect(response).not_to include_content_type(...)' do
+    it 'passes if the response headers do not include content type' do
+      response.status = 204
+      expect(response).not_to include_content_type
+    end
+
+    it 'fails if the response headers include the given content type' do
+      response.headers = {'Content-Type' => 'application/json; charset=utf-8'}
+      expect {
+        expect(response).not_to include_content_type(:json)
+      }.to fail_with %q{expected headers not to include 'Content-Type': 'application/json; charset=utf-8', but was found}
+    end
+  end
+end