api_exception 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 470b587029958c92a73e72c11fa665682f6075b0a837a52458119c103b905f28
-  data.tar.gz: 1f397f8fb83fc90ee8b43c3ca5ce8ee305e4571d7676d5af543c786b7f2a7ec4
+  metadata.gz: 8b90703e1bb43fa3822e44d1b51e37a8a9ac66ba6229351e40eeffe7bee4020a
+  data.tar.gz: 4f806eabfe86079a1dd7882d37c0c3c5fea70e7bb642ed6f628f30bad57c2c0f
 SHA512:
-  metadata.gz: 84588aebe63e702c03e127788d129e6105afd34c93f47648ee1223658399b85534892f43e08e427c899b1491395201981988247e2ce386f3a9c111d33e58ec75
-  data.tar.gz: b6d62c6f8b18bc816ef02063888a4f268093c088d2b95d7b98eb03b50c198f8f3b821a89d5d1f095b77d7c413021f43e8f7850ecfeb6a9f7e804505774cb749c
+  metadata.gz: cec3705d7c5049d5a8108743905f8bc44b4441509ab1603a00356194b7035ca5bfea2e0e07e72d0daa3776be64e6d553ad3ef56facadfde3fc40ac446483f0f5
+  data.tar.gz: d03479ab02b272b25c26b54f4a840ef572ec91aff4123f4b7aec5057edbbf0b37568b6ab355ff7fa3df241618845f43fa658eb31d4d3c801c35b43b242e4b1ab

data/config/locales/en/en.yml

@@ -1,18 +1,30 @@
 en:
   base_exceptions:
-    record_not_found: "Record not found for %{model}"
     timeout: "Could not connect to %{provider}"
     invalid_user: Invalid user
     duplicated_emails: Some user emails are duplicated
-    invalid_status_change: "Cannot change status from %{original_status} to %{new_status}"
     unauthorized_user: User is unauthorized to do this action
     standard_error: "%{message}"
-    cannot_update: "Cannot update %{model} with the requested parameters"
-    not_unique_record: ID should be unique for this datatype
     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.
+    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
+  controller_exceptions:
+    empty_params: The provided params are empty
+    invalid_params: The provided params are invalid
+  file_exceptions:
     invalid_file: One or more of the sent file are invalid or corrupt
     unsupported_file: The file you are trying to upload is not supported
-    invalid_params: There was a problem in the JSON submitted
-    update_conflict: Update conflict. Please retry.
-    invalid_date_range: Invalid date range
-    authentication_failure: Verify authentication parameters.
+    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

data/config/locales/es/es.yml

@@ -1,18 +1,30 @@
 es:
   base_exceptions:
-    record_not_found: "Registro no encontrado para %{model}"
     timeout: "No se pudo conectar a %{provider}"
     invalid_user: Usuario invalido
     duplicated_emails: Algunos e-mails están duplicados
-    invalid_status_change: "No se puede cambiar el status de %{original_status} a %{new_status}"
     unauthorized_user: Usuario no autorizado para realizar esta acción
     standard_error: "%{message}"
-    cannot_update: "No se puede actualizar %{model} con los estos parametros"
-    not_unique_record: El identificador debe ser único para este tipo de dato
     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}"
+    invalid_update: "No se puede actualizar %{model} con los parametros proporcionados"
+    not_unique_record: El identificador debe ser único para este tipo de dato
+    invalid_attributes: "Algunos atributos proporcionados no son válidos o no están permitidos para el modelo %{model}"
+    update_conflict: Conflicto de actualización. Por favor revise los atributos e intenta nuevamente.
+    unique_combination: Existe una combinación única de atributos que ya se encuentra en uso
+    required_dependency_missing: "%{model} depende de tener una relacion con %{dependency_model} antes de guardar el registro"
+    validation_failed: Hay algunas validaciones fallidas, antes de guardar este registro asegúrese de cumplirlas
+  controller_exceptions:
+    empty_params: Los parámetros proporcionados se encuentran vacios
+    invalid_params: Los parámetros proporcionados son inválidos
+  file_exceptions:
     invalid_file: Uno o más de los archivos que se están enviando son inválidos o están corruptos
     unsupported_file: El archivo que está intentando cargar no está soportado
