arkaan 0.10.3 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b41bc45ca378ea3096c7b01067649bd3e329e936
-  data.tar.gz: f9a5e0b1e69dcf9a5ca960d425aa6eff0fbde84d
+  metadata.gz: 87ef1ed2c56986510788857b6985687a48969daf
+  data.tar.gz: 56877508868545d823c8711c8b9c14acb9b9e00a
 SHA512:
-  metadata.gz: 61a7f9b312a46c385014a9cb0dd54a731037bed5d4424e8b22e8f72298db66918bed060fc461f58828416b2dfd69dc05e255c7aa41c80d4a171f2f8c95c96f57
-  data.tar.gz: f27cc60e0a0cafef2b3a5c9cf16d6378c039f9ac4931816c737e182bcbeb0f75570f91f2bdea27b40e2460cb8f60c71794e469864aa1f6cc72c2fb7319b43ef5
+  metadata.gz: 90e08e088e3395e18278a7081bfc7dce953e7d040fd2f3378d349397ec5526038d3941b7c28c9ed1bc70d6eb082a5477a51ed7593de2e38d61028e9496f45b30
+  data.tar.gz: 1e95b66e78c16d30c45b384478ab189f457616db9ba98c63280d27b1add9ca9153901f35b689712bcee73b21c1d5590e11dd10bb8eb06e8cbfba9cccc0c64a8e

data/lib/arkaan/utils.rb

@@ -2,8 +2,9 @@ module Arkaan
   # Utility classes for the different micro-services of the suite.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Utils
-    autoload :Controller  , 'arkaan/utils/controller'
-    autoload :Errors      , 'arkaan/utils/errors'
-    autoload :MicroService, 'arkaan/utils/micro_service'
+    autoload :Controller             , 'arkaan/utils/controller'
+    autoload :ControllerWithoutFilter, 'arkaan/utils/controller_without_filter'
+    autoload :Errors                 , 'arkaan/utils/errors'
+    autoload :MicroService           , 'arkaan/utils/micro_service'
   end
 end

data/lib/arkaan/utils/controller.rb

@@ -2,8 +2,7 @@ module Arkaan
   module Utils
     # 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
+    class Controller < Arkaan::Utils::ControllerWithoutFilter
 
       before do
         add_body_to_params
@@ -18,135 +17,6 @@ module Arkaan
           custom_error(404, 'common.app_key.unknown')
         end
       end
-
-      # Creates a premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
-      # @param verb [String] the HTTP method used to create this route.
-      # @param path [String] the path, beginning with a /, of the route to create.
-      def self.declare_route(verb, path, &block)
-        self.declare_route_with(verb, path, false, &block)
-      end
-
-      # Creates a non premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
-      # @param verb [String] the HTTP method used to create this route.
-      # @param path [String] the path, beginning with a /, of the route to create.
-      def self.declare_premium_route(verb, path, &block)
-        self.declare_route_with(verb, path, true, &block)
-      end
-
-      # Creates a route whithin the Sinatra application, and registers it in the database if it does not already exists.
-      # @param verb [String] the HTTP method used to create this route.
-      # @param path [String] the path, beginning with a /, of the route to create.
-      # @param premium [Boolean] TRUE to make the route premium, FALSE otherwise.
-      def self.declare_route_with(verb, path, premium, &block)
-        service = Arkaan::Utils::MicroService.instance.service
-        unless service.nil? || !service.routes.where(path: path, verb: verb).first.nil?
-          Arkaan::Monitoring::Route.create(path: path, verb: verb, premium: premium, service: service)
-        end
-        if premium
-          self.public_send(verb, path) do
-            @sinatra_route = parse_current_route
-            if !@application.premium?
-              custom_error(403, 'common.app_key.forbidden')
-            end
-            instance_eval(&block)
-          end
-        else
-          self.public_send(verb, path, &block)
-        end
-      end
-
-      # Loads the errors configuration file from the config folder.
-      # @param file [String] send __FILE__
-      def self.load_errors_from(file)
-        config_file File.join(File.dirname(file), '..', 'config', 'errors.yml')
-      end
-
-      # Checks the presence of several fields given as parameters and halts the execution if it's not present.
-      # @param fields [Array<String>] an array of fields names to search in the parameters
-      def check_presence(*fields, route:)
-        fields.each do |field|
-          custom_error(400, "#{route}.#{field}.required") if params[field].nil? || params[field] == ''
-        end
-      end
-
-      # Checks if the session ID is given in the parameters and if the session exists.
-      # @param action [String] the action used to get the errors from the errors file.
-      # @return [Arkaan::Authentication::Session] the session when it exists.
-      def check_session(action)
-        check_presence('session_id', route: action)
-        session = Arkaan::Authentication::Session.where(token: params['session_id']).first
-        if session.nil?
-          custom_error(404, "#{action}.session_id.unknown")
-        end
-        return session
-      end
-
-      def check_application(action)
-        check_presence('app_key', route: action)
-        application = Arkaan::OAuth::Appliation.where(keu: params['app_key']).first
-        if application.nil?
-          custom_error(404, "#{action}.app_key.unknown")
-        end
-        return application
-      end
-
-      # Adds the parsed body to the parameters, overwriting the parameters of the querystring with the values
-      # of the SON body if they have similar keys.
-      def add_body_to_params
-        parsed_body = JSON.parse(request.body.read.to_s) rescue {}
-        parsed_body.keys.each do |key|
-          params[key] = parsed_body[key]
-        end
-      end
-
-      # Gets the current route in the database from the sinatra route.
-      # @return [Arkaan::Monitoring::Route] the route declared in the services registry.
-      def parse_current_route
-        splitted = request.env['sinatra.route'].split(' ')
-        return Arkaan::Monitoring::Route.where(verb: splitted.first.downcase, path: splitted.last).first
-      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 path [String] the path in the configuration file to access the URL.
-      def custom_error(status, path)
-        route, field, error = path.split('.')
-        halt status, {status: status, field: field, error: error, docs: settings.errors[route][field][error]}.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 route [String] the type of action you're currently doing (e.g: 'creation')
-      def model_error(instance, route)
-        messages = instance.errors.messages
-        field = messages.keys.first
-        custom_error(400, "#{route}.#{field}.#{messages[field].first}")
-      end
-
-      # Select parameters in the params hash, by its keys.
-      # @param fields [Array<String>] the keys to select in the params hash.
-      # @return [Hash] the selected chunk of the params hash.
-      def select_params(*fields)
-        return params.select { |key, value| fields.include?(key) }
-      end
-
-      # Creates a custom error from an existing Arkaan exception class.
-      # @param exception {StandardError} the exception to transform in a usable error.
-      def handle_arkaan_exception(exception)
-        custom_error(exception.status, "#{exception.action}.#{exception.field}.#{exception.error}")
-      end
-
-      error Arkaan::Utils::Errors::BadRequest do |exception|
-        handle_arkaan_exception(exception)
-      end
-
-      error Arkaan::Utils::Errors::Forbidden do |exception|
-        handle_arkaan_exception(exception)
-      end
-
-      error Arkaan::Utils::Errors::NotFound do |exception|
-        handle_arkaan_exception(exception)
-      end
     end
   end
 end

data/lib/arkaan/utils/controller_without_filter.rb

@@ -0,0 +1,138 @@
+module Arkaan
+  module Utils
+    # Base controller to handle the standard error when accessing the API.
+    # @author Vincent Courtois <courtois.vincenet@outlook.com>
+    class ControllerWithoutFilter < Sinatra::Base
+      register Sinatra::ConfigFile
+
+      # Creates a premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
+      # @param verb [String] the HTTP method used to create this route.
+      # @param path [String] the path, beginning with a /, of the route to create.
+      def self.declare_route(verb, path, &block)
+        self.declare_route_with(verb, path, false, &block)
+      end
+
+      # Creates a non premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
+      # @param verb [String] the HTTP method used to create this route.
+      # @param path [String] the path, beginning with a /, of the route to create.
+      def self.declare_premium_route(verb, path, &block)
+        self.declare_route_with(verb, path, true, &block)
+      end
+
+      # Creates a route whithin the Sinatra application, and registers it in the database if it does not already exists.
+      # @param verb [String] the HTTP method used to create this route.
+      # @param path [String] the path, beginning with a /, of the route to create.
+      # @param premium [Boolean] TRUE to make the route premium, FALSE otherwise.
+      def self.declare_route_with(verb, path, premium, &block)
+        service = Arkaan::Utils::MicroService.instance.service
+        unless service.nil? || !service.routes.where(path: path, verb: verb).first.nil?
+          Arkaan::Monitoring::Route.create(path: path, verb: verb, premium: premium, service: service)
+        end
+        if premium
+          self.public_send(verb, path) do
+            @sinatra_route = parse_current_route
+            if !@application.premium?
+              custom_error(403, 'common.app_key.forbidden')
+            end
+            instance_eval(&block)
+          end
+        else
+          self.public_send(verb, path, &block)
+        end
+      end
+
+      # Loads the errors configuration file from the config folder.
+      # @param file [String] send __FILE__
+      def self.load_errors_from(file)
+        config_file File.join(File.dirname(file), '..', 'config', 'errors.yml')
+      end
+
+      # Checks the presence of several fields given as parameters and halts the execution if it's not present.
+      # @param fields [Array<String>] an array of fields names to search in the parameters
+      def check_presence(*fields, route:)
+        fields.each do |field|
+          custom_error(400, "#{route}.#{field}.required") if params[field].nil? || params[field] == ''
+        end
+      end
+
+      # Checks if the session ID is given in the parameters and if the session exists.
+      # @param action [String] the action used to get the errors from the errors file.
+      # @return [Arkaan::Authentication::Session] the session when it exists.
+      def check_session(action)
+        check_presence('session_id', route: action)
+        session = Arkaan::Authentication::Session.where(token: params['session_id']).first
+        if session.nil?
+          custom_error(404, "#{action}.session_id.unknown")
+        end
+        return session
+      end
+
+      def check_application(action)
+        check_presence('app_key', route: action)
+        application = Arkaan::OAuth::Appliation.where(keu: params['app_key']).first
+        if application.nil?
+          custom_error(404, "#{action}.app_key.unknown")
+        end
+        return application
+      end
+
+      # Adds the parsed body to the parameters, overwriting the parameters of the querystring with the values
+      # of the SON body if they have similar keys.
+      def add_body_to_params
+        parsed_body = JSON.parse(request.body.read.to_s) rescue {}
+        parsed_body.keys.each do |key|
+          params[key] = parsed_body[key]
+        end
+      end
+
+      # Gets the current route in the database from the sinatra route.
+      # @return [Arkaan::Monitoring::Route] the route declared in the services registry.
+      def parse_current_route
+        splitted = request.env['sinatra.route'].split(' ')
+        return Arkaan::Monitoring::Route.where(verb: splitted.first.downcase, path: splitted.last).first
+      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 path [String] the path in the configuration file to access the URL.
+      def custom_error(status, path)
+        route, field, error = path.split('.')
+        halt status, {status: status, field: field, error: error, docs: settings.errors[route][field][error]}.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 route [String] the type of action you're currently doing (e.g: 'creation')
+      def model_error(instance, route)
+        messages = instance.errors.messages
+        field = messages.keys.first
+        custom_error(400, "#{route}.#{field}.#{messages[field].first}")
+      end
+
+      # Select parameters in the params hash, by its keys.
+      # @param fields [Array<String>] the keys to select in the params hash.
+      # @return [Hash] the selected chunk of the params hash.
+      def select_params(*fields)
+        return params.select { |key, value| fields.include?(key) }
+      end
+
+      # Creates a custom error from an existing Arkaan exception class.
+      # @param exception {StandardError} the exception to transform in a usable error.
+      def handle_arkaan_exception(exception)
+        custom_error(exception.status, "#{exception.action}.#{exception.field}.#{exception.error}")
+      end
+
+      error Arkaan::Utils::Errors::BadRequest do |exception|
+        handle_arkaan_exception(exception)
+      end
+
+      error Arkaan::Utils::Errors::Forbidden do |exception|
+        handle_arkaan_exception(exception)
+      end
+
+      error Arkaan::Utils::Errors::NotFound do |exception|
+        handle_arkaan_exception(exception)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2018-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -245,6 +245,7 @@ files:
 - lib/arkaan/specs.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controller.rb
+- lib/arkaan/utils/controller_without_filter.rb
 - lib/arkaan/utils/errors.rb
 - lib/arkaan/utils/errors/bad_request.rb
 - lib/arkaan/utils/errors/forbidden.rb