minato_error_handler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc543ada4f565f9bfa76c2eba17eea4c7cddf8c587fb4a3e686a6424e3a7b8fa
+  data.tar.gz: 1ed085ad3783fa4c05774759c71d8f8e9996d8d1804aa0f5cce3a9ae60474e2e
+SHA512:
+  metadata.gz: 92b2590329c0f2d92eb343c76e79bf38cb8c9d599033e3ea2db80e83753d12a4c156222033519485d96bb3c275ef8730141ee25abb094c9d0871c4724cec9866
+  data.tar.gz: 36e207a8be34f6d67fa0c3da6f6e50178041bb9f7ad432699951efe36b2e61aaa08512f07daf395128341a3bb093bc56c9287d456573329d4087d823257df2b0

data/.devcontainer/devcontainer.json

@@ -0,0 +1,39 @@
+
+{
+	"name": "${localWorkspaceFolderBasename}",
+	"dockerComposeFile": [
+		"../compose.yml",
+		"docker-compose.yml"
+	],
+	"service": "minato-error-handler-rails",
+	"workspaceFolder": "/usr/src/api",
+	"features": {
+		"ghcr.io/devcontainers/features/common-utils:2": {},
+		"ghcr.io/devcontainers-contrib/features/zsh-plugins:0": {
+			"plugins": "zsh-autosuggestions zsh-syntax-highlighting",
+			"omzPlugins": "https://github.com/zsh-users/zsh-autosuggestions https://github.com/zsh-users/zsh-syntax-highlighting"
+		},
+		"ghcr.io/stuartleeks/dev-container-features/shell-history:0": {},
+		"ghcr.io/guiyomh/features/vim:0": {},
+		"ghcr.io/devcontainers/features/git:1": {}
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"eamodio.gitlens",
+				"redhat.vscode-yaml",
+				"EditorConfig.EditorConfig",
+				"GitLab.gitlab-workflow",
+				"MS-vsliveshare.vsliveshare"
+			],
+			"settings": {
+				"terminal.integrated.defaultProfile.linux": "zsh",
+				"terminal.integrated.defaultProfile.windows": "zsh",
+				"terminal.integrated.defaultProfile.osx": "zsh"
+			}
+		}
+	},
+	"postCreateCommand": "bundle config --local GITLAB__COM gitlab-ci-token:$GITLAB_AUTH_TOKEN",
+	"postStartCommand": "bundle install",
+	"remoteUser": "ruby"
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3.8'
+
+services:
+  minato-error-handler-rails:
+    volumes:
+      - .:/usr/src/api:cached
+    entrypoint: []
+    command: /bin/sh -c "while sleep 1000; do :; done"
+

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - spec/dummy/**/*
+    - vendor/**/*
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+RSpec/AnyInstance:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1 @@
+FROM us-east1-docker.pkg.dev/minato-cloud/images/ruby-minato:1.0.0-dev

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Siderlan Santos
+
+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,31 @@
+# minato-error-handler-rails
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/minato_error_handler`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/compose.yml

@@ -0,0 +1,11 @@
+services:
+  minato-error-handler-rails:
+    environment:
+      GITLAB_AUTH_TOKEN: ${GITLAB_AUTH_TOKEN}
+    build: .
+    volumes:
+      - .:/usr/src/api
+      - bundle:/home/rails/.bundle
+
+volumes:
+  bundle:

data/lib/minato_error_handler/error_handler.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "minato_logger"
+
+module MinatoErrorHandler
+  module ErrorHandler
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from StandardError, with: :handle
+    end
+
+    private
+
+    def handle(exception)
+      error = MinatoErrorHandler::MinatoError.from_error(exception)
+      report_error(error)
+      render json: { errors: [error.to_json] }, status: error.status_code
+    end
+
+    def report_error(error)
+      logger = MinatoLogger::Logger.new
+      logger.error(error.to_json)
+    end
+  end
+end

data/lib/minato_error_handler/minato_error.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "json"
+
+module MinatoErrorHandler
+  class MinatoError < StandardError
+    def initialize(details: {}, caused_by: nil, status_code: 500)
+      @caused_by = caused_by
+      @details = details
+      @status_code = status_code
+      super
+    end
+
+    def self.from_error(error)
+      return error if error.instance_of?(MinatoErrorHandler::MinatoError)
+
+      new caused_by: error.cause
+    end
+
+    attr_reader :details, :status_code
+
+    def message
+      "An unknow error has occurred!"
+    end
+
+    def code
+      self.class.name
+    end
+
+    def unique_identfier
+      @unique_identfier || SecureRandom.uuid
+    end
+
+    def caused_by
+      @caused_by || cause
+    end
+
+    def serialized_hash
+      { message: message, code: code, unique_identfier: unique_identfier,
+        details: details, caused_by: caused_by, status_code: status_code }
+    end
+
+    def to_json(*_args)
+      serialized_hash.to_json
+    end
+  end
+end

data/lib/minato_error_handler/network_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MinatoErrorHandler
+  class NetworkError < MinatoErrorHandler::MinatoError
+    def initialize(details: {}, caused_by: nil, status_code: nil, request_body: {})
+      @request_body = request_body
+      super(details: details, caused_by: caused_by, status_code: status_code)
+    end
+
+    attr_reader :request_body
+
+    def message
+      "A network error has occurred!"
+    end
+
+    def serialized_hash
+      super.merge({ request_body: request_body })
+    end
+  end
+end

data/lib/minato_error_handler/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module MinatoErrorHandler
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/minato_error_handler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MinatoErrorHandler
+  VERSION = "0.1.0"
+end

data/lib/minato_error_handler.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "minato_error_handler/railtie"
+require "minato_error_handler/version"
+require "minato_error_handler/minato_error"
+require "minato_error_handler/network_error"
+require "minato_error_handler/error_handler"

data/minato_error_handler.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/minato_error_handler/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minato_error_handler"
+  spec.version = MinatoErrorHandler::VERSION
+  spec.authors = ["Ferreri"]
+  spec.email = ["contato@ferreri.co"]
+
+  spec.summary = "Error reporting for Minato Rails Apps."
+  spec.homepage = "https://gitlab.com/ferreri/minato/minato_error_handler"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/ferreri/minato/minato_error_handler"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/ferreri/minato/minato_error_handler/-/blob/main/CHANGELOG.md?ref_type=heads"
+  # rubocop:disable Gemspec/RequireMFA
+  spec.metadata["rubygems_mfa_required"] = "false"
+  # rubocop:enable Gemspec/RequireMFA
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minato_logger", "~>0.1.6"
+  spec.add_dependency "rails", ">= 7.0.4"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/minato_error_handler.rbs

@@ -0,0 +1,4 @@
+module MinatoErrorHandler
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: minato_error_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ferreri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minato_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+description: 
+email:
+- contato@ferreri.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- compose.yml
+- lib/minato_error_handler.rb
+- lib/minato_error_handler/error_handler.rb
+- lib/minato_error_handler/minato_error.rb
+- lib/minato_error_handler/network_error.rb
+- lib/minato_error_handler/railtie.rb
+- lib/minato_error_handler/version.rb
+- minato_error_handler.gemspec
+- sig/minato_error_handler.rbs
+homepage: https://gitlab.com/ferreri/minato/minato_error_handler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ferreri/minato/minato_error_handler
+  source_code_uri: https://gitlab.com/ferreri/minato/minato_error_handler
+  changelog_uri: https://gitlab.com/ferreri/minato/minato_error_handler/-/blob/main/CHANGELOG.md?ref_type=heads
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Error reporting for Minato Rails Apps.
+test_files: []