api_exception 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 470b587029958c92a73e72c11fa665682f6075b0a837a52458119c103b905f28
+  data.tar.gz: 1f397f8fb83fc90ee8b43c3ca5ce8ee305e4571d7676d5af543c786b7f2a7ec4
+SHA512:
+  metadata.gz: 84588aebe63e702c03e127788d129e6105afd34c93f47648ee1223658399b85534892f43e08e427c899b1491395201981988247e2ce386f3a9c111d33e58ec75
+  data.tar.gz: b6d62c6f8b18bc816ef02063888a4f268093c088d2b95d7b98eb03b50c198f8f3b821a89d5d1f095b77d7c413021f43e8f7850ecfeb6a9f7e804505774cb749c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright killjoy
+
+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,28 @@
+# ApiException
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "api_exception"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install api_exception
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/api_exception_manifest.js

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

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

@@ -0,0 +1,15 @@
+/*
+ * 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

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

data/app/helpers/api_exception/application_helper.rb

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

data/app/jobs/api_exception/application_job.rb

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

data/app/mailers/api_exception/application_mailer.rb

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

data/app/models/api_exception/application_record.rb

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

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

@@ -0,0 +1,17 @@
+<!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/locales/en/en.yml

@@ -0,0 +1,18 @@
+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_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.

data/config/locales/es/es.yml

@@ -0,0 +1,18 @@
+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_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.

data/config/routes.rb

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

data/lib/api_exception/base_exception.rb

@@ -0,0 +1,73 @@
+require 'yaml'
+
+module ApiException
+  class BaseException < StandardError
+    include ActiveModel::Model
+    include ActiveModel::Serialization
+
+    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_type = error_type
+      @errors = [*errors]
+      @code = error[:code] if error
+      @message = parse_message if error
+      @errors.push(@message)
+      @errors = @errors.flatten
+      @type = platform
+    end
+
+    def parse_message
+      @parsed_message = @hash_message
+
+      if @params.present?
+        @params.each do |k, v|
+          param = @parsed_message["{{#{parse_key(k)}}}"] || @parsed_message["%{#{parse_key(k)}}"]
+          @parsed_message[param.to_s] = (v.to_s || "nil") if param
+        end
+      end
+
+      @parsed_message
+    end
+
+    private
+
+    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) },
+      }
+    end
+
+    def parse_key(key)
+      if key.class == Integer
+        ""
+      else
+        key.try(:to_s)
+      end
+    end
+
+    def find_translation(error)
+      I18n.t("base_exceptions.#{error.to_s}")
+    end
+  end
+end

data/lib/api_exception/engine.rb

@@ -0,0 +1,5 @@
+module ApiException
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiException
+  end
+end

data/lib/api_exception/version.rb

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

data/lib/api_exception.rb

@@ -0,0 +1,15 @@
+require "api_exception/version"
+require "api_exception/engine"
+require_relative 'api_exception/base_exception'
+
+module ApiException
+  class << self
+    def root
+      Pathname.new(File.expand_path('../', __FILE__))
+    end
+
+    def setup
+      yield self
+    end
+  end
+end

data/lib/tasks/api_exception_tasks.rake

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: api_exception
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- killjoy
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+description: 'This gem pretends just be used for exception handling in a simple way,
+  giving to you: code, message and type error'
+email:
+- tiloanne96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/engine.rb
+- lib/api_exception/version.rb
+- lib/tasks/api_exception_tasks.rake
+homepage: https://gitlab.com/code-nest2/api_exception
+licenses:
+- MIT
+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
+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.21
+signing_key:
+specification_version: 4
+summary: Simple Exception handle
+test_files: []