api_matchers 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5898931ec179ab8dd81ed8552603cb2b8af12579
-  data.tar.gz: bf28c99233720e3051d57ddf4b877720439214a4
+SHA256:
+  metadata.gz: e95d5e4168a2bd1c785f8b34e09bfe20bd4dcec0cc3ee0abe9a9b8aaf8ed7e3f
+  data.tar.gz: a0a040ed88113347d1ef6cb0d106fb22f1a7d8fad9cb06efcc0e8f5d1fe74972
 SHA512:
-  metadata.gz: 51c74fc5d3cd98e4d9b94a72c5c2301f1abed5bab16173eb20332b31f723ad206a4e95eb28931fcf6e260fa9b6d91d8d2cc09dbab35774363af8f958fc64ca48
-  data.tar.gz: 6c13e7610d754784d6e5d7ea21223cf52c54103d5e09fad374779a3366d2a5e3cb1d0d2a3a902fcfcd3aac086ec1c581d90a0f6ad6de56060774d6f49faaaad6
+  metadata.gz: 1c4256cd5c98b95ef782c915a39b06adad236ae0fe6a4d2b0622151556594bc6a34644d444c0a21f25f79bf43347e34b9c5c454bd046c7aa60174da24ac60ec4
+  data.tar.gz: 76bb73874d08e845c587dd880418080c03eb9ae834389f3e5ec3534da4b19cdc26c8a800698d78fd239cd07965402a9e71d6ff9967fd8638adaa492e4ee3e98b

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: false
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -17,3 +16,4 @@ test/version_tmp
 tmp
 *.DS_Store
 .rvmrc
+Gemfile.lock

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in api_matchers.gemspec
 gemspec

data/History.markdown

@@ -1,67 +1,83 @@
-## 0.6.1
+# History
 
-* Add description to matchers. This makes RSpec not complain about missing
-    description.
+## 1.0.0 (2026-02-04)
 
-## 0.6.0
-
-* Add be_forbidden matcher:
-
-```ruby
-  expect(response.status).to be_forbidden
-```
-
-* Add RSpec 3 and RSpec 2 compatibility.
-
-## 0.5.1
+### Major Release - Comprehensive API Testing Suite
 
-* Fix #have_json matcher fail message. Fix issue #20
+This release transforms API Matchers into a complete API testing toolkit with 30+ new matchers.
 
-## 0.5.0
-
-* Internals - Migrate to the RSpec expect syntax.
-
-## v0.4.0
+#### New Features
 
-* jRuby support;
-* have_json matcher;
+**HTTP Status Matchers**
+- `have_http_status(status)` - Match by code or symbol
+- `be_successful` - Match 2xx responses
+- `be_redirect` - Match 3xx responses
+- `be_client_error` - Match 4xx responses
+- `be_server_error` - Match 5xx responses
+- `be_not_found` - Match 404
+- `be_unauthorized` - Match 401
+- `be_forbidden` - Match 403
+- `be_unprocessable` - Match 422
+- `be_no_content` - Match 204
 
-## v0.1.1
+**JSON Structure Matchers**
+- `have_json_keys(*keys)` - Verify key presence
+- `have_json_type(type)` - Check value types
 
-1) Support Datetime, Date and Time comparison (Thanks to Stephen Orens).
-2) The have_node should accept boolean values (Thanks to Stephen Orens).
+**Collection Matchers**
+- `have_json_size(size)` - Verify collection sizes
+- `be_sorted_by(field)` - Check sorting with `.ascending`/`.descending`
 
-## v0.1.0
+**Header Matchers**
+- `have_header(name)` - Check headers with `.with_value`
+- `have_cors_headers` - Verify CORS compliance
+- `have_cache_control(*directives)` - Check cache directives
 
-1) Add the #including_text for have_json_node and have_xml_node matcher:
+**Pagination Matchers**
+- `be_paginated` - Check pagination metadata
+- `have_pagination_links(*types)` - Verify link types
+- `have_total_count(count)` - Match total counts
 
-    { :error => "Transaction error: Name can't be blank" }.to_json.should have_json_node(:error).including_text("Transaction error")
+**Error Response Matchers**
+- `have_error` / `have_errors` - Check error presence
+- `have_error_on(field)` - Field-specific errors with `.with_message`
 
-    "<error>Transaction error: Name can't be blank</error>".should have_xml_node(:error).including_text("Transaction error")
+**JSON:API Matchers**
+- `be_json_api_compliant` - Validate spec compliance
+- `have_json_api_data` - Check data with `.of_type`/`.with_id`
+- `have_json_api_attributes(*attrs)` - Verify attributes
+- `have_json_api_relationships(*rels)` - Check relationships
 
-## v0.0.2
+**HATEOAS Matchers**
+- `have_link(rel)` - Match HAL-style links with `.with_href`
 
-1) Put the headers method and the content type key in the setup class and that will be used by the headers matchers(be_json and be_xml).
+#### Improvements
+- Added Ruby 3.4 support
+- Modernized codebase with `frozen_string_literal` pragmas
+- Simplified internal setup pattern
+- Enhanced error messages across all matchers
+- Comprehensive README documentation with examples
 
-This:
+#### Breaking Changes
+- Minimum Ruby version is now 3.1
+- Removed deprecated configuration options
 
-    response.headers['Content-Type'].should be_in_json
-    response.headers['Content-Type'].should be_in_xml
+---
 
-With:
+## 0.6.0
 
-    APIMatchers.setup do |config|
-      config.header_method           = :headers
-      config.header_content_type_key = 'Content-Type'
-    end
+- Added `have_json` matcher for exact JSON matching
+- Added `match_json_schema` matcher for JSON Schema validation
+- Improved `have_json_node` with better nested path support
 
-Becomes:
+## 0.5.0
 
-    response.should be_in_json
-    response.should be_in_xml
+- Added support for RSpec 3
+- Added `have_xml_node` matcher
+- Improved error messages
 
-## v0.0.1
+## 0.4.0
 
-1) Headers Matchers: be_xml, be_json (**OBS:** Need to think about the setup!)
-2) HTTP Status Matchers: be_a_bad_request, be_internal_server_error, be_unauthorized, create_resource
-3) Response body Matchers: have_node, have_json_node, have_xml_node
+- Initial configurable setup
+- Added `be_json` and `be_xml` content type matchers
+- Added `have_node` matcher with format detection