reqcord 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a786e42c21b820aeb729b9b401a4dc61fe61e6946e27d5f615186cbffe1b554c
-  data.tar.gz: b6fa31a65a90c88c20b51329b34cef327436890700b43fe07f43369056a18e3b
+  metadata.gz: 71c23f11e62a357bbc63bc7479cd77d65da3245062b9c0594e4b3d3dc0421fd2
+  data.tar.gz: d20cfd0db3a617adc966f2641da79c155be232baad7fb94b47db235820da3a2d
 SHA512:
-  metadata.gz: 0d4bc1a375c768e8f025f555887c341a39eb980841f6f49eb7de5ca1f5f78a82dff51ad5b554d91b434da042d73d2abe446f159d41ad4e7a54e646f5b64f428d
-  data.tar.gz: 80b569646f903b92d778af3dd00f140817b8f308213074022b8b9bc050307bf0f83ed076cfc5a2f7598c5bc9b6cde43c3f5b08c540a116c79d4cac09f83103c4
+  metadata.gz: a5c2d1ebe2463d5c3647e843d4f70b04114fe3d225a8059b5e6e09d9461945305203c5bbfe4189039a8b48edc713cf39a3d0e5cafadefb6648f62f70aaff4595
+  data.tar.gz: 98406f42d54d21b3d7854a4b36960be53cfe0293be738ca1d1e64194215920b4194c30649a730662e078d4b9558298c1ec9a13d15096207bb4a99257733d4b1f

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+## [0.1.2] - Unreleased
+
+### Added
+
+* Rails 7.1 and 7.2 are supported alongside 8.x (Ruby 3.2+); CI runs every
+  supported Ruby × Rails pair through `gemfiles/`.
+
+### Fixed
+
+* CI resolves the bundle per Ruby (no committed `Gemfile.lock`) and pins
+  `json < 3` for development: activesupport 8.1 calls `JSON.parse(json,
+  options)`, a signature json 3.0 dropped.
+
+## [0.1.1] - 2026-09-15
+
+### Added
+
+* Postman Collection v2.1 exporter (`postman/collection.json`), on by default.
+  Folders follow controller namespaces, requests come from the successful
+  captured example, every captured status is a saved response, sanitizer
+  placeholders become collection variables and `Bearer {{token}}` becomes
+  collection-level auth. Hoppscotch imports the same file.
+* Request parameters (`parameters.path/query/body`) and response fields
+  (`responses[].schema`) inferred per endpoint from accepted requests, written
+  to `dataset.json` (`schema_version: 2`) and rendered as typed tables in
+  Markdown, with closed value sets listed (`"active" | "passive"`).
+* Full route table coverage: `match … via: [:get, :post]` becomes one endpoint
+  per verb, `via: :all` is documented per verb the tests used, mounted engines
+  are walked under their mount path, `resource :cart` and `root` are titled
+  sensibly, optional segments and globs are path parameters.
+* PATCH/PUT twins of `update` fold into one endpoint (`also_methods`).
+* Resources are grouped by full controller path, so `admin/customers` and
+  `api/v2/customers` get separate directories and Postman folders.
+* The run reconciles the route table:
+  `routes = documented + uncovered + skipped`, with redirects and Rack mounts
+  counted as skipped instead of vanishing.
+* `RESOURCE=` accepts the singular (`cart`) and the controller path.
+* `route_name` (the `as:` name) is kept in the dataset.
+* `Renderers::Payload`: the JSON/form and query-flattening decisions shared by
+  cURL and Postman.
+* `test.paths`: name the directories (or files, or globs) the API tests live
+  in and Reqcord picks the runner — `bin/rails test`, `rspec`, or a plain Ruby
+  runner when the project has no `bin/rails`. `test.command` still wins when
+  given, and its globs now expand.
+* Three-resource examples (`customers`, `users`, `tasks`) in both
+  `examples/test-app` and `examples/spec-app`.
+
+### Changed
+
+* Canonical cURL comes only from captured 2xx requests; error-case payloads
+  stay as response examples.
+* Endpoint Markdown/cURL files are written only when a successful request was
+  captured; uncovered routes are listed under `uncovered_routes` and in the
+  index.
+* Form bodies render as `--data 'a=b'` / `urlencoded`, never re-invented as
+  JSON.
+* `reqcord:init` defaults `test.command` to `bin/rails test`.
+
+### Fixed
+
+* `Endpoint#add_exchange` records the response status on the request, so the
+  public API produces documented endpoints without extra setup.
+* `RequestExample.from_h` / `ResponseExample.from_h` ignore keys written by a
+  newer Reqcord.
+* A request that produced a different status is kept as its own example even
+  when sanitization makes it read like an earlier one (a right and a wrong
+  password both become `{{password}}`), so test order can no longer decide
+  whether a login endpoint counts as covered.
+* A parameter is only `required` when every accepted request carried it; a
+  request accepted with no parameters at all now counts, so `?status=` on a
+  list endpoint is documented as optional.
+* Response fields list a closed set of values only when the values look like
+  tokens (`"open" | "done"`); fixture names and SKUs that merely repeat across
+  responses are shown as one example.
+
+## [0.1.0]
+
+* RSpec request spec support (`test.framework: rspec`)
+* Runnable Minitest and RSpec examples under `examples/`
+* Minitest integration test capture for Rails 8, written to a lockable
+  capture file so parallel test workers can share it
+* Rails route discovery and endpoint grouping
+* `reqcord.yml` configuration
+* Header and body sanitization
+* Canonical `dataset.json`
+* Markdown documentation with generated cURL examples
+* Resource and API version filtering
+* Routes with no captured example are reported as documentation gaps

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+# activesupport 8.1.3.1 calls JSON.parse(json, options), a signature json 3.0
+# dropped, so every JSON request body fails to parse with a 400. Development
+# only: the gemspec leaves json to the host application and to Rails.
+gem "json", "< 3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Ahmet Saridogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.