gloo 3.1.1 → 3.3.0

data/lib/gloo/objs/web_svr/svr.rb

@@ -16,6 +16,10 @@ module Gloo
       HOST = 'host'.freeze
       PORT = 'port'.freeze
 
+      # SSL Configuration
+      SSL_CERT = 'ssl_cert'.freeze
+      SSL_KEY = 'ssl_key'.freeze
+
       # Events
       ON_START = 'on_start'.freeze
       ON_STOP = 'on_stop'.freeze
@@ -32,7 +36,7 @@ module Gloo
 
 
       # Messages
-      SERVER_NOT_RUNNING = 'The web server is not running and cannot be stopped'.freeze
+      SERVER_NOT_RUNNING = 'The web server is not running!'.freeze
 
       # 
       # Should the current request be redirected?
@@ -115,6 +119,56 @@ module Gloo
         return o
       end
 
+
+      # ---------------------------------------------------------------------
+      #    SSL
+      # ---------------------------------------------------------------------
+
+      # 
+      # Is SSL configured for this server?
+      # True if the Cert and Key are both present.
+      # 
+      def use_ssl?
+        return ssl_cert && ssl_key
+      end
+
+      #
+      # Get the SSL certificate from the child object.
+      # Returns nil if there is none.
+      #
+      def ssl_cert
+        cert = find_child SSL_CERT
+        return nil unless cert
+
+        cert = Gloo::Objs::Alias.resolve_alias( @engine, cert )
+        return cert
+      end
+
+      #
+      # Get the SSL key from the child object.
+      # Returns nil if there is none.
+      #
+      def ssl_key
+        key = find_child SSL_KEY
+        return nil unless key
+
+        key = Gloo::Objs::Alias.resolve_alias( @engine, key )
+        return key
+      end
+
+      # 
+      # Get the SSL configuration for the server.
+      # 
+      def ssl_config
+        return nil unless use_ssl?
+
+        return {
+          :private_key_file => ssl_key.value,
+          :cert_chain_file => ssl_cert.value,
+          :verify_peer => false,
+        }
+      end
+
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -156,7 +210,7 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        return super + [ 'start', 'stop' ]
+        return super + [ 'start', 'stop', 'routes' ]
       end
 
       #
@@ -183,6 +237,18 @@ module Gloo
         end
       end
 
+      # 
+      # Helper message to show all routes in the running server.
+      # 
+      def msg_routes
+        if @router
+          @router.show_routes
+        else
+          @engine.log.error SERVER_NOT_RUNNING
+        end
+      end
+
+
       # ---------------------------------------------------------------------
       #    Start and Stop Events
       #    Might come from messages or from other application events.
@@ -197,10 +263,10 @@ module Gloo
         @engine.log.info "Web Server URL: #{config.base_url}"
 
         handler = Gloo::WebSvr::Handler.new( @engine, self )
-        @web_server = Gloo::WebSvr::Server.new( @engine, handler, config )
+        @web_server = Gloo::WebSvr::Server.new( @engine, handler, config, ssl_config )
         @web_server.start
 
-        @router = Gloo::WebSvr::Router.new( @engine, self )
+        @router = Gloo::WebSvr::Routing::Router.new( @engine, self )
         @router.add_page_routes
 
         @asset = Gloo::WebSvr::Asset.new( @engine, self )
@@ -219,6 +285,7 @@ module Gloo
         @engine.log.info "Stopping web server…"
         @web_server.stop
         @web_server = nil
+        @router = nil
 
         run_on_stop
         @engine.log.info "Web server stopped…"

data/lib/gloo/verbs/break.rb

@@ -0,0 +1,44 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Break out of the script without error.
+#
+
+module Gloo
+  module Verbs
+    class Break < Gloo::Core::Verb
+
+      KEYWORD = 'break'.freeze
+      KEYWORD_SHORT = 'stop'.freeze
+
+      #
+      # Run the verb.
+      # Stop the execution of the current script.
+      #
+      def run
+        @engine.exec_env.running_script.break_out
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+    end
+  end
+end

data/lib/gloo/verbs/create.rb

@@ -57,6 +57,12 @@ module Gloo
         if Gloo::Expr::LString.string?( value )
           value = Gloo::Expr::LString.strip_quotes( value )
         end
+
+        # Check to see if this is an alias
+        pn = Gloo::Core::Pn.new( @engine, name )
+        obj = pn.resolve if pn
+        name = obj.value if obj&.is_alias?
+
         obj = @engine.factory.create( { name: name, type: type, value: value } )
 
         obj.add_default_children if obj&.add_children_on_create?

data/lib/gloo/verbs/invoke.rb

@@ -0,0 +1,80 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Invoke a function from a script.
+#
+
+module Gloo
+  module Verbs
+    class Invoke < Gloo::Core::Verb
+
+      KEYWORD = 'invoke'.freeze
+      KEYWORD_SHORT = '~>'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        if @tokens.token_count > 1
+          ob = @tokens.first
+
+          # Get the function object
+          pn = Gloo::Core::Pn.new( @engine, @tokens.second ) 
+          func = pn.resolve
+
+          # Is the object a function?
+          if func&.is_function?
+            params = get_params_arr
+          
+            @engine.log.debug "invoking function: #{func.pn}"
+            result = func.invoke( params ) 
+            @engine.log.debug "function returned: #{result}"
+            @engine.heap.it.set_to result
+            return result
+          end
+        end
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get params array.
+      #
+      def get_params_arr
+        @engine.log.debug "token params: #{@tokens.params}"
+        params = @tokens.params[1..-1]
+
+        @engine.log.info "params: #{params}"
+        evaluated_params = []
+
+        params.each do |p|
+          expr = Gloo::Expr::Expression.new( @engine, [ p ] )
+          evaluated_params << expr.evaluate
+        end
+
+        @engine.log.debug "evaluated_params: #{evaluated_params}"
+
+        return evaluated_params
+      end
+
+    end
+  end
+end

data/lib/gloo/verbs/log.rb

@@ -16,11 +16,11 @@ module Gloo
       #
       def run
         if @tokens.token_count > 1
-          expr = Gloo::Expr::Expression.new( @engine, @tokens.params )
-          result = expr.evaluate
-          level = log_level_specified( result )
-          @engine.log.write result, level
-          @engine.heap.it.set_to result
+          if is_clear_cmd?
+            @engine.log.clear
+          else
+            write_to_log
+          end
         else
           @engine.log.debug ''
         end
@@ -46,6 +46,27 @@ module Gloo
 
       private
 
+      # 
+      # Write to the specified logger.
+      # 
+      def write_to_log
+        expr = Gloo::Expr::Expression.new( @engine, @tokens.params )
+        result = expr.evaluate
+        level = log_level_specified( result )
+        @engine.log.write result, level
+        @engine.heap.it.set_to result
+      end
+
+      # 
+      # Is this a clear logs command?
+      # 
+      def is_clear_cmd?      
+        return true if ( ( @tokens.token_count == 2 ) && 
+          ( @tokens.params.first == 'clear' ) )
+          
+        return false
+      end
+
       #
       # Get the formatted string.
       #

data/lib/gloo/verbs/redirect.rb

@@ -12,7 +12,11 @@ module Gloo
       KEYWORD = 'redirect'.freeze
       KEYWORD_SHORT = 'go'.freeze
 
+      RUN_MESSAGE = 'run'.freeze
+
       MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+      APP_NOT_RUNING_ERR = 'The application is not running!'.freeze
+      BAD_TARGET_ERR = 'Bad redirect target!'.freeze
 
       #
       # Run the verb.
@@ -23,12 +27,8 @@ module Gloo
           return
         end
 
-        # Send the redirect page to the running app.
-        if @engine.app_running?
-          obj_name = @tokens.second
-          pn = Gloo::Core::Pn.new( @engine, obj_name )
-          @engine.running_app.obj.redirect = pn.resolve
-        end
+        determine_target
+        redirect_to_target
       end
 
       #
@@ -51,6 +51,54 @@ module Gloo
 
       private
 
+      # 
+      # Send the control to the redirect target.
+      # This could be a page or a script.
+      # 
+      def redirect_to_target
+        if @target_obj.class == Gloo::Objs::Page 
+          redirect_to_page
+        elsif @target_obj.can_receive_message?( RUN_MESSAGE )
+          redirect_to_script
+        else
+          @engine.err BAD_TARGET_ERR
+        end
+      end
+
+      # 
+      # Find the target of the redirect.
+      # 
+      def determine_target
+        obj_name = @tokens.second
+        pn = Gloo::Core::Pn.new( @engine, obj_name )
+
+        @target_obj = pn.resolve
+ 
+        @engine.log.info "obj type: #{@target_obj.class}"
+      end
+
+      # 
+      # Redirect to a page.
+      # This requires a running web server.
+      # 
+      def redirect_to_page
+        if @engine.app_running?
+          @engine.running_app.obj.redirect = @target_obj
+        else
+          @engine.err APP_NOT_RUNING_ERR
+        end
+      end
+
+      # 
+      # Redirect to another script.
+      # This stops execution of the current script.
+      # 
+      def redirect_to_script
+        @engine.exec_env.running_script.break_out
+
+        Gloo::Exec::Dispatch.message( @engine, RUN_MESSAGE, @target_obj )
+      end
+
     end
   end
 end

data/lib/gloo/web_svr/asset.rb

@@ -8,9 +8,10 @@ module Gloo
   module WebSvr
     class Asset
       
-      ASSETS_FOLDER = 'assets'.freeze
-      IMAGES_FOLDER = 'images'.freeze
-      STYLESHEETS_FOLDER = 'stylesheets'.freeze
+      ASSET_FOLDER = 'asset'.freeze
+      IMAGE_FOLDER = 'image'.freeze
+      STYLESHEET_FOLDER = 'stylesheet'.freeze
+      JAVASCRIPT_FOLDER = 'javascript'.freeze
 
       CSS_TYPE = 'text/css'.freeze
       JS_TYPE = 'text/javascript'.freeze
@@ -41,22 +42,29 @@ module Gloo
       # 
       # Get the asset folder in the project.
       #
-      def assets_folder
-        return File.join( @engine.settings.project_path, ASSETS_FOLDER )
+      def asset_folder
+        return File.join( @engine.settings.project_path, ASSET_FOLDER )
       end
 
       #
       # Get the images folder in the project.
       #
-      def images_folder
-        return File.join( assets_folder, IMAGES_FOLDER )
+      def image_folder
+        return File.join( asset_folder, IMAGE_FOLDER )
       end
 
       # 
       # Get the stylesheets folder in the project.
       #
-      def stylesheets_folder
-        return File.join( assets_folder, STYLESHEETS_FOLDER )
+      def stylesheet_folder
+        return File.join( asset_folder, STYLESHEET_FOLDER )
+      end
+
+      # 
+      # Get the stylesheets folder in the project.
+      #
+      def javascript_folder
+        return File.join( asset_folder, JAVASCRIPT_FOLDER )
       end
 
       # 
@@ -69,7 +77,7 @@ module Gloo
         return pn if File.exist? pn
 
         # Look in the web server's asset folder.
-        pn = File.join( assets_folder, pn )
+        pn = File.join( asset_folder, pn )
 
         return pn
       end
@@ -117,7 +125,7 @@ module Gloo
       # Add all asssets to the web server pages (routes).
       # 
       def add_asset_routes
-        return unless File.exist? assets_folder
+        return unless File.exist? asset_folder
 
         @log.debug 'Adding asset routes to web server…'
         @factory = @engine.factory
@@ -125,6 +133,7 @@ module Gloo
         add_containers
         add_images
         add_stylesheets
+        add_javascript
       end
 
       # 
@@ -133,14 +142,17 @@ module Gloo
       def add_containers
         pages = @web_svr_obj.pages_container
 
-        @assets = pages.find_child( ASSETS_FOLDER ) || 
-          @factory.create_can( ASSETS_FOLDER, pages )
+        @assets = pages.find_child( ASSET_FOLDER ) || 
+          @factory.create_can( ASSET_FOLDER, pages )
+
+        @images = @assets.find_child( IMAGE_FOLDER ) || 
+          @factory.create_can( IMAGE_FOLDER, @assets )
 
-        @images = @assets.find_child( IMAGES_FOLDER ) || 
-          @factory.create_can( IMAGES_FOLDER, @assets )
+        @stylesheets = @assets.find_child( STYLESHEET_FOLDER ) || 
+          @factory.create_can( STYLESHEET_FOLDER, @assets )
 
-        @stylesheets = @assets.find_child( STYLESHEETS_FOLDER ) || 
-          @factory.create_can( STYLESHEETS_FOLDER, @assets )
+        @javascript = @assets.find_child( JAVASCRIPT_FOLDER ) || 
+          @factory.create_can( JAVASCRIPT_FOLDER, @assets )
       end
 
       #
@@ -149,12 +161,12 @@ module Gloo
       def add_images
         @log.debug 'Adding image asset routes to web server…'
         
-        return unless File.exist? images_folder
+        return unless File.exist? image_folder
 
         # for each file in the images folder
         # create a file object and add it to the images container
-        Dir.each_child( images_folder ) do |name|
-          pn = File.join( IMAGES_FOLDER, name )
+        Dir.each_child( image_folder ) do |name|
+          pn = File.join( IMAGE_FOLDER, name )
           add_file_obj( @images, name, pn )
         end
       end
@@ -165,16 +177,32 @@ module Gloo
       def add_stylesheets
         @log.debug 'Adding stylesheet asset routes to web server…'
 
-        return unless File.exist? stylesheets_folder
+        return unless File.exist? stylesheet_folder
 
         # for each file in the stylesheets folder
         # create a file object and add it to the stylesheets container
-        Dir.each_child( stylesheets_folder ) do |name|
-          pn = File.join( STYLESHEETS_FOLDER, name )
+        Dir.each_child( stylesheet_folder ) do |name|
+          pn = File.join( STYLESHEET_FOLDER, name )
           add_file_obj( @stylesheets, name, pn )
         end
       end
 
+      #
+      # Add the Javascript files to the web server pages.
+      #
+      def add_javascript
+        @log.debug 'Adding javascript asset routes to web server…'
+
+        return unless File.exist? javascript_folder
+
+        # for each file in the javascript folder
+        # create a file object and add it to the javascript container
+        Dir.each_child( javascript_folder ) do |name|
+          pn = File.join( JAVASCRIPT_FOLDER, name )
+          add_file_obj( @javascript, name, pn )
+        end
+      end
+
       # 
       # Add a file object (page route) to the given container.
       # 

data/lib/gloo/web_svr/handler.rb

@@ -36,7 +36,9 @@ module Gloo
       def handle request
         @request = request
 
-        page = @server_obj.router.page_for_route @request.path
+        page, id = @server_obj.router.page_for_route( @request.path, @request.method )
+        @engine.log.debug "Found Page: #{page&.name}" if page
+        request.id = id
         if page
           if page.is_a? Gloo::Objs::FileHandle
             return handle_file page
@@ -53,7 +55,7 @@ module Gloo
       # Render the page, with possible redirect.
       # 
       def handle_page page
-        result = page.render
+        result = page.render @request
         if redirect_set?
           page = @engine.running_app.obj.redirect
           @log.debug "Redirecting to: #{page.pn}"

data/lib/gloo/web_svr/request.rb

@@ -19,7 +19,8 @@ module Gloo
       HTTP_HOST = 'HTTP_HOST'.freeze
       QUERY_STRING = 'QUERY_STRING'.freeze
 
-      attr_reader :method, :host, :path, :query
+      attr_reader :method, :host, :path, :query, :body
+      attr_accessor :id
 
       
       # ---------------------------------------------------------------------
@@ -66,6 +67,10 @@ module Gloo
         @path = @env[ REQUEST_PATH ]
         @host = @env[ HTTP_HOST ]
         @query = @env[ QUERY_STRING ]
+
+        @body = @env[ 'rack.input' ].read
+        @body = Rack::Utils.parse_query @body
+        check_body_method
       end
 
 
@@ -78,6 +83,7 @@ module Gloo
       # 
       def start_timer
         @start = Time.now
+        @engine.running_app.reset_db_time
       end
     
       # 
@@ -86,7 +92,8 @@ module Gloo
       def finish_timer
         @finish = Time.now
         @elapsed = ( ( @finish - @start ) * 1000.0 ).round(2)
-        @log.info "Web request complete.  Elapsed time: #{@elapsed} ms"
+        db = @engine.running_app.db_time
+        @log.info "*** Web request complete.  DB: #{db} ms.  Elapsed time: #{@elapsed} ms"
       end
     
 
@@ -94,12 +101,38 @@ module Gloo
       #    Helper functions
       # ---------------------------------------------------------------------
 
+      # 
+      # Check the body to see if there is a PATCH or a PUT in 
+      # the method override.
+      # 
+      def check_body_method
+        if @body[ '_method' ]
+          @method = @body[ '_method' ].upcase
+        end
+      end
+
+      #
+      # Get the hash of query parameters.
+      # 
+      def query_params
+        return {} unless @query
+        return Rack::Utils.parse_query( @query )
+      end
+
+      # 
+      # Get the hash of body parameters.
+      # 
+      def body_params
+        return @body ? @body : {}
+      end
+
       # 
       # Write the request information to the log.
       # 
       def log
         @log.info "#{@method} #{@host}#{@path}"
         @log.info "Parameters: #{@query}"
+        @log.info "Body: #{@body}" unless @body.empty?
       end
 
     end

data/lib/gloo/web_svr/routing/resource_router.rb

@@ -0,0 +1,47 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class for Resource routing.
+# 
+
+module Gloo
+  module WebSvr
+    module Routing
+      class ResourceRouter
+        
+        INDEX = 'index'.freeze
+        SHOW = 'show'.freeze
+        DELETE = 'delete'.freeze
+        UPDATE = 'update'.freeze
+
+        POST_ROUTE = 'create'.freeze
+
+
+        # 
+        # Is the given route segment an implicit create resource?
+        # It is explicit if it is 'create' 
+        #  and implicit if it is a POST to the resource.
+        # 
+        def self.is_implicit_create?( method, route_segment )
+          return false unless Gloo::WebSvr::WebMethod.is_post?( method )
+
+          return ! route_segment.eql?( POST_ROUTE )
+        end
+
+        # 
+        # Add the segment based on the method.
+        # 
+        def self.segment_for_method( method ) 
+          if Gloo::WebSvr::WebMethod.is_delete?( method )
+            return DELETE
+          elsif Gloo::WebSvr::WebMethod.is_patch?( method )
+            return UPDATE
+          else
+            return SHOW
+          end
+        end
+        
+      end
+    end
+  end
+end