model_driven_api 3.1.9 → 3.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b18a1b177632591c520596c5b8443da17b84937c934b450550512355d4690d
-  data.tar.gz: 8992f753df4957e584a303989130f48ef63346f9adff290f72140bc2f7df14f7
+  metadata.gz: bbaf42c9a62f9ebdc9cdf60633aeeb47ad39b11e9ebb9d20a94af73fea6c7213
+  data.tar.gz: c56851d1ae81777a20cc1d7ea26c0a31fb2f349933df72e41f303b8194cc8da6
 SHA512:
-  metadata.gz: be09d8af6479897b60e760e1d8a1096804acca2a881a9dba302af39a701eeeba3e801ca09bd25caadcdc3a4ae20d8ea0280e9e70458331ea2a53d6a7bbba55b0
-  data.tar.gz: a49c63942e572826abe3e6176bca618589993da59957d012a34db8b49acd4550102b0fb8987a8a602faf20be56363ace53c53fe1496feb97316cd7796edf736d
+  metadata.gz: 67ff210a1024a027db62fdaad0091b52229b36d61753ee95c128930a3e4ea8bd127bc1bf8e61209a7aac9938b0c32fd768cdd8b72548adf7f8cc1336b41c95e6
+  data.tar.gz: fc5a82329178979b349055efb02840708ee1d2df4a3ea37d19f9b317403a5d583a584c25f712e3a72c83d438d344d46fbcfb8762bfa573d40909f991e8716fc6

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

@@ -515,49 +515,17 @@ class Api::V2::InfoController < Api::V2::ApplicationController
           }
         }
         # Non CRUD or Search, but custom, usually bulk operations endpoints
-        custom_actions = d.methods(false).select do |m| m.to_s.starts_with?("custom_action_") end
-        # Add also custom actions created using th enew Endpoints Interface
-        custom_actions += "Endpoints::#{d.model_name.name}".constantize.methods(false) rescue []
-        custom_actions.each do |action|
-          custom_action_name = action.to_s.gsub("custom_action_", "")
-          pivot["/#{model}/custom_action/#{custom_action_name}"] = {
-            "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],
-              "security": [
-                "bearerAuth": []
-              ],
-              "responses": {
-                "200": {
-                  "description": "Custom Action",
-                  "content": {
-                    "application/json": {
-                      "schema": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "integer"
-                          },
-                          "created_at": {
-                            "type": "string",
-                            "format": "date-time"
-                          },
-                          "updated_at": {
-                            "type": "string",
-                            "format": "date-time"
-                          }
-                        }
-                      }
-                    }
-                  }
-                },
-                "404": {
-                  "description": "No #{model} found"
-                }
-              }
-            }
-          }
+        new_custom_actions = ("Endpoints::#{d.model_name.name}".constantize.instance_methods(false) rescue [])
+        # Rails.logger.debug "New Custom Actions (#{d.model_name.name}): #{new_custom_actions}"
+        new_custom_actions.each do |action|
+          openapi_definition = "Endpoints::#{d.model_name.name}".constantize.definitions[action.to_sym] rescue false
+          
+          # Add the tag to the openapi definition
+          openapi_definition.each do |k, v|
+            v[:tags] = [ d.model_name.name ]
+          end
+
+          pivot["/#{model}/custom_action/#{action}"] = openapi_definition if openapi_definition
         end
         pivot["/#{model}/search"] = {
           # Complex queries are made using ranskac search via a post endpoint

data/app/models/endpoints/test_api.rb

@@ -0,0 +1,78 @@
+class Endpoints::TestApi < NonCrudEndpoints
+  self.desc :test, {
+    # Define the action name using openapi swagger format
+    get: {
+      summary: "Test API Custom Action",
+      description: "This is a test API custom action",
+      operationId: "test",
+      tags: ["Test"],
+      parameters: [
+        {
+          name: "explain",
+          in: "query",
+          description: "Explain the action by returning this openapi schema",
+          required: true,
+          schema: {
+            type: "boolean"
+          }
+        }
+      ],
+      responses: {
+        200 => {
+          description: "The openAPI json schema for this action",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                additionalProperties: true
+              }
+            }
+          }
+        },
+        501 => {
+          error: :string,
+        }
+      }
+    },
+    post: {
+      summary: "Test API Custom Action",
+      description: "This is a test API custom action",
+      operationId: "test",
+      tags: ["Test"],
+      requestBody: {
+        required: true,
+        content: {
+          "application/json": {}
+        }
+      },
+      responses: {
+        200 => {
+          description: "The openAPI json schema for this action",
+          # This will return the object with a message string and a params object
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  message: {
+                    type: "string"
+                  },
+                  params: {
+                    type: "object",
+                    additionalProperties: true
+                  }
+                }
+              }
+            }
+          }
+        },
+        501 => {
+          error: :string,
+        }
+      }
+    }
+  }
+  def test(params)    
+    return { message: "Hello World From Test API Custom Action called test", params: params }, 200
+  end
+end

data/app/models/test_api.rb

@@ -1,6 +1,2 @@
 class TestApi
-    # Initialize the class with the request params
-    def initialize params
-        @params = params
-    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.9".freeze
+  VERSION = "3.1.11".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,62 @@
+class NonCrudEndpoints
+    attr_accessor :result
+    cattr_accessor :definitions
+    self.definitions = {}
+    # 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.name}" unless self.respond_to? m
+        @definition = self.definitions[m.to_sym].with_indifferent_access
+
+        # self.send(m, { explain: true }) rescue []
+        validate_request(params)
+        @result = self.send(m, params)
+    end
+
+    def validate_request(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.keys.join(", ")}." if definition.keys.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 self.desc(key, definition)
+        self.definitions[key] = definition
+    end
+
+    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.9
+  version: 3.1.11
 platform: ruby
 authors:
 - Gabriele Tassoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-20 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,23 +0,0 @@
-module Endpoints::TestApi
-    def self.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"],
-            body: {},
-            query: {},
-            responses: {
-                200 => {
-                    message: :string,
-                    params: {}
-                },
-                501 => {
-                    error: :string
-                }
-            }
-        }
-
-        return explain, 200 if params[:explain] == "true"
-        return { error: "This method responds only to #{explain[:verbs].join(", ")} requests" }, 501 if explain[:verbs].exclude? params[:request_verb]
-        return { message: "Hello World From Test API Custom Action called test", params: params }, 200
-    end
-end