model_driven_api 3.1.8 → 3.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcceec80f10a8a7bc91a9f8f32982f6d632f8af71936e8333ffe2f47308da2f7
-  data.tar.gz: e6b1f3833363f78ff5884a25ac986fb47e44e322193b65e3fc90494de2ab08dd
+  metadata.gz: 0afb3dc1dca5b7277c7ea2bfd601669765d5227fe68ede17fa6fbfc3de19d36f
+  data.tar.gz: 02c3ece69e6237b42f8f04de6660469d528c81a84cf392a34a743360b765d832
 SHA512:
-  metadata.gz: 8675f05d7145638a141e358fac87bb481318f2ea868817ea578d1400e6600291bdbc1d21691277f9c11f2c498be9e2659d724d0e3038f23c706b4a5ef8a81528
-  data.tar.gz: c1bd46b4cd97f04f50ddef90b3394f4ffce98348f8f73f8e05ac30259c0c16319b785ceeb5f77fb17aa0bbb55ae374009d65eaae7dc1e9e860f06ee7e0ec3565
+  metadata.gz: 92c3d537101cb23123ce34564eaac4fe1d767770628dddcd1cc94487253bb82c880e07721a78c2be3dc571c370020b12e13ab30e9981d035c7766634dccdeb7b
+  data.tar.gz: 69385bf1c20fe26e8168be63da529edb847002984084e133e431aef6b07815bb88edf1f42ed43d65dc0ef5194a28ede011c29f05aca3de0176dd11a119da3a8a

data/app/controllers/api/v2/application_controller.rb

@@ -66,7 +66,6 @@ class Api::V2::ApplicationController < ActionController::API
 
   def create
     # Normal Create Action
-    @record = @model.new(@body)
     authorize! :create, @record
     # Custom Action
     status, result, status_number = check_for_custom_action
@@ -74,6 +73,7 @@ class Api::V2::ApplicationController < ActionController::API
     # Keeping this automation can be too dangerous and lead to unpredicted results
     # TODO: Remove it
     # @record.user_id = current_user.id if @model.column_names.include? "user_id"
+    @record = @model.new(@body)
     @record.save!
     render json: @record.to_json(json_attrs), status: 201
   end
@@ -158,11 +158,13 @@ class Api::V2::ApplicationController < ActionController::API
     # The endpoint can be expressed in two ways:
     # 1. As a method in the model, with suffix custom_action_<custom_action>
     # 2. As a module instance method in the model, like Track::Endpoints.inventory
-    if defined?("Endpoints::#{@model}.#{custom_action}")
-      # Custom endpoint exists and can be called in the sub-modules form
-      body, status = "Endpoints::#{@model}".constantize.send(custom_action, params)
-    elsif @model.respond_to?("custom_action_#{custom_action}")
+    # Example:
+    # Endpoints::TestApi.new(:test, {request_verb: "POST", is_connected: "Uhhhh"}).result
+    if @model.respond_to?("custom_action_#{custom_action}")
       body, status = @model.send("custom_action_#{custom_action}", params)
+    elsif ("Endpoints::#{@model}".constantize rescue false) && "Endpoints::#{@model}".constantize.instance_methods.include?(custom_action.to_sym)
+      # Custom endpoint exists and can be called in the sub-modules form
+      body, status = "Endpoints::#{@model}".constantize.new(custom_action, params).result
     else
       # Custom endpoint does not exist or cannot be called
       raise NoMethodError

data/app/controllers/api/v2/info_controller.rb

@@ -521,7 +521,7 @@ class Api::V2::InfoController < Api::V2::ApplicationController
         custom_actions.each do |action|
           custom_action_name = action.to_s.gsub("custom_action_", "")
           pivot["/#{model}/custom_action/#{custom_action_name}"] = {
-            "post": {
+            "get": {
               "summary": "Custom Action #{custom_action_name.titleize}",
               "description": "This is just an example of a custom action, they can accept a wide range of payloads and response with a wide range of responses, also all verbs are valid. Please refer to the documentation for more information.",
               "tags": [model.classify],

data/app/models/endpoints/test_api.rb

@@ -0,0 +1,56 @@
+class Endpoints::TestApi < NonCrudEndpoints
+  def test(params)
+    # Define an explain var to be used to validate and document the action behavior when using ?explain=true in query string
+    explain = {
+      verbs: ["GET", "POST"],
+      body: {
+        messages: {
+          type: :array,
+          optional: true,
+          items: {
+            type: :string,
+            optional: false
+          }
+        },
+        is_connected: {
+          type: :boolean,
+          optional: false
+        },
+        user: {
+          type: :object,
+          optional: true,
+          properties: {
+            name: {
+              type: :string,
+              optional: false
+            },
+            age: {
+              type: :integer,
+              optional: true
+            }
+          }
+        }
+      },
+      query: {
+        explain: {
+          type: :boolean,
+          optional: true
+        }
+      },
+      responses: {
+        200 => {
+          message: :string,
+          params: {},
+        },
+        501 => {
+          error: :string,
+        },
+      },
+    }
+    return explain, 200 if params[:explain].to_s == "true" && !explain.blank?
+    
+    
+    return { message: "Hello World From Test API Custom Action called test", params: params }, 200
+  end
+end
+# end

data/config/routes.rb

@@ -30,17 +30,17 @@ Rails.application.routes.draw do
             patch ":ctrl/custom_action/:action_name/:id", to: 'application#update'
             delete ":ctrl/custom_action/:action_name/:id", to: 'application#destroy'
             # Catchall routes
-            # # # CRUD Show
-            # get '*path/:id', to: 'application#show'
-            # # # CRUD Index
-            # get '*path', to: 'application#index'
-            # # # CRUD Create
-            # post '*path', to: 'application#create'
-            # # CRUD Update
+            # # CRUD Show
+            get '*path/:id', to: 'application#show'
+            # # CRUD Index
+            get '*path', to: 'application#index'
+            # # CRUD Create
+            post '*path', to: 'application#create'
+            # CRUD Update
             put '*path/:id/multi', to: 'application#update_multi'
             patch '*path/:id/multi', to: 'application#update_multi'
-            # put '*path/:id', to: 'application#update'
-            # patch '*path/:id', to: 'application#patch'
+            put '*path/:id', to: 'application#update'
+            patch '*path/:id', to: 'application#patch'
 
             # # CRUD Delete
             delete '*path/:id/multi', to: 'application#destroy_multi'

data/lib/concerns/api_exception_management.rb

@@ -11,6 +11,7 @@ module ApiExceptionManagement
             rescue_from ActiveRecord::RecordInvalid, with: :invalid!
             rescue_from ActiveRecord::RecordNotFound, with: :not_found!
             rescue_from ActiveRecord::RecordNotUnique, with: :invalid!
+            rescue_from EndpointValidationError, with: :api_error
         end
         
         def unauthenticated! exception = AuthenticateUser::AccessDenied.new
@@ -34,7 +35,7 @@ module ApiExceptionManagement
             return api_error status: 500, errors: exception.message
         end
         
-        def api_error(status: 500, errors: [])
+        def api_error(status: 501, errors: [])
             # puts errors.full_messages if !Rails.env.production? && errors.respond_to?(:full_messages)
             head status && return if errors.blank?
             

data/lib/endpoint_validation_error.rb

@@ -0,0 +1,2 @@
+class EndpointValidationError < StandardError
+end

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.1.8".freeze
+  VERSION = "3.1.10".freeze
 end

data/lib/model_driven_api.rb

@@ -1,3 +1,5 @@
+require 'endpoint_validation_error'
+require 'non_crud_endpoints'
 require 'thecore_backend_commons'
 require 'rack/cors'
 require 'ransack'

data/lib/non_crud_endpoints.rb

@@ -0,0 +1,54 @@
+class NonCrudEndpoints
+    attr_accessor :result
+    # Add a validation method which will be inherited by all the instances, and automatically run before any method call
+    def initialize(m, params)
+        # Check if self hase the m method, if not, raise a NoMethodError
+        raise NoMethodError, "The method #{m} does not exist in #{self.class}" unless self.respond_to? m
+        definition = self.send(m, { explain: true }) rescue []
+        validate_request(definition.first.presence || {}, params)
+        @result = self.send(m, params)
+    end
+
+    def validate_request(definition, params)
+        # If there is no definition, return
+        return if definition.blank?
+        # puts "Called Class is: #{self.class}"
+        # puts "Which is son of: #{self.class.superclass}"
+        body_mandatory_keys = definition[:body].select { |k, v| v[:optional] == false }.keys
+        query_mandatory_keys = definition[:query].select { |k, v| v[:optional] == false }.keys
+        # Raise a ValidationError if the request does not match the definition
+        raise EndpointValidationError, "The verb \"#{params[:request_verb].presence || "No Verb Provided"}\" is not present in #{definition[:verbs].join(", ")}." if definition[:verbs].exclude? params[:request_verb]
+        # Raise an exception if the verb is put or post and the body keys in definition are not all present as params keys, both params and definition[:body] can have nested objects
+        raise EndpointValidationError, "The request body does not match the definition: in #{params[:request_verb]} requests all of the params must be present in definition. The body definition is #{definition[:body]}." if params[:request_verb] != "GET" && (body_mandatory_keys & params.keys) != body_mandatory_keys
+        # Raise an exception if the verb is put or post and the body keys in definition are not all present as params keys, both params and definition[:body] can have nested objects
+        raise EndpointValidationError, "The request query does not match the definition. The query definition is: #{definition[:query]}." if (query_mandatory_keys & params.keys) != query_mandatory_keys
+        # Rais if the type of the param is not the same as the definition
+        definition[:body].each do |k, v|
+            next if params[k].nil?
+            computed_type = get_type(params[k])
+            raise EndpointValidationError, "The type of the param #{k} is not the same as the definition. The definition is #{v[:type]} and the param is #{computed_type}." if v[:type] != computed_type
+        end
+    end
+
+    private
+
+    def get_type(type)
+        case type
+        when String
+            :string
+        when Integer
+            :integer
+        when Float
+            :number
+        when TrueClass, FalseClass
+            :boolean
+        when Array
+            :array
+        when Hash
+            :object
+        else
+            :undefined
+        end
+    end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.1.10
 platform: ruby
 authors:
 - Gabriele Tassoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thecore_backend_commons
@@ -125,7 +125,7 @@ files:
 - app/controllers/api/v2/authentication_controller.rb
 - app/controllers/api/v2/info_controller.rb
 - app/controllers/api/v2/users_controller.rb
-- app/models/concerns/endpoints/test_api.rb
+- app/models/endpoints/test_api.rb
 - app/models/test_api.rb
 - app/models/used_token.rb
 - config/initializers/after_initialize_for_model_driven_api.rb
@@ -140,10 +140,12 @@ files:
 - lib/concerns/model_driven_api_application_record.rb
 - lib/concerns/model_driven_api_role.rb
 - lib/concerns/model_driven_api_user.rb
+- lib/endpoint_validation_error.rb
 - lib/json_web_token.rb
 - lib/model_driven_api.rb
 - lib/model_driven_api/engine.rb
 - lib/model_driven_api/version.rb
+- lib/non_crud_endpoints.rb
 - lib/tasks/model_driven_api_tasks.rake
 homepage: https://github.com/gabrieletassoni/model_driven_api
 licenses:

data/app/models/concerns/endpoints/test_api.rb

@@ -1,5 +0,0 @@
-module Endpoints::TestApi
-    def self.test params
-        return { message: "Hello World From Test API Custom Action called test", params: params }, 200
-    end
-end