yml_error_responder 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b712bf03484c6a6030038f21b29c23c356343bcc1ea9698dafc06158be20c462
+  data.tar.gz: 2b5454009878d9cd8a778d2880a7228d5b9056f9a919982f8a111401ddd194fc
+SHA512:
+  metadata.gz: ee6409416404f8ee3d73cc041e6cc37117e3d9c79095e1bde126e0ca246ad8d564bf202c1181bebfa8e2d8b42990e63d88edca61ffe01869e9ae090cdce04667
+  data.tar.gz: a914e3ec1325b1997666c565197206859cf8bab44f885102c127af3c100f4452c2847b57e9396877e34d684a4fb79bfabc7eb939f1e59bcdd5ec4ba35b5520d9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Egench
+
+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.rdoc

@@ -0,0 +1,3 @@
+= YmlErrorResponder
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'YmlErrorResponder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/yml_error_responder/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/yml_error_responder/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/yml_error_responder/application_controller.rb

@@ -0,0 +1,5 @@
+module YmlErrorResponder
+  class ApplicationController < ActionController::Base
+    handle_errors_with_yml_responder
+  end
+end

data/app/controllers/yml_error_responder/errors_controller.rb

@@ -0,0 +1,7 @@
+module YmlErrorResponder
+  class ErrorsController < ApplicationController
+    def index
+      @errors = YmlMapper.errors_handlers
+    end
+  end
+end

data/app/controllers/yml_error_responder/errors_example_controller.rb

@@ -0,0 +1,30 @@
+module YmlErrorResponder
+  class ErrorsExampleController < Api::V1::BaseController
+
+    class CvvInvalid < ApiError; end
+    class Appointment < ApiError; end
+
+    def cvv
+      raise CvvInvalid
+    end
+
+    def appointment
+      raise Appointment.new(meta: {
+        "available_slots": [
+          {
+            "id": 4,
+            "name": "Slot1"
+          },
+          {
+            "id": 5,
+            "name": "Slot2"
+          }
+        ]
+      })
+    end
+
+    def uncovered
+      raise 'UncoveredExeption'
+    end
+  end
+end

data/app/errors/api_error.rb

@@ -0,0 +1,16 @@
+class ApiError < StandardError
+  attr_reader :meta
+
+  def initialize(meta: {})
+    @meta = meta
+  end
+
+  def serialize
+    errors = instance_variables.each_with_object({}) do |exceptions, var|
+      exceptions[var.to_s.gsub(/@/, '')] = instance_variable_get(var)
+      exceptions
+    end
+
+    { errors: errors }
+  end
+end

data/app/helpers/yml_error_responder/application_helper.rb

@@ -0,0 +1,4 @@
+module YmlErrorResponder
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/yml_error_responder/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>YmlErrorResponder</title>
+  <%= stylesheet_link_tag    "yml_error_responder/application", media: "all" %>
+  <%= javascript_include_tag "yml_error_responder/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/yml_error_responder/errors/index.html.erb

@@ -0,0 +1,14 @@
+<ul>
+  <% @errors.each do |namespace, error| %>
+    <li>
+      <h4><%= namespace%></h4>
+
+      <dl>
+        <% error.each do |key, value| %>
+          <dt><%= key %></dt>
+          <dd><%= value %></dd>
+        <% end %>
+      </dl>
+    </li>
+  <% end %>
+</ul>

data/config/errors/base_errors.yml

@@ -0,0 +1,9 @@
+#
+# Sample:
+#
+# ActiveRecord::RecordInvalid:
+#   error_code: record_invalid
+#   http_code: 422
+#   translation_key: 'errors.active_record.record_invalid'
+#   description: 'Record is invalid.'
+#

data/config/routes.rb

@@ -0,0 +1,3 @@
+YmlErrorResponder::Engine.routes.draw do
+  get '/errors/list', to: 'errors#index'
+end

data/lib/tasks/yml_error_responder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :yml_error_responder do
+#   # Task goes here
+# end

data/lib/yml_error_responder.rb

@@ -0,0 +1,33 @@
+require 'yml_error_responder/yml_mapper'
+require 'yml_error_responder/error_handlers'
+require 'yml_error_responder/error_handlers/base_error_handler'
+require 'yml_error_responder/error_handlers/default_error_handler'
+require 'yml_error_responder/error_handlers/unknow_error_handler'
+require 'yml_error_responder/responder'
+require 'yml_error_responder/engine'
+
+module YmlErrorResponder
+  @configuration_path = 'config/errors/'
+  @handle_unknown_error = false
+  @unknown_error_logger = nil
+
+  class << self
+    attr_accessor :configuration_path
+    attr_accessor :handle_unknown_error
+    attr_accessor :unknown_error_logger
+
+    def setup
+      yield self
+    end
+
+    def log_unknown_error_with(&block)
+      @unknown_error_logger = block
+    end
+
+    def routes(application)
+      unless Rails.env.production?
+        application.mount YmlErrorResponder::Engine => "/api/yml_error_responder"
+      end
+    end
+  end
+end

data/lib/yml_error_responder/engine.rb

@@ -0,0 +1,5 @@
+module YmlErrorResponder
+  class Engine < ::Rails::Engine
+    isolate_namespace YmlErrorResponder
+  end
+end

data/lib/yml_error_responder/error_handlers.rb

@@ -0,0 +1,21 @@
+module YmlErrorResponder
+  module ErrorHandlers
+    extend self
+
+    def unknown_error
+      UnknowErrorHandler.new
+    end
+
+    def handler(error, payload)
+      lookup_handler(error).new(error, payload)
+    end
+
+    private
+
+    def lookup_handler(error)
+      "::ErrorHandlers::#{error.class.to_s}".constantize
+    rescue
+      DefaultErrorHandler
+    end
+  end
+end

data/lib/yml_error_responder/error_handlers/base_error_handler.rb

@@ -0,0 +1,32 @@
+module YmlErrorResponder
+  module ErrorHandlers
+    class BaseErrorHandler
+      attr_accessor :handler_data, :error
+
+      def initialize(error, handler_data)
+        @handler_data = handler_data
+        @error = error
+      end
+
+      def http_code
+        @handler_data[:http_code]
+      end
+
+      def meta
+        @error.try(:meta) || {}
+      end
+
+      def as_json
+        {
+          data: {
+            error: {
+              code: @handler_data[:error_code],
+              description: @handler_data[:description]
+            },
+            meta: meta
+          }
+        }
+      end
+    end
+  end
+end

data/lib/yml_error_responder/error_handlers/default_error_handler.rb

@@ -0,0 +1,6 @@
+module YmlErrorResponder
+  module ErrorHandlers
+    class DefaultErrorHandler < BaseErrorHandler
+    end
+  end
+end

data/lib/yml_error_responder/error_handlers/unknow_error_handler.rb

@@ -0,0 +1,13 @@
+module YmlErrorResponder
+  module ErrorHandlers
+    class UnknowErrorHandler < BaseErrorHandler
+      def initialize
+        @handler_data = {
+          http_code: :internal_server_error,
+          error_code: :unknow_error,
+          description: 'Something went wrong.'
+        }
+      end
+    end
+  end
+end

data/lib/yml_error_responder/responder.rb

@@ -0,0 +1,55 @@
+module YmlErrorResponder
+  module Responder
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from Exception, with: :resque_global
+    end
+
+    private
+
+    def resque_global(error)
+      if YmlMapper.error_defined?(error)
+        respond_with_error ErrorHandlers::handler(error, YmlMapper.error_payload(error))
+      else
+
+        log_error(error)
+        ExceptionNotifier.notify_exception(error) if defined?(ExceptionNotifier)
+
+        if YmlErrorResponder.handle_unknown_error
+          respond_with_error ErrorHandlers.unknown_error
+        else
+          raise error
+        end
+      end
+    end
+
+    def respond_with_error(handler)
+      respond_to do |format|
+        format.html do
+          render file: "#{Rails.root}/public/#{handler.http_code}",
+            layout: false,
+            status: handler.http_code
+        end
+        format.json do
+          render json: handler.as_json,
+            status: handler.http_code
+        end
+      end
+    end
+
+    def log_error(error)
+      if YmlErrorResponder.unknown_error_logger.respond_to?(:call)
+        YmlErrorResponder.unknown_error_logger.call(error)
+      end
+      Rails.logger.error error.message
+      Rails.logger.error error.backtrace.join("\n")
+    end
+  end
+end
+
+class << ActionController::Base
+  def handle_errors_with_yml_responder
+    include YmlErrorResponder::Responder
+  end
+end

data/lib/yml_error_responder/version.rb

@@ -0,0 +1,3 @@
+module YmlErrorResponder
+  VERSION = "1.0.6"
+end

data/lib/yml_error_responder/yml_mapper.rb

@@ -0,0 +1,53 @@
+module YmlErrorResponder
+  module YmlMapper
+    extend self
+    attr_reader :errors_handlers
+    FILE_MASK = '**/*.yml'
+
+    @errors_handlers = HashWithIndifferentAccess.new
+
+    def error_payload(error)
+      @errors_handlers[error.class.to_s]
+    end
+
+    def error_defined?(error)
+      @errors_handlers.key?(error.class.to_s)
+    end
+
+    def load!
+      raise 'Configuration path is not set!' if YmlErrorResponder.configuration_path.blank?
+
+      read_dir do |path|
+        add_handler(load_handlers(path, path_to_namespace(path)))
+      end
+    end
+
+    def read_dir
+      Dir[[YmlErrorResponder.configuration_path, FILE_MASK].join].each do |path|
+        yield path
+      end
+    end
+
+    def load_handlers(path, namespace)
+      YAML
+        .load_file(path)
+        .try(:transform_keys) do |key|
+          namespace.blank? ? key.to_s.camelize : [namespace, key.to_s.camelize].join('::')
+        end
+    end
+
+    def path_to_namespace(path)
+      path.match(/#{YmlErrorResponder.configuration_path}([^.]*)\/(.*).yml/)
+        .try(:[], 1)
+        .try do |match|
+          match.split('/')
+          .map{|m| m.camelize}
+          .join('::')
+        end
+    end
+
+    def add_handler(handlers)
+      @errors_handlers.merge!(handlers) if handlers.present?
+    end
+  end
+end