railerr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d4bd95812d58ddf87e8b5a1d8deb962f3c10d329ad32108c537d0e8e5df1c16
+  data.tar.gz: 86311328d87f4a159f6495ba15c1cc592b22e62eb1cccebc7226d33784f1c9c3
+SHA512:
+  metadata.gz: b46e3748f88ba6a72c236f0ba1f0f5a23def27253e488f685e1ca1c7b788e4ae834646bb404846b73c4745d86eb2c2ab73ab423190bc1c50bbf6be859704b0e3
+  data.tar.gz: 8e73380426e860f6a9b2a1a95a8adfed7e7def951e44ce235e39f21f6e45aa4c4aae5fadc88c7526b07d41552fe0466b50dba964e994e0ed972b6cc79baa4f80

data/lib/railerr/api_exceptions.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'status'
+
+module Railerr
+  # Base Exception class to raise exceptions associated with HTTP errors
+  class APIException < StandardError
+    DEFAULT_MESSAGE = 'A server error occurred'
+    STATUS_CODE = Status::HTTP_500_INTERNAL_SERVER_ERROR
+
+    def initialize(message = nil)
+      super(message || default_message)
+    end
+
+    def default_message
+      self.class::DEFAULT_MESSAGE
+    end
+
+    def status_code
+      self.class::STATUS_CODE
+    end
+  end
+
+  # Raised for HTTP 400 Bad Request
+  class BadRequestError < APIException
+    DEFAULT_MESSAGE = 'Bad request'
+    STATUS_CODE = Status::HTTP_400_BAD_REQUEST
+  end
+
+  # Raised for HTTP 500 Internal Server Errors
+  class InternalServerError < APIException
+    DEFAULT_MESSAGE = 'Internal server error'
+  end
+
+  # Raised for HTTP 423 Locked
+  class LockedError < APIException
+    DEFAULT_MESSAGE = 'Locked'
+    STATUS_CODE = Status::HTTP_423_LOCKED
+  end
+
+  # Raised for HTTP 404 Not Found.
+  class NotFoundError < APIException
+    DEFAULT_MESSAGE = 'Not found'
+    STATUS_CODE = Status::HTTP_404_NOT_FOUND
+  end
+
+  # Raised for HTTP 422 Unprocessable Content
+  class UnprocessableContentError < APIException
+    DEFAULT_MESSAGE = 'Unprocessable content'
+    STATUS_CODE = Status::HTTP_422_UNPROCESSABLE_ENTITY
+  end
+end

data/lib/railerr/status.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Railerr
+  module Status
+    HTTP_100_CONTINUE = 100
+    HTTP_101_SWITCHING_PROTOCOLS = 101
+    HTTP_102_PROCESSING = 102
+    HTTP_103_EARLY_HINTS = 103
+    HTTP_200_OK = 200
+    HTTP_201_CREATED = 201
+    HTTP_202_ACCEPTED = 202
+    HTTP_203_NON_AUTHORITATIVE_INFORMATION = 203
+    HTTP_204_NO_CONTENT = 204
+    HTTP_205_RESET_CONTENT = 205
+    HTTP_206_PARTIAL_CONTENT = 206
+    HTTP_207_MULTI_STATUS = 207
+    HTTP_208_ALREADY_REPORTED = 208
+    HTTP_226_IM_USED = 226
+    HTTP_300_MULTIPLE_CHOICES = 300
+    HTTP_301_MOVED_PERMANENTLY = 301
+    HTTP_302_FOUND = 302
+    HTTP_303_SEE_OTHER = 303
+    HTTP_304_NOT_MODIFIED = 304
+    HTTP_305_USE_PROXY = 305
+    HTTP_306_RESERVED = 306
+    HTTP_307_TEMPORARY_REDIRECT = 307
+    HTTP_308_PERMANENT_REDIRECT = 308
+    HTTP_400_BAD_REQUEST = 400
+    HTTP_401_UNAUTHORIZED = 401
+    HTTP_402_PAYMENT_REQUIRED = 402
+    HTTP_403_FORBIDDEN = 403
+    HTTP_404_NOT_FOUND = 404
+    HTTP_405_METHOD_NOT_ALLOWED = 405
+    HTTP_406_NOT_ACCEPTABLE = 406
+    HTTP_407_PROXY_AUTHENTICATION_REQUIRED = 407
+    HTTP_408_REQUEST_TIMEOUT = 408
+    HTTP_409_CONFLICT = 409
+    HTTP_410_GONE = 410
+    HTTP_411_LENGTH_REQUIRED = 411
+    HTTP_412_PRECONDITION_FAILED = 412
+    HTTP_413_REQUEST_ENTITY_TOO_LARGE = 413
+    HTTP_414_REQUEST_URI_TOO_LONG = 414
+    HTTP_415_UNSUPPORTED_MEDIA_TYPE = 415
+    HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE = 416
+    HTTP_417_EXPECTATION_FAILED = 417
+    HTTP_418_IM_A_TEAPOT = 418
+    HTTP_421_MISDIRECTED_REQUEST = 421
+    HTTP_422_UNPROCESSABLE_ENTITY = 422
+    HTTP_423_LOCKED = 423
+    HTTP_424_FAILED_DEPENDENCY = 424
+    HTTP_425_TOO_EARLY = 425
+    HTTP_426_UPGRADE_REQUIRED = 426
+    HTTP_428_PRECONDITION_REQUIRED = 428
+    HTTP_429_TOO_MANY_REQUESTS = 429
+    HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE = 431
+    HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS = 451
+    HTTP_500_INTERNAL_SERVER_ERROR = 500
+    HTTP_501_NOT_IMPLEMENTED = 501
+    HTTP_502_BAD_GATEWAY = 502
+    HTTP_503_SERVICE_UNAVAILABLE = 503
+    HTTP_504_GATEWAY_TIMEOUT = 504
+    HTTP_505_HTTP_VERSION_NOT_SUPPORTED = 505
+    HTTP_506_VARIANT_ALSO_NEGOTIATES = 506
+    HTTP_507_INSUFFICIENT_STORAGE = 507
+    HTTP_508_LOOP_DETECTED = 508
+    HTTP_509_BANDWIDTH_LIMIT_EXCEEDED = 509
+    HTTP_510_NOT_EXTENDED = 510
+    HTTP_511_NETWORK_AUTHENTICATION_REQUIRED = 511
+  end
+end

data/lib/railerr.rb

@@ -0,0 +1,2 @@
+require_relative 'railerr/api_exceptions'
+require_relative 'railerr/status'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: railerr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bernhard Niksch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A declarative, fire and forget way to handle errors in a REST API
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/railerr.rb
+- lib/railerr/api_exceptions.rb
+- lib/railerr/status.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: RESTful API error handler
+test_files: []