jsonapi_errors_handler 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb11b3f42d8dc4e23da33a7c3768b59f551b0ba5c8f41dc31ae794543751f888
-  data.tar.gz: 0f3861d1e70dffac65da8acb2c15bf6cd3e2ab056a798ecfb64158df0585d5a7
+  metadata.gz: 14dce3e97fbd94737b08f9c1d52b5637f38f81e347589a9cee9f095305dab36a
+  data.tar.gz: 95774806d217b6d842edbd8fb40dbf1cf2b391869b838a40df5dbf406ef357d7
 SHA512:
-  metadata.gz: d9d1cb4e282c15cdc999df5a6181059b5ddaec11b2494fb5e37bef0ab17f2a968431d4acbf137ec3c676827c5542e920cc1c75b218b71345b739deacf624873a
-  data.tar.gz: c128b273ce317c637992c3b04b24c5ad9382d04dbc9793184e0197ce2e97bf15889c0f529fd964b970455d72f8eccaa3c00422b445d7566aef34c1794aad132d
+  metadata.gz: 27beb749c4762b1348e333fa5553e4f03abeef2f2098493cf8ddadbd6ba3e40f8e8ce3f89bd04b7c28db4f8b68e800017edbac601409cf4f72e32da56aeac303
+  data.tar.gz: d432bb2937e6acd84442175d66dc17279e473ab291eb87bc5633740b08669b3e7e0547f9a15a32909942dedc98131b24475b89b4d68c705db3a35560234c37bd

data/README.md

@@ -1,8 +1,6 @@
 # JsonapiErrorsHandler
 
-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/jsonapi_errors_handler`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A convienient way to serialize errors in JsonAPI format (https://jsonapi.org)
 
 ## Installation
 
@@ -22,7 +20,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your controller:
+
+```
+include JsonapiErrorsHandler
+```
+
+From this point you'll have default html errors being serialized. JsonapiErrorsHandler offers 4 predefined errors:
+- JsonapiErrorsHandler::Errors::Invalid
+- JsonapiErrorsHandler::Errors::Forbidden
+- JsonapiErrorsHandler::Errors::NotFound
+- JsonapiErrorsHandler::Errors::Unauthorized
+
+If you rise any of errors above in any place of your application, client gets the nicely formatted error message instead of 500
+
+### Custom errors mapping
+
+If you want your custom errors being handled by default, just add them to th emapper
+
+```
+ErrorsMapper.map_errors!({
+    'ActiveRecord::RecordNotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
+    'ActiveRecord::RecordInvalid' => 'JsonapiErrorsHandler::Errors::Invalid',
+})
+```
 
 ## Development
 
@@ -32,7 +53,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsonapi_errors_handler.
+Bug reports and pull requests are welcome on GitHub at https://github.com/driggl/jsonapi_errors_handler.
 
 ## License
 

data/lib/jsonapi_errors_handler.rb

@@ -1,5 +1,44 @@
 require "jsonapi_errors_handler/version"
+require "jsonapi_errors_handler/error_mapper"
+require "jsonapi_errors_handler/error_serializer"
 
 module JsonapiErrorsHandler
-  # Your code goes here...
+  def self.included(base)
+    base.extend ClassMethods
+    base.class_eval do
+      ErrorsMapper.map_errors!({
+        'JsonapiErrorsHandler::Errors::Invalid' => 'JsonapiErrorsHandler::Errors::Invalid',
+        'JsonapiErrorsHandler::Errors::Forbidden' => 'JsonapiErrorsHandler::Errors::Forbidden',
+        'JsonapiErrorsHandler::Errors::NotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
+        'JsonapiErrorsHandler::Errors::Unauthorized' => 'JsonapiErrorsHandler::Errors::Unauthorized'
+      })
+
+      rescue_from(::StandardError, with: lambda { |e| handle_error(e) })
+    end
+  end
+
+  module ClassMethods
+    def handle_error(e)
+      mapped = map_error(e)
+      unless Rails.env.development?
+        # notify about unexpected_error unless mapped
+        mapped ||= ::JsonapiErrorsHandler::Errors::StandardError.new
+      end
+      if mapped
+        render_error(mapped)
+      else
+        raise e
+      end
+    end
+
+    def map_error(e)
+      error_klass = e.class.name
+      return e if ErrorsMapper.mapped_error?(error_klass)
+      ErrorsMapper.mapped_errors[error_klass]&.constantize&.new
+    end
+
+    def render_error(error)
+      render json: ::JsonapiErrorHandler::ErrorSerializer.new(error), status: error.status
+    end
+  end
 end

data/lib/jsonapi_errors_handler/error_mapper.rb

@@ -0,0 +1,15 @@
+module JsonapiErrorsHandler
+  class ErrorMapper
+    cattr_accessor :mapped_errors
+
+    def self.map_errors!(errors_hash={})
+      @@mapped_errors ||= {}
+      @@mapped_errors.merge!(errors_hash)
+    end
+
+    def self.mapped_error?(error_klass)
+      mapped_errors.values.include?(error_klass)
+    end
+  end
+end
+

data/lib/jsonapi_errors_handler/error_searializer.rb

@@ -0,0 +1,26 @@
+module JsonapiErrorsHandler
+  class ErrorSerializer
+    def initialize(error)
+      @error = error
+    end
+
+    def to_h
+      serializable_hash
+    end
+
+    def to_json(payload)
+      to_h.to_json
+    end
+
+    private
+
+    def serializable_hash
+      {
+        errors: Array.wrap(error.serializable_hash)
+      }
+    end
+
+    attr_reader :error
+  end
+end
+

data/lib/jsonapi_errors_handler/errors.rb

@@ -0,0 +1,11 @@
+module JsonapiErrorsHandler
+  module Errors
+
+  end
+end
+
+require_dependency 'jsonapi_errors_handler/errors/standard_error'
+require_dependency 'jsonapi_errors_handler/errors/forbidden'
+require_dependency 'jsonapi_errors_handler/errors/invalid'
+require_dependency 'jsonapi_errors_handler/errors/not_found'
+require_dependency 'jsonapi_errors_handler/errors/unauthorized'

data/lib/jsonapi_errors_handler/errors/forbidden.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JsonapiErrorsHandler
+  module Errors
+    class Forbidden < ::JsonapiErrorsHandler::Errors::StandardError
+      def initialize(message: nil)
+        super(
+          title: "Forbidden request",
+          status: 403,
+          detail: message || "You have no rights to access this resource",
+          source: { pointer: "/request/headers/authorization" }
+        )
+      end
+    end
+  end
+end

data/lib/jsonapi_errors_handler/errors/invalid.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module JsonapiErrorsHandler
+  module Errors
+    class Invalid < ::JsonapiErrorsHandler::Errors::StandardError
+      def initialize(errors: {})
+        @errors = errors
+        @status = 422
+        @title = "Invalid request"
+      end
+
+      def serializable_hash
+        errors.reduce([]) do |r, (att, msg)|
+          r << {
+            status: status,
+            title: title,
+            detail: msg,
+            source: { pointer: "/data/attributes/#{att}" }
+          }
+        end
+      end
+
+      private
+
+      attr_reader :errors
+    end
+  end
+end

data/lib/jsonapi_errors_handler/errors/not_found.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JsonapiErrorsHandler
+  module Errors
+    class NotFound < ::JsonapiErrorsHandler::Errors::StandardError
+      def initialize(message: nil)
+        super(
+          title: "Record not Found",
+          status: 404,
+          detail: "We could not find the object you were looking for.",
+          source: { pointer: "/request/url/:id" }
+        )
+      end
+    end
+  end
+end
+

data/lib/jsonapi_errors_handler/errors/standard_error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module JsonapiErrorsHandler
+  module Errors
+    class StandardError < ::StandardError
+      def initialize(title: nil, detail: nil, status: nil, source: {})
+        @title = title || "Something went wrong"
+        @detail = detail || "We encountered unexpected error, but our developers had been already notified about it"
+        @status = status || 500
+        @source = source.deep_stringify_keys
+      end
+
+      def to_h
+        {
+          status: status,
+          title: title,
+          detail: detail,
+          source: source
+        }
+      end
+
+      def serializable_hash
+        to_h
+      end
+
+      def to_s
+        to_h.to_s
+      end
+
+      attr_reader :title, :detail, :status, :source
+    end
+  end
+end

data/lib/jsonapi_errors_handler/errors/unauthorized.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JsonapiErrorsHandler
+  module Errors
+    class Unauthorized < ::JsonapiErrorsHandler::Errors::StandardError
+      def initialize(message: nil)
+        super(
+          title: "Unauthorized",
+          status: 401,
+          detail: message || "You need to login to authorize this request.",
+          source: { pointer: "/request/headers/authorization" }
+        )
+      end
+    end
+  end
+end

data/lib/jsonapi_errors_handler/version.rb

@@ -1,3 +1,3 @@
 module JsonapiErrorsHandler
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_errors_handler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,8 +71,17 @@ files:
 - bin/console
 - bin/setup
 - jsonapi_errors_handler-0.0.0.gem
+- jsonapi_errors_handler-0.0.1.gem
 - jsonapi_errors_handler.gemspec
 - lib/jsonapi_errors_handler.rb
+- lib/jsonapi_errors_handler/error_mapper.rb
+- lib/jsonapi_errors_handler/error_searializer.rb
+- lib/jsonapi_errors_handler/errors.rb
+- lib/jsonapi_errors_handler/errors/forbidden.rb
+- lib/jsonapi_errors_handler/errors/invalid.rb
+- lib/jsonapi_errors_handler/errors/not_found.rb
+- lib/jsonapi_errors_handler/errors/standard_error.rb
+- lib/jsonapi_errors_handler/errors/unauthorized.rb
 - lib/jsonapi_errors_handler/version.rb
 homepage: https://github.com/driggl/jsonapi_error_handler
 licenses: