api_exception 1.1.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98dabbff847276d241f8b6339317135669ea5001b75d936bbc42fc9f001dbcde
-  data.tar.gz: 5d1423c28d88c359b727c1de12b76ae593382d6155966644aae31cca6b6352e2
+  metadata.gz: 27f04c16cb291109915c1ea4787587cc66fb40841121b4844c3c4dbd117b2582
+  data.tar.gz: 5996cc49ba242dbc5b7d316bceb61358efe72215660be16cbb47a11180787012
 SHA512:
-  metadata.gz: e9554a7292def309a58d54af58e6ad235069dbacd75a5c5c9ea494f55b89310e4e5a7ce610fe408e58795be5b6d656209139cdef1eb4c30fe202e4c1ed375540
-  data.tar.gz: 7acb28722554c9864bc66154a8ad8a2fe7e655d9f75a0d1c4e4d83c3826aa1f39ec67f45858fd369c0f330cf21c0d5b45380f7ac45cc9339a8de5a1c8d6b8610
+  metadata.gz: 9302833bc0e8e1f5d820d75e624d79dce16f42c39eb9d71299f4a4753b6d52aefdb3ef5a536aa1673edf3635d32afdea6c3dc3997a3cfd1b821c7c483a63f45e
+  data.tar.gz: fa67d0509d5c19b635d54dd03fb11c136ca00a318d0f6b4856a8d2389e7973b21e1bd908884fb5a58b8081f953d8cf88ef6ad84bbb7300a9ca48877c9f3ce1db

data/README.md

@@ -10,11 +10,31 @@ ApiException::BaseException
 # You can initialize with the following params
 # error_type -> This argument should be a symbol
 # errors -> This argument should be an array of string errors
-# params -> Should be a hash as params for I18n.t translations
-# platform -> Should specify where this error is rendered from, 'API' value is by default
+# params -> Should be a hash as params for I18n.t translations (optional)
+# platform -> Should specify where this error is rendered from, 'API' value is by default (optional)
 ApiException::BaseException.new(:UNKNOWN_ERROR, ["Something went wrong"], { process: "" })
 ```
 
+## Examples availables
+```ruby
+
+ApiException::ModelException.new(:RECORD_NOT_FOUND, ["Item not found"], { model: "User"})
+#=> Record not found for User (ApiException::ModelException)
+
+ApiException::ControllerException.new(:INVALID_PARAMS, ["cant parse body params"])
+#=> The provided params are invalid (ApiException::ControllerException)
+
+ApiException::FileException.new(:UNSUPPORTED_FILE, ["wrong file extension"])
+#=> The file you are trying to upload is not supported (ApiException::FileException)
+
+ApiException::RequestException.new(:TIMEOUT, ["Server response time exceed"], { timeout: "3 mins"})
+#=> The response timeout was exceeded: 3 mins (ApiException::RequestException)
+
+ApiException::UserException.new(:DUPLICATED_USER, ["user data already exist"])
+#=> Duplicate user (ApiException::UserException)
+
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/config/locales/en/en.yml

@@ -38,4 +38,13 @@ en:
     authentication_error: The user could not be authenticated
     permission_denied: The user does not have the permissions to perform this action
     insecure_password_storage: The password must be strong
-    profile_update_error: The user data could not be updated
+    profile_update_error: The user data could not be updated
+  service_exceptions:
+    invalid_parameters: The parameters provided to the service are invalid
+    business_logic_error: Business logic error in the service
+    transaction_error: An error occurred during the service transaction
+    missing_required_parameter: A required parameter is missing to execute the service
+    service_execution_failed: Service execution failed
+    invalid_context: The provided context is not valid for this operation
+    dependency_error: Error in the dependencies required by the service
+    validation_error: Validation error in the service

data/config/locales/es/es.yml

@@ -39,3 +39,12 @@ es:
     permission_denied: El usuario no cuenta con los permisos para realizar esta acción
     insecure_password_storage: La contraseña debe ser segura
     profile_update_error: No fue posible actualizar los datos del usuario
+  service_exceptions:
+    invalid_parameters: Los parámetros proporcionados al servicio no son válidos
+    business_logic_error: Error en la lógica de negocio del servicio
+    transaction_error: Ocurrió un error durante la transacción del servicio
+    missing_required_parameter: Falta un parámetro requerido para ejecutar el servicio
+    service_execution_failed: La ejecución del servicio falló
+    invalid_context: El contexto proporcionado no es válido para esta operación
+    dependency_error: Error en las dependencias requeridas por el servicio
+    validation_error: Error de validación en el servicio

data/lib/api_exception/base_exception.rb

@@ -5,7 +5,7 @@ module ApiException
 
     attr_reader :code, :message, :errors, :type, :error_type
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       @error = error_code_map[error_type]
 
       define_attributes(error_type, errors, params, platform)

data/lib/api_exception/controller_exception.rb

@@ -1,7 +1,7 @@
 module ApiException
   class ControllerException < BaseException
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       super
     end
 

data/lib/api_exception/file_exception.rb

@@ -1,7 +1,7 @@
 module ApiException
   class FileException < BaseException
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       super
     end
 

data/lib/api_exception/model_exception.rb

@@ -1,7 +1,7 @@
 module ApiException
   class ModelException < BaseException
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       super
     end
 

data/lib/api_exception/request_exception.rb

@@ -1,7 +1,7 @@
 module ApiException
   class RequestException < BaseException
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       super
     end
 

data/lib/api_exception/service_exception.rb

@@ -0,0 +1,29 @@
+module ApiException
+    class ServiceException < BaseException
+  
+      def initialize(error_type, errors, params = {}, platform = "API")
+        super
+      end
+  
+      private
+  
+      # Service error code should between 601 and 700
+      def error_code_map
+        {
+          INVALID_PARAMETERS: { code: 601, message: find_translation(:invalid_parameters) },
+          BUSINESS_LOGIC_ERROR: { code: 602, message: find_translation(:business_logic_error) },
+          TRANSACTION_ERROR: { code: 603, message: find_translation(:transaction_error) },
+          MISSING_REQUIRED_PARAMETER: { code: 604, message: find_translation(:missing_required_parameter) },
+          SERVICE_EXECUTION_FAILED: { code: 605, message: find_translation(:service_execution_failed) },
+          INVALID_CONTEXT: { code: 606, message: find_translation(:invalid_context) },
+          DEPENDENCY_ERROR: { code: 607, message: find_translation(:dependency_error) },
+          VALIDATION_ERROR: { code: 608, message: find_translation(:validation_error) },
+        }
+      end
+  
+      def find_translation(error)
+        I18n.t("service_exceptions.#{error.to_s}")
+      end
+    end
+  end
+  

data/lib/api_exception/user_exception.rb

@@ -1,7 +1,7 @@
 module ApiException
   class UserException < BaseException
 
-    def initialize(error_type, errors, params, platform = "API")
+    def initialize(error_type, errors, params = {}, platform = "API")
       super
     end
 

data/lib/api_exception/version.rb

@@ -2,5 +2,5 @@ module ApiException
   # first number stable version
   # second number major release
   # bug fixes or minor release
-  VERSION = "1.1.2"
+  VERSION = "1.2.3"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: api_exception
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.3
 platform: ruby
 authors:
 - killjoy
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +43,7 @@ files:
 - lib/api_exception/file_exception.rb
 - lib/api_exception/model_exception.rb
 - lib/api_exception/request_exception.rb
+- lib/api_exception/service_exception.rb
 - lib/api_exception/user_exception.rb
 - lib/api_exception/version.rb
 homepage: https://gitlab.com/code-nest2/api_exception
@@ -53,7 +53,6 @@ metadata:
   homepage_uri: https://gitlab.com/code-nest2/api_exception
   source_code_uri: https://gitlab.com/code-nest2/api_exception
   changelog_uri: https://gitlab.com/code-nest2/api_exception/-/blob/main/README.md?ref_type=heads
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple Exception handle
 test_files: []