respondo 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f627c02a80d4eb8ab106714e2739d38b17545a93d1772e052497850c8a56f437
-  data.tar.gz: 8f078c4540d8182fc59ccdc8c539b29835ccb9f7cf5d781b2ae389e0a9c04461
+  metadata.gz: fbe7751852587a50eb66e9d18128db0f0b98295f6e309ea1db812d2c6802827e
+  data.tar.gz: d59797929ccbf67f507eba232a36c04f5642318b1f3992aa0251f3949b4ed284
 SHA512:
-  metadata.gz: 4677d2d32eaa9441032829a6414cd81d24d831b61ce45e0fd3586c4d804745d9307a1bc375b280b0801d53812b6accb656ae28ac1c36dc858befa51c3098b2aa
-  data.tar.gz: 937d964de71ac65cd5d13df236cf74012b390cee914c13b8078a653db7d7a2273037593fad1981df41a59280e3cba677f5ede00ea6992b07058b90a5456645f6
+  metadata.gz: d3d210ee9413164b2d0b80b4c84e8f238ffac624145704dbabfb4a09242d655460e18ecd0591cd010a43a5a9c37d1b0a1ad6086ac0ab8f0a7e36536f0d6b16c3
+  data.tar.gz: 8683372f8e107d696b62d6f5e69e9f693638ce3dc50f21775d54820781c987fae14e924bce00c126b83747ce8ef14857652582a7a1e0d1c881c1536c7c4bbfe5

data/CHANGELOG.md

@@ -1,5 +1,132 @@
 # Changelog
 
+## [2.1.1] — Bug Fix
+
+### Fixed
+
+#### `render_no_content` — status mismatch corrected
+Previously `render_no_content` was sending `status: :ok` (200) while setting
+`code: 204` in the meta block. This meant the HTTP response status was 200
+but the meta claimed 204 — inconsistent and misleading to clients.
+
+**Before (buggy):**
+```ruby
+def render_no_content(message: "Deleted successfully", meta: {}, pagination: nil)
+  render_success(data: nil, message: message, meta: meta, pagination: pagination, code: 204, status: :ok)
+  #                                                                                          ^^^^^^^^^^
+  #                                                                                          wrong — sends 200
+end
+```
+
+**After (fixed):**
+```ruby
+def render_no_content(message: "Deleted successfully", meta: {}, pagination: nil)
+  render_success(data: nil, message: message, meta: meta, pagination: pagination, code: 204, status: :no_content)
+  #                                                                                          ^^^^^^^^^^^^^^^^^^
+  #                                                                                          correct — sends 204
+end
+```
+
+**Why body is kept:** HTTP spec discourages a body on 204 but does not
+strictly forbid it. Respondo keeps the JSON body so FE clients can display
+the `message` field on delete confirmations. Rails and all major HTTP clients
+(Axios, Fetch, OkHttp) handle this correctly.
+
+**Migration:** No changes needed — method signature is identical. If you were
+relying on the incorrect 200 status in tests, update your assertions to
+expect 204.
+
+### Changed
+
+#### `respondo.gemspec` — corrected `bug_tracker_uri`
+A stray `auditron/` path segment was present in the `bug_tracker_uri` metadata
+field, producing a broken link on RubyGems.
+
+**Before:**
+```ruby
+"bug_tracker_uri" => "#{spec.homepage}/auditron/issues"
+```
+
+**After:**
+```ruby
+"bug_tracker_uri" => "#{spec.homepage}/issues"
+```
+
+#### `response_builder.rb` — removed stale commented-out code
+A dead `build_meta` implementation was left commented out from a previous
+refactor. Removed to keep the file clean and readable.
+
+---
+
+## [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