arkaan 0.8.12 → 0.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 274d18d1f23d156f2665a5bd1359fe482a0736cd
-  data.tar.gz: 0db5765f3a5aec00ea6cbcd9e3f23828ee3a8eb9
+  metadata.gz: 322dc038e57c83ed444731f3ce872764dcf2d2b6
+  data.tar.gz: 81359044b199b30db67afbfcd4182a9352daf126
 SHA512:
-  metadata.gz: 2d8915708a7e1a471ae84c6e8d7201ae742aaa1b524b59d67a7beb9f9b0baa4d4510fc8fbb2d8f4291d9d685c12976138c55c6e1f7be68f97444fd58637018ec
-  data.tar.gz: a435fab17ee5dca22cf9a3de9c80b5c825f9aeda6e989cb060183e31c9c5c884d37844e445fb5726ab102c8dd88f14e2ed5ca72eb7b51cd4aeab2ad3a286ac6d
+  metadata.gz: 318e55d0c138f9af923633d0487365b0e362df2df0fc37f1dfb727f432ac0a30cc32e06967c5d7b767f9eef5007d7a573ea4c9612c5f9df8e55f0e46e63179cc
+  data.tar.gz: 90af48c1eba840737fed44e9885b2a3fd003e3b955cfd2b15665c38971129b8255676049d0718d5fc4459db1025fcf82f00a7eade04f438a86b67df263f49cde

data/lib/arkaan.rb

@@ -2,6 +2,7 @@ require 'mongoid'
 require 'active_model'
 require 'active_support'
 require 'sinatra/base'
+require 'sinatra/config_file'
 
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>

data/lib/arkaan/utils/controller.rb

@@ -3,6 +3,7 @@ module Arkaan
     # Base controller to handle the standard error when accessing the API.
     # @author Vincent Courtois <courtois.vincenet@outlook.com>
     class Controller < Sinatra::Base
+      register Sinatra::ConfigFile
 
       before do
         add_body_to_params
@@ -83,6 +84,31 @@ module Arkaan
         splitted = request.env['sinatra.route'].split(' ')
         return Arkaan::Monitoring::Route.where(verb: splitted.first.downcase, path: splitted.last).first
       end
+
+      # Loads the errors configuration file from the config folder.
+      # @param file [String] send __FILE__
+      def load_errors_from(file)
+        config_file File.join(File.dirname(file), '..', 'config', 'errors.yml')
+      end
+
+      # Halts the application and creates the returned body from the parameters and the errors config file.
+      # @param status [Integer] the HTTP status to halt the application with.
+      # @param field [String] the value of the :value key in the returned JSON body, corresponding to the field in error.
+      # @param error [String] the name of the error affecing the field.
+      # @param suffix [String] the eventual suffix of the URL in the doc.
+      def custom_error(status, field, error, suffix: '')
+        url = settings.errors[field][error]
+        halt status, {status: status, field: field, error: error, docs: "#{url}#{suffix}"}.to_json
+      end
+
+      # Halts the application with a Bad Request error affecting a field of a model.
+      # @param instance [Mongoid::Document] the document having a field in error.
+      # @param suffix [String] the eventual suffix of the URL in the doc.
+      def model_error(instance, suffix: '')
+        field = instance.errors.messages.keys.first
+        error = instance.errors.messages[field].first
+        custom_error(400, field, error, suffix: suffix)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.8.12
+  version: 0.8.13
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-07 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -178,6 +178,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []