api_error_handler 0.1.0.rc → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 136050d80b1f4f57e427a7b6d626d898824a09ab
-  data.tar.gz: eef41026be0cf4ec1db00bce32f368d52cda3863
+SHA256:
+  metadata.gz: 18b6ef31f241b4845ddbf59be8721e55a218a84fb4d39fad730b2c6941e616fe
+  data.tar.gz: 9881362b337b651e73c2472996f6e4c959660bec85fe9856d7a8c54f2b4206e8
 SHA512:
-  metadata.gz: d1e3dad2f964a603860c5cbd8d106d47060e2c43735653dd5fda161daff4b2f9708ea77985abf29efea4af14fda20f7c369192edcd749a1f48a6a5b3beedfd85
-  data.tar.gz: ee295410c74e4dcf66f6e6dc4a34a485f342a6fc35ddacb37667e05ba2a01350a9dfda2bb2ec450310b707f4f371028e2b4e41771de6d4d3105bca6429c55021
+  metadata.gz: e4c5ed604f7295e4b1e54738aafd43d3288ce98a8f93b5e18897077f4691b713b08db3db1d1cb06c988ec62aae5f51f02aa8d4bfed3ed795e89de9cf360ed2fd
+  data.tar.gz: 8cc44416b4ecadc12b17ab728f1ce30e067d53582fae1b2891e6a5b7a6acacab2ed12be1e33ed93250f2bdd7110e5becc76069f36698b74f8ee1571fef53c06c

data/.gitignore

@@ -7,8 +7,20 @@
 /spec/reports/
 /tmp/
 
+/Gemfile.lock
+
 # rspec failure tracking
 .rspec_status
 
-# Stuff to ignore in the test_app
-test_app/tmp
+# Stuff to ignore in the test_apps
+rails_5_test_app/tmp
+rails_5_test_app/log
+rails_5_test_app/.byebug_history
+
+rails_4_test_app/tmp
+rails_4_test_app/log
+rails_4_test_app/.byebug_history
+
+rails_6_test_app/tmp
+rails_6_test_app/log
+rails_6_test_app/.byebug_history

data/.rubocop.yml

@@ -0,0 +1,30 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'vendor/**/*'
+    - 'rails_*/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 100
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'api_error_handler.gemspec'
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,85 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 100`
+# on 2019-08-25 13:23:25 +0100 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'api_error_handler.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/ClosingParenthesisIndentation:
+  Exclude:
+    - 'spec/api_error_handler/serializers/xml_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/api_error_handler.rb'
+    - 'lib/api_error_handler/error_reporter.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/api_error_handler/error_reporter.rb'
+
+# Offense count: 3
+# Configuration parameters: CountComments, Max, ExcludedMethods.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/api_error_handler.rb'
+    - 'lib/api_error_handler/error_reporter.rb'
+    - 'lib/api_error_handler/error_id_generator.rb'
+    - 'lib/api_error_handler/serializers/json_api.rb'
+
+# Offense count: 1
+# Configuration parameters: Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/api_error_handler/error_reporter.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'api_error_handler.gemspec'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/api_error_handler.rb'
+    - 'spec/api_error_handler/serializers/json_api_spec.rb'
+    - 'spec/api_error_handler/serializers/json_spec.rb'
+    - 'spec/api_error_handler/serializers/xml_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInArrayLiteral:
+  Exclude:
+    - 'lib/api_error_handler/serializers/json_api.rb'
+    - 'spec/api_error_handler/serializers/json_api_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/api_error_handler.rb'
+    - 'lib/api_error_handler/serializers/json.rb'
+    - 'lib/api_error_handler/serializers/json_api.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.8

data/.travis.yml

@@ -1,7 +1,36 @@
 ---
-sudo: false
 language: ruby
+before_install:
+  - gem update --system
+  - gem install bundler
+install: bundle install --jobs=3 --retry=3
 cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.1
+branches:
+  only:
+    - master
+jobs:
+  include:
+  - rvm: 2.5.1
+    gemfile: ./rails_5_test_app/Gemfile
+    script: cd rails_5_test_app && bundle exec rspec
+  - rvm: 2.5.1
+    gemfile: ./rails_6_test_app/Gemfile
+    script: cd rails_6_test_app && bundle exec rspec
+  - rvm: 2.7.2
+    gemfile: ./rails_6_test_app/Gemfile
+    script: cd rails_6_test_app && bundle exec rspec
+  - rvm: 3.0.0
+    gemfile: ./rails_6_test_app/Gemfile
+    script: cd rails_6_test_app && bundle exec rspec
+  - rvm: 2.7.2
+    gemfile: Gemfile
+    script: bundle exec rubocop
+  - rvm: 2.7.2
+    gemfile: Gemfile
+    script: bundle exec rspec
+  - rvm: 3.0.0
+    gemfile: Gemfile
+    script: bundle exec rubocop
+  - rvm: 3.0.0
+    gemfile: Gemfile
+    script: bundle exec rspec

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in api_error_handler.gemspec

data/README.md

@@ -1,8 +1,26 @@
 # ApiErrorHandler
+[![Build Status](https://travis-ci.org/jamesstonehill/api_error_handler.svg?branch=master)](https://travis-ci.org/jamesstonehill/api_error_handler)
 
-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/api_error_handler`. To experiment with that code, run `bin/console` for an interactive prompt.
+Are your API error responses not all that you want them to be? If so, you've
+found the right gem! `api_error_handler` handles all aspects of returning
+informative, spec-compliant responses to clients when your application
+encounters an error in the course of processing a response.
 
-TODO: Delete this and the text above, and describe your gem
+This "handling" includes:
+- __Error serialization__: each response will include a response body that
+    gives some information on the type of error that your application
+    encountered. See the [Responses Body Options](#response-body-options)
+    section for details and configuration options.
+- __Status code setting__: `api_error_handler` will set the HTTP status code of
+    the response based on the type of error that is raised. For example, when an
+    `ActiveRecord::RecordNotFound` error is raised, it will set the response
+    status to 404. See the [HTTP Status Mapping](#http-status-mapping) section
+    for details and configuration options.
+- __Error reporting__: If you use a 3rd party bug tracking
+    tool like Honeybadger or Sentry, `api_error_handler` will notify this
+    service of the error for you so you don't have to!
+- __Content type setting__: `api_error_handler` will set the content type of the
+    response based on the format of response body.
 
 ## Installation
 
@@ -14,25 +32,284 @@ gem 'api_error_handler'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install api_error_handler
+To get started, all you need to do is invoke `handle_api_errors` inside your
+controller like so:
 
-## Usage
+```ruby
+class MyController < ActionController::API
+  handle_api_errors()
+
+  def index
+    raise "Something is very very wrong!"
+  end
+end
+```
+
+Now when you go to `MyController#index`, your API will return the following
+response:
+
+```json
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/json
+
+{
+  "error": {
+    "title":"Internal Server Error",
+    "detail":"Something is very very wrong!"
+  }
+}
+```
+
+### Error handling options
+
+`handle_api_errors` implements a bunch of (hopefully) sensible defaults so that
+all you need to do is invoke `handle_api_errors()` in your controller to get
+useful error handling! However, in all likelihood you'll want to override some
+of these options. This section gives details on the various options available
+for configuring the `api_error_handler`.
+
+#### Response Body Options
+By default, `handle_api_errors` picks the `:json` format for serializing errors.
+However, this gem comes with a number of other formats for serializing your
+errors.
+
+##### JSON (the default)
+```ruby
+  handle_api_errors(format: :json)
+  # Or
+  handle_api_errors()
+```
+
+```json
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/json
+
+{
+  "error": {
+    "title":"Internal Server Error",
+    "detail":"Something is very very wrong!"
+  }
+}
+```
+
+##### JSON:API
+If your API follows the `JSON:API` spec, you'll want to use the `:json_api`
+format option.
+
+```ruby
+  handle_api_errors(format: :json_api)
+```
+
+Responses with this format will follow the `JSON:API` [specification for error
+objects](https://jsonapi.org/format/#error-objects). This will look something
+like this:
+
+```json
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/vnd.api+json
+
+{
+  "errors": [
+    {
+      "status":"500",
+      "title":"Internal Server Error",
+      "detail":"Something is very very wrong!"
+    }
+  ]
+}
+```
+
+##### XML
+```ruby
+  handle_api_errors(format: :xml)
+```
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<Error>
+  <Title>Internal Server Error</title>
+  <Detail>Something is very very wrong!</detail>
+</Error>
+```
+
+##### Custom Error Responses
+If none of the out-of-the-box options suit you then you can pass in your own
+error serializer like so:
+
+```ruby
+  handle_api_errors(serializer: MyCustomErrorSerializer)
+```
+
+The custom serializer must implement two instance methods, `serialize` and
+`render_format`. The `serialize` method should return the body of the response
+you want to render. The `render_format` should be the format that you want to
+render the response in (e.g `:json`, `:xml`, `:plain`), which will be passed to
+Rails' `render` method.
+
+It is recommended you inherit your serializer from
+`ApiErrorHandler::Serializers::BaseSerializer` to gain some helpful instance
+methods and defaults.
+
+```ruby
+class MyCustomErrorSerializer < ApiErrorHandler::Serializers::BaseSerializer
+  def serialize(serializer_options)
+    # The `title` and `status_code` come from the BaseSerializer.
+    "Error! Title: #{title} Status Code: #{status_code}"
+  end
 
-TODO: Write usage instructions here
+  def render_format
+    :plain
+  end
+end
+```
+##### Backtraces
+If you want to include the error's backtrace in the response body:
+
+```ruby
+  handle_api_errors(backtrace: true)
+```
+
+```json
+{
+  "error": {
+    "title":"Internal Server Error",
+    "detail":"Something is very very wrong!",
+    "backtrace": [
+      # The backtrace
+    ]
+  }
+}
+```
+
+### HTTP Status Mapping
+
+Most of the time, you'll want to set the HTTP status code based on the type of
+error being raised. To determine which errors map to which status codes,
+`api_error_handler` uses `ActionDispatch::ExceptionWrapper.rescue_responses`. If
+you're using Rails with ActiveRecord, by default this includes:
+
+```ruby
+{
+  "ActionController::RoutingError"               => :not_found,
+  "AbstractController::ActionNotFound"           => :not_found,
+  "ActionController::MethodNotAllowed"           => :method_not_allowed,
+  "ActionController::UnknownHttpMethod"          => :method_not_allowed,
+  "ActionController::NotImplemented"             => :not_implemented,
+  "ActionController::UnknownFormat"              => :not_acceptable,
+  "Mime::Type::InvalidMimeType"                  => :not_acceptable,
+  "ActionController::MissingExactTemplate"       => :not_acceptable,
+  "ActionController::InvalidAuthenticityToken"   => :unprocessable_entity,
+  "ActionController::InvalidCrossOriginRequest"  => :unprocessable_entity,
+  "ActionDispatch::Http::Parameters::ParseError" => :bad_request,
+  "ActionController::BadRequest"                 => :bad_request,
+  "ActionController::ParameterMissing"           => :bad_request,
+  "Rack::QueryParser::ParameterTypeError"        => :bad_request,
+  "Rack::QueryParser::InvalidParameterError"     => :bad_request,
+  "ActiveRecord::RecordNotFound"                 => :not_found,
+  "ActiveRecord::StaleObjectError"               => :conflict,
+  "ActiveRecord::RecordInvalid"                  => :unprocessable_entity,
+  "ActiveRecord::RecordNotSaved"                 => :unprocessable_entity
+}
+```
+- https://guides.rubyonrails.org/configuring.html#configuring-action-dispatch
+
+You can add to this mapping on an application level by doing the following:
+```ruby
+config.action_dispatch.rescue_responses.merge!(
+  "AuthenticationError" => :unauthorized
+)
+```
+
+Now when an you raise an `AuthenticationError` in one of your actions, the
+status code of the response will be 401.
 
-## Development
+### Error IDs
+Sometimes it's helpful to include IDs with your error responses so that you can
+correlate a specific error with a record in your logs or bug tracking software.
+For this you can use the `error_id` option.
 
-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.
+You can either use the UUID error strategy
+```ruby
+handle_api_errors(error_id: :uuid)
+```
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Or pass a Proc if you need to do something custom.
+```ruby
+handle_api_errors(error_id: Proc.new { |error| SecureRandom.uuid })
+```
 
-## Contributing
+These will result in:
+```json
+{
+  "error": {
+    "title": "Internal Server Error",
+    "detail": "Something is very very wrong!",
+    "id": "4ab520f2-ae33-4539-9371-ea21aada5582"
+  }
+}
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_error_handler.
+### Error Reporting
+If you use an external error tracking software like Sentry or Honeybadger, you'll
+want to report all errors to that service.
+
+#### Out of the Box Error Reporting
+There are a few supported error reporter options that you can select.
+
+##### Raven/Sentry
+```ruby
+handle_api_errors(error_reporter: :raven)
+# Or
+handle_api_errors(error_reporter: :sentry)
+```
+
+##### Honeybadger
+```ruby
+handle_api_errors(error_reporter: :honeybadger)
+```
+
+__NOTE:__ If you use the `:error_id` option, the error error reporter will tag
+the exception with the error ID when reporting the error.
+
+#### Custom Reporting
+If none of the out of the box options work for you, you can pass in a proc which
+will receive the error and the error_id as arguments.
+
+```ruby
+handle_api_errors(
+  error_reporter: Proc.new do |error, error_id|
+    # Do something with the `error` here.
+  end
+)
+```
+
+### Setting Content Type
+The api_error_handler will set the content type of your error based on the
+`format` option you pick. However, you can override this by setting the
+`content_type` option if you wish.
+
+```ruby
+handle_api_errors(
+  format: :json,
+  content_type: 'application/vnd.api+json'
+)
+```
+
+```json
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/vnd.api+json
+
+{
+  "error": {
+    "title":"Internal Server Error",
+    "detail":"Something is very very wrong!"
+  }
+}
+```
 
 ## License
 

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/api_error_handler.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -7,27 +8,40 @@ Gem::Specification.new do |spec|
   spec.name          = "api_error_handler"
   spec.version       = ApiErrorHandler::VERSION
   spec.authors       = ["James Stonehill"]
-  spec.email         = ["jamesstonehill@gmail.com"]
+  spec.email         = ["james.stonehill@gmail.com"]
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.summary = <<~SUMMARY
+    A gem that helps you easily handle exceptions in your Rails API and return
+    informative responses to the client.
+  SUMMARY
+
+  spec.description = <<~DESCRIPTION
+    A gem that helps you easily handle exceptions in your Ruby on Rails API and
+    return informative responses to the client by serializing exceptions into JSON
+    and other popular API formats and returning a response with a status code that
+    makes sense based on the exception.
+  DESCRIPTION
 
-  spec.summary       = %q{A gem that helps you easily handle exptions in your Rails API and return informative responses to the client.}
-  spec.description   = %q{A gem that helps you easily handle exptions in your Ruby on Rails API and return informative responses to the client by serializing exceptions into JSON and other popular API formats and returning a response with a status code that makes sense based on the exception.}
   spec.homepage      = "https://github.com/jamesstonehill/api_error_handler"
   spec.license       = "MIT"
 
   # 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(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|test_app)/}) }
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|rails_.+)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 4.1.0"
-  spec.add_dependency "actionpack"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "actionpack", ">= 5.0"
+  spec.add_dependency "rack", ">= 1.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 0.80.0"
+  spec.add_development_dependency "pry-byebug"
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "api_error_handler"

data/lib/api_error_handler/action_controller.rb

@@ -1,7 +1,9 @@
-require 'active_support/lazy_load_hooks'
-require 'action_controller'
+# frozen_string_literal: true
+
+require "active_support/lazy_load_hooks"
+require "action_controller"
 
 ActiveSupport.on_load :action_controller do
-  ::ActionController::Base.send :extend, ApiErrorHandler
-  ::ActionController::API.send :extend, ApiErrorHandler
+  ::ActionController::Base.extend ApiErrorHandler
+  ::ActionController::API.extend ApiErrorHandler
 end

data/lib/api_error_handler/error_id_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require_relative "./errors"
+
+module ApiErrorHandler
+  class ErrorIdGenerator
+    def self.run(error_id_option)
+      if error_id_option.instance_of?(Proc)
+        error_id_option.call
+      elsif error_id_option == :uuid
+        SecureRandom.uuid
+      elsif error_id_option.nil?
+        nil
+      else
+        raise(
+          InvalidOptionError,
+          "Unable to handle `#{error_id_option}` as argument for the `:error_id` option."
+        )
+      end
+    end
+  end
+end

data/lib/api_error_handler/error_reporter.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "logger"
+require_relative "./errors"
+
+module ApiErrorHandler
+  class ErrorReporter
+    def initialize(strategy)
+      @strategy = strategy
+    end
+
+    def report(error, error_id: nil)
+      if @strategy.nil?
+        true
+      elsif @strategy.instance_of?(Proc)
+        @strategy.call(error, error_id)
+      elsif @strategy == :honeybadger
+        raise_dependency_error(missing_constant: "Honeybadger") unless defined?(Honeybadger)
+
+        context = error_id ? { error_id: error_id } : {}
+        Honeybadger.notify(error, context: context)
+      elsif @strategy == :raven
+        raise_dependency_error(missing_constant: "Raven") unless defined?(Raven)
+
+        extra = error_id ? { error_id: error_id } : {}
+        Raven.capture_exception(error, extra: extra)
+      elsif @strategy == :sentry
+        raise_dependency_error(missing_constant: "Sentry") unless defined?(Sentry)
+
+        extra = error_id ? { error_id: error_id } : {}
+        Sentry.capture_exception(error, extra: extra)
+      else
+        raise(
+          InvalidOptionError,
+          "`#{@strategy.inspect}` is an invalid argument for the `:error_id` option."
+        )
+      end
+    end
+
+    private
+
+    def raise_dependency_error(missing_constant:)
+      raise MissingDependencyError, <<~MESSAGE
+        You selected the #{@strategy.inspect} error reporter option but the
+        #{missing_constant} constant is not defined. If you wish to use this
+        error reporting option you must have the #{@strategy} client gem
+        installed.
+      MESSAGE
+    end
+  end
+end

data/lib/api_error_handler/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ApiErrorHandler
+  class Error < StandardError; end
+
+  class InvalidOptionError < Error; end
+  class MissingDependencyError < Error; end
+end

data/lib/api_error_handler/serializers/base_serializer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rack/utils"
+
+module ApiErrorHandler
+  module Serializers
+    class BaseSerializer
+      DEFAULT_STATUS_CODE = "500"
+
+      def initialize(error, status)
+        @error = error
+        @status = status
+      end
+
+      def status_code
+        Rack::Utils::SYMBOL_TO_STATUS_CODE.fetch(@status, DEFAULT_STATUS_CODE).to_s
+      end
+
+      def title
+        Rack::Utils::HTTP_STATUS_CODES.fetch(status_code.to_i)
+      end
+    end
+  end
+end

data/lib/api_error_handler/serializers/json.rb

@@ -1,6 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "./base_serializer"
+
 module ApiErrorHandler
   module Serializers
-    class Json
+    class Json < BaseSerializer
+      # There is no official spec that governs this error response format so
+      # this serializer is just trying to impliment a simple response with
+      # sensible defaults.
+      #
+      # I borrowed heavily from Facebook's error response format since it seems
+      # to be a reasonable approach for a simple light-weight error response.
+
+      def serialize(options = {})
+        body = {
+          error: {
+            title: title,
+            detail: @error.message,
+          }
+        }
+
+        body[:error][:id] = options[:error_id] if options[:error_id]
+        body[:error][:backtrace] = @error.backtrace if options[:backtrace]
+
+        body.to_json
+      end
+
+      def render_format
+        :json
+      end
     end
   end
 end

data/lib/api_error_handler/serializers/json_api.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "./base_serializer"
+
+module ApiErrorHandler
+  module Serializers
+    class JsonApi < BaseSerializer
+      def serialize(options = {})
+        body = {
+          errors: [
+            {
+              status: status_code,
+              title: title,
+              detail: @error.message,
+            }
+          ]
+        }
+
+        body[:errors].first[:id] = options[:error_id] if options[:error_id]
+        body[:errors].first[:meta] = { backtrace: @error.backtrace } if options[:backtrace]
+
+        body.to_json
+      end
+
+      def render_format
+        :json
+      end
+    end
+  end
+end

data/lib/api_error_handler/serializers/xml.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/conversions"
+require_relative "./base_serializer"
+
+module ApiErrorHandler
+  module Serializers
+    class Xml < BaseSerializer
+      def serialize(options = {})
+        body = {
+          Title: title,
+          Detail: @error.message,
+        }
+
+        body[:Id] = options[:error_id] if options[:error_id]
+        body[:Backtrace] = @error.backtrace if options[:backtrace]
+
+        body.to_xml(root: "Error")
+      end
+
+      def render_format
+        :xml
+      end
+    end
+  end
+end

data/lib/api_error_handler/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiErrorHandler
-  VERSION = "0.1.0.rc"
+  VERSION = "0.2.1"
 end

data/lib/api_error_handler.rb

@@ -1,11 +1,55 @@
-require "api_error_handler/version"
-require "api_error_handler/action_controller"
+# frozen_string_literal: true
+
+require_relative "./api_error_handler/version"
+require_relative "./api_error_handler/action_controller"
+require_relative "./api_error_handler/error_id_generator"
+require_relative "./api_error_handler/error_reporter"
+Dir[File.join(__dir__, "api_error_handler", "serializers", "*.rb")].sort.each do |file|
+  require file
+end
 
 module ApiErrorHandler
-  def handle_api_errors(format: :json)
+  SERIALIZERS_BY_FORMAT = {
+    json: Serializers::Json,
+    json_api: Serializers::JsonApi,
+    xml: Serializers::Xml,
+  }.freeze
+
+  SERIALIZER_OPTIONS = {
+    backtrace: false,
+  }.freeze
+
+  CONTENT_TYPE_BY_FORMAT = {
+    json_api: "application/vnd.api+json"
+  }.freeze
+
+  def handle_api_errors(options = {})
+    format = options.fetch(:format, :json)
+    error_reporter = ErrorReporter.new(options[:error_reporter])
+    serializer_options = SERIALIZER_OPTIONS.merge(
+      options.slice(*SERIALIZER_OPTIONS.keys)
+    )
+
+    serializer_class = options[:serializer] || SERIALIZERS_BY_FORMAT.fetch(format)
+    content_type = options[:content_type] || CONTENT_TYPE_BY_FORMAT[format]
+    rescue_from StandardError do |error|
+      status = ActionDispatch::ExceptionWrapper.rescue_responses[error.class.to_s]
+
+      error_id = ErrorIdGenerator.run(options[:error_id])
+      error_reporter.report(error, error_id: error_id)
+
+      serializer = serializer_class.new(error, status)
+      response_body = serializer.serialize(
+        serializer_options.merge(error_id: error_id)
+      )
 
-    rescue_from StandardError do |exception|
-      render json: "caught!"
+      render(
+        serializer.render_format => response_body,
+        content_type: content_type,
+        status: status
+      )
+    rescue
+      raise error
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_error_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc
+  version: 0.2.1
 platform: ruby
 authors:
 - James Stonehill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-20 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,30 +72,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,21 +122,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A gem that helps you easily handle exptions in your Ruby on Rails API
-  and return informative responses to the client by serializing exceptions into JSON
-  and other popular API formats and returning a response with a status code that makes
-  sense based on the exception.
+description: |
+  A gem that helps you easily handle exceptions in your Ruby on Rails API and
+  return informative responses to the client by serializing exceptions into JSON
+  and other popular API formats and returning a response with a status code that
+  makes sense based on the exception.
 email:
-- jamesstonehill@gmail.com
+- james.stonehill@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -117,10 +148,14 @@ files:
 - bin/setup
 - lib/api_error_handler.rb
 - lib/api_error_handler/action_controller.rb
-- lib/api_error_handler/error_serializer.rb
+- lib/api_error_handler/error_id_generator.rb
+- lib/api_error_handler/error_reporter.rb
+- lib/api_error_handler/errors.rb
+- lib/api_error_handler/serializers/base_serializer.rb
 - lib/api_error_handler/serializers/json.rb
+- lib/api_error_handler/serializers/json_api.rb
+- lib/api_error_handler/serializers/xml.rb
 - lib/api_error_handler/version.rb
-- lib/serializers/json.rb
 homepage: https://github.com/jamesstonehill/api_error_handler
 licenses:
 - MIT
@@ -133,17 +168,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: A gem that helps you easily handle exptions in your Rails API and return
+summary: A gem that helps you easily handle exceptions in your Rails API and return
   informative responses to the client.
 test_files: []

data/Gemfile.lock

@@ -1,96 +0,0 @@
-PATH
-  remote: .
-  specs:
-    api_error_handler (0.1.0)
-      actionpack
-      activesupport (>= 4.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    builder (3.2.3)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.7)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-rails (3.8.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  api_error_handler!
-  bundler (~> 2.0)
-  pry
-  rake (~> 10.0)
-  rspec-rails (~> 3.0)
-
-BUNDLED WITH
-   2.0.2

data/lib/api_error_handler/error_serializer.rb

@@ -1,25 +0,0 @@
-require_relative 'serializers/json'
-
-module ApiErrorHandler
-  class ErrorSerializer
-    SERIALIZERS_BY_FORMAT = {
-      json: Serializers::Json
-    }
-
-    def initialize(error, format, status)
-      @error = error
-      @format = format
-      @status = status
-    end
-
-    def serialize
-
-    end
-
-    private
-
-    def serializer
-
-    end
-  end
-end

data/lib/serializers/json.rb

@@ -1,9 +0,0 @@
-class ApiErrorHandler
-  module Serializers
-    class Json
-      def self.serialize(error)
-        { message: error.message }.to_json
-      end
-    end
-  end
-end