api_matchers 0.6.1 → 1.0.0

data/spec/api_matchers/headers/be_json_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe APIMatchers::Headers::BeJSON do
       response = OpenStruct.new(:response_header => { "foo-bar" => "application/xml; charset=utf-8"})
       expect {
         expect(response).to be_json
-      }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: '{"foo-bar"=>"application/xml; charset=utf-8"}'.})
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected a JSON response with 'application\/json; charset=utf-8'. Got: '\{"foo-bar".*"application\/xml; charset=utf-8"\}'\./)
     end
   end
 end

data/spec/api_matchers/headers/be_xml_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe APIMatchers::Headers::BeXML do
       response = OpenStruct.new(:response_header => { "foo-baz" => "application/json; charset=utf-8"})
       expect {
         expect(response).to be_xml
-      }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: '{"foo-baz"=>"application/json; charset=utf-8"}'.})
+      }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /expected a XML response with 'application\/xml; charset=utf-8'. Got: '\{"foo-baz".*"application\/json; charset=utf-8"\}'\./)
     end
   end
 end

data/spec/api_matchers/headers/have_cache_control_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::Headers::HaveCacheControl do
+  describe "actual.to have_cache_control" do
+    context "with single directive" do
+      it "passes when directive is present" do
+        headers = { 'Cache-Control' => 'no-cache' }
+        expect(headers).to have_cache_control(:no_cache)
+      end
+
+      it "fails when directive is not present" do
+        headers = { 'Cache-Control' => 'public' }
+        expect {
+          expect(headers).to have_cache_control(:no_cache)
+        }.to fail_with(/expected Cache-Control to include \["no-cache"\]/)
+      end
+    end
+
+    context "with multiple directives" do
+      it "passes when all directives are present" do
+        headers = { 'Cache-Control' => 'private, no-store, max-age=0' }
+        expect(headers).to have_cache_control(:private, :no_store)
+      end
+
+      it "fails when some directives are missing" do
+        headers = { 'Cache-Control' => 'private' }
+        expect {
+          expect(headers).to have_cache_control(:private, :no_store)
+        }.to fail_with(/expected Cache-Control to include \["private", "no-store"\]/)
+      end
+    end
+
+    context "with directives that have values" do
+      it "passes when max-age is present" do
+        headers = { 'Cache-Control' => 'max-age=3600' }
+        expect(headers).to have_cache_control('max-age')
+      end
+
+      it "passes when s-maxage is present" do
+        headers = { 'Cache-Control' => 's-maxage=7200, public' }
+        expect(headers).to have_cache_control('s-maxage', :public)
+      end
+    end
+
+    context "when Cache-Control header is missing" do
+      it "fails with descriptive message" do
+        headers = { 'Content-Type' => 'application/json' }
+        expect {
+          expect(headers).to have_cache_control(:no_cache)
+        }.to fail_with(/but Cache-Control header was not present/)
+      end
+    end
+
+    context "underscore to dash conversion" do
+      it "converts underscores to dashes" do
+        headers = { 'Cache-Control' => 'no-store, must-revalidate' }
+        expect(headers).to have_cache_control(:no_store, :must_revalidate)
+      end
+    end
+
+    context "case insensitivity" do
+      it "matches directives case-insensitively" do
+        headers = { 'Cache-Control' => 'NO-CACHE, PRIVATE' }
+        expect(headers).to have_cache_control(:no_cache, :private)
+      end
+
+      it "matches header name case-insensitively" do
+        headers = { 'cache-control' => 'no-cache' }
+        expect(headers).to have_cache_control(:no_cache)
+      end
+    end
+  end
+
+  describe "actual.not_to have_cache_control" do
+    it "passes when directives are not present" do
+      headers = { 'Cache-Control' => 'public' }
+      expect(headers).not_to have_cache_control(:private)
+    end
+
+    it "fails when directives are present" do
+      headers = { 'Cache-Control' => 'private, no-cache' }
+      expect {
+        expect(headers).not_to have_cache_control(:private)
+      }.to fail_with(/expected Cache-Control NOT to include \["private"\]/)
+    end
+  end
+
+  describe "with configuration" do
+    before do
+      APIMatchers.setup { |config| config.header_method = :response_headers }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.header_method = nil }
+    end
+
+    it "extracts headers from response object" do
+      response = OpenStruct.new(response_headers: { 'Cache-Control' => 'no-cache' })
+      expect(response).to have_cache_control(:no_cache)
+    end
+  end
+end

data/spec/api_matchers/headers/have_cors_headers_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::Headers::HaveCorsHeaders do
+  describe "actual.to have_cors_headers" do
+    context "with required CORS headers" do
+      it "passes when Access-Control-Allow-Origin is present" do
+        headers = { 'Access-Control-Allow-Origin' => '*' }
+        expect(headers).to have_cors_headers
+      end
+
+      it "fails when Access-Control-Allow-Origin is missing" do
+        headers = { 'Content-Type' => 'application/json' }
+        expect {
+          expect(headers).to have_cors_headers
+        }.to fail_with(/expected response to have CORS headers. Missing: \["Access-Control-Allow-Origin"\]/)
+      end
+    end
+
+    context "with for_origin" do
+      it "passes when origin matches" do
+        headers = { 'Access-Control-Allow-Origin' => 'https://example.com' }
+        expect(headers).to have_cors_headers.for_origin('https://example.com')
+      end
+
+      it "passes when origin is wildcard" do
+        headers = { 'Access-Control-Allow-Origin' => '*' }
+        expect(headers).to have_cors_headers.for_origin('https://example.com')
+      end
+
+      it "fails when origin does not match" do
+        headers = { 'Access-Control-Allow-Origin' => 'https://other.com' }
+        expect {
+          expect(headers).to have_cors_headers.for_origin('https://example.com')
+        }.to fail_with(/expected Access-Control-Allow-Origin to be 'https:\/\/example.com' or '\*'/)
+      end
+    end
+
+    context "case insensitivity" do
+      it "matches headers case-insensitively" do
+        headers = { 'access-control-allow-origin' => '*' }
+        expect(headers).to have_cors_headers
+      end
+    end
+  end
+
+  describe "actual.not_to have_cors_headers" do
+    it "passes when CORS headers are not present" do
+      headers = { 'Content-Type' => 'application/json' }
+      expect(headers).not_to have_cors_headers
+    end
+
+    it "fails when CORS headers are present" do
+      headers = { 'Access-Control-Allow-Origin' => '*' }
+      expect {
+        expect(headers).not_to have_cors_headers
+      }.to fail_with(/expected response NOT to have CORS headers, but they were present/)
+    end
+  end
+
+  describe "with configuration" do
+    before do
+      APIMatchers.setup { |config| config.header_method = :response_headers }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.header_method = nil }
+    end
+
+    it "extracts headers from response object" do
+      response = OpenStruct.new(response_headers: { 'Access-Control-Allow-Origin' => '*' })
+      expect(response).to have_cors_headers
+    end
+  end
+end

data/spec/api_matchers/headers/have_header_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::Headers::HaveHeader do
+  describe "actual.to have_header" do
+    context "with hash headers" do
+      it "passes when header is present" do
+        headers = { 'Content-Type' => 'application/json' }
+        expect(headers).to have_header('Content-Type')
+      end
+
+      it "fails when header is not present" do
+        headers = { 'Content-Type' => 'application/json' }
+        expect {
+          expect(headers).to have_header('X-Custom-Header')
+        }.to fail_with(/expected response to have header 'X-Custom-Header', but it was not present/)
+      end
+
+      it "is case-insensitive" do
+        headers = { 'content-type' => 'application/json' }
+        expect(headers).to have_header('Content-Type')
+      end
+    end
+
+    context "with with_value" do
+      it "passes when header has expected value" do
+        headers = { 'X-Request-Id' => '12345' }
+        expect(headers).to have_header('X-Request-Id').with_value('12345')
+      end
+
+      it "fails when header has different value" do
+        headers = { 'X-Request-Id' => '12345' }
+        expect {
+          expect(headers).to have_header('X-Request-Id').with_value('67890')
+        }.to fail_with(/expected header 'X-Request-Id' to have value '67890'. Got: '12345'/)
+      end
+    end
+
+    context "with matching (regex)" do
+      it "passes when header matches pattern" do
+        headers = { 'X-Request-Id' => 'req-12345-abc' }
+        expect(headers).to have_header('X-Request-Id').matching(/req-\d+-\w+/)
+      end
+
+      it "fails when header does not match pattern" do
+        headers = { 'X-Request-Id' => 'invalid' }
+        expect {
+          expect(headers).to have_header('X-Request-Id').matching(/req-\d+-\w+/)
+        }.to fail_with(/expected header 'X-Request-Id' to match/)
+      end
+    end
+  end
+
+  describe "actual.not_to have_header" do
+    it "passes when header is not present" do
+      headers = { 'Content-Type' => 'application/json' }
+      expect(headers).not_to have_header('X-Custom-Header')
+    end
+
+    it "fails when header is present" do
+      headers = { 'X-Custom-Header' => 'value' }
+      expect {
+        expect(headers).not_to have_header('X-Custom-Header')
+      }.to fail_with(/expected response NOT to have header 'X-Custom-Header', but it was present/)
+    end
+  end
+
+  describe "with configuration" do
+    before do
+      APIMatchers.setup { |config| config.header_method = :response_headers }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.header_method = nil }
+    end
+
+    it "extracts headers from response object" do
+      response = OpenStruct.new(response_headers: { 'X-Custom' => 'value' })
+      expect(response).to have_header('X-Custom')
+    end
+  end
+
+  describe "with response object having headers method" do
+    it "automatically uses headers method" do
+      response = OpenStruct.new(headers: { 'X-Custom' => 'value' })
+      expect(response).to have_header('X-Custom')
+    end
+  end
+end

data/spec/api_matchers/http_status/be_client_error_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeClientError do
+  describe "actual.to be_client_error" do
+    it "passes for status 400" do
+      expect(400).to be_client_error
+    end
+
+    it "passes for status 401" do
+      expect(401).to be_client_error
+    end
+
+    it "passes for status 403" do
+      expect(403).to be_client_error
+    end
+
+    it "passes for status 404" do
+      expect(404).to be_client_error
+    end
+
+    it "passes for status 422" do
+      expect(422).to be_client_error
+    end
+
+    it "passes for status 499" do
+      expect(499).to be_client_error
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_client_error
+      }.to fail_with("expected response to be client error (4xx). Got: 200")
+    end
+
+    it "fails for status 500" do
+      expect {
+        expect(500).to be_client_error
+      }.to fail_with("expected response to be client error (4xx). Got: 500")
+    end
+  end
+
+  describe "actual.not_to be_client_error" do
+    it "passes for non-4xx status" do
+      expect(200).not_to be_client_error
+    end
+
+    it "fails for 4xx status" do
+      expect {
+        expect(404).not_to be_client_error
+      }.to fail_with("expected response NOT to be client error (4xx). Got: 404")
+    end
+  end
+end

data/spec/api_matchers/http_status/be_forbidden_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeForbidden do
+  describe "actual.to be_forbidden" do
+    it "passes for status 403" do
+      expect(403).to be_forbidden
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_forbidden
+      }.to fail_with("expected response to be forbidden (403). Got: 200")
+    end
+
+    it "fails for status 401" do
+      expect {
+        expect(401).to be_forbidden
+      }.to fail_with("expected response to be forbidden (403). Got: 401")
+    end
+  end
+
+  describe "actual.not_to be_forbidden" do
+    it "passes for non-403 status" do
+      expect(200).not_to be_forbidden
+    end
+
+    it "fails for 403 status" do
+      expect {
+        expect(403).not_to be_forbidden
+      }.to fail_with("expected response NOT to be forbidden (403). Got: 403")
+    end
+  end
+end

data/spec/api_matchers/http_status/be_no_content_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeNoContent do
+  describe "actual.to be_no_content" do
+    it "passes for status 204" do
+      expect(204).to be_no_content
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_no_content
+      }.to fail_with("expected response to be no content (204). Got: 200")
+    end
+
+    it "fails for status 201" do
+      expect {
+        expect(201).to be_no_content
+      }.to fail_with("expected response to be no content (204). Got: 201")
+    end
+  end
+
+  describe "actual.not_to be_no_content" do
+    it "passes for non-204 status" do
+      expect(200).not_to be_no_content
+    end
+
+    it "fails for 204 status" do
+      expect {
+        expect(204).not_to be_no_content
+      }.to fail_with("expected response NOT to be no content (204). Got: 204")
+    end
+  end
+end

data/spec/api_matchers/http_status/be_not_found_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeNotFound do
+  describe "actual.to be_not_found" do
+    it "passes for status 404" do
+      expect(404).to be_not_found
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_not_found
+      }.to fail_with("expected response to be not found (404). Got: 200")
+    end
+
+    it "fails for status 500" do
+      expect {
+        expect(500).to be_not_found
+      }.to fail_with("expected response to be not found (404). Got: 500")
+    end
+
+    it "fails for other 4xx status" do
+      expect {
+        expect(401).to be_not_found
+      }.to fail_with("expected response to be not found (404). Got: 401")
+    end
+  end
+
+  describe "actual.not_to be_not_found" do
+    it "passes for non-404 status" do
+      expect(200).not_to be_not_found
+    end
+
+    it "fails for 404 status" do
+      expect {
+        expect(404).not_to be_not_found
+      }.to fail_with("expected response NOT to be not found (404). Got: 404")
+    end
+  end
+end

