model_driven_api 3.1.6 → 3.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a72bb6cfea6d9f8e0fd4fff0643ee5f73c4c4434532092bd428c7b048c5f9b0
-  data.tar.gz: 51c3691214427e0aaa6111cf00a9b476fdb4c91861ba1819a227ea859f924a2d
+  metadata.gz: dcceec80f10a8a7bc91a9f8f32982f6d632f8af71936e8333ffe2f47308da2f7
+  data.tar.gz: e6b1f3833363f78ff5884a25ac986fb47e44e322193b65e3fc90494de2ab08dd
 SHA512:
-  metadata.gz: af0ddbc93b40f315b170630facacb7357022880e560502c83f4e2f2e5ac4342ffb5eaece4be1e1e591d5f0fa6b0a447b1e49ecbd6f9bf2975ee15c2a4b5c8743
-  data.tar.gz: f6318805dc382e2ce28494a74174d01bd53fb12749151a6ea5b21d4ea610dd23a9a4ac8c3dce09ff241c21202f8c3291694056917024781df012f39ac8e25460
+  metadata.gz: 8675f05d7145638a141e358fac87bb481318f2ea868817ea578d1400e6600291bdbc1d21691277f9c11f2c498be9e2659d724d0e3038f23c706b4a5ef8a81528
+  data.tar.gz: c1bd46b4cd97f04f50ddef90b3394f4ffce98348f8f73f8e05ac30259c0c16319b785ceeb5f77fb17aa0bbb55ae374009d65eaae7dc1e9e860f06ee7e0ec3565

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

@@ -121,36 +121,54 @@ class Api::V2::ApplicationController < ActionController::API
 
   private
 
+  ## CUSTOM ACTION
+  # [GET|PUT|POST|DELETE] :controller?do=:custom_action
+  # or
+  # [GET|PUT|POST|DELETE] :controller/:id?do=:
+  # or
+  # [GET|PUT|POST|DELETE] :controller?do=:custom_action-token
+  # or
+  # [GET|PUT|POST|DELETE] :controller/:id?do=:custom_action-token
+  # or
+  # [GET|PUT|POST|DELETE] :controller/custom_action/:custom_action
+  # or
+  # [GET|PUT|POST|DELETE] :controller/custom_action/:custom_action/:id
   def check_for_custom_action
-    ## CUSTOM ACTION
-    # [GET|PUT|POST|DELETE] :controller?do=:custom_action
-    # or
-    # [GET|PUT|POST|DELETE] :controller/:id?do=:custom_action
-    unless params[:do].blank?
-      # Poor man's solution to avoid the possibility to
-      # call an unwanted method in the AR Model.
-      custom_action, token = params[:do].split("-")
-
-      params[:request_url] = request.url
-      params[:remote_ip] = request.remote_ip
-      params[:token] = token.presence || bearer_token
-      # The endpoint can be expressed in two wayy:
-      # 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}")
-        body, status = @model.send("custom_action_#{custom_action}", params)
-      else
-        # Custom endpoint does not exist or cannot be called
-        raise NoMethodError
-      end
-      
-      return true, body.to_json(json_attrs), status
+
+    custom_action, token = if !params[:do].blank?
+      # This also responds to custom actions which have the bearer token in the custom action name. A workaround to remove for some IoT devices
+      # Which don't support token in header or in querystring
+      # This is for backward compatibility and in future it can ben removed
+      params[:do].split("-")
+    elsif request.url.include? "/custom_action/"
+      [params[:action_name], nil]
+    else
+      # Not a custom action call
+      false
     end
-    # if it's here there is no custom action in the request querystring
-    return false
+    return false unless custom_action
+    # Poor man's solution to avoid the possibility to
+    # call an unwanted method in the AR Model.
+
+    # Adding some useful information to the params hash
+    params[:request_url] = request.url
+    params[:remote_ip] = request.remote_ip
+    params[:request_verb] = request.request_method
+    params[:token] = token.presence || bearer_token
+    # 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}")
+      body, status = @model.send("custom_action_#{custom_action}", params)
+    else
+      # Custom endpoint does not exist or cannot be called
+      raise NoMethodError
+    end
+    
+    return true, body.to_json(json_attrs), status
   end
 
   def bearer_token
