respondo 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb9a42fee14d341990b700fd36592d17757abccb2c1a7cac406177a0eee259f
-  data.tar.gz: 31885b2ddb68d296998f82900273e36a76ec896c4ca691291544db0242932508
+  metadata.gz: fb5118a5648863ec54d68805d897485f40da5b81b9b628b9b9a08d6ee2f735d7
+  data.tar.gz: 4282b491b0bd587ba668e7accaf19f6dfb879cc61261d64d744de69c803ae8a0
 SHA512:
-  metadata.gz: 6be63c0f45ece4fd72f6a4880f624cc875616e77fda1321474c59ba8f8709fc20a2187a8989661ce21d1d59a6815084020b7f570e7c1d3e4809191c32bfa3dd7
-  data.tar.gz: 8fc37dd22d9052f5d7a4fb85de3e607053358bc4ad00a7fb2cb5c991aabb77726cb35c4aef8a68ad9459ec9229ccf8e5a3a16a7b16d97dc4f3c54d35d00d7735
+  metadata.gz: 4ae4daae47ef9c2c66388fc6d8f3a915b66439208fafa25b7046234813229704de0e53863921f2b4e2100817218b2a315ef40a564c5f672a9848194e55814906
+  data.tar.gz: 86a9ecb6864c1bba75dc4d47941bd0f80c837f4dbc72ed424526e1dad3f05ead92b738a417a239f3fb160e7043fc465418fe6670948be147399ea90ee3ce85d8

data/CHANGELOG.md

@@ -1,5 +1,224 @@
 # Changelog
 
+## [2.1.0] — Interactive Install Generator
+
+### Added
+
+#### `rails generate respondo:install` — interactive setup wizard
+A new generator that walks developers through configuration interactively at
+install time, writing a fully commented `config/initializers/respondo.rb` so
+they never have to read the README to get started.
+
+**Usage:**
+```bash
+rails generate respondo:install
+```
+
+**What the wizard collects:**
+
+| Prompt | Config written |
+|--------|---------------|
+| Project / app name | Comment header in initializer |
+| API version | Auto-added to `config.default_meta` |
+| Default success message | `config.default_success_message` |
+| Default error message | `config.default_error_message` |
+| Include request ID? | `config.include_request_id` |
+| Camelize keys? | `config.camelize_keys` |
+| Extra global meta fields | `config.default_meta` (merged with api_version) |
+| Custom serializer stub? | Commented example added to initializer |
+
+**Example output — `config/initializers/respondo.rb`:**
+```ruby
+# frozen_string_literal: true
+
+# Respondo initializer — MyApp
+# Generated by: rails generate respondo:install
+# Respondo version: 2.1.0
+
+Respondo.configure do |config|
+
+  # ── Messages ─────────────────────────────────────────────────────────
+  config.default_success_message = "Success"
+  config.default_error_message   = "Something went wrong"
+
+  # ── Request ID ───────────────────────────────────────────────────────
+  config.include_request_id = true
+
+  # ── Key Format ───────────────────────────────────────────────────────
+  config.camelize_keys = true
+
+  # ── Global Meta ──────────────────────────────────────────────────────
+  config.default_meta = {
+    api_version: "v1",
+    platform: "mobile"
+  }
+
+  # ── Custom Serializer ────────────────────────────────────────────────
+  # config.serializer = ->(obj) { MySerializer.new(obj).as_json }
+
+end
+```
+
+**Generator file location:**
+```
+lib/generators/respondo/install/install_generator.rb
+```
+
+Rails auto-discovers this path — no manual require needed. Re-running the
+generator overwrites the existing initializer with fresh answers.
+
+---
+
+## [2.0.0] — Full HTTP Coverage
+
+### Breaking Changes
+
+#### Pagination API completely redesigned
+The old approach auto-detected Kaminari, Pagy, and WillPaginate collections and
+extracted pagination metadata silently. This was over-engineered — Respondo is a
+**response formatter**, not a pagination library.
+
+**Before (1.x):**
+```ruby
+# Kaminari / WillPaginate — auto-detected from collection
+render_ok(data: @users)
+
+# Pagy — required a separate pagy: argument
+render_ok(data: @users, pagy: @pagy)
+
+# Suppress pagination
+render_ok(data: @users, pagination: false)
+```
+
+**After (2.x):**
+```ruby
+# All libraries — you build the hash, Respondo places it in meta
+render_ok(
+  data:       @users,
+  pagination: {
+    current_page: @users.current_page,
+    per_page:     @users.limit_value,   # Kaminari
+    total_pages:  @users.total_pages,
+    total_count:  @users.total_count,
+    next_page:    @users.next_page,
+    prev_page:    @users.prev_page
+  }
+)
+
+# No pagination — just omit the param
+render_ok(data: @user)
+```
+
+**Why:** The caller already has the paginated data in hand. Building the hash
+themselves is one extra step, but it makes the behavior completely explicit,
+works with any library (or no library), and removes a hidden dependency from
+the gem's internals.
+
+**Migration steps:**
+1. Delete any `pagy:` arguments — replace with `pagination: { ... }` hash
+2. Delete any `pagination: false` arguments — just omit `pagination:` instead
+3. Remove `pagination.rb` from your gem if you vendored it
+
+#### `render_success` signature change
+- `pagy:` parameter removed
+- `pagination:` parameter type changed from `Boolean` → `Hash | nil`
+
+**Before:** `render_success(data:, message:, meta:, code:, pagy:, pagination: Boolean, status:)`  
+**After:** `render_success(data:, message:, meta:, code:, pagination: Hash | nil, status:)`
+
+---
+
+### Added
+
+#### 1xx — Informational helpers (all new)
+These return a JSON body for API consistency. Note that 1xx responses are
+protocol-level and most HTTP clients will not receive them as normal responses.
+
+| Helper | Code |
+|--------|------|
+| `render_continue` | 100 |
+| `render_switching_protocols` | 101 |
+| `render_processing` | 102 |
+| `render_early_hints` | 103 |
+
+#### 2xx — Additional success helpers
+| Helper | Code |
+|--------|------|
+| `render_non_authoritative` | 203 |
+| `render_reset_content` | 205 |
+| `render_already_reported` | 208 |
+| `render_im_used` | 226 |
+
+#### 3xx — Redirect helpers (all new)
+Pass the target URL via `meta: { redirect_url: "..." }`.
+
+| Helper | Code |
+|--------|------|
+| `render_multiple_choices` | 300 |
+| `render_moved_permanently` | 301 |
+| `render_found` | 302 |
+| `render_see_other` | 303 |
+| `render_not_modified` | 304 |
+| `render_temporary_redirect` | 307 |
+| `render_permanent_redirect` | 308 |
+
+#### 4xx — Additional client error helpers
+| Helper | Code |
+|--------|------|
+| `render_proxy_auth_required` | 407 |
+| `render_length_required` | 411 |
+| `render_payload_too_large` | 413 |
+| `render_uri_too_long` | 414 |
+| `render_range_not_satisfiable` | 416 |
+| `render_expectation_failed` | 417 |
+| `render_im_a_teapot` | 418 |
+| `render_misdirected_request` | 421 |
+| `render_failed_dependency` | 424 |
+| `render_too_early` | 425 |
+| `render_upgrade_required` | 426 |
+| `render_precondition_required` | 428 |
+| `render_request_header_fields_too_large` | 431 |
+| `render_unavailable_for_legal_reasons` | 451 |
+
+#### 5xx — Additional server error helpers
+| Helper | Code |
+|--------|------|
+| `render_http_version_not_supported` | 505 |
+| `render_variant_also_negotiates` | 506 |
+| `render_insufficient_storage` | 507 |
+| `render_loop_detected` | 508 |
+| `render_not_extended` | 510 |
+| `render_network_authentication_required` | 511 |
+
+#### `pagination:` on all 2xx and 3xx helpers
+Previously only `render_ok` exposed a pagination parameter. Now every 2xx and
+3xx helper accepts `pagination: Hash | nil` so you can include pagination meta
+from any success response type, not just 200.
+
+---
+
+### Removed
+
+- `pagination.rb` — entire file deleted. Auto-detection of Kaminari, Pagy, and
+  WillPaginate is no longer part of the gem. Respondo has zero pagination
+  library dependencies.
+- `pagy:` parameter from `render_success` and `render_ok`
+- `pagination: Boolean` flag — no longer needed since passing `nil` (the default)
+  simply omits the key from meta
+
+---
+
+### Stats
+
+| | v1.0.0 | v2.0.0 |
+|---|---|---|
+| Total helpers | 7 | 57 |
+| HTTP codes covered | 13 | 52 |
+| Files | 7 | 6 (pagination.rb removed) |
+| Pagination gem dependencies | 3 (optional) | 0 |
+
+---
+
 ## [1.0.0] — Production Ready
 
 ### Breaking Changes