api_error_handler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9be82ce1e320cfcf1a01d61211f628087cc67ea5
-  data.tar.gz: c1ba01e3184c4e1b02aa44da16c9a48ba27be409
+SHA256:
+  metadata.gz: 3630f225962137c7df9417b7a6e9654f60ee38ebb8afff7480f74e9daf02a4bc
+  data.tar.gz: 2d644936de3e3d714fe974bb313c8eb14b51c44b2da818f12f8f0f85cd1f0ff7
 SHA512:
-  metadata.gz: 417b51a2dec65912d6e0ff9b8e3865aa59d14897b54ee3cbaa07f6f3de987a92023210602d7480627eff200438e4a91b654e798859480b78c5d9a0617d0065a2
-  data.tar.gz: 3d06ed46fbc62e48b8601f416298edfaa80d9c6a0aac75038c63f9da94d42e9fb3242ff05b3f86c70569eee7a539c5fa64a839dd232cab3e55eab90934234652
+  metadata.gz: c41e88553d9cba1cb1679cf1da2205cd8ec3148c5e706a29faf0e9405f6b59666e25da1968a959f52d81bf6982ce90157746e1475b2ee73a10abf86de897cd32
+  data.tar.gz: eb089aed46d76d994fe642c2efebdc9f2598228d877772044069421d5fb2da992b69ce858565f22f1daf68015d1ad5dab9c329115e84584a650d52a17010324a

data/.gitignore

@@ -12,8 +12,15 @@
 # rspec failure tracking
 .rspec_status
 
-# Stuff to ignore in the test_app
-test_app/tmp
-test_app/log
-test_app/.byebug_history
-test_app/log/development.log
+# 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.3
+  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,10 +1,27 @@
 ---
 sudo: false
 language: ruby
-rvm:
-  - 2.4
-cache: bundler
 before_install:
   - gem update --system
   - gem install bundler
-script: ./bin/test.sh
+cache: bundler
+branches:
+  only:
+    - master
+matrix:
+  include:
+  - rvm: 2.3.8
+    gemfile: ./rails_4_test_app/Gemfile
+    script: cd rails_4_test_app && bundle exec rspec
+  - rvm: 2.3.8
+    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.3.8
+    gemfile: Gemfile
+    script: bundle exec rubocop
+  - rvm: 2.3.8
+    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

@@ -220,39 +220,29 @@ you're using Rails with ActiveRecord, by default this includes:
 You can add to this mapping on an application level by doing the following:
 ```ruby
 config.action_dispatch.rescue_responses.merge!(
-  "AuthenticationError" => :not_authorized
+  "AuthenticationError" => :unauthorized
 )
 ```
 
 Now when an you raise an `AuthenticationError` in one of your actions, the
 status code of the response will be 401.
 
-### Error Reporting
-If you use an external error tracking software like Sentry or Honeybadger you'll
-want to report all errors to that service.
-
-You can do so by passing in a `Proc` to the `error_reporter` option. The first
-argument provided to the Proc will be the error. The second argument will be the
-`error_id` if you have one. See the section below for more details on error IDs.
-
-```ruby
-handle_api_errors(
-  error_reporter: Proc.new do |error, error_id|
-    Raven.capture_exception(error, error_id: error_id)
-  end
-)
-```
-
 ### 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.
 
+You can either use the UUID error strategy
 ```ruby
-handle_api_errors(
-  error_id: Proc.new { |error| SecureRandom.uuid }
-)
+handle_api_errors(error_id: :uuid)
 ```
 
+Or pass a Proc if you need to do something custom.
+```ruby
+handle_api_errors(error_id: Proc.new { |error| SecureRandom.uuid })
+```
+
+These will result in:
 ```json
 {
   "error": {
@@ -263,6 +253,40 @@ handle_api_errors(
 }
 ```
 
+### 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

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)
@@ -8,17 +9,27 @@ Gem::Specification.new do |spec|
   spec.version       = ApiErrorHandler::VERSION
   spec.authors       = ["James Stonehill"]
   spec.email         = ["james.stonehill@gmail.com"]
-  spec.required_ruby_version = '~> 2.2'
+  spec.required_ruby_version = "~> 2.3"
+
+  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 exceptions in your Rails API and return informative responses to the client.}
-  spec.description   = %q{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.}
   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) }
@@ -31,4 +42,5 @@ Gem::Specification.new do |spec|
   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 "rubocop", "~> 0.74.0"
 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.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require_relative "./api_error_handler/version"
 require_relative "./api_error_handler/action_controller"
-Dir[File.join(__dir__, 'api_error_handler', 'serializers', "*.rb")].each { |file| require file }
+require_relative "./api_error_handler/error_id_generator"
+require_relative "./api_error_handler/error_reporter"
+Dir[File.join(__dir__, "api_error_handler", "serializers", "*.rb")].each do |file|
+  require file
+end
 
 module ApiErrorHandler
   SERIALIZERS_BY_FORMAT = {
@@ -19,22 +25,19 @@ module ApiErrorHandler
 
   def handle_api_errors(options = {})
     format = options.fetch(:format, :json)
-    status_mapping = ActionDispatch::ExceptionWrapper.rescue_responses
-    error_reporter = options[:error_reporter]
+    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|
       begin
-        status = status_mapping[error.class.to_s]
+        status = ActionDispatch::ExceptionWrapper.rescue_responses[error.class.to_s]
 
-        error_id = nil
-        error_id = options[:error_id].call(error) if options[:error_id]
-        error_reporter.call(error, error_id) if error_reporter
+        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(

data/lib/api_error_handler/action_controller.rb

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

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,46 @@
+# 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 || @strategy == :sentry
+        raise_dependency_error(missing_constant: "Raven") unless defined?(Raven)
+
+        extra = error_id ? { error_id: error_id } : {}
+        Raven.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

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

data/lib/api_error_handler/serializers/base_serializer.rb

@@ -1,9 +1,11 @@
-require 'rack/utils'
+# frozen_string_literal: true
+
+require "rack/utils"
 
 module ApiErrorHandler
   module Serializers
     class BaseSerializer
-      DEFAULT_STATUS_CODE = "500".freeze
+      DEFAULT_STATUS_CODE = "500"
 
       def initialize(error, status)
         @error = error

data/lib/api_error_handler/serializers/json.rb

@@ -1,4 +1,6 @@
-require_relative './base_serializer'
+# frozen_string_literal: true
+
+require_relative "./base_serializer"
 
 module ApiErrorHandler
   module Serializers

data/lib/api_error_handler/serializers/json_api.rb

@@ -1,4 +1,6 @@
-require_relative './base_serializer'
+# frozen_string_literal: true
+
+require_relative "./base_serializer"
 
 module ApiErrorHandler
   module Serializers

data/lib/api_error_handler/serializers/xml.rb

@@ -1,5 +1,7 @@
-require 'active_support/core_ext/hash/conversions'
-require_relative './base_serializer'
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/conversions"
+require_relative "./base_serializer"
 
 module ApiErrorHandler
   module Serializers

data/lib/api_error_handler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_error_handler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Stonehill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,10 +94,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-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.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+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:
 - james.stonehill@gmail.com
 executables: []
@@ -106,6 +121,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -114,9 +132,10 @@ files:
 - api_error_handler.gemspec
 - bin/console
 - bin/setup
-- bin/test.sh
 - lib/api_error_handler.rb
 - lib/api_error_handler/action_controller.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
@@ -135,15 +154,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A gem that helps you easily handle exceptions in your Rails API and return

data/bin/test.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-bundle install && bundle exec rspec
-bundle install --gemfile ./test_app/Gemfile && bundle exec --gemfile ./test_app/Gemfile rspec