@@ -209,9 +227,9 @@ class Api::V2::ApplicationController < ActionController::API
     @model = (params[:ctrl].classify.constantize rescue params[:path].split("/").first.classify.constantize rescue controller_path.classify.constantize rescue controller_name.classify.constantize rescue nil)
     # Getting the body of the request if it exists, it's ok the singular or
     # plural form, this helps with automatic tests with Insomnia.
-    @body = params[@model.model_name.singular].presence || params[@model.model_name.route_key]
+    @body = (params[@model.model_name.singular].presence || params[@model.model_name.route_key]) rescue params
     # Only ActiveRecords can have this model caputed
-    return not_found! if (!@model.new.is_a? ActiveRecord::Base rescue false)
+    return not_found! if (@model != TestApi && !@model.new.is_a?(ActiveRecord::Base) rescue false)
   end
 
   def check_authorization(cmd)

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

@@ -84,14 +84,36 @@ class Api::V2::InfoController < Api::V2::ApplicationController
     method_key.type.to_s
   end
 
+  def integer?(str)
+    true if Integer(str) rescue false
+  end
+
+  def number?(str)
+    true if Float(str) rescue false
+  end
+
+  def datetime?(str)
+    true if DateTime.parse(str) rescue false
+  end
+
   def create_properties_from_model(model, dsl, remove_reserved = false)
-    JSON.parse(model.new.to_json(dsl)).keys.map do |k|
+    parsed_json = JSON.parse(model.new.to_json(dsl))
+    parsed_json.keys.map do |k|
       type = compute_type(model, k)
       
       # Remove fields that cannot be created or updated
       if remove_reserved && %w( id created_at updated_at lock_version).include?(k.to_s)
         nil
+      elsif type == "method" && (parsed_json[k].is_a?(FalseClass) || parsed_json[k].is_a?(TrueClass))
+        [k, { "type": "boolean" }]
+      elsif type == "method" && parsed_json[k].is_a?(String) && number?(parsed_json[k])
+        [k, { "type": "number" }]
+      elsif type == "method" && parsed_json[k].is_a?(String) && integer?(parsed_json[k])
+        [k, { "type": "integer" }]
+      elsif type == "method" && parsed_json[k].is_a?(String) && datetime?(parsed_json[k])
+        [k, { "type": "string", "format": "date-time" }]
       elsif type == "method"
+        # Unknown or complex format returned
         [k, { "type": "object", "additionalProperties": true }]
       elsif type == "date"
         [k, { "type": "string", "format": "date" }]
@@ -422,7 +444,7 @@ class Api::V2::InfoController < Api::V2::ApplicationController
         }
       }
     }
-    ApplicationRecord.subclasses.each do |d|
+    ApplicationRecord.subclasses.sort_by { |d| d.to_s }.each do |d|
       # Only if current user can read the model
       if true # can? :read, d
         model = d.to_s.underscore.tableize
@@ -494,6 +516,8 @@ 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}"] = {

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

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

data/app/models/test_api.rb

@@ -0,0 +1,2 @@
+class TestApi
+end

data/config/routes.rb

@@ -21,19 +21,30 @@ Rails.application.routes.draw do
             post "authenticate" => "authentication#authenticate"
             post ":ctrl/search" => 'application#index'
 
+            # Add a route with placeholders for custom actions, the custom actions routes have a form like: :ctrl/custom_action/:action_name or :ctrl/custom_action/:action_name/:id
+            # Can have all the verbs, but the most common are: get, post, put, delete
+            get ":ctrl/custom_action/:action_name", to: 'application#index'
+            get ":ctrl/custom_action/:action_name/:id", to: 'application#show'
+            post ":ctrl/custom_action/:action_name", to: 'application#create'
+            put ":ctrl/custom_action/:action_name/:id", to: 'application#update'
+            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 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'
-            put '*path/:id', to: 'application#update'
+            patch '*path/:id/multi', to: 'application#update_multi'
+            # put '*path/:id', to: 'application#update'
+            # patch '*path/:id', to: 'application#patch'
+
             # # CRUD Delete
             delete '*path/:id/multi', to: 'application#destroy_multi'
-            delete '*path/:id', to: 'application#destroy'
+            # delete '*path/:id', to: 'application#destroy'
         end
     end
 end

data/lib/model_driven_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.1.8
 platform: ruby
 authors:
 - Gabriele Tassoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thecore_backend_commons
@@ -125,6 +125,8 @@ 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/test_api.rb
 - app/models/used_token.rb
 - config/initializers/after_initialize_for_model_driven_api.rb
 - config/initializers/cors_api_thecore.rb