reqcord 0.1.1 → 0.1.3

data/examples/test-app/generate.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# Stands in for `bin/rails reqcord:generate`, which this single file example
-# has no `bin/rails` to run.
-require_relative "app"
-
-dataset = Reqcord::Generator.call(
-  resources: ENV.fetch("RESOURCE", "").split(",").map(&:strip).reject(&:empty?),
-  version: ENV["VERSION"]
-)
-
-puts
-puts "Endpoints: #{dataset.endpoints.size} (#{dataset.documented_endpoints.size} covered by tests)"
-puts "Output: #{Reqcord.configuration.output_directory}"

data/examples/test-app/reqcord.yml

@@ -1,28 +0,0 @@
-version: 1
-
-test:
-  framework: minitest
-  # A directory is enough. There is no bin/rails here, so Reqcord runs every
-  # *_test.rb beneath it itself; in a Rails app it runs `bin/rails test <path>`.
-  paths:
-    - test/integration
-
-routes:
-  prefix: /api
-
-output:
-  directory: docs/api
-
-exporters:
-  - curl
-  - markdown
-  - postman
-
-variables:
-  base_url: http://localhost:3000
-
-sanitize:
-  headers:
-    Authorization: "Bearer {{token}}"
-  body:
-    password: "{{password}}"

data/examples/test-app/test/integration/customers_test.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-# Ordinary Rails integration tests. Nothing here mentions Reqcord: the
-# documentation is generated from the requests these tests already make.
-require_relative "../../app"
-require "minitest/autorun"
-
-class CustomersTest < ActionDispatch::IntegrationTest
-  def auth
-    { "Authorization" => "Bearer eyJhbGciOiJIUzI1NiJ9.super-secret" }
-  end
-
-  test "lists customers" do
-    get "/api/v1/customers", params: { per_page: 1 }, headers: auth, as: :json
-
-    assert_response :ok
-  end
-
-  test "shows customer" do
-    get "/api/v1/customers/1", headers: auth, as: :json
-
-    assert_response :ok
-  end
-
-  test "returns not found for an unknown customer" do
-    get "/api/v1/customers/999", headers: auth, as: :json
-
-    assert_response :not_found
-  end
-
-  test "creates an active customer" do
-    post "/api/v1/customers",
-         params: { customer: { name: "Ada Lovelace", email: "ada@example.com", status: "active" } },
-         headers: auth,
-         as: :json
-
-    assert_response :created
-  end
-
-  test "creates a passive customer" do
-    post "/api/v1/customers",
-         params: { customer: { name: "Grace Hopper", email: "grace@example.com", status: "passive" } },
-         headers: auth,
-         as: :json
-
-    assert_response :created
-  end
-
-  test "rejects an unknown status" do
-    post "/api/v1/customers",
-         params: { customer: { name: "Ada Lovelace", email: "ada@example.com", status: "inactive" } },
-         headers: auth,
-         as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "rejects a customer without an email" do
-    post "/api/v1/customers",
-         params: { customer: { name: "Ada Lovelace", email: "", status: "active" } },
-         headers: auth,
-         as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "requires authentication" do
-    get "/api/v1/customers", as: :json
-
-    assert_response :unauthorized
-  end
-end

data/examples/test-app/test/integration/tasks_test.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-# Ordinary Rails integration tests. Nothing here mentions Reqcord: the
-# documentation is generated from the requests these tests already make.
-require_relative "../../app"
-require "minitest/autorun"
-
-class TasksTest < ActionDispatch::IntegrationTest
-  test "lists tasks" do
-    get "/api/v1/tasks", as: :json
-
-    assert_response :ok
-  end
-
-  test "lists open tasks" do
-    get "/api/v1/tasks", params: { status: "open" }, as: :json
-
-    assert_response :ok
-  end
-
-  test "lists done tasks" do
-    get "/api/v1/tasks", params: { status: "done" }, as: :json
-
-    assert_response :ok
-  end
-
-  test "shows a task" do
-    get "/api/v1/tasks/1", as: :json
-
-    assert_response :ok
-  end
-
-  test "returns not found for an unknown task" do
-    get "/api/v1/tasks/999", as: :json
-
-    assert_response :not_found
-  end
-
-  test "creates a high priority task" do
-    post "/api/v1/tasks", params: { task: { title: "Review the release", priority: "high" } }, as: :json
-
-    assert_response :created
-  end
-
-  test "creates a low priority task" do
-    post "/api/v1/tasks", params: { task: { title: "Water the plants", priority: "low" } }, as: :json
-
-    assert_response :created
-  end
-
-  test "rejects a task without a title" do
-    post "/api/v1/tasks", params: { task: { title: "", priority: "high" } }, as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "rejects an unknown priority" do
-    post "/api/v1/tasks", params: { task: { title: "Anything", priority: "urgent" } }, as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "updates a task" do
-    patch "/api/v1/tasks/1", params: { task: { title: "Write better docs" } }, as: :json
-
-    assert_response :ok
-  end
-
-  test "completes a task" do
-    post "/api/v1/tasks/1/complete", as: :json
-
-    assert_response :ok
-  end
-
-  test "deletes a task" do
-    delete "/api/v1/tasks/3", as: :json
-
-    assert_response :no_content
-  end
-end

data/examples/test-app/test/integration/users_test.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-# Ordinary Rails integration tests. Nothing here mentions Reqcord: the
-# documentation is generated from the requests these tests already make.
-require_relative "../../app"
-require "minitest/autorun"
-
-class UsersTest < ActionDispatch::IntegrationTest
-  def auth
-    { "Authorization" => "Bearer eyJhbGciOiJIUzI1NiJ9.super-secret" }
-  end
-
-  test "lists users" do
-    get "/api/v1/users", params: { per_page: 1 }, headers: auth, as: :json
-
-    assert_response :ok
-  end
-
-  test "shows user" do
-    get "/api/v1/users/1", headers: auth, as: :json
-
-    assert_response :ok
-  end
-
-  test "returns not found for an unknown user" do
-    get "/api/v1/users/999", headers: auth, as: :json
-
-    assert_response :not_found
-  end
-
-  test "creates an active user" do
-    post "/api/v1/users",
-         params: { user: { name: "Ada Lovelace", email: "ada@example.com", status: "active" } },
-         headers: auth,
-         as: :json
-
-    assert_response :created
-  end
-
-  test "creates a inactive user" do
-    post "/api/v1/users",
-         params: { user: { name: "Grace Hopper", email: "grace@example.com", status: "inactive" } },
-         headers: auth,
-         as: :json
-
-    assert_response :created
-  end
-
-  test "rejects an unknown status" do
-    post "/api/v1/users",
-         params: { user: { name: "Ada Lovelace", email: "ada@example.com", status: "passive" } },
-         headers: auth,
-         as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "rejects a user without an email" do
-    post "/api/v1/users",
-         params: { user: { name: "Ada Lovelace", email: "", status: "active" } },
-         headers: auth,
-         as: :json
-
-    assert_response :unprocessable_entity
-  end
-
-  test "requires authentication" do
-    get "/api/v1/users", as: :json
-
-    assert_response :unauthorized
-  end
-end