marr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c09a278383e2aaff5752cedcccc2e2c4251f4b58c99cec751b730507ad83a72
+  data.tar.gz: 4cbf6d1a32256ed9ddfe08be9ba7395ca8c80121b5dcaa7e492181eb6cee5298
+SHA512:
+  metadata.gz: b04a39184f988a8d32b176605f91cdd620c3b6efcda8914b179f1cfec5594d7c8b14201d194f84a87b1a6ccdef942ce57d724cf484306d2f5e3fc28dd1165ac5
+  data.tar.gz: bed427a55d7b4213cf254f3fd1d2ddf46fa2c42c95dcc774ff732f3a6fc33da04173a6d20d7feeb3a3249f0c1b48eb027cd65d089aca7aa886f5a8ddb2be6099

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.8
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore all files with the .gem extension
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    marr (0.1.0)
+      activesupport (>= 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  marr!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Micah Bowie
+
+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,121 @@
+# Marr (Memereply Api Rescue Response)
+
+Dynamically handle exceptions and render a structured JSON response to client applications.
+Formerly (Memereply sad pepe)
+
+![sad pepe on the floor](https://www.meme-arsenal.com/memes/1adf62bd401ea536f9e6d4df9097201b.jpg)
+![pepe the enginer](https://images-cdn.9gag.com/photo/ajq1ePg_700b.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'marr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marr
+
+## Example Response
+
+```json
+{
+  "errors": {
+    "code": "GroupError",
+    "title": "GroupInvalid",
+    "detail": "The Group can not be saved. Invalid or missing data.",
+    "meta": {
+      "object_errors": [
+        {
+          "pointer": "owner",
+          "detail": "Owner can't be blank"
+        },
+        {
+          "pointer": "name",
+          "detail": "Name can't be blank"
+        }
+      ],
+      "trace_id": "6CA01AF9E592595F"
+    }
+  }
+}
+```
+
+## Usage
+
+There is a method automatically created for each each class that inherits from Marr::ApiError. The method is preprended with 'raise'.
+
+```ruby
+  raise_meme_error
+```
+
+You can also pass in options to your method for a more robust response:
+
+```ruby
+  raise_meme_error(controller: self, subcode: :meme_invalid, object: @meme)
+```
+
+## Setup
+
+Configure the gem. For the gem to recognize the descendant classes you have to provide the name space the errors are under.
+
+```ruby
+Marr::Api::Error.configure do |config|
+  config.namespaces = ['Api::V1::Errors']
+  config.trace_id_length = 16
+end
+```
+
+Create a new Error that inherits from the ApiError class. The class needs to be under the configured name space. NOTE: The `message` method must be implemented.
+
+```ruby
+module Api
+  module V1
+    module Errors
+      class MemeError < ::Marr::ApiError
+        def message
+          "There was an issue processing the meme"
+        end
+
+        def subcodes
+          super({
+            meme_invalid: 'This meme is invalid.',
+            meme_too_large: 'This meme is too damn big nephew',
+          })
+        end
+      end
+    end
+  end
+end
+```
+
+Include the ErrorEngine module in your base api class
+
+```ruby
+include ::Marr::Api::ErrorEngine
+```
+
+Next rescue all your api errors. This method could be in your base api class.
+
+```ruby
+rescue_from 'Marr::ApiError' do |exception|
+  render exception.render, status: exception.status
+end
+```
+
+If you are custom rendering using a gem like Jbuilder you can do something like this:
+
+```ruby
+# you would overide the custom_render in your class to return the file path you want to use
+#=> 'api/internal/v1/errors/error'
+rescue_from 'Marr::ApiError' do |error|
+  @error = error
+  render @error.render, status: @error.status
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/marr/api/error/version.rb

@@ -0,0 +1,7 @@
+module Marr
+  module Api
+    module Error
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/marr/api/error.rb

@@ -0,0 +1,28 @@
+require 'marr/api/error/version'
+require 'marr/configuration'
+require 'marr/api_error'
+
+module Marr
+  module Api
+    module Error
+      class << self 
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        def configure
+          yield(configuration)
+          load 'marr/api/error_engine'
+        end
+
+        def all_errors
+          return [] if self.configuration.namespaces.blank?
+
+          self.configuration.namespaces.map(&:constantize).map do |namespace|
+            namespace.constants.map { |x| { namespace: namespace, name: x.to_s.underscore } }
+          end
+        end
+      end 
+    end
+  end
+end

data/lib/marr/api/error_engine.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+require 'marr/api/error'
+
+module Marr
+  module Api
+    module ErrorEngine
+      ::Marr::Api::Error.all_errors.each do |error|
+        name = error[:name]
+        namespace = error[:namespace]
+
+        define_method "raise_#{name}".to_sym do |*args|
+          api_error = "#{namespace}::#{name.camelcase}".constantize.new(args)
+
+          raise api_error
+        end
+      end
+    end
+  end
+end

data/lib/marr/api_error.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+require 'json'
+require 'securerandom'
+
+module Marr
+  class ApiError < StandardError
+    attr_accessor :resource, :object, :request, :response, :add_context, :add_error_context
+
+    def initialize(attributes={})
+      @controller = attributes[:controller]
+      @object = attributes[:object]
+      @resource = attributes[:resource] || 'Resource'
+      @subcode = attributes[:subcode]
+      @override_detail = attributes[:override_detail]
+      @override_status = attributes[:override_status]
+      @add_context = attributes[:add_context] || {}
+      @add_error_context = attributes[:add_error_context] || {}
+      @request = @controller.try(:request)
+      @response = @controller.try(:response)
+      set_resource
+    end
+
+    # Error name => code
+    # Status => status
+    # Subcodes => title
+    # message => detail
+    def object_errors
+      return [] unless @object.present?
+      return [] unless @object&.errors&.full_messages.present?
+
+      attributes = @object.errors.details.map(&:first)
+      @object_errors = []
+
+      attributes.each do |attrb|
+        @object.errors.full_messages_for(attrb).each do |msg|
+          error = { pointer: attrb.to_s }
+          error_with_message = error.merge(detail: msg)
+
+          @object_errors << error_with_message
+        end
+      end
+      @object_errors
+    end
+
+    def status(status: 422)
+      @override_status&.integer? ? @override_status : status
+    end
+
+    def message
+      raise NotImplementedError, 'Message must be implemented. Add Error message method.'
+    end
+
+    def subcodes(hash=nil)
+      return {} if hash.blank
+
+      hash.with_indifferent_access
+    end
+
+    def subcode
+      return '' unless subcodes[@subcode].present?
+
+      @subcode.to_s.camelcase
+    end
+
+    def detail
+      return '' unless @override_detail.present? || subcodes[@subcode].present?
+
+      @override_detail.present? ? override_detail : subcodes[@subcode]
+    end
+
+    def trace_id
+      trace_id ||= SecureRandom.hex(trace_id_length).upcase
+    end
+
+    def type
+      self.class.name.split('::').last
+    end
+
+    def render
+      if Marr::Api::Error.configuration.custom_render
+        custom_render
+      else
+        default_render.to_json
+      end
+    end
+
+    def custom_render
+      if Marr::Api::Error.configuration.custom_render
+        raise NotImplementedError, 'Message must be implemented. Add Error message method.'
+      else
+        nil
+      end
+    end
+
+    def default_render
+      {
+        errors: {
+          code: type,
+          title: subcode,
+          detail: message,
+          meta: {
+            object_errors: object_errors,
+            trace_id: trace_id,
+          }
+        }.merge(add_error_context)
+      }.merge(add_context)
+    end
+
+    private
+
+    def trace_id_length
+      Marr::Api::Error.configuration.trace_id_length / 2
+    end
+
+    def set_resource
+      return unless @object.present?
+      return unless @object.errors&.full_messages.present?
+
+      @resource = @object.class.name.split('::').last if @resource == 'Resource'
+    end
+  end
+end

data/lib/marr/configuration.rb

@@ -0,0 +1,9 @@
+class Configuration
+  attr_accessor :namespaces, :trace_id_length, :custom_render
+
+  def initialize
+    @namespaces = []
+    @trace_id_length = 8
+    @custom_render = false
+  end
+end

data/marr.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/marr/api/error/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "marr" # Memereply Api Rescue Response aka marr
+  spec.version       = Marr::Api::Error::VERSION
+  spec.authors       = ["Memereply", "Micah Bowie"]
+  spec.email         = ["engineering@memereply.io"]
+
+  spec.summary       = "Dynamically rescue errors and render a structured JSON response to client applications"
+  spec.description   = "Dynamically rescue errors and render a structured JSON response to client applications"
+  spec.homepage      = "https://github.com/meme-reply/marr"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/meme-reply/marr"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "activesupport", " >= 6.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: marr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Memereply
+- Micah Bowie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-01 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Dynamically rescue errors and render a structured JSON response to client
+  applications
+email:
+- engineering@memereply.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/marr/api/error.rb
+- lib/marr/api/error/version.rb
+- lib/marr/api/error_engine.rb
+- lib/marr/api_error.rb
+- lib/marr/configuration.rb
+- marr.gemspec
+homepage: https://github.com/meme-reply/marr
+licenses: []
+metadata:
+  homepage_uri: https://github.com/meme-reply/marr
+  source_code_uri: https://github.com/meme-reply/marr
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Dynamically rescue errors and render a structured JSON response to client
+  applications
+test_files: []