otpor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d65aa7219b3a7e0218aceb14abc70ffa459989de2421eb8dddf56eb9e902462f
+  data.tar.gz: 491bb18692f97fe0525c01f87ba99a89f78576208b8fa16e2d35eb92d90808e7
+SHA512:
+  metadata.gz: bedbe5c976532ce83c83ee2e99d864cf9be6f223ac2834d382791128a09022ec4fab145e728c980b819b25900390989a5f66cde56b3587cca37346f2e44cbe81
+  data.tar.gz: 55b496f6d2b6bfb4d56f3a92f7e0456d6741d941cf53764357ae53cbe1f6705d6088df1a0d50b850c43db7b19c13fded9a7c7d37dc862de5d89c725cb33b433e

data/lib/otpor/active_record_validation_error.rb

@@ -0,0 +1,22 @@
+module Otpor
+  module ActiveRecordValidationError
+    extend ActiveSupport::Concern
+  
+    included do
+      after_validation :log_validation_errors, if: -> { errors.any? }
+    end
+  
+    private
+  
+    def log_validation_errors
+      error_messages = []
+      errors.each do |error|
+        error_messages << { attribute: error.attribute, message: error.message, type: error.options.dig(:type) || error.type, entity: self.class.name, entity_id: self.id || 'new record'}
+      end
+      return unless error_messages.present?
+
+      RequestStore.store[:errors] ||= error_messages
+      RequestStore.store[:status_symbol] ||= :unprocessable_content
+    end
+  end
+end

data/lib/otpor/json_response.rb

@@ -0,0 +1,124 @@
+module Otpor
+  module JsonResponse
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :capture_initial_instance_variables
+      around_action :rescue_exceptions
+      rescue_from ActionView::MissingTemplate, with: :handle_missing_partial
+    end
+
+    def handle_missing_partial; end
+
+    def default_render(*args)
+      super and return unless request.format.json?
+
+      @errors ||= RequestStore.store[:errors] || nil
+      @notes ||= nil
+
+      @status_symbol = RequestStore.store[:status_symbol] if RequestStore.store[:status_symbol]
+      @status_code = Rack::Utils::SYMBOL_TO_STATUS_CODE[@status_symbol] if @status_symbol
+      @status_code ||= response.status
+      @status = {
+        name: http_status_name(@status_code),
+        code: @status_code,
+        type: http_status_type(@status_code)
+      }
+
+      partial_exists = lookup_context.exists?("#{controller_path}/#{action_name}", [], true)
+
+      @data_partial ||= "#{controller_path}/#{action_name}" if @status[:type].eql?("Success") && partial_exists
+
+      @instance_variables = capture_new_instance_variables
+
+      @meta ||= infer_meta
+
+      render template: "shared/response", formats: :json, status: @status_code
+    end
+
+    private
+
+    def http_status_name(status_code)
+      Rack::Utils::HTTP_STATUS_CODES[status_code]
+    end
+
+    def rescue_exceptions
+      yield
+    rescue StandardError => e
+      @status_code = determine_status_code(e)
+      @status = {
+        name: http_status_name(@status_code),
+        code: @status_code,
+        type: http_status_type(@status_code)
+      }
+      @errors ||= RequestStore.store[:errors] || nil
+      @exception_log = [{ message: e.message, backtrace: e.backtrace[0, 5] }] if Rails.env.development?
+      render template: "shared/response", formats: :json, status: @status_code
+    end
+
+    def determine_status_code(exception)
+      case exception
+      when ActiveRecord::RecordNotFound
+        404
+      when ActionController::RoutingError, ActionController::UnknownFormat
+        404
+      when ActiveRecord::RecordInvalid, ActionController::ParameterMissing
+        422
+      else
+        500
+      end
+    end
+
+    def http_status_type(status_code)
+      case status_code
+      when 100..199
+        "Informational"
+      when 200..299
+        "Success"
+      when 300..399
+        "Redirection"
+      when 400..499
+        "Client Error"
+      when 500..599
+        "Server Error"
+      else
+        "Unknown"
+      end
+    end
+
+    def capture_initial_instance_variables
+      @initial_instance_variables = instance_variables
+    end
+
+    def capture_new_instance_variables
+      current_instance_variables = instance_variables
+      new_vars = current_instance_variables - @initial_instance_variables
+      new_vars -= %i[@initial_instance_variables @errors @notes @data_partial @status
+                     @_response_body @new_instance_variables]
+      new_instance_vars = {}
+      new_vars.each do |var|
+        new_instance_vars[var] = instance_variable_get(var)
+      end
+      new_instance_vars
+    end
+
+    def infer_meta
+      @instance_variables.each do |key, value|
+        next unless value.respond_to?(:total_pages)
+
+        return {
+          pagination: {
+            total_pages: value.total_pages,
+            total_count: value.total_count,
+            current_page: value.current_page,
+            next_page: value.next_page,
+            prev_page: value.prev_page,
+            per_page: value.limit_value
+          }
+        }
+      end
+
+      nil
+    end
+  end
+end

data/lib/otpor/templates/shared/response.json.jbuilder

@@ -0,0 +1,14 @@
+json.status do
+  json.name @status[:name]
+  json.code @status[:code]
+  json.type @status[:type]
+end
+
+json.data do
+  json.partial! @data_partial if @data_partial.present?
+end
+
+json.errors @errors
+json.notes @notes
+json.meta @meta
+json.exception_log @exception_log

data/lib/otpor/version.rb

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

data/lib/otpor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "request_store"
+require_relative "otpor/version"
+require_relative "otpor/json_response"
+require_relative "otpor/active_record_validation_error"
+
+module Otpor
+  class Engine < ::Rails::Engine
+    initializer "otpor.load_view_paths" do |app|
+      ActiveSupport.on_load(:action_controller) do
+        append_view_path Otpor::Engine.root.join("lib", "otpor", "templates")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: otpor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renan Garcia
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem includes a concern that defines a default Jbuilder template
+  for controller actions that include it, rendering consistent JSON responses.
+email:
+- renan.almeida.garcia@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/otpor.rb
+- lib/otpor/active_record_validation_error.rb
+- lib/otpor/json_response.rb
+- lib/otpor/templates/shared/response.json.jbuilder
+- lib/otpor/version.rb
+homepage: https://github.com/renan-garcia/otpor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: 'Otpor: JSON Response Concern'
+test_files: []