Module: RSpecApi::Matchers::ContentType

Included in:
RSpecApi::Matchers
Defined in:
lib/rspec-api/matchers/content_type/matcher.rb,
lib/rspec-api/matchers/content_type/have_content_type.rb

Defined Under Namespace

Classes: Matcher

Instance Method Summary collapse

Instance Method Details

#have_content_type(type = nil) ⇒ Object

Passes if the object includes the expected content type in the headers.

Examples:

Passes if the headers matches the provided JSON content type

require 'rspec-api-matchers'

headers ={'Content-Type' => 'application/json; charset=utf-8'}
obj = OpenStruct.new headers: headers

describe 'have_content_type' do
  include RSpecApi::Matchers::ContentType
  it { expect(obj).to have_content_type(:json) }
end

# => (rspec) 1 example, 0 failures

Parameters:

  • type (Symbol or String) (defaults to: nil) —

    The expected content type. Can either be the exact Content-Type string or just the format. The special value :any matches any content type.

See Also:



26
27
28
29
30
31
32
33
 
# File 'lib/rspec-api/matchers/content_type/have_content_type.rb', line 26

def have_content_type(type = nil)
  content_type = case type
    when :json then 'application/json; charset=utf-8'
    when :any then %r{}
    else type
  end
  RSpecApi::Matchers::ContentType::Matcher.new content_type
end