data/spec/api_matchers/http_status/be_redirect_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeRedirect do
+  describe "actual.to be_redirect" do
+    it "passes for status 300" do
+      expect(300).to be_redirect
+    end
+
+    it "passes for status 301" do
+      expect(301).to be_redirect
+    end
+
+    it "passes for status 302" do
+      expect(302).to be_redirect
+    end
+
+    it "passes for status 307" do
+      expect(307).to be_redirect
+    end
+
+    it "passes for status 308" do
+      expect(308).to be_redirect
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_redirect
+      }.to fail_with("expected response to be redirect (3xx). Got: 200")
+    end
+
+    it "fails for status 400" do
+      expect {
+        expect(400).to be_redirect
+      }.to fail_with("expected response to be redirect (3xx). Got: 400")
+    end
+  end
+
+  describe "actual.not_to be_redirect" do
+    it "passes for non-3xx status" do
+      expect(200).not_to be_redirect
+    end
+
+    it "fails for 3xx status" do
+      expect {
+        expect(302).not_to be_redirect
+      }.to fail_with("expected response NOT to be redirect (3xx). Got: 302")
+    end
+  end
+
+  describe "alias be_redirection" do
+    it "works as alias for be_redirect" do
+      expect(301).to be_redirection
+    end
+  end
+end

data/spec/api_matchers/http_status/be_server_error_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeServerError do
+  describe "actual.to be_server_error" do
+    it "passes for status 500" do
+      expect(500).to be_server_error
+    end
+
+    it "passes for status 501" do
+      expect(501).to be_server_error
+    end
+
+    it "passes for status 502" do
+      expect(502).to be_server_error
+    end
+
+    it "passes for status 503" do
+      expect(503).to be_server_error
+    end
+
+    it "passes for status 599" do
+      expect(599).to be_server_error
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_server_error
+      }.to fail_with("expected response to be server error (5xx). Got: 200")
+    end
+
+    it "fails for status 404" do
+      expect {
+        expect(404).to be_server_error
+      }.to fail_with("expected response to be server error (5xx). Got: 404")
+    end
+  end
+
+  describe "actual.not_to be_server_error" do
+    it "passes for non-5xx status" do
+      expect(200).not_to be_server_error
+    end
+
+    it "fails for 5xx status" do
+      expect {
+        expect(500).not_to be_server_error
+      }.to fail_with("expected response NOT to be server error (5xx). Got: 500")
+    end
+  end
+end

data/spec/api_matchers/http_status/be_successful_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeSuccessful do
+  describe "actual.to be_successful" do
+    it "passes for status 200" do
+      expect(200).to be_successful
+    end
+
+    it "passes for status 201" do
+      expect(201).to be_successful
+    end
+
+    it "passes for status 204" do
+      expect(204).to be_successful
+    end
+
+    it "passes for status 299" do
+      expect(299).to be_successful
+    end
+
+    it "fails for status 199" do
+      expect {
+        expect(199).to be_successful
+      }.to fail_with("expected response to be successful (2xx). Got: 199")
+    end
+
+    it "fails for status 300" do
+      expect {
+        expect(300).to be_successful
+      }.to fail_with("expected response to be successful (2xx). Got: 300")
+    end
+
+    it "fails for status 404" do
+      expect {
+        expect(404).to be_successful
+      }.to fail_with("expected response to be successful (2xx). Got: 404")
+    end
+
+    it "fails for status 500" do
+      expect {
+        expect(500).to be_successful
+      }.to fail_with("expected response to be successful (2xx). Got: 500")
+    end
+  end
+
+  describe "actual.not_to be_successful" do
+    it "passes for non-2xx status" do
+      expect(404).not_to be_successful
+    end
+
+    it "fails for 2xx status" do
+      expect {
+        expect(200).not_to be_successful
+      }.to fail_with("expected response NOT to be successful (2xx). Got: 200")
+    end
+  end
+
+  describe "alias be_success" do
+    it "works as alias for be_successful" do
+      expect(200).to be_success
+    end
+  end
+
+  describe "with configuration" do
+    before do
+      APIMatchers.setup { |config| config.http_status_method = :code }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.http_status_method = nil }
+    end
+
+    it "extracts status from response object" do
+      response = OpenStruct.new(code: 200)
+      expect(response).to be_successful
+    end
+  end
+end

data/spec/api_matchers/http_status/be_unauthorized_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatus::BeUnauthorized do
+  describe "actual.to be_unauthorized" do
+    it "passes for status 401" do
+      expect(401).to be_unauthorized
+    end
+
+    it "fails for status 200" do
+      expect {
+        expect(200).to be_unauthorized
+      }.to fail_with("expected response to be unauthorized (401). Got: 200")
+    end
+
+    it "fails for status 403" do
+      expect {
+        expect(403).to be_unauthorized
+      }.to fail_with("expected response to be unauthorized (401). Got: 403")
+    end
+  end
+
+  describe "actual.not_to be_unauthorized" do
+    it "passes for non-401 status" do
+      expect(200).not_to be_unauthorized
+    end
+
+    it "fails for 401 status" do
+      expect {
+        expect(401).not_to be_unauthorized
+      }.to fail_with("expected response NOT to be unauthorized (401). Got: 401")
+    end
+  end
+end