reqcord 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a786e42c21b820aeb729b9b401a4dc61fe61e6946e27d5f615186cbffe1b554c
-  data.tar.gz: b6fa31a65a90c88c20b51329b34cef327436890700b43fe07f43369056a18e3b
+  metadata.gz: 2203f5a2f9ca4548874caf3a40a93c8fbe5a73e6f9d916f6162cbd843fec4341
+  data.tar.gz: 05b67df4290c1e6aeba3e5a29416df3f5e779c2d5fcf3eef6cfd76e4a8fabdb8
 SHA512:
-  metadata.gz: 0d4bc1a375c768e8f025f555887c341a39eb980841f6f49eb7de5ca1f5f78a82dff51ad5b554d91b434da042d73d2abe446f159d41ad4e7a54e646f5b64f428d
-  data.tar.gz: 80b569646f903b92d778af3dd00f140817b8f308213074022b8b9bc050307bf0f83ed076cfc5a2f7598c5bc9b6cde43c3f5b08c540a116c79d4cac09f83103c4
+  metadata.gz: 11602f1a318f214c92cec4f68723d47ba8b237fa8fb4d7a46e2fe2628168441e9ab3ec8f1f8cf73922f2b3bc5ac0954876e2904e03f9454fd8c99faa7648141f
+  data.tar.gz: a273eb86d0b0939215a3375054239c2361d1520c0bf2c8faa8429ae15a9db8c1d923cf005731bd8690da67529496217c807d75abb760f2d963588109273f9e9e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/pkg/
+/tmp/
+*.gem
+/test/dummy/tmp/
+/test/dummy/docs/
+/test/dummy/log/
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,77 @@
+# Changelog
+
+## [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,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,171 @@
+PATH
+  remote: .
+  specs:
+    reqcord (0.1.1)
+      actionpack (>= 8.0, < 9.0)
+      railties (>= 8.0, < 9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (8.1.3.1)
+      actionview (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.1.3.1)
+      activesupport (= 8.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (8.1.3.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    builder (3.3.0)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    crass (1.0.7)
+    drb (2.2.3)
+    erb (6.0.7)
+    erubi (1.13.1)
+    i18n (1.15.2)
+      concurrent-ruby (~> 1.0)
+    io-console (0.9.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.2)
+    logger (1.7.0)
+    loofah (2.25.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    nokogiri (1.19.4-arm64-darwin)
+      racc (~> 1.4)
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    racc (1.8.1)
+    rack (3.2.7)
+    rack-session (2.1.2)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.3.1)
+      rack (>= 3)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.1.3.1)
+      actionpack (= 8.1.3.1)
+      activesupport (= 8.1.3.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
+      zeitwerk (~> 2.6)
+    rake (13.4.2)
+    rbs (4.2.0)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.0.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    reline (0.7.0)
+      io-console (~> 0.5)
+    securerandom (0.4.1)
+    thor (1.5.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (1.1.1)
+    useragent (0.16.11)
+    zeitwerk (2.8.3)
+
+PLATFORMS
+  arm64-darwin-24
+
+DEPENDENCIES
+  minitest
+  rake
+  reqcord!
+
+CHECKSUMS
+  actionpack (8.1.3.1)
+  actionview (8.1.3.1)
+  activesupport (8.1.3.1)
+  base64 (0.3.0)
+  bigdecimal (4.1.2)
+  builder (3.3.0)
+  concurrent-ruby (1.3.8)
+  connection_pool (3.0.2)
+  crass (1.0.7)
+  drb (2.2.3)
+  erb (6.0.7)
+  erubi (1.13.1)
+  i18n (1.15.2)
+  io-console (0.9.2)
+  irb (1.18.0)
+  json (2.21.2)
+  logger (1.7.0)
+  loofah (2.25.2)
+  minitest (6.0.6)
+  nokogiri (1.19.4-arm64-darwin)
+  pp (0.6.4)
+  prettyprint (0.2.0)
+  prism (1.9.0)
+  racc (1.8.1)
+  rack (3.2.7)
+  rack-session (2.1.2)
+  rack-test (2.2.0)
+  rackup (2.3.1)
+  rails-dom-testing (2.3.0)
+  rails-html-sanitizer (1.7.1)
+  railties (8.1.3.1)
+  rake (13.4.2)
+  rbs (4.2.0)
+  rdoc (8.0.0)
+  reline (0.7.0)
+  reqcord (0.1.1)
+  securerandom (0.4.1)
+  thor (1.5.0)
+  tsort (0.2.0)
+  tzinfo (2.0.6)
+  uri (1.1.1)
+  useragent (0.16.11)
+  zeitwerk (2.8.3)
+
+BUNDLED WITH
+  4.0.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.