api_exception 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b90703e1bb43fa3822e44d1b51e37a8a9ac66ba6229351e40eeffe7bee4020a
-  data.tar.gz: 4f806eabfe86079a1dd7882d37c0c3c5fea70e7bb642ed6f628f30bad57c2c0f
+  metadata.gz: 98dabbff847276d241f8b6339317135669ea5001b75d936bbc42fc9f001dbcde
+  data.tar.gz: 5d1423c28d88c359b727c1de12b76ae593382d6155966644aae31cca6b6352e2
 SHA512:
-  metadata.gz: cec3705d7c5049d5a8108743905f8bc44b4441509ab1603a00356194b7035ca5bfea2e0e07e72d0daa3776be64e6d553ad3ef56facadfde3fc40ac446483f0f5
-  data.tar.gz: d03479ab02b272b25c26b54f4a840ef572ec91aff4123f4b7aec5057edbbf0b37568b6ab355ff7fa3df241618845f43fa658eb31d4d3c801c35b43b242e4b1ab
+  metadata.gz: e9554a7292def309a58d54af58e6ad235069dbacd75a5c5c9ea494f55b89310e4e5a7ce610fe408e58795be5b6d656209139cdef1eb4c30fe202e4c1ed375540
+  data.tar.gz: 7acb28722554c9864bc66154a8ad8a2fe7e655d9f75a0d1c4e4d83c3826aa1f39ec67f45858fd369c0f330cf21c0d5b45380f7ac45cc9339a8de5a1c8d6b8610

data/README.md

@@ -1,8 +1,19 @@
 # ApiException
-Short description and motivation.
+This gem is a compilation of common errors that can be encountered with File, Model and Controller handling
 
 ## Usage
-How to use my plugin.
+```ruby
+# This is the base class
+# New exception handlers should inherit from this class
+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
+ApiException::BaseException.new(:UNKNOWN_ERROR, ["Something went wrong"], { process: "" })
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/config/locales/en/en.yml

@@ -1,20 +1,14 @@
 en:
   base_exceptions:
-    timeout: "Could not connect to %{provider}"
-    invalid_user: Invalid user
-    duplicated_emails: Some user emails are duplicated
-    unauthorized_user: User is unauthorized to do this action
     standard_error: "%{message}"
     action_not_permitted: Action is not permitted
-    invalid_date_range: Invalid date range
-    authentication_failure: Verify authentication parameters.
   model_exceptions:
     record_not_found: "Record not found for %{model}"
     invalid_status_change: "Cannot change status from %{original_status} to %{new_status}"
     invalid_update: "Cannot update %{model} with the requested parameters"
     not_unique_record: ID should be unique for this datatype
     invalid_attributes: "Some attributes provided are not valid or allowed for %{model} model"
-    update_conflict: Update conflict. Please check the attributes and retry again.
+    update_conflict: Update conflict. Please check the attributes and retry again
     unique_combination: There is a unique combination of attributes already in use
     required_dependency_missing: "%{model} depends of %{dependency_model} relation before save"
     validation_failed: There are some validation failed, before save this record ensure to pass them
@@ -27,4 +21,21 @@ en:
     invalid_extension: "The file has an invalid extension, allowed extensions are: %{extension_allowed}"
     cant_decode: The file could not be decoded
     max_size_exceeded: "The file exceeds the maximum defined size: %{max_size}"
-    invalid_content: The file does not have valid content
+    invalid_content: The file does not have valid content
+  request_exceptions:
+    timeout: "The response timeout was exceeded: %{timeout}"
+    request_format_error: The request format is invalid
+    invalid_response: The server response is invalid
+    request_sever_error: An error occurred processing the request
+    connection_refused: The server rejected the request
+    http_error_code: There was a problem with the request
+    encoding_error: A problem occurred with the encoding of parameters or headers
+    ssl_error: An error occurred while verifying the SSL certificate
+    dns_error: An error occurred with the DNS configuration
+    authentication_error: Authentication error
+  user_exceptions:
+    duplicated_user: Duplicate user
+    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

data/config/locales/es/es.yml

@@ -1,13 +1,7 @@
 es:
   base_exceptions:
-    timeout: "No se pudo conectar a %{provider}"
-    invalid_user: Usuario invalido
-    duplicated_emails: Algunos e-mails están duplicados
-    unauthorized_user: Usuario no autorizado para realizar esta acción
     standard_error: "%{message}"
     action_not_permitted: La acción no está permitida
-    invalid_date_range: Rango de fechas inválido
-    authentication_failure: Verifique parámetros de autenticación.
   model_exceptions:
     record_not_found: "Registro no encontrado para %{model}"
     invalid_status_change: "No se puede cambiar el status de %{original_status} a %{new_status}"
@@ -27,4 +21,21 @@ es:
     invalid_extension: "El archivo tiene una extension invalida, las extensiones permitidas son: %{extension_allowed}"
     cant_decode: El archivo no pudo ser decodificado
     max_size_exceeded: "El archivo excede el tamaño maximo definido de %{max_size}"
-    invalid_content: El archivo no tiene un contenido valido
+    invalid_content: El archivo no tiene un contenido valido
+  request_exceptions:
+    timeout: "Se excedió el tiempo de respuesta: %{timeout}"
+    request_format_error: El formato de la petición no es válido
+    invalid_response: La respuesta del servidor no es válida
+    request_sever_error: Ocurrio un error procesando la solicitud
+    connection_refused: El servidor rechazo la solicitud
+    http_error_code: Hubo un problema en la solicitud
+    encoding_error: Se produjo un error con la codificación de parámetros o encabezados
+    ssl_error: Se produjo un error al verificar el certificado SSL
+    dns_error: Se produjo un error con la configuración de DNS
+    authentication_error: Error de autenticación
+  user_exceptions:
+    duplicated_user: Usuario duplicado
+    authentication_error: No fue posible autenticar al usuario
+    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

data/lib/api_exception/base_exception.rb

@@ -11,6 +11,8 @@ module ApiException
       define_attributes(error_type, errors, params, platform)
     end
 
+    private
+
     def parse_message
       @parsed_message = @hash_message
 
@@ -24,20 +26,11 @@ module ApiException
       @parsed_message
     end
 
-    private
-
     # Base error code should between 1 and 100
     def error_code_map
       {
-        TIMEOUT: { code: 1, message: find_translation(:timeout) },
-        INVALID_USER: { code: 2, message: find_translation(:invalid_user) },
-        REPEATED_USER: { code: 3, message: find_translation(:duplicated_emails) },
-        UNAUTHORIZED: { code: 4, message: find_translation(:unauthorized_user) },
-        NOT_ALLOWED: { code: 5, message: find_translation(:standard_error) },
-        BASE_ERROR: { code: 6, message: "" },
+        UNKNOWN_ERROR: { code: 6, message: find_translation(:standard_error) },
         ACTION_NOT_PERMITTED: { code: 7, message: find_translation(:action_not_permitted) },
-        INVALID_DATE_RANGE: { code: 8, message: find_translation(:invalid_date_range) },
-        AUTHENTICATION_FAILURE: { code: 9, message: find_translation(:authentication_failure) },
       }
     end
 

data/lib/api_exception/controller_exception.rb

@@ -2,11 +2,7 @@ module ApiException
   class ControllerException < BaseException
 
     def initialize(error_type, errors, params, platform = "API")
-      super(error_type, errors, params, platform)
-
-      @error = error_code_map[error_type]
-
-      define_attributes(error_type, errors, params, platform)
+      super
     end
 
     private

data/lib/api_exception/file_exception.rb

@@ -2,11 +2,7 @@ module ApiException
   class FileException < BaseException
 
     def initialize(error_type, errors, params, platform = "API")
-      super(error_type, errors, params, platform)
-
-      @error = error_code_map[error_type]
-
-      define_attributes(error_type, errors, params, platform)
+      super
     end
 
     private
@@ -14,8 +10,8 @@ module ApiException
     # File error code should between 301 and 400
     def error_code_map
       {
-        INVALID_FILE: { code: 301, message: find_translation(:empty_params) },
-        UNSUPPORTED_FILE: { code: 302, message: find_translation(:invalid_params) },
+        INVALID_FILE: { code: 301, message: find_translation(:invalid_file) },
+        UNSUPPORTED_FILE: { code: 302, message: find_translation(:unsupported_file) },
         INVALID_EXTENSION: { code: 303, message: find_translation(:invalid_extension)},
         CANT_DECODE: { code: 304, message: find_translation(:cant_decode)},
         MAX_SIZE_EXCEEDEED: { code: 305, message: find_translation(:max_size_exceeded)},

data/lib/api_exception/model_exception.rb

@@ -2,11 +2,7 @@ module ApiException
   class ModelException < BaseException
 
     def initialize(error_type, errors, params, platform = "API")
-      super(error_type, errors, params, platform)
-
-      @error = error_code_map[error_type]
-
-      define_attributes(error_type, errors, params, platform)
+      super
     end
 
     private

data/lib/api_exception/request_exception.rb

@@ -0,0 +1,30 @@
+module ApiException
+  class RequestException < BaseException
+
+    def initialize(error_type, errors, params, platform = "API")
+      super
+    end
+
+    private
+
+    # File error code should between 401 and 500
+    def error_code_map
+      {
+        TIMEOUT: { code: 401, message: find_translation(:timeout) },
+        REQUEST_FORMAT_ERROR: { code: 402, message: find_translation(:request_format_error) },
+        INVALID_RESPONSE: { code: 403, message: find_translation(:invalid_response)},
+        REQUEST_SERVER_ERROR: { code: 404, message: find_translation(:request_sever_error)},
+        CONNECTION_REFUSED: { code: 405, message: find_translation(:connection_refused)},
+        HTTP_ERROR_CODE: { code: 406, message: find_translation(:http_error_code)},
+        ENCODING_ERROR:  { code: 407, message: find_translation(:encoding_error)},
+        SSL_ERROR:  { code: 408, message: find_translation(:ssl_error)},
+        DNS_ERROR:  { code: 409, message: find_translation(:dns_error)},
+        AUTHENTICATION_ERROR: { code: 410, message: find_translation(:authentication_error)},
+      }
+    end
+
+    def find_translation(error)
+      I18n.t("request_exceptions.#{error.to_s}")
+    end
+  end
+end

data/lib/api_exception/user_exception.rb

@@ -0,0 +1,25 @@
+module ApiException
+  class UserException < BaseException
+
+    def initialize(error_type, errors, params, platform = "API")
+      super
+    end
+
+    private
+
+    # User error code should between 501 and 600
+    def error_code_map
+      {
+        DUPLICATED_USER: { code: 501, message: find_translation(:duplicated_user) },
+        AUTHENTICATION_ERROR: { code: 502, message: find_translation(:authentication_error) },
+        PERMISSION_DENIED: { code: 503, message: find_translation(:permission_denied) },
+        INSECURE_PASSWORD_STORAGE: { code: 504, message: find_translation(:insecure_password_storage) },
+        PROFILE_UPDATE_ERROR: { code: 505, message: find_translation(:profile_update_error) },
+      }
+    end
+
+    def find_translation(error)
+      I18n.t("user_exceptions.#{error.to_s}")
+    end
+  end
+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.1"
+  VERSION = "1.1.2"
 end

data/lib/api_exception.rb

@@ -6,6 +6,8 @@ require_relative 'api_exception/base_exception'
 require_relative 'api_exception/model_exception'
 require_relative 'api_exception/controller_exception'
 require_relative 'api_exception/file_exception'
+require_relative 'api_exception/request_exception'
+require_relative 'api_exception/user_exception'
 
 module ApiException
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_exception
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - killjoy
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-17 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,8 @@ files:
 - lib/api_exception/engine.rb
 - lib/api_exception/file_exception.rb
 - lib/api_exception/model_exception.rb
+- lib/api_exception/request_exception.rb
+- lib/api_exception/user_exception.rb
 - lib/api_exception/version.rb
 homepage: https://gitlab.com/code-nest2/api_exception
 licenses:
@@ -51,7 +53,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.5.6
+signing_key: 
 specification_version: 4
 summary: Simple Exception handle
 test_files: []