rails_react_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7ef71a095ca3fcaef5dc57a2add11dd13dea5c088226c4561957a93d72f7be5
+  data.tar.gz: 43401d67835cddd1ad89efeafefc0f91eb8b10671c36060832d5ec1cb5693d1c
+SHA512:
+  metadata.gz: 5f032bd5f67b6c8938cc07a3d0d173cc973e2c834687829703e7402eda367bd0fa30f475d0b1994b0a3bdd58659a242fe2654bc1b8fa0dc584209bcffdba9543
+  data.tar.gz: 5c3b634d195ab8bc05be86366cfa5ab85d5fd7c9476dbfacc3c0f010ab3ce55cfcc2239da30d186b585f568314d123d1794a2c68289448b8c3c75ce7254227ae

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-03-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"rails_react_errors" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["manish.prajapati0492@gmail.com"](mailto:"manish.prajapati0492@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Manish0407
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# RailsReactErrors
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_react_errors`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_react_errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_react_errors/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsReactErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_react_errors/blob/master/CODE_OF_CONDUCT.md).
+
+# rails_react_errors
+
+Consistent error responses for Rails APIs used by React frontends.
+
+## Installation
+
+## Usage
+
+## Validation Errors
+
+## Not Found Errors
+
+## Unauthorized Errors
+
+## Configuration
+
+## React Example
+
+## Contributing
+
+# rails_react_errors
+
+Consistent error responses for Rails APIs used by React frontends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_react_errors"

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rails_react_errors/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RailsReactErrors
+  class Configuration
+    attr_accessor :include_full_messages,
+                  :rescue_standard_error,
+                  :log_errors
+
+    def initialize
+      @include_full_messages = true
+      @rescue_standard_error = false
+      @log_errors = true
+    end
+  end
+end

data/lib/rails_react_errors/controller.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RailsReactErrors
+  module Controller
+    def self.included(base)
+      base.include RailsReactErrors::Renderer
+
+      if defined?(ActiveRecord::RecordNotFound)
+        base.rescue_from ActiveRecord::RecordNotFound, with: :handle_record_not_found
+      end
+
+      if defined?(ActionController::ParameterMissing)
+        base.rescue_from ActionController::ParameterMissing, with: :handle_parameter_missing
+      end
+
+      return unless RailsReactErrors.configuration.rescue_standard_error
+
+      base.rescue_from StandardError, with: :handle_internal_server_error
+    end
+
+    private
+
+    def handle_record_not_found(exception)
+      render_not_found_error(exception.message)
+    end
+
+    def handle_parameter_missing(exception)
+      render json: {
+        success: false,
+        message: exception.message,
+        code: 'PARAMETER_MISSING',
+        errors: {}
+      }, status: :bad_request
+    end
+
+    def handle_internal_server_error(exception)
+      log_exception(exception) if RailsReactErrors.configuration.log_errors
+      render_server_error('Something went wrong')
+    end
+
+    def log_exception(exception)
+      return unless defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+
+      Rails.logger.error("[RailsReactErrors] #{exception.class}: #{exception.message}")
+    end
+  end
+end

data/lib/rails_react_errors/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module RailsReactErrors
+  class Railtie < Rails::Railtie
+    initializer 'rails_react_errors.configure_controller' do
+      ActiveSupport.on_load(:action_controller_api) do
+        include RailsReactErrors::Renderer
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        include RailsReactErrors::Renderer
+      end
+    end
+  end
+end

data/lib/rails_react_errors/renderer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RailsReactErrors
+  module Renderer
+    def render_validation_error(record, status: :unprocessable_entity)
+      render json: RailsReactErrors::Serializer.validation(record), status: status
+    end
+
+    def render_not_found_error(message = 'Record not found', status: :not_found)
+      render json: RailsReactErrors::Serializer.not_found(message), status: status
+    end
+
+    def render_unauthorized_error(message = 'Unauthorized', status: :unauthorized)
+      render json: RailsReactErrors::Serializer.unauthorized(message), status: status
+    end
+
+    def render_forbidden_error(message = 'Forbidden', status: :forbidden)
+      render json: RailsReactErrors::Serializer.forbidden(message), status: status
+    end
+
+    def render_server_error(message = 'Something went wrong', status: :internal_server_error)
+      render json: RailsReactErrors::Serializer.server_error(message), status: status
+    end
+
+    def render_error(message:, code:, status:, errors: {})
+      render json: {
+        success: false,
+        message: message,
+        code: code,
+        errors: errors
+      }, status: status
+    end
+  end
+end

data/lib/rails_react_errors/serializer.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RailsReactErrors
+  class Serializer
+    def self.validation(record)
+      new.validation(record)
+    end
+
+    def self.not_found(message = 'Record not found')
+      new.not_found(message)
+    end
+
+    def self.unauthorized(message = 'Unauthorized')
+      new.unauthorized(message)
+    end
+
+    def self.forbidden(message = 'Forbidden')
+      new.forbidden(message)
+    end
+
+    def self.server_error(message = 'Something went wrong')
+      new.server_error(message)
+    end
+
+    def validation(record)
+      {
+        success: false,
+        message: 'Validation failed',
+        code: 'VALIDATION_ERROR',
+        errors: serialized_errors(record)
+      }
+    end
+
+    def not_found(message)
+      {
+        success: false,
+        message: message,
+        code: 'NOT_FOUND',
+        errors: {}
+      }
+    end
+
+    def unauthorized(message)
+      {
+        success: false,
+        message: message,
+        code: 'UNAUTHORIZED',
+        errors: {}
+      }
+    end
+
+    def forbidden(message)
+      {
+        success: false,
+        message: message,
+        code: 'FORBIDDEN',
+        errors: {}
+      }
+    end
+
+    def server_error(message)
+      {
+        success: false,
+        message: message,
+        code: 'INTERNAL_SERVER_ERROR',
+        errors: {}
+      }
+    end
+
+    private
+
+    def serialized_errors(record)
+      return {} unless record.respond_to?(:errors)
+
+      if RailsReactErrors.configuration.include_full_messages
+        record.errors.to_hash(true)
+      else
+        record.errors.to_hash
+      end
+    end
+  end
+end

data/lib/rails_react_errors/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsReactErrors
+  VERSION = '0.1.0'
+end

data/lib/rails_react_errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'rails_react_errors/version'
+require_relative 'rails_react_errors/configuration'
+require_relative 'rails_react_errors/serializer'
+require_relative 'rails_react_errors/renderer'
+require_relative 'rails_react_errors/controller'
+
+module RailsReactErrors
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end
+
+require_relative 'rails_react_errors/railtie' if defined?(Rails::Railtie)

data/sig/rails_react_errors.rbs

@@ -0,0 +1,4 @@
+module RailsReactErrors
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rails_react_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manish0407
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: rails_react_errors standardizes validation and API error responses in
+  a React-friendly JSON format.
+email:
+- manish.prajapati0492@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_react_errors.rb
+- lib/rails_react_errors/configuration.rb
+- lib/rails_react_errors/controller.rb
+- lib/rails_react_errors/railtie.rb
+- lib/rails_react_errors/renderer.rb
+- lib/rails_react_errors/serializer.rb
+- lib/rails_react_errors/version.rb
+- sig/rails_react_errors.rbs
+homepage: https://github.com/Manish0407/rails_react_errors
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Manish0407/rails_react_errors
+  source_code_uri: https://github.com/Manish0407/rails_react_errors
+  changelog_uri: https://github.com/Manish0407/rails_react_errors/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Consistent error responses for Rails APIs used by React frontends
+test_files: []