RubyGems - funapi - Versions diffs - 0.1.0 - Mend

funapi 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (87) hide show

checksums.yaml +7 -0
data/.claude/25-09-01-OPENAPI_IMPLEMENTATION.md +233 -0
data/.claude/25-09-05-RESPONSE_SCHEMA.md +383 -0
data/.claude/25-09-10-OPENAPI_PLAN.md +219 -0
data/.claude/25-10-26-MIDDLEWARE_IMPLEMENTATION.md +230 -0
data/.claude/25-10-26-MIDDLEWARE_PLAN.md +353 -0
data/.claude/25-10-27-BACKGROUND_TASKS_ANALYSIS.md +325 -0
data/.claude/25-10-27-DEPENDENCY_IMPLEMENTATION_SUMMARY.md +325 -0
data/.claude/25-10-27-DEPENDENCY_INJECTION_PLAN.md +753 -0
data/.claude/25-12-24-LIFECYCLE_HOOKS_PLAN.md +421 -0
data/.claude/25-12-24-PUBLISHING_AND_DOGFOODING_PLAN.md +327 -0
data/.claude/25-12-24-TEMPLATE_RENDERING_PLAN.md +704 -0
data/.claude/DECISIONS.md +397 -0
data/.claude/PROJECT_PLAN.md +80 -0
data/.claude/TESTING_PLAN.md +285 -0
data/.claude/TESTING_STATUS.md +157 -0
data/.tool-versions +1 -0
data/AGENTS.md +416 -0
data/CHANGELOG.md +5 -0
data/CODE_OF_CONDUCT.md +132 -0
data/LICENSE.txt +21 -0
data/README.md +660 -0
data/Rakefile +10 -0
data/docs +8 -0
data/docs-site/.gitignore +3 -0
data/docs-site/Gemfile +9 -0
data/docs-site/app.rb +138 -0
data/docs-site/content/essential/handler.md +156 -0
data/docs-site/content/essential/lifecycle.md +161 -0
data/docs-site/content/essential/middleware.md +201 -0
data/docs-site/content/essential/openapi.md +155 -0
data/docs-site/content/essential/routing.md +123 -0
data/docs-site/content/essential/validation.md +166 -0
data/docs-site/content/getting-started/at-glance.md +82 -0
data/docs-site/content/getting-started/key-concepts.md +150 -0
data/docs-site/content/getting-started/quick-start.md +127 -0
data/docs-site/content/index.md +81 -0
data/docs-site/content/patterns/async-operations.md +137 -0
data/docs-site/content/patterns/background-tasks.md +143 -0
data/docs-site/content/patterns/database.md +175 -0
data/docs-site/content/patterns/dependencies.md +141 -0
data/docs-site/content/patterns/deployment.md +212 -0
data/docs-site/content/patterns/error-handling.md +184 -0
data/docs-site/content/patterns/response-schema.md +159 -0
data/docs-site/content/patterns/templates.md +193 -0
data/docs-site/content/patterns/testing.md +218 -0
data/docs-site/mise.toml +2 -0
data/docs-site/public/css/style.css +234 -0
data/docs-site/templates/layouts/docs.html.erb +28 -0
data/docs-site/templates/page.html.erb +3 -0
data/docs-site/templates/partials/_nav.html.erb +19 -0
data/examples/background_tasks_demo.rb +159 -0
data/examples/demo_middleware.rb +55 -0
data/examples/demo_openapi.rb +63 -0
data/examples/dependency_block_demo.rb +150 -0
data/examples/dependency_cleanup_demo.rb +146 -0
data/examples/dependency_injection_demo.rb +200 -0
data/examples/lifecycle_demo.rb +57 -0
data/examples/middleware_demo.rb +74 -0
data/examples/templates/layouts/application.html.erb +66 -0
data/examples/templates/todos/_todo.html.erb +15 -0
data/examples/templates/todos/index.html.erb +12 -0
data/examples/templates_demo.rb +87 -0
data/lib/funapi/application.rb +521 -0
data/lib/funapi/async.rb +57 -0
data/lib/funapi/background_tasks.rb +52 -0
data/lib/funapi/config.rb +23 -0
data/lib/funapi/database/sequel/fibered_connection_pool.rb +87 -0
data/lib/funapi/dependency_wrapper.rb +66 -0
data/lib/funapi/depends.rb +138 -0
data/lib/funapi/exceptions.rb +72 -0
data/lib/funapi/middleware/base.rb +13 -0
data/lib/funapi/middleware/cors.rb +23 -0
data/lib/funapi/middleware/request_logger.rb +32 -0
data/lib/funapi/middleware/trusted_host.rb +34 -0
data/lib/funapi/middleware.rb +4 -0
data/lib/funapi/openapi/schema_converter.rb +85 -0
data/lib/funapi/openapi/spec_generator.rb +179 -0
data/lib/funapi/router.rb +43 -0
data/lib/funapi/schema.rb +65 -0
data/lib/funapi/server/falcon.rb +38 -0
data/lib/funapi/template_response.rb +17 -0
data/lib/funapi/templates.rb +111 -0
data/lib/funapi/version.rb +5 -0
data/lib/funapi.rb +14 -0
data/sig/fun_api.rbs +499 -0
metadata +220 -0

data/docs-site/content/patterns/templates.md ADDED Viewed

@@ -0,0 +1,193 @@
+---
+title: Templates
+---
+# Templates
+Render ERB templates for HTML responses. Perfect for HTMX-powered applications.
+## Setup
+```ruby
+require 'funapi/templates'
+templates = FunApi::Templates.new(
+  directory: 'templates',
+  layout: 'layouts/application.html.erb'  # Optional default layout
+)
+```
+## Basic Rendering
+Return a `TemplateResponse` from your handler:
+```ruby
+api.get '/' do |input, req, task|
+  templates.response('home.html.erb', title: 'Home', user: current_user)
+end
+```
+Template (`templates/home.html.erb`):
+```erb
+<h1>Welcome, <%= user[:name] %>!</h1>
+<p>This is the home page.</p>
+```
+## Layouts
+### Default Layout
+Set a default layout in the constructor:
+```ruby
+templates = FunApi::Templates.new(
+  directory: 'templates',
+  layout: 'layouts/application.html.erb'
+)
+```
+Layout (`templates/layouts/application.html.erb`):
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= title %></title>
+</head>
+<body>
+  <nav>...</nav>
+  <main>
+    <%= yield_content %>
+  </main>
+  <footer>...</footer>
+</body>
+</html>
+```
+Use `yield_content` to insert the template content.
+### Disabling Layout
+For partials or HTMX responses, disable the layout:
+```ruby
+api.post '/items' do |input, req, task|
+  item = create_item(input[:body])
+  templates.response('items/_item.html.erb', layout: false, item: item, status: 201)
+end
+```
+### Different Layouts
+Use `with_layout` for route groups:
+```ruby
+templates = FunApi::Templates.new(directory: 'templates')
+public_templates = templates.with_layout('layouts/public.html.erb')
+admin_templates = templates.with_layout('layouts/admin.html.erb')
+api.get '/' do |input, req, task|
+  public_templates.response('home.html.erb', title: 'Home')
+end
+api.get '/admin' do |input, req, task|
+  admin_templates.response('admin/dashboard.html.erb', title: 'Dashboard')
+end
+```
+## Partials
+Render partials within templates:
+```erb
+<!-- templates/items/index.html.erb -->
+<ul id="items">
+  <% items.each do |item| %>
+    <%= render_partial('items/_item.html.erb', item: item) %>
+  <% end %>
+</ul>
+```
+```erb
+<!-- templates/items/_item.html.erb -->
+<li id="item-<%= item[:id] %>">
+  <%= item[:name] %>
+</li>
+```
+## With HTMX
+FunApi templates work great with HTMX:
+```ruby
+# Full page with layout
+api.get '/items' do |input, req, task|
+  items = fetch_items
+  templates.response('items/index.html.erb', items: items)
+end
+# Partial for HTMX insertion
+api.post '/items', body: ItemSchema do |input, req, task|
+  item = create_item(input[:body])
+  templates.response('items/_item.html.erb', layout: false, item: item, status: 201)
+end
+# Empty response for HTMX delete
+api.delete '/items/:id' do |input, req, task|
+  delete_item(input[:path]['id'])
+  FunApi::TemplateResponse.new('')
+end
+```
+Template with HTMX:
+```erb
+<form hx-post="/items" hx-target="#items" hx-swap="beforeend">
+  <input type="text" name="name" placeholder="New item">
+  <button type="submit">Add</button>
+</form>
+<ul id="items">
+  <% items.each do |item| %>
+    <%= render_partial('items/_item.html.erb', item: item) %>
+  <% end %>
+</ul>
+```
+## Template Variables
+Pass any variables as keyword arguments:
+```ruby
+templates.response('page.html.erb',
+  title: 'My Page',
+  user: current_user,
+  items: items,
+  flash: { notice: 'Success!' }
+)
+```
+Access them directly in templates:
+```erb
+<h1><%= title %></h1>
+<p>Hello, <%= user[:name] %></p>
+<% if flash[:notice] %>
+  <div class="notice"><%= flash[:notice] %></div>
+<% end %>
+```
+## Custom Status and Headers
+```ruby
+templates.response('error.html.erb',
+  status: 404,
+  headers: { 'X-Custom' => 'value' },
+  message: 'Not found'
+)
+```

data/docs-site/content/patterns/testing.md ADDED Viewed

@@ -0,0 +1,218 @@
+---
+title: Testing
+---
+# Testing
+Test FunApi applications with any Ruby testing framework.
+## Basic Setup with Minitest
+```ruby
+require 'minitest/autorun'
+require 'rack/test'
+require 'async'
+class TestMyApi < Minitest::Test
+  include Rack::Test::Methods
+  def app
+    @app ||= FunApi::App.new do |api|
+      api.get '/hello' do |input, req, task|
+        [{ message: 'Hello!' }, 200]
+      end
+    end
+  end
+  def async_request(method, path, **options)
+    Async do
+      send(method, path, **options)
+      last_response
+    end.wait
+  end
+  def test_hello
+    response = async_request(:get, '/hello')
+    assert_equal 200, response.status
+    assert_equal({ 'message' => 'Hello!' }, JSON.parse(response.body))
+  end
+end
+```
+## Testing with RSpec
+```ruby
+require 'rack/test'
+require 'async'
+RSpec.describe 'My API' do
+  include Rack::Test::Methods
+  let(:app) do
+    FunApi::App.new do |api|
+      api.get '/hello' do |input, req, task|
+        [{ message: 'Hello!' }, 200]
+      end
+    end
+  end
+  def async_request(method, path, **options)
+    Async do
+      send(method, path, **options)
+      last_response
+    end.wait
+  end
+  it 'returns hello' do
+    response = async_request(:get, '/hello')
+    expect(response.status).to eq(200)
+    expect(JSON.parse(response.body)).to eq({ 'message' => 'Hello!' })
+  end
+end
+```
+## Testing POST Requests
+```ruby
+def test_create_user
+  response = async_request(:post, '/users',
+    input: JSON.dump({ name: 'Alice', email: 'alice@example.com' }),
+    'CONTENT_TYPE' => 'application/json'
+  )
+  assert_equal 201, response.status
+  body = JSON.parse(response.body)
+  assert_equal 'Alice', body['created']['name']
+end
+```
+## Testing Validation Errors
+```ruby
+def test_validation_error
+  response = async_request(:post, '/users',
+    input: JSON.dump({ name: 'Alice' }),  # Missing email
+    'CONTENT_TYPE' => 'application/json'
+  )
+  assert_equal 422, response.status
+  body = JSON.parse(response.body)
+  assert body['detail'].any? { |e| e['loc'].include?('email') }
+end
+```
+## Testing with Dependencies
+Mock dependencies for testing:
+```ruby
+def app
+  @app ||= FunApi::App.new do |api|
+    api.register(:db) { MockDatabase.new }
+    api.get '/users', depends: [:db] do |input, req, task, db:|
+      [{ users: db.all_users }, 200]
+    end
+  end
+end
+class MockDatabase
+  def all_users
+    [{ id: 1, name: 'Test User' }]
+  end
+end
+def test_users_with_mock_db
+  response = async_request(:get, '/users')
+  assert_equal 200, response.status
+  assert_equal 1, JSON.parse(response.body)['users'].length
+end
+```
+## Testing Path Parameters
+```ruby
+def test_get_user_by_id
+  response = async_request(:get, '/users/123')
+  assert_equal 200, response.status
+  assert_equal '123', JSON.parse(response.body)['id']
+end
+```
+## Testing Query Parameters
+```ruby
+def test_search
+  response = async_request(:get, '/search?q=ruby&limit=10')
+  assert_equal 200, response.status
+end
+```
+## Testing Headers
+```ruby
+def test_auth_header
+  response = async_request(:get, '/protected',
+    'HTTP_AUTHORIZATION' => 'Bearer token123'
+  )
+  assert_equal 200, response.status
+end
+```
+## Integration Testing with Real Database
+```ruby
+class TestWithDatabase < Minitest::Test
+  def setup
+    @db = PG.connect(ENV['TEST_DATABASE_URL'])
+    @db.exec("TRUNCATE users")
+  end
+  def teardown
+    @db.close
+  end
+  def app
+    FunApi::App.new do |api|
+      api.register(:db) { @db }
+      # routes...
+    end
+  end
+  def test_creates_user_in_database
+    async_request(:post, '/users',
+      input: JSON.dump({ name: 'Alice', email: 'alice@test.com' }),
+      'CONTENT_TYPE' => 'application/json'
+    )
+    result = @db.exec("SELECT * FROM users WHERE email = 'alice@test.com'")
+    assert_equal 1, result.ntuples
+  end
+end
+```
+## Helper Module
+Extract common test helpers:
+```ruby
+module FunApiTestHelpers
+  def async_request(method, path, **options)
+    Async do
+      send(method, path, **options)
+      last_response
+    end.wait
+  end
+  def json_body
+    JSON.parse(last_response.body)
+  end
+  def post_json(path, body)
+    async_request(:post, path,
+      input: JSON.dump(body),
+      'CONTENT_TYPE' => 'application/json'
+    )
+  end
+end
+```

data/docs-site/mise.toml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ [tools]
2	+ ruby = "3.4.5"

data/docs-site/public/css/style.css ADDED Viewed

@@ -0,0 +1,234 @@
+/* Reset and base */
+*, *::before, *::after {
+  box-sizing: border-box;
+}
+:root {
+  --color-bg: #0a0a0a;
+  --color-bg-secondary: #141414;
+  --color-text: #e5e5e5;
+  --color-text-muted: #a3a3a3;
+  --color-primary: #3b82f6;
+  --color-primary-hover: #60a5fa;
+  --color-border: #262626;
+  --color-code-bg: #1a1a1a;
+  --font-sans: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, sans-serif;
+  --font-mono: "SF Mono", SFMono-Regular, Consolas, "Liberation Mono", Menlo, monospace;
+}
+body {
+  margin: 0;
+  font-family: var(--font-sans);
+  font-size: 16px;
+  line-height: 1.6;
+  color: var(--color-text);
+  background-color: var(--color-bg);
+}
+a {
+  color: var(--color-primary);
+  text-decoration: none;
+}
+a:hover {
+  color: var(--color-primary-hover);
+}
+/* Layout */
+.layout {
+  display: grid;
+  grid-template-columns: 260px 1fr;
+  grid-template-rows: 60px 1fr;
+  min-height: 100vh;
+}
+.header {
+  grid-column: 1 / -1;
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  padding: 0 24px;
+  border-bottom: 1px solid var(--color-border);
+  background-color: var(--color-bg);
+  position: sticky;
+  top: 0;
+  z-index: 100;
+}
+.logo {
+  font-size: 1.25rem;
+  font-weight: 700;
+  color: var(--color-text);
+}
+.header-nav {
+  display: flex;
+  gap: 24px;
+}
+.header-nav a {
+  color: var(--color-text-muted);
+}
+.header-nav a:hover {
+  color: var(--color-text);
+}
+.sidebar {
+  padding: 24px;
+  border-right: 1px solid var(--color-border);
+  background-color: var(--color-bg);
+  overflow-y: auto;
+  position: sticky;
+  top: 60px;
+  height: calc(100vh - 60px);
+}
+.content {
+  padding: 48px;
+  max-width: 800px;
+}
+/* Navigation */
+.nav-section {
+  margin-bottom: 24px;
+}
+.nav-section-title {
+  font-size: 0.75rem;
+  font-weight: 600;
+  text-transform: uppercase;
+  letter-spacing: 0.05em;
+  color: var(--color-text-muted);
+  margin: 0 0 12px 0;
+}
+.nav-list {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+.nav-item {
+  margin: 0;
+}
+.nav-link {
+  display: block;
+  padding: 6px 12px;
+  margin: 2px 0;
+  border-radius: 6px;
+  color: var(--color-text-muted);
+  font-size: 0.9rem;
+}
+.nav-link:hover {
+  color: var(--color-text);
+  background-color: var(--color-bg-secondary);
+}
+.nav-link.active {
+  color: var(--color-primary);
+  background-color: rgba(59, 130, 246, 0.1);
+}
+/* Article content */
+.article {
+  color: var(--color-text);
+}
+.article h1 {
+  font-size: 2.5rem;
+  font-weight: 700;
+  margin: 0 0 16px 0;
+  line-height: 1.2;
+}
+.article h2 {
+  font-size: 1.5rem;
+  font-weight: 600;
+  margin: 48px 0 16px 0;
+  padding-top: 24px;
+  border-top: 1px solid var(--color-border);
+}
+.article h3 {
+  font-size: 1.25rem;
+  font-weight: 600;
+  margin: 32px 0 12px 0;
+}
+.article p {
+  margin: 0 0 16px 0;
+  color: var(--color-text-muted);
+}
+.article ul, .article ol {
+  margin: 0 0 16px 0;
+  padding-left: 24px;
+  color: var(--color-text-muted);
+}
+.article li {
+  margin: 8px 0;
+}
+.article code {
+  font-family: var(--font-mono);
+  font-size: 0.9em;
+  background-color: var(--color-code-bg);
+  padding: 2px 6px;
+  border-radius: 4px;
+}
+.article pre {
+  background-color: var(--color-code-bg);
+  border-radius: 8px;
+  padding: 16px;
+  overflow-x: auto;
+  margin: 0 0 24px 0;
+}
+.article pre code {
+  background: none;
+  padding: 0;
+  font-size: 0.875rem;
+  line-height: 1.7;
+}
+.article blockquote {
+  margin: 0 0 16px 0;
+  padding: 12px 16px;
+  border-left: 3px solid var(--color-primary);
+  background-color: var(--color-bg-secondary);
+  border-radius: 0 8px 8px 0;
+}
+.article blockquote p {
+  margin: 0;
+}
+/* Code highlighting (Rouge) */
+.highlight .k, .highlight .kd, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kt { color: #c678dd; }
+.highlight .s, .highlight .s1, .highlight .s2, .highlight .sr { color: #98c379; }
+.highlight .c, .highlight .c1, .highlight .cm { color: #5c6370; font-style: italic; }
+.highlight .n, .highlight .nf, .highlight .nb { color: #61afef; }
+.highlight .nc, .highlight .no { color: #e5c07b; }
+.highlight .o, .highlight .p { color: #abb2bf; }
+.highlight .mi, .highlight .mf { color: #d19a66; }
+.highlight .ss { color: #56b6c2; }
+/* Responsive */
+@media (max-width: 768px) {
+  .layout {
+    grid-template-columns: 1fr;
+  }
+  .sidebar {
+    display: none;
+  }
+  .content {
+    padding: 24px;
+  }
+}

data/docs-site/templates/layouts/docs.html.erb ADDED Viewed

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= title %> - FunApi</title>
+  <link rel="stylesheet" href="/css/style.css">
+</head>
+<body>
+  <div class="layout">
+    <header class="header">
+      <a href="/" class="logo">FunApi</a>
+      <nav class="header-nav">
+        <a href="/docs/getting-started/quick-start">Docs</a>
+        <a href="https://github.com/gafemoyano/fun_api" target="_blank">GitHub</a>
+      </nav>
+    </header>
+    <aside class="sidebar">
+      <%= render_partial("partials/_nav.html.erb", nav: nav, current_path: current_path) %>
+    </aside>
+    <main class="content">
+      <%= yield_content %>
+    </main>
+  </div>
+</body>
+</html>

data/docs-site/templates/page.html.erb ADDED Viewed

@@ -0,0 +1,3 @@
+<article class="article">
+  <%= content %>
+</article>

data/docs-site/templates/partials/_nav.html.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<nav class="nav">
+  <% nav.each do |section| %>
+    <div class="nav-section">
+      <h3 class="nav-section-title"><%= section[:title] %></h3>
+      <ul class="nav-list">
+        <% section[:items].each do |item| %>
+          <li class="nav-item">
+            <a
+              href="/docs/<%= item[:path] %>"
+              class="nav-link<%= ' active' if current_path == item[:path] %>"
+            >
+              <%= item[:title] %>
+            </a>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+</nav>