respondo 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ebeacf9ef38e8d7d2c41182edca0cd2ae55b0520e93a5900dafea65e84584d
-  data.tar.gz: 4e185739d3eb720712a9c0264558a7669d1f6bdd420d474ce9b68a85409ddf45
+  metadata.gz: cbb9a42fee14d341990b700fd36592d17757abccb2c1a7cac406177a0eee259f
+  data.tar.gz: 31885b2ddb68d296998f82900273e36a76ec896c4ca691291544db0242932508
 SHA512:
-  metadata.gz: 560d4983326902e3c8c5859af0105142a8799aeeeda2a4c6036917db393f117fc3d885cc8389ec6ad6f24b6a0846d4ad5262809e5b37af4c2c63dcdceb7a6059
-  data.tar.gz: 35a6a092f71d876b30c749ce92dfeff9414689898aa12adb2c1c74466b2e9df233763f446745d93fdcb63c9a4a9f7b1332aa1c2a743fe6683afb804a0e713f35
+  metadata.gz: 6be63c0f45ece4fd72f6a4880f624cc875616e77fda1321474c59ba8f8709fc20a2187a8989661ce21d1d59a6815084020b7f570e7c1d3e4809191c32bfa3dd7
+  data.tar.gz: 8fc37dd22d9052f5d7a4fb85de3e607053358bc4ad00a7fb2cb5c991aabb77726cb35c4aef8a68ad9459ec9229ccf8e5a3a16a7b16d97dc4f3c54d35d00d7735

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## [1.0.0] — Production Ready
+
+### Breaking Changes
+- `render_error` and all error helpers (`render_bad_request`, `render_unauthorized`,
+  `render_forbidden`, `render_not_found`, etc.) — removed `status` as a public
+  parameter; status is now derived internally and can no longer be overridden by callers
+- All error helpers now accept `meta: {}` — allows per-call meta injection
+  (previously only `render_success` and success helpers supported this)
+
+### Added
+- `meta: {}` parameter on all error helpers — pass per-request meta such as
+  `api_version`, `env`, `region` directly at the call site
+- `config.default_meta` — static key-value pairs merged into every response's
+  meta block automatically (e.g. `{ api_version: "v1", platform: "api" }`)
+- Deterministic meta key ordering — `request_id` → `timestamp` → `default_meta`
+  → caller `meta` → `code` → `status`
+
+### Fixed
+- Error helper `code:` values were strings (e.g. `"404"`) while success helpers
+  used integers — all codes are now consistently integers across all helpers
+- Trailing commas removed from `render_service_unavailable` and
+  `render_gateway_timeout` signatures
+- `render_no_content` had mismatched `status: :ok` (200) with `code: 204` in
+  meta — now consistent
+- Caller-supplied `meta` could previously override system fields (`timestamp`,
+  `request_id`) — system fields are now always authoritative
+
+---
+
 ## [0.1.0] — Initial Release
 
 ### Added

data/README.md

@@ -1,5 +1,8 @@
 # Respondo 🎯
 
+[![Gem Version](https://badge.fury.io/rb/respondo.svg?icon=si%3Arubygems&icon_color=%23ce0303)](https://badge.fury.io/rb/respondo)
+![GitHub Repo Views](https://gitviews.com/repo/spatelpatidar/respondo.svg)
+
 Smart JSON API response formatter for Rails — consistent structure every time, across every app.
 
 ```json

data/lib/respondo/configuration.rb

@@ -29,12 +29,18 @@ module Respondo
     #   config.serializer = ->(obj) { SomeSerializer.new(obj).as_json }
     attr_accessor :serializer
 
+    # Static key-value pairs merged into every response's meta block.
+    # @example
+    #   config.default_meta = { api_version: "v1", platform: "mobile" }
+    attr_accessor :default_meta
+
     def initialize
       @default_success_message = "Success"
       @default_error_message   = "An error occurred"
       @include_request_id      = false
       @camelize_keys           = false
       @serializer              = nil
+      @default_meta            = {}  # e.g. { api_version: "v1", env: "production" }
     end
   end
 end

data/lib/respondo/controller_helpers.rb

@@ -114,78 +114,78 @@ module Respondo
     # =========================================================================
 
     # 400 Bad Request — malformed request, invalid params
-    def render_bad_request(message: "Bad request", errors: nil, code: "BAD_REQUEST")
-      render_error(message: message, errors: errors, code: code, status: :bad_request)
+    def render_bad_request(message: "Bad request", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 400, status: :bad_request)
     end
 
     # 401 Unauthorized — not authenticated
-    def render_unauthorized(message: "Unauthorized", errors: nil, code: "UNAUTHORIZED")
-      render_error(message: message, errors: errors, code: code, status: :unauthorized)
+    def render_unauthorized(message: "Unauthorized", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 401, status: :unauthorized)
     end
 
     # 402 Payment Required — paywalled features
-    def render_payment_required(message: "Payment required to access this resource", errors: nil, code: "PAYMENT_REQUIRED")
-      render_error(message: message, errors: errors, code: code, status: :payment_required)
+    def render_payment_required(message: "Payment required to access this resource", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 402, status: :payment_required)
     end
 
     # 403 Forbidden — authenticated but not authorized
-    def render_forbidden(message: "You do not have permission to perform this action", errors: nil, code: "FORBIDDEN")
-      render_error(message: message, errors: errors, code: code, status: :forbidden)
+    def render_forbidden(message: "You do not have permission to perform this action", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 403, status: :forbidden)
     end
 
     # 404 Not Found
-    def render_not_found(message: "Resource not found", errors: nil, code: "NOT_FOUND")
-      render_error(message: message, errors: errors, code: code, status: :not_found)
+    def render_not_found(message: "Resource not found", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 404, status: :not_found)
     end
 
     # 405 Method Not Allowed
-    def render_method_not_allowed(message: "HTTP method not allowed", errors: nil, code: "METHOD_NOT_ALLOWED")
-      render_error(message: message, errors: errors, code: code, status: :method_not_allowed)
+    def render_method_not_allowed(message: "HTTP method not allowed", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 405, status: :method_not_allowed)
     end
 
     # 406 Not Acceptable — client Accept header can't be satisfied
-    def render_not_acceptable(message: "Requested format not acceptable", errors: nil, code: "NOT_ACCEPTABLE")
-      render_error(message: message, errors: errors, code: code, status: :not_acceptable)
+    def render_not_acceptable(message: "Requested format not acceptable", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 406, status: :not_acceptable)
     end
 
     # 408 Request Timeout
-    def render_request_timeout(message: "Request timed out", errors: nil, code: "REQUEST_TIMEOUT")
-      render_error(message: message, errors: errors, code: code, status: :request_timeout)
+    def render_request_timeout(message: "Request timed out", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 408, status: :request_timeout)
     end
 
     # 409 Conflict — duplicate record, state conflict
-    def render_conflict(message: "Resource conflict", errors: nil, code: "CONFLICT")
-      render_error(message: message, errors: errors, code: code, status: :conflict)
+    def render_conflict(message: "Resource conflict", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 409, status: :conflict)
     end
 
     # 410 Gone — resource permanently deleted
-    def render_gone(message: "Resource no longer available", errors: nil, code: "GONE")
-      render_error(message: message, errors: errors, code: code, status: :gone)
+    def render_gone(message: "Resource no longer available", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 410, status: :gone)
     end
 
     # 412 Precondition Failed — conditional request failed
-    def render_precondition_failed(message: "Precondition failed", errors: nil, code: "PRECONDITION_FAILED")
-      render_error(message: message, errors: errors, code: code, status: :precondition_failed)
+    def render_precondition_failed(message: "Precondition failed", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 412, status: :precondition_failed)
     end
 
     # 415 Unsupported Media Type — wrong Content-Type header
-    def render_unsupported_media_type(message: "Unsupported media type", errors: nil, code: "UNSUPPORTED_MEDIA_TYPE")
-      render_error(message: message, errors: errors, code: code, status: :unsupported_media_type)
+    def render_unsupported_media_type(message: "Unsupported media type", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 415, status: :unsupported_media_type)
     end
 
     # 422 Unprocessable Entity — validation errors (most common for APIs)
-    def render_unprocessable(message: "Validation failed", errors: nil, code: "UNPROCESSABLE_ENTITY")
-      render_error(message: message, errors: errors, code: code, status: :unprocessable_entity)
+    def render_unprocessable(message: "Validation failed", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 422, status: :unprocessable_content)
     end
 
     # 423 Locked — resource is locked
-    def render_locked(message: "Resource is locked", errors: nil, code: "LOCKED")
-      render_error(message: message, errors: errors, code: code, status: :locked)
+    def render_locked(message: "Resource is locked", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 423, status: :locked)
     end
 
     # 429 Too Many Requests — rate limiting
-    def render_too_many_requests(message: "Too many requests. Please slow down.", errors: nil, code: "RATE_LIMITED")
-      render_error(message: message, errors: errors, code: code, status: :too_many_requests)
+    def render_too_many_requests(message: "Too many requests. Please slow down.", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 429, status: :too_many_requests)
     end
 
     # =========================================================================
@@ -193,28 +193,28 @@ module Respondo
     # =========================================================================
 
     # 500 Internal Server Error
-    def render_server_error(message: "An unexpected error occurred", errors: nil, code: "SERVER_ERROR")
-      render_error(message: message, errors: errors, code: code, status: :internal_server_error)
+    def render_server_error(message: "An unexpected error occurred", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 500, status: :internal_server_error)
     end
 
     # 501 Not Implemented — feature not built yet
-    def render_not_implemented(message: "This feature is not yet implemented", errors: nil, code: "NOT_IMPLEMENTED")
-      render_error(message: message, errors: errors, code: code, status: :not_implemented)
+    def render_not_implemented(message: "This feature is not yet implemented", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 501, status: :not_implemented)
     end
 
     # 502 Bad Gateway — upstream service failed
-    def render_bad_gateway(message: "Bad gateway — upstream service error", errors: nil, code: "BAD_GATEWAY")
-      render_error(message: message, errors: errors, code: code, status: :bad_gateway)
+    def render_bad_gateway(message: "Bad gateway — upstream service error", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 502, status: :bad_gateway)
     end
 
     # 503 Service Unavailable — maintenance, overloaded
-    def render_service_unavailable(message: "Service temporarily unavailable", errors: nil, code: "SERVICE_UNAVAILABLE")
-      render_error(message: message, errors: errors, code: code, status: :service_unavailable)
+    def render_service_unavailable(message: "Service temporarily unavailable", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 503, status: :service_unavailable)
     end
 
     # 504 Gateway Timeout — upstream service timed out
-    def render_gateway_timeout(message: "Gateway timeout — upstream service did not respond", errors: nil, code: "GATEWAY_TIMEOUT")
-      render_error(message: message, errors: errors, code: code, status: :gateway_timeout)
+    def render_gateway_timeout(message: "Gateway timeout — upstream service did not respond", errors: nil, meta: {})
+      render_error(message: message, errors: errors, meta: meta, code: 504, status: :gateway_timeout)
     end
 
     private

data/lib/respondo/response_builder.rb

@@ -69,27 +69,60 @@ module Respondo
     end
 
     def build_meta
-      meta = { timestamp: current_timestamp }
+      meta = {}
 
-      # Only extract pagination when caller has not explicitly disabled it
+      # 1. Request ID first (opt-in, always authoritative)
+      if Respondo.config.include_request_id && @request&.respond_to?(:request_id)
+        meta[:request_id] = @request.request_id
+      end
+
+      # 2. Timestamp second
+      meta[:timestamp] = current_timestamp
+
+      # 3. Global defaults in the middle (lowest priority)
+      meta.merge!(Respondo.config.default_meta)
+
+      # 4. Caller-supplied meta (overrides defaults)
+      meta.merge!(@extra_meta)
+
+      # 5. Pagination
       if @pagination
-        pagination = if @pagy
-          Pagination.extract(@pagy)
-        else
-          Pagination.extract(@raw_data)
-        end
+        pagination = @pagy ? Pagination.extract(@pagy) : Pagination.extract(@raw_data)
         meta[:pagination] = pagination if pagination
       end
 
-      # Request ID (Rails only, opt-in via config)
-      if Respondo.config.include_request_id && @request&.respond_to?(:request_id)
-        meta[:request_id] = @request.request_id
-      end
+      # 6. Code and status always last
+      # (these come from @extra_meta via render_error, so we re-pin them to the end)
+      code   = meta.delete(:code)
+      status = meta.delete(:status)
+      meta[:code]   = code   if code
+      meta[:status] = status if status
 
-      # Merge any caller-supplied meta last (allows overriding)
-      meta.merge(@extra_meta)
+      meta
     end
 
+    # def build_meta
+    #   meta = { timestamp: current_timestamp }
+
+    #   # Only extract pagination when caller has not explicitly disabled it
+    #   if @pagination
+    #     pagination = if @pagy
+    #       Pagination.extract(@pagy)
+    #     else
+    #       Pagination.extract(@raw_data)
+    #     end
+    #     meta[:pagination] = pagination if pagination
+    #   end
+
+    #   # Request ID (Rails only, opt-in via config)
+    #   if Respondo.config.include_request_id && @request&.respond_to?(:request_id)
+    #     meta[:request_id] = @request.request_id
+    #   end
+
+    #   # Merge any caller-supplied meta last (allows overriding)
+    #   meta.merge(@extra_meta)
+    # end
+
     def current_timestamp
       if defined?(Time.current)
         Time.current.iso8601

data/lib/respondo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Respondo
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: respondo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - shailendra Kumar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-31 00:00:00.000000000 Z
+date: 2026-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec