api_exception 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98dabbff847276d241f8b6339317135669ea5001b75d936bbc42fc9f001dbcde
-  data.tar.gz: 5d1423c28d88c359b727c1de12b76ae593382d6155966644aae31cca6b6352e2
+  metadata.gz: aeefc2868036a903c5bf6f66723a5e25a7cd422a7922a34cb67f715a9c83a96f
+  data.tar.gz: c8577f4396e3405903c615a6a04455ef47b6ef302968f9ea1ea7da830848f23e
 SHA512:
-  metadata.gz: e9554a7292def309a58d54af58e6ad235069dbacd75a5c5c9ea494f55b89310e4e5a7ce610fe408e58795be5b6d656209139cdef1eb4c30fe202e4c1ed375540
-  data.tar.gz: 7acb28722554c9864bc66154a8ad8a2fe7e655d9f75a0d1c4e4d83c3826aa1f39ec67f45858fd369c0f330cf21c0d5b45380f7ac45cc9339a8de5a1c8d6b8610
+  metadata.gz: 683d5ca3828d37482ae74f8641180faba8b857f202895f5ea6ad77f9c12a5393b7a6b2328ed08eb578d9fcbec93db29419ae22b2a170cc2a056f7cab50aa5b66
+  data.tar.gz: 31ac7672a69b290f52378021e5aba39508f17617521a67542cec546605b24c6a5d04b580f166452eb122d49687d110a405a3be1953727dc723d05d87f6b0c2d2

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/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/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.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_exception
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - killjoy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails