reqcord 0.1.0 → 0.1.1

data/lib/tasks/reqcord.rake

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+namespace :reqcord do
+  desc "Create reqcord.yml"
+  task init: :environment do
+    path = Rails.root.join("reqcord.yml")
+
+    if path.exist?
+      puts "reqcord.yml already exists."
+      next
+    end
+
+    content = <<~YAML
+      version: 1
+
+      test:
+        framework: minitest
+        command: bin/rails test
+
+      routes:
+        prefix: /api
+
+      output:
+        directory: docs/api
+        include_uncovered: false
+
+      exporters:
+        - curl
+        - markdown
+        - postman
+
+      variables:
+        base_url: http://localhost:3000
+
+      sanitize:
+        headers:
+          Authorization: "Bearer {{token}}"
+          X-Api-Key: "{{api_key}}"
+    YAML
+
+    File.write(path, content)
+
+    FileUtils.mkdir_p(
+      Rails.root.join("docs", "api")
+    )
+
+    puts "Created reqcord.yml"
+    puts "Created docs/api/"
+  end
+
+  desc "Generate API documentation from Rails integration tests"
+  task generate: :environment do
+    resources =
+      ENV.fetch("RESOURCE", "")
+         .split(",")
+         .map(&:strip)
+         .reject(&:empty?)
+
+    version = ENV["VERSION"]&.strip
+
+    version = nil if version&.empty?
+
+    Reqcord.reload_configuration!
+
+    dataset =
+      Reqcord::Generator.call(
+        resources: resources,
+        version: version
+      )
+
+    documented = dataset.curl_ready_endpoints.size
+
+    puts
+    puts "Reqcord generated API documentation."
+    puts "Endpoints: #{dataset.endpoints.size} (#{documented} with successful 2xx request)"
+    puts "Output: #{Reqcord.configuration.output_directory}"
+  end
+
+  desc "List the routes Reqcord would document"
+  task routes: :environment do
+    routes =
+      Reqcord::RouteCollector.call(
+        resources: ENV.fetch("RESOURCE", "").split(",").map(&:strip).reject(&:empty?),
+        version: ENV["VERSION"],
+        prefix: Reqcord.configuration.route_prefix
+      )
+
+    if routes.empty?
+      puts "No routes matched the configured prefix."
+      next
+    end
+
+    width = routes.map { |route| route.method.length }.max
+
+    routes.each do |route|
+      puts format("%-#{width}s %s  (%s#%s)", route.method, route.path, route.controller, route.action)
+    end
+  end
+end

data/reqcord.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/reqcord/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "reqcord"
+  spec.version = Reqcord::VERSION
+
+  spec.authors = ["Ahmet Saridogan"]
+
+  spec.summary = "Generate living API documentation from Rails integration tests"
+  spec.description = <<~DESC
+    Reqcord captures HTTP requests and responses from Rails integration tests
+    and generates static API documentation with executable cURL examples.
+  DESC
+
+  spec.homepage = "https://github.com/ahmetsaridogan/reqcord"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.start_with?(
+        "test/",
+        "spec/",
+        "features/",
+        ".git/",
+        ".github/"
+      ) || file.end_with?(".gem")
+    end
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 8.0", "< 9.0"
+  spec.add_dependency "actionpack", ">= 8.0", "< 9.0"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,14 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: reqcord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ahmet Saridogan
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Reqcord captures HTTP requests and responses from Rails integration tests
   and generates static API documentation with executable cURL examples.
@@ -16,14 +84,260 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- docs/configuration.md
+- examples/complex-spec-app/.rspec
+- examples/complex-spec-app/README.md
+- examples/complex-spec-app/app.rb
+- examples/complex-spec-app/docs/api/README.md
+- examples/complex-spec-app/docs/api/api/v1/admin/products/create.md
+- examples/complex-spec-app/docs/api/api/v1/admin/products/destroy.md
+- examples/complex-spec-app/docs/api/api/v1/admin/products/index.md
+- examples/complex-spec-app/docs/api/api/v1/admin/products/list.md
+- examples/complex-spec-app/docs/api/api/v1/auth/index.md
+- examples/complex-spec-app/docs/api/api/v1/auth/login.md
+- examples/complex-spec-app/docs/api/api/v1/cart-items/create.md
+- examples/complex-spec-app/docs/api/api/v1/cart-items/destroy.md
+- examples/complex-spec-app/docs/api/api/v1/cart-items/index.md
+- examples/complex-spec-app/docs/api/api/v1/carts/checkout.md
+- examples/complex-spec-app/docs/api/api/v1/carts/index.md
+- examples/complex-spec-app/docs/api/api/v1/carts/show.md
+- examples/complex-spec-app/docs/api/api/v1/home/index.md
+- examples/complex-spec-app/docs/api/api/v1/home/list.md
+- examples/complex-spec-app/docs/api/api/v1/notes/create.md
+- examples/complex-spec-app/docs/api/api/v1/notes/index.md
+- examples/complex-spec-app/docs/api/api/v1/notes/list.md
+- examples/complex-spec-app/docs/api/api/v1/orders/cancel.md
+- examples/complex-spec-app/docs/api/api/v1/orders/create.md
+- examples/complex-spec-app/docs/api/api/v1/orders/destroy.md
+- examples/complex-spec-app/docs/api/api/v1/orders/index.md
+- examples/complex-spec-app/docs/api/api/v1/orders/list.md
+- examples/complex-spec-app/docs/api/api/v1/orders/show.md
+- examples/complex-spec-app/docs/api/api/v1/products/index.md
+- examples/complex-spec-app/docs/api/api/v1/products/list.md
+- examples/complex-spec-app/docs/api/api/v1/products/search.md
+- examples/complex-spec-app/docs/api/api/v1/products/show.md
+- examples/complex-spec-app/docs/api/api/v1/profiles/index.md
+- examples/complex-spec-app/docs/api/api/v1/profiles/show.md
+- examples/complex-spec-app/docs/api/api/v1/profiles/update.md
+- examples/complex-spec-app/docs/api/api/v2/products/index.md
+- examples/complex-spec-app/docs/api/api/v2/products/list.md
+- examples/complex-spec-app/docs/api/curl/api/v1/admin/products/create.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/admin/products/destroy.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/admin/products/list.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/auth/login.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/cart-items/create.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/cart-items/destroy.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/carts/checkout.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/carts/show.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/home/list.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/notes/create.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/notes/list.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/orders/cancel.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/orders/create.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/orders/destroy.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/orders/list.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/orders/show.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/products/list.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/products/search.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/products/show.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/profiles/show.sh
+- examples/complex-spec-app/docs/api/curl/api/v1/profiles/update.sh
+- examples/complex-spec-app/docs/api/curl/api/v2/products/list.sh
+- examples/complex-spec-app/docs/api/dataset.json
+- examples/complex-spec-app/docs/api/postman/collection.json
+- examples/complex-spec-app/generate.rb
+- examples/complex-spec-app/reqcord.yml
+- examples/complex-spec-app/spec/requests/admin_spec.rb
+- examples/complex-spec-app/spec/requests/cart_spec.rb
+- examples/complex-spec-app/spec/requests/home_and_auth_spec.rb
+- examples/complex-spec-app/spec/requests/orders_spec.rb
+- examples/complex-spec-app/spec/requests/products_spec.rb
+- examples/complex-spec-app/spec/spec_helper.rb
+- examples/complex-test-app/README.md
+- examples/complex-test-app/app.rb
+- examples/complex-test-app/docs/api/README.md
+- examples/complex-test-app/docs/api/api/v1/admin/products/create.md
+- examples/complex-test-app/docs/api/api/v1/admin/products/destroy.md
+- examples/complex-test-app/docs/api/api/v1/admin/products/index.md
+- examples/complex-test-app/docs/api/api/v1/admin/products/list.md
+- examples/complex-test-app/docs/api/api/v1/auth/index.md
+- examples/complex-test-app/docs/api/api/v1/auth/login.md
+- examples/complex-test-app/docs/api/api/v1/cart-items/create.md
+- examples/complex-test-app/docs/api/api/v1/cart-items/destroy.md
+- examples/complex-test-app/docs/api/api/v1/cart-items/index.md
+- examples/complex-test-app/docs/api/api/v1/carts/checkout.md
+- examples/complex-test-app/docs/api/api/v1/carts/index.md
+- examples/complex-test-app/docs/api/api/v1/carts/show.md
+- examples/complex-test-app/docs/api/api/v1/home/index.md
+- examples/complex-test-app/docs/api/api/v1/home/list.md
+- examples/complex-test-app/docs/api/api/v1/notes/create.md
+- examples/complex-test-app/docs/api/api/v1/notes/index.md
+- examples/complex-test-app/docs/api/api/v1/notes/list.md
+- examples/complex-test-app/docs/api/api/v1/orders/cancel.md
+- examples/complex-test-app/docs/api/api/v1/orders/create.md
+- examples/complex-test-app/docs/api/api/v1/orders/destroy.md
+- examples/complex-test-app/docs/api/api/v1/orders/index.md
+- examples/complex-test-app/docs/api/api/v1/orders/list.md
+- examples/complex-test-app/docs/api/api/v1/orders/show.md
+- examples/complex-test-app/docs/api/api/v1/products/index.md
+- examples/complex-test-app/docs/api/api/v1/products/list.md
+- examples/complex-test-app/docs/api/api/v1/products/search.md
+- examples/complex-test-app/docs/api/api/v1/products/show.md
+- examples/complex-test-app/docs/api/api/v1/profiles/index.md
+- examples/complex-test-app/docs/api/api/v1/profiles/show.md
+- examples/complex-test-app/docs/api/api/v1/profiles/update.md
+- examples/complex-test-app/docs/api/api/v2/products/index.md
+- examples/complex-test-app/docs/api/api/v2/products/list.md
+- examples/complex-test-app/docs/api/curl/api/v1/admin/products/create.sh
+- examples/complex-test-app/docs/api/curl/api/v1/admin/products/destroy.sh
+- examples/complex-test-app/docs/api/curl/api/v1/admin/products/list.sh
+- examples/complex-test-app/docs/api/curl/api/v1/auth/login.sh
+- examples/complex-test-app/docs/api/curl/api/v1/cart-items/create.sh
+- examples/complex-test-app/docs/api/curl/api/v1/cart-items/destroy.sh
+- examples/complex-test-app/docs/api/curl/api/v1/carts/checkout.sh
+- examples/complex-test-app/docs/api/curl/api/v1/carts/show.sh
+- examples/complex-test-app/docs/api/curl/api/v1/home/list.sh
+- examples/complex-test-app/docs/api/curl/api/v1/notes/create.sh
+- examples/complex-test-app/docs/api/curl/api/v1/notes/list.sh
+- examples/complex-test-app/docs/api/curl/api/v1/orders/cancel.sh
+- examples/complex-test-app/docs/api/curl/api/v1/orders/create.sh
+- examples/complex-test-app/docs/api/curl/api/v1/orders/destroy.sh
+- examples/complex-test-app/docs/api/curl/api/v1/orders/list.sh
+- examples/complex-test-app/docs/api/curl/api/v1/orders/show.sh
+- examples/complex-test-app/docs/api/curl/api/v1/products/list.sh
+- examples/complex-test-app/docs/api/curl/api/v1/products/search.sh
+- examples/complex-test-app/docs/api/curl/api/v1/products/show.sh
+- examples/complex-test-app/docs/api/curl/api/v1/profiles/show.sh
+- examples/complex-test-app/docs/api/curl/api/v1/profiles/update.sh
+- examples/complex-test-app/docs/api/curl/api/v2/products/list.sh
+- examples/complex-test-app/docs/api/dataset.json
+- examples/complex-test-app/docs/api/postman/collection.json
+- examples/complex-test-app/generate.rb
+- examples/complex-test-app/reqcord.yml
+- examples/complex-test-app/test/integration/admin_test.rb
+- examples/complex-test-app/test/integration/cart_test.rb
+- examples/complex-test-app/test/integration/home_and_auth_test.rb
+- examples/complex-test-app/test/integration/orders_test.rb
+- examples/complex-test-app/test/integration/products_test.rb
+- examples/reqcord.yml
+- examples/spec-app/.rspec
+- examples/spec-app/README.md
+- examples/spec-app/app.rb
+- examples/spec-app/docs/api/README.md
+- examples/spec-app/docs/api/api/v1/customers/create.md
+- examples/spec-app/docs/api/api/v1/customers/index.md
+- examples/spec-app/docs/api/api/v1/customers/list.md
+- examples/spec-app/docs/api/api/v1/customers/show.md
+- examples/spec-app/docs/api/api/v1/tasks/complete.md
+- examples/spec-app/docs/api/api/v1/tasks/create.md
+- examples/spec-app/docs/api/api/v1/tasks/destroy.md
+- examples/spec-app/docs/api/api/v1/tasks/index.md
+- examples/spec-app/docs/api/api/v1/tasks/list.md
+- examples/spec-app/docs/api/api/v1/tasks/show.md
+- examples/spec-app/docs/api/api/v1/tasks/update.md
+- examples/spec-app/docs/api/api/v1/users/create.md
+- examples/spec-app/docs/api/api/v1/users/index.md
+- examples/spec-app/docs/api/api/v1/users/list.md
+- examples/spec-app/docs/api/api/v1/users/show.md
+- examples/spec-app/docs/api/curl/api/v1/customers/create.sh
+- examples/spec-app/docs/api/curl/api/v1/customers/list.sh
+- examples/spec-app/docs/api/curl/api/v1/customers/show.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/complete.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/create.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/destroy.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/list.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/show.sh
+- examples/spec-app/docs/api/curl/api/v1/tasks/update.sh
+- examples/spec-app/docs/api/curl/api/v1/users/create.sh
+- examples/spec-app/docs/api/curl/api/v1/users/list.sh
+- examples/spec-app/docs/api/curl/api/v1/users/show.sh
+- examples/spec-app/docs/api/dataset.json
+- examples/spec-app/docs/api/postman/collection.json
+- examples/spec-app/generate.rb
+- examples/spec-app/reqcord.yml
+- examples/spec-app/spec/requests/customers_spec.rb
+- examples/spec-app/spec/requests/tasks_spec.rb
+- examples/spec-app/spec/requests/users_spec.rb
+- examples/spec-app/spec/spec_helper.rb
+- examples/test-app/README.md
+- examples/test-app/app.rb
+- examples/test-app/docs/api/README.md
+- examples/test-app/docs/api/api/v1/customers/create.md
+- examples/test-app/docs/api/api/v1/customers/index.md
+- examples/test-app/docs/api/api/v1/customers/list.md
+- examples/test-app/docs/api/api/v1/customers/show.md
+- examples/test-app/docs/api/api/v1/tasks/complete.md
+- examples/test-app/docs/api/api/v1/tasks/create.md
+- examples/test-app/docs/api/api/v1/tasks/destroy.md
+- examples/test-app/docs/api/api/v1/tasks/index.md
+- examples/test-app/docs/api/api/v1/tasks/list.md
+- examples/test-app/docs/api/api/v1/tasks/show.md
+- examples/test-app/docs/api/api/v1/tasks/update.md
+- examples/test-app/docs/api/api/v1/users/create.md
+- examples/test-app/docs/api/api/v1/users/index.md
+- examples/test-app/docs/api/api/v1/users/list.md
+- examples/test-app/docs/api/api/v1/users/show.md
+- examples/test-app/docs/api/curl/api/v1/customers/create.sh
+- examples/test-app/docs/api/curl/api/v1/customers/list.sh
+- examples/test-app/docs/api/curl/api/v1/customers/show.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/complete.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/create.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/destroy.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/list.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/show.sh
+- examples/test-app/docs/api/curl/api/v1/tasks/update.sh
+- examples/test-app/docs/api/curl/api/v1/users/create.sh
+- examples/test-app/docs/api/curl/api/v1/users/list.sh
+- examples/test-app/docs/api/curl/api/v1/users/show.sh
+- examples/test-app/docs/api/dataset.json
+- examples/test-app/docs/api/postman/collection.json
+- examples/test-app/generate.rb
+- examples/test-app/reqcord.yml
+- examples/test-app/test/integration/customers_test.rb
+- examples/test-app/test/integration/tasks_test.rb
+- examples/test-app/test/integration/users_test.rb
+- lib/reqcord.rb
+- lib/reqcord/capture.rb
+- lib/reqcord/capture/collector.rb
+- lib/reqcord/capture/integration_patch.rb
+- lib/reqcord/capture/minitest_context.rb
+- lib/reqcord/capture/rspec_context.rb
+- lib/reqcord/capture/test_context.rb
+- lib/reqcord/configuration.rb
+- lib/reqcord/dataset.rb
+- lib/reqcord/endpoint.rb
+- lib/reqcord/errors.rb
+- lib/reqcord/exporters.rb
+- lib/reqcord/exporters/curl.rb
+- lib/reqcord/exporters/markdown.rb
+- lib/reqcord/exporters/postman.rb
+- lib/reqcord/generator.rb
+- lib/reqcord/railtie.rb
+- lib/reqcord/renderers/curl.rb
+- lib/reqcord/renderers/payload.rb
+- lib/reqcord/request_example.rb
+- lib/reqcord/response_example.rb
+- lib/reqcord/route_collector.rb
+- lib/reqcord/sanitizers/sanitizer.rb
+- lib/reqcord/schema.rb
+- lib/reqcord/support.rb
+- lib/reqcord/version.rb
+- lib/tasks/reqcord.rake
+- reqcord.gemspec
 homepage: https://github.com/ahmetsaridogan/reqcord
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ahmetsaridogan/reqcord
+  changelog_uri: https://github.com/ahmetsaridogan/reqcord
   source_code_uri: https://github.com/ahmetsaridogan/reqcord
-  changelog_uri: https://github.com/ahmetsaridogan/reqcord/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: