marr 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 543dbce426c58c432cfeee42629f3e4e9f22a35c279d86d76fc807db04ccc51c
-  data.tar.gz: eb3d0cd1c22ac0b80e868eacba83f3a4b8df91d176105884375979031ca3fc74
+  metadata.gz: 66ce919bb7a333d43960ef38b2c43af4851169441d4db40388567a51e2af110d
+  data.tar.gz: cf49f56be589f2ebab4b3ac76940c58c9e86d37d7dcec7bf4008ab2899c1f052
 SHA512:
-  metadata.gz: 5f9465b57a19934e732bf0eafd930f0bc25ffdcccf652d8cd00595036e756dcc38ef40b6f1546d55ce1ad009f8182810ca6a45dfdc536657166f47fe2978a6e2
-  data.tar.gz: 17aa45daf2672e3bcabf8b71d5538fc6fa21455e06cd9fbf069bd111da94116af1023e519ea48bc40a2352fb2804febfa0afd1679e454961cce74562b99138fa
+  metadata.gz: d9e35c72530bc24a1ea4d6d354bf9f6832c89a5e50c1127651d9fdedcfe4f62c496280a4dd470ee084fe2ec8189c945fbe86a23ffa715285c2ab2c3ad00c24b7
+  data.tar.gz: 9da3772f4c8048edae8786ffc606774568c24e861a35307b612e3b86a5c611a26edc0e74a6b614e9e823107acb36572fe5938a9ad0bebd5449b20769a8dad9c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    marr (0.1.1)
+    marr (0.1.3)
       activesupport (>= 6.0)
 
 GEM

data/README.md

@@ -27,8 +27,9 @@ Or install it yourself as:
 ```json
 {
   "errors": {
-    "code": "GroupError",
-    "title": "GroupInvalid",
+    "id": "6CA01AF9E592595F",
+    "code": "UnprocessableGroup",
+    "title": "Request can not be processed.",
     "detail": "The Group can not be saved. Invalid or missing data.",
     "meta": {
       "object_errors": [
@@ -52,13 +53,13 @@ Or install it yourself as:
 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
+  raise_unprocessable_group_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)
+  raise_unprocessable_group_error(controller: self, subcode: :missing_data, object: @group)
 ```
 
 ## Setup
@@ -66,7 +67,7 @@ You can also pass in options to your method for a more robust response:
 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|
+Marr.configure do |config|
   config.namespaces = ['Api::V1::Errors']
   config.trace_id_length = 16
 end
@@ -78,15 +79,14 @@ Create a new Error that inherits from the ApiError class. The class needs to be
 module Api
   module V1
     module Errors
-      class MemeError < ::Marr::ApiError
+      class UnprocessableGroup < ::Marr::ApiError
         def message
-          "There was an issue processing the meme"
+          "Request can not be processed."
         end
 
         def subcodes
           super({
-            meme_invalid: 'This meme is invalid.',
-            meme_too_large: 'This meme is too damn big nephew',
+            missing_data: 'The Group can not be saved. Invalid or missing data.',
           })
         end
       end

data/bin/console

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
+require "./lib/marr"
 
 # 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.

data/lib/marr/api/error_engine.rb

@@ -1,10 +1,9 @@
 require 'active_support'
-require 'marr/api/error'
 
 module Marr
   module Api
     module ErrorEngine
-      ::Marr::Api::Error.all_errors.each do |error|
+      ::Marr.all_errors.each do |error|
         name = error[:name]
         namespace = error[:namespace]
 

data/lib/marr/api_error.rb

@@ -9,7 +9,7 @@ module Marr
     def initialize(attributes={})
       @controller = attributes[:controller]
       @object = attributes[:object]
-      @resource = attributes[:resource] || 'Resource'
+      @resource = attributes[:resource] || 'Resource'.freeze
       @subcode = attributes[:subcode]
       @override_detail = attributes[:override_detail]
       @override_status = attributes[:override_status]
@@ -20,10 +20,6 @@ module Marr
       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?
@@ -42,8 +38,9 @@ module Marr
       @object_errors
     end
 
-    def status(status: 422)
-      @override_status&.integer? ? @override_status : status
+    def status
+      default_status = '422'
+      @override_status&.integer? ? @override_status.to_s : default_status
     end
 
     def message
@@ -62,6 +59,10 @@ module Marr
       @subcode.to_s.camelcase
     end
 
+    def subcode_detail
+      subcodes[@subcode].present? ? subcodes[@subcode] : ''
+    end
+
     def detail
       return '' unless @override_detail.present? || subcodes[@subcode].present?
 
@@ -77,7 +78,7 @@ module Marr
     end
 
     def render
-      if Marr::Api::Error.configuration.custom_render
+      if Marr.configuration.custom_render
         custom_render
       else
         default_render.to_json
@@ -85,7 +86,7 @@ module Marr
     end
 
     def custom_render
-      if Marr::Api::Error.configuration.custom_render
+      if Marr.configuration.custom_render
         raise NotImplementedError, 'Message must be implemented. Add Error message method.'
       else
         nil
@@ -95,9 +96,11 @@ module Marr
     def default_render
       {
         errors: {
+          id: trace_id,
+          status: status,
           code: type,
           title: message,
-          detail: subcode,
+          detail: subcode_detail,
           meta: {
             object_errors: object_errors,
             trace_id: trace_id,
@@ -109,7 +112,7 @@ module Marr
     private
 
     def trace_id_length
-      Marr::Api::Error.configuration.trace_id_length / 2
+      Marr.configuration.trace_id_length / 2
     end
 
     def set_resource

data/lib/marr/configuration.rb

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

data/lib/marr/version.rb

@@ -0,0 +1,3 @@
+module Marr
+  VERSION = "0.1.3"
+end

data/lib/marr.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'active_support'
+require 'json'
+require 'securerandom'
+require 'marr/configuration'
+require 'marr/version'
+
+module Marr
+  autoload :Configuration,      'marr/configuration'
+  autoload :ApiError,           'marr/api_error'
+
+  module Api
+    autoload :ErrorEngine,      'marr/api/error_engine'
+  end
+
+  class << self 
+    def configuration
+      @configuration ||= ::Marr::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+      load('./lib/marr/api/error_engine.rb')
+    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
+
+    def version
+      ::Marr::VERSION
+    end
+  end 
+end

data/marr.gemspec

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "lib/marr/api/error/version"
+require_relative "lib/marr/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "marr" # Memereply Api Rescue Response aka marr
-  spec.version       = Marr::Api::Error::VERSION
+  spec.version       = Marr::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.files         = Dir["{lib}/**/*", "LICENSE.txt", "README.md"]
+  spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Memereply
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,11 +86,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/marr/api/error.rb
-- lib/marr/api/error/version.rb
+- lib/marr.rb
 - lib/marr/api/error_engine.rb
 - lib/marr/api_error.rb
 - lib/marr/configuration.rb
+- lib/marr/version.rb
 - marr.gemspec
 homepage: https://github.com/meme-reply/marr
 licenses: []

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

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

data/lib/marr/api/error.rb

@@ -1,28 +0,0 @@
-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