-    invalid_params: Hubo un problema con el JSON enviado
-    update_conflict: Conflicto de actualización. Por favor, intenta nuevamente.
-    invalid_date_range: Rango de fechas inválido
-    authentication_failure: Verifique parámetros de autenticación.
+    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

data/lib/api_exception/base_exception.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module ApiException
   class BaseException < StandardError
     include ActiveModel::Model
@@ -8,17 +6,9 @@ module ApiException
     attr_reader :code, :message, :errors, :type, :error_type
 
     def initialize(error_type, errors, params, platform = "API")
-      error = error_code_map[error_type]
-      @hash_message = error[:message]
-      @params = params
+      @error = error_code_map[error_type]
 
-      @error_type = error_type
-      @errors = [*errors]
-      @code = error[:code] if error
-      @message = parse_message if error
-      @errors.push(@message)
-      @errors = @errors.flatten
-      @type = platform
+      define_attributes(error_type, errors, params, platform)
     end
 
     def parse_message
@@ -36,25 +26,18 @@ module ApiException
 
     private
 
+    # Base error code should between 1 and 100
     def error_code_map
       {
         TIMEOUT: { code: 1, message: find_translation(:timeout) },
-        RECORD_NOT_FOUND: { code: 2, message: find_translation(:record_not_found) },
-        INVALID_USER: { code: 3, message: find_translation(:invalid_user) },
-        REPEATED_USER: { code: 4, message: find_translation(:duplicated_emails) },
-        INVALID_STATUS_CHANGE: { code: 5, message: find_translation(:invalid_status_change) },
-        UNAUTHORIZED: { code: 6, message: find_translation(:unauthorized_user) },
-        NOT_ALLOWED: { code: 7, message: find_translation(:standard_error) },
-        INVALID_UPDATE: { code: 8, message: find_translation(:cannot_update) },
-        BASE_ERROR: { code: 9, message: "" },
-        NOT_UNIQUE_RECORD: { code: 10, message: find_translation(:not_unique_record) },
-        ACTION_NOT_PERMITTED: { code: 11, message: find_translation(:action_not_permitted) },
-        INVALID_FILE: { code: 12, message: find_translation(:invalid_file) },
-        UNSUPPORTED_FILE: { code: 13, message: find_translation(:unsupported_file) },
-        INVALID_PARAMS: { code: 14, message: find_translation(:invalid_params) },
-        UPDATE_CONFLICT: { code: 15, message: find_translation(:update_conflict) },
-        INVALID_DATE_RANGE: { code: 16, message: find_translation(:invalid_date_range) },
-        AUTHENTICATION_FAILURE: { code: 17, message: find_translation(:authentication_failure) },
+        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: "" },
+        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
 
@@ -69,5 +52,18 @@ module ApiException
     def find_translation(error)
       I18n.t("base_exceptions.#{error.to_s}")
     end
+
+    def define_attributes(error_type, errors, params, platform)
+      @hash_message = @error[:message]
+      @params = params
+
+      @error_type = error_type
+      @errors = [*errors]
+      @code = @error[:code] if @error
+      @message = parse_message if @error
+      @errors.push(@message)
+      @errors = @errors.flatten
+      @type = platform
+    end
   end
 end

data/lib/api_exception/controller_exception.rb

@@ -0,0 +1,26 @@
+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)
+    end
+
+    private
+
+    # Controller error code should between 201 and 300
+    def error_code_map
+      {
+        EMPTY_PARAMS: { code: 201, message: find_translation(:empty_params) },
+        INVALID_PARAMS: { code: 202, message: find_translation(:invalid_params) },
+      }
+    end
+
+    def find_translation(error)
+      I18n.t("controller_exceptions.#{error.to_s}")
+    end
+  end
+end

data/lib/api_exception/file_exception.rb

@@ -0,0 +1,30 @@
+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)
+    end
+
+    private
+
+    # 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_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)},
+        INVALID_CONTENT: { code: 306, message: find_translation(:invalid_content)},
+      }
+    end
+
+    def find_translation(error)
+      I18n.t("file_exceptions.#{error.to_s}")
+    end
+  end
+end

data/lib/api_exception/model_exception.rb

@@ -0,0 +1,33 @@
+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)
+    end
+
+    private
+
+    # Model error code should between 101 and 200
+    def error_code_map
+      {
+        RECORD_NOT_FOUND: { code: 101, message: find_translation(:record_not_found) },
+        INVALID_STATUS_CHANGE: { code: 102, message: find_translation(:invalid_status_change) },
+        INVALID_UPDATE: { code: 103, message: find_translation(:invalid_update) },
+        NOT_UNIQUE_RECORD: { code: 104, message: find_translation(:not_unique_record) },
+        INVALID_ATTRIBUTES: { code: 105, message: find_translation(:invalid_attributes) },
+        UPDATE_CONFLICT: { code: 106, message: find_translation(:update_conflict) },
+        UNIQUE_COMBINATION: { code: 107, message: find_translation(:unique_combination) },
+        REQUIRED_DEPENDENCY_MISSING: { code: 108, message: find_translation(:required_dependency_missing) },
+        VALIDATION_FAILED: { code: 109, message: find_translation(:validation_failed) },
+      }
+    end
+
+    def find_translation(error)
+      I18n.t("model_exceptions.#{error.to_s}")
+    end
+  end
+end

data/lib/api_exception/version.rb

@@ -1,6 +1,6 @@
 module ApiException
   # first number stable version
   # second number major release
-  # bug fixes
-  VERSION = "1.0.0"
+  # bug fixes or minor release
+  VERSION = "1.1.1"
 end

data/lib/api_exception.rb

@@ -1,6 +1,11 @@
 require "api_exception/version"
 require "api_exception/engine"
+
+# Personalized Exceptions
 require_relative 'api_exception/base_exception'
+require_relative 'api_exception/model_exception'
+require_relative 'api_exception/controller_exception'
+require_relative 'api_exception/file_exception'
 
 module ApiException
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_exception
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - killjoy
@@ -35,22 +35,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/api_exception_manifest.js
-- app/assets/stylesheets/api_exception/application.css
-- app/controllers/api_exception/application_controller.rb
-- app/helpers/api_exception/application_helper.rb
-- app/jobs/api_exception/application_job.rb
-- app/mailers/api_exception/application_mailer.rb
-- app/models/api_exception/application_record.rb
-- app/views/layouts/api_exception/application.html.erb
 - config/locales/en/en.yml
 - config/locales/es/es.yml
-- config/routes.rb
 - lib/api_exception.rb
 - lib/api_exception/base_exception.rb
+- lib/api_exception/controller_exception.rb
 - lib/api_exception/engine.rb
+- lib/api_exception/file_exception.rb
+- lib/api_exception/model_exception.rb
 - lib/api_exception/version.rb
-- lib/tasks/api_exception_tasks.rake
 homepage: https://gitlab.com/code-nest2/api_exception
 licenses:
 - MIT
@@ -66,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/assets/config/api_exception_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/api_exception .css

data/app/assets/stylesheets/api_exception/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/api_exception/application_controller.rb

@@ -1,4 +0,0 @@
-module ApiException
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/helpers/api_exception/application_helper.rb

@@ -1,4 +0,0 @@
-module ApiException
-  module ApplicationHelper
-  end
-end

data/app/jobs/api_exception/application_job.rb

@@ -1,4 +0,0 @@
-module ApiException
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/api_exception/application_mailer.rb

@@ -1,6 +0,0 @@
-module ApiException
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end

data/app/models/api_exception/application_record.rb

@@ -1,5 +0,0 @@
-module ApiException
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/api_exception/application.html.erb

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Api exception</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= yield :head %>
-
-  <%= stylesheet_link_tag    "api_exception/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/routes.rb

@@ -1,2 +0,0 @@
-ApiException::Engine.routes.draw do
-end

data/lib/tasks/api_exception_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :api_exception do
-#   # Task goes here
-# end