gloo 3.3.0 → 3.4.0

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

@@ -11,18 +11,45 @@ module Gloo
       KEYWORD = 'server'.freeze
       KEYWORD_SHORT = 'svr'.freeze
 
-      # Configuration
-      SCHEME = 'scheme'.freeze      
+      # ---------------------------------------------------------------------
+      #    CONFIGURATION KEYS
+      # ---------------------------------------------------------------------
+      CONFIG = 'config'.freeze
+      SCHEME = 'scheme'.freeze
+      HTTP = 'http'.freeze
+      HTTPS = 'https'.freeze
       HOST = 'host'.freeze
       PORT = 'port'.freeze
+      SESSION_NAME = 'session_name'.freeze
+      ENCRYPT_KEY = 'encryption_key'.freeze
+      ENCRYPT_IV = 'encryption_iv'.freeze
+      COOKIE_EXPIRES = 'cookie_expires'.freeze
+      COOKIE_PATH = 'cookie_path'.freeze
+      DEFAULT_COOKIE_PATH = '/'.freeze
 
       # SSL Configuration
       SSL_CERT = 'ssl_cert'.freeze
       SSL_KEY = 'ssl_key'.freeze
 
+      # ---------------------------------------------------------------------
+      #    OTHER KEYS
+      # ---------------------------------------------------------------------
+
       # Events
       ON_START = 'on_start'.freeze
       ON_STOP = 'on_stop'.freeze
+      ON_REQUEST = 'on_request'.freeze
+      ON_RESPONSE = 'on_response'.freeze
+      RESQUEST_DATA = 'request_data'.freeze
+      METHOD = 'method'.freeze
+      PATH = 'path'.freeze
+      QUERY = 'query'.freeze
+      IP = 'ip'.freeze
+      RESPONSE_DATA = 'response_data'.freeze
+      TYPE = 'type'.freeze
+      CODE = 'code'.freeze
+      ELAPSED = 'elapsed'.freeze
+      DB = 'db'.freeze
 
       # Container with pages in the web app.
       PAGES = 'pages'.freeze
@@ -34,6 +61,9 @@ module Gloo
       HOME = 'home'.freeze
       ERR_PAGE = 'error'.freeze
 
+      # Session
+      SESSION = 'session'.freeze
+
 
       # Messages
       SERVER_NOT_RUNNING = 'The web server is not running!'.freeze
@@ -44,6 +74,7 @@ module Gloo
       # of the one requested.
       # 
       attr_accessor :redirect, :router, :asset, :embedded_renderer
+      attr_accessor :session
 
       #
       # The name of the object type.
@@ -74,12 +105,29 @@ module Gloo
         return false
       end
 
+      # 
+      # Get the default layout for the app.
+      # 
+      def default_page_layout
+        o = find_child LAYOUT
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Configuration
+      # ---------------------------------------------------------------------
+
       #
       # Get the Scheme (http or https) from the child object.
       # Returns nil if there is none.
       #
       def scheme_value
-        scheme = find_child SCHEME
+        config = find_child CONFIG
+        scheme = config.find_child SCHEME
         return nil unless scheme
 
         return scheme.value
@@ -90,7 +138,8 @@ module Gloo
       # Returns nil if there is none.
       #
       def host_value
-        host = find_child HOST
+        config = find_child CONFIG
+        host = config.find_child HOST
         return nil unless host
 
         return host.value
@@ -101,24 +150,163 @@ module Gloo
       # Returns nil if there is none.
       #
       def port_value
-        port = find_child PORT
+        config = find_child CONFIG
+        port = config.find_child PORT
         return nil unless port
 
         return port.value
       end
 
+      # 
+      # Is this server configured to use a session?
+      # It is if theere is a non-empty session name.
+      # 
+      def use_session?
+        return ! session_name.blank?
+      end
 
       # 
-      # Get the default layout for the app.
+      # Get the session cookie name.
       # 
-      def default_page_layout
-        o = find_child LAYOUT
+      def session_name
+        config = find_child CONFIG
+        session_name = config.find_child SESSION_NAME
+        return nil unless session_name
+
+        name = session_name.value
+        return nil if name.blank?
+
+        return name
+      end
+
+      # 
+      # Get the key for the encryption cipher.
+      # 
+      def encryption_key
+        config = find_child CONFIG
+        o = config.find_child ENCRYPT_KEY
         return nil unless o
 
         o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      # 
+      # Get the initialization vector for the cipher.
+      # 
+      def encryption_iv
+        config = find_child CONFIG
+        o = config.find_child ENCRYPT_IV
+        return nil unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      # 
+      # Get the path for the session cookie.
+      # If not specified, use the root path.
+      # 
+      def session_cookie_path
+        config = find_child CONFIG
+        o = config.find_child COOKIE_PATH
+        if o
+          return o.value
+        else
+          return DEFAULT_COOKIE_PATH
+        end
+      end
+
+      # 
+      # Get the expiration time for the session cookie.
+      # If not specified, use one week from now.
+      # 
+      def session_cookie_expires
+        config = find_child CONFIG
+        o = config.find_child COOKIE_EXPIRES
+        if o
+          dt = Chronic.parse( o.value )
+          return dt
+        else
+          return 1.week.from_now
+        end
+      end
+
+      # 
+      # Should the session cookie be secure?
+      # Get the value from the scheme settings/config.
+      # 
+      def session_cookie_secure
+        return scheme_value.downcase == HTTPS
+      end
+
+
+      # ---------------------------------------------------------------------
+      #    Session
+      # ---------------------------------------------------------------------
+
+      # 
+      # Get the session container object.
+      # If there is none, one will be created.
+      # 
+      def session_container
+        o = find_child SESSION
+
+        unless o
+          o = add_session_container
+        end
+
         return o
       end
 
+      # 
+      # Add the session container because it is missing.
+      # 
+      def add_session_container
+        fac = @engine.factory
+        return fac.create_can SESSION, self
+      end
+
+      # 
+      # Get the data from the session container.
+      # Data will be in the form of a hash ( key => value ).
+      # 
+      def get_session_data
+        data = {}
+
+        session_container.children.each do |session_var|
+          key = session_var.name
+          value = session_var.value
+          data[ key ] = value
+        end
+
+        return data
+      end
+
+      # 
+      # Get the session child object with the given value.
+      # Create the child if it does not exist.
+      # 
+      def set_session_var( key, value )
+        child_obj = session_container.find_child( key )
+        unless child_obj
+          fac = @engine.factory
+          child_obj = fac.create_string key, value, session_obj
+        end
+        child_obj.value = value
+      end
+
+      # 
+      # Clear out all session data.
+      # Important to do this after the response is sent
+      # to avoid holding on to data that is no longer needed.
+      # 
+      def clear_session_data
+        session_container.children.each do |session_var|
+          session_var.value = ''
+        end
+      end
+
 
       # ---------------------------------------------------------------------
       #    SSL
@@ -190,15 +378,20 @@ module Gloo
       def add_default_children
         fac = @engine.factory
 
-        fac.create_string SCHEME, 'http', self
-        fac.create_string HOST, 'localhost', self
-        fac.create_string PORT, '8080', self
+        # Configuration
+        config = fac.create_can CONFIG, self
+        fac.create_string SCHEME, HTTP, config
+        fac.create_string HOST, 'localhost', config
+        fac.create_string PORT, '8080', config
 
         fac.create_script ON_START, '', self
         fac.create_script ON_STOP, '', self
 
+        fac.create_alias LAYOUT, nil, self
+        fac.create_alias HOME, nil, self
+        fac.create_alias ERR_PAGE, nil, self
+
         fac.create_can PAGES, self
-        fac.create_can HOME, self
       end
 
 
@@ -274,6 +467,8 @@ module Gloo
 
         @embedded_renderer = Gloo::WebSvr::EmbeddedRenderer.new( @engine, self )
 
+        @session = Gloo::WebSvr::Session.new( @engine, self )
+        
         run_on_start
         @engine.log.info "Web server started and listening…"
       end
@@ -283,6 +478,10 @@ module Gloo
       # 
       def stop
         @engine.log.info "Stopping web server…"
+
+        # Last chance to clear out session data.
+        clear_session_data
+
         @web_server.stop
         @web_server = nil
         @router = nil
@@ -297,7 +496,7 @@ module Gloo
       # ---------------------------------------------------------------------
 
       #
-      # Run the on render script if there is one.
+      # Run the on start script if there is one.
       #
       def run_on_start
         o = find_child ON_START
@@ -307,7 +506,7 @@ module Gloo
       end
 
       #
-      # Run the on rendered script if there is one.
+      # Run the on stop script if there is one.
       #
       def run_on_stop
         o = find_child ON_STOP
@@ -316,6 +515,60 @@ module Gloo
         Gloo::Exec::Dispatch.message( @engine, 'run', o )
       end
 
+      #
+      # Run the on request script if there is one.
+      #
+      def run_on_request
+        o = find_child ON_REQUEST
+        return unless o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+      #
+      # Run the on response script if there is one.
+      #
+      def run_on_response
+        o = find_child ON_RESPONSE
+        return unless o
+        o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+        Gloo::Exec::Dispatch.message( @engine, 'run', o )
+      end
+
+      # 
+      # Set up the request data for the page load.
+      # This is done before the on_request event is fired.
+      # 
+      def set_request_data( request )
+        data = find_child RESQUEST_DATA
+        return unless data
+        data = Gloo::Objs::Alias.resolve_alias( @engine, data )
+
+        data.find_child( METHOD )&.set_value( request.method )
+        data.find_child( HOST )&.set_value( request.host )
+        data.find_child( PATH )&.set_value( request.path )
+        data.find_child( QUERY )&.set_value( request.query )
+        data.find_child( IP )&.set_value( request.ip )
+      end
+
+      # 
+      # Set up the response data for the page load.
+      # This is done after the page is rendered and before
+      # the on_response event is fired.
+      # 
+      def set_response_data( request, response )
+        data = find_child RESPONSE_DATA
+        return unless data
+        data = Gloo::Objs::Alias.resolve_alias( @engine, data )
+
+        data.find_child( ELAPSED )&.set_value( request.elapsed )
+        data.find_child( DB )&.set_value( request.db )
+        data.find_child( TYPE )&.set_value( response.type )
+        data.find_child( CODE )&.set_value( response.code )
+      end
+
 
       # ---------------------------------------------------------------------
       #    Pages and standard elements.

data/lib/gloo/verbs/version.rb

@@ -55,7 +55,7 @@ module Gloo
       def show_vers_notes
         @engine.log.show "Gloo version notes..."
         notes = Gloo::App::Info.get_version_notes
-        @engine.platform.show( notes, false, true )
+        @engine.platform.show notes
       end
 
       # 

data/lib/gloo/web_svr/asset.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A helper class for static assets.
 # 
@@ -155,6 +155,26 @@ module Gloo
           @factory.create_can( JAVASCRIPT_FOLDER, @assets )
       end
 
+      # 
+      # Traverse the given folder and add all files to the container.
+      # This is a recursive method and look look for files in subfolders.
+      # 
+      def add_files_in_folder( folder, container, path )
+        Dir.each_child( folder ) do |name|
+          pn = File.join( path, name )
+          full_path = File.join( folder, name )
+
+          if File.directory? full_path
+            child = container.find_child( name )
+            child = @factory.create_can( name, container ) if child.nil?
+
+            add_files_in_folder( full_path, child, pn )
+          else
+            add_file_obj( container, name, pn )
+          end
+        end
+      end
+
       #
       # Add the images to the web server pages.
       #
@@ -165,10 +185,7 @@ module Gloo
 
         # for each file in the images folder
         # create a file object and add it to the images container
-        Dir.each_child( image_folder ) do |name|
-          pn = File.join( IMAGE_FOLDER, name )
-          add_file_obj( @images, name, pn )
-        end
+        add_files_in_folder( image_folder, @images, IMAGE_FOLDER )
       end
 
       #
@@ -181,10 +198,12 @@ module Gloo
 
         # for each file in the stylesheets folder
         # create a file object and add it to the stylesheets container
-        Dir.each_child( stylesheet_folder ) do |name|
-          pn = File.join( STYLESHEET_FOLDER, name )
-          add_file_obj( @stylesheets, name, pn )
-        end
+        add_files_in_folder( stylesheet_folder, @stylesheets, STYLESHEET_FOLDER )
+
+        # Dir.each_child( stylesheet_folder ) do |name|
+        #   pn = File.join( STYLESHEET_FOLDER, name )
+        #   add_file_obj( @stylesheets, name, pn )
+        # end
       end
 
       #
@@ -197,10 +216,12 @@ module Gloo
 
         # 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
+        add_files_in_folder( javascript_folder, @javascript, JAVASCRIPT_FOLDER )
+
+        # Dir.each_child( javascript_folder ) do |name|
+        #   pn = File.join( JAVASCRIPT_FOLDER, name )
+        #   add_file_obj( @javascript, name, pn )
+        # end
       end
 
       # 

data/lib/gloo/web_svr/config.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # Configuration for a gloo web server.
 #

data/lib/gloo/web_svr/embedded_renderer.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A helper class used to render parameters (ERB) in text.
 # Also uses helper functions to render.

data/lib/gloo/web_svr/handler.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # Web application request handler.
 # Takes a request and does what is needed to create a response.
@@ -41,13 +41,15 @@ module Gloo
         request.id = id
         if page
           if page.is_a? Gloo::Objs::FileHandle
-            return handle_file page
+            result = handle_file page
           else
-            return handle_page page
+            result = handle_page page
           end
+        else
+          result = server_error_result
         end
 
-        return server_error_result
+        return result
       end
 
       # 

data/lib/gloo/web_svr/request.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A web Request for a page, action, or static resource.
 #
@@ -9,6 +9,10 @@
 #   API - returns JSON instead of HTML (but is that different from Web Page?)
 #   Static Resource - File, PDF, Image, etc.
 # 
+# 
+# See More doc here:
+#    https://www.rubydoc.info/gems/rack/Rack/Request/Helpers#path-instance_method
+# 
 
 module Gloo
   module WebSvr
@@ -19,7 +23,8 @@ module Gloo
       HTTP_HOST = 'HTTP_HOST'.freeze
       QUERY_STRING = 'QUERY_STRING'.freeze
 
-      attr_reader :method, :host, :path, :query, :body
+      attr_reader :method, :host, :path, :query, :body, :ip
+      attr_reader :db, :elapsed
       attr_accessor :id
 
       
@@ -50,11 +55,22 @@ module Gloo
       # 
       def process
         start_timer
+
+        # Run the on_request script if there is one.
+        @handler.server_obj.set_request_data self
+        @handler.server_obj.run_on_request
+        
         result = @handler.handle self
         finish_timer
+
+        # Run the on_response script if there is one.
+        @handler.server_obj.set_response_data self, result
+        @handler.server_obj.run_on_response
+
         return result
       end
 
+      
       # ---------------------------------------------------------------------
       #    ENV
       # ---------------------------------------------------------------------
@@ -63,10 +79,20 @@ module Gloo
       # Write the request information to the log.
       # 
       def detect_env
-        @method = @env[ REQUEST_METHOD ]
-        @path = @env[ REQUEST_PATH ]
-        @host = @env[ HTTP_HOST ]
-        @query = @env[ QUERY_STRING ]
+        req = Rack::Request.new( @env )
+
+        @method = req.request_method
+        @path = req.path
+        @host = req.host_with_port
+        @query = req.query_string
+        @ip = req.ip
+
+        # @method = @env[ REQUEST_METHOD ]
+        # @path = @env[ REQUEST_PATH ]
+        # @host = @env[ HTTP_HOST ]
+        # @query = @env[ QUERY_STRING ]
+
+        @handler.server_obj.session.set_session_data_for_request( @env )
 
         @body = @env[ 'rack.input' ].read
         @body = Rack::Utils.parse_query @body
@@ -92,8 +118,8 @@ module Gloo
       def finish_timer
         @finish = Time.now
         @elapsed = ( ( @finish - @start ) * 1000.0 ).round(2)
-        db = @engine.running_app.db_time
-        @log.info "*** Web request complete.  DB: #{db} ms.  Elapsed time: #{@elapsed} ms"
+        @db = @engine.running_app.db_time
+        @log.info "*** Web request complete.  DB: #{@db} ms.  Elapsed time: #{@elapsed} ms"
       end
     
 

data/lib/gloo/web_svr/response.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # The Response for a web Request.
 #
@@ -88,7 +88,19 @@ module Gloo
       # Get the headers for the response.
       # 
       def headers
-        return { CONTENT_TYPE => @type }
+        # 
+        # TO DO: Add more cookie headers here.
+        # 
+        #  https://stackoverflow.com/questions/3295083/how-do-i-set-a-cookie-with-a-ruby-rack-middleware-component
+        #   https://www.rubydoc.info/gems/rack/1.4.7/Rack/Session/Cookie
+        #
+
+        headers = { CONTENT_TYPE => @type }
+
+        session = @engine&.running_app&.obj&.session      
+        headers = session.add_session_for_response( headers ) if session
+  
+        return headers
       end
 
       # 

data/lib/gloo/web_svr/response_code.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # Standard Response Codes.
 # 

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

@@ -1,9 +1,8 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A helper class for page routing.
 # 
-require 'tty-table'
 
 module Gloo
   module WebSvr

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

@@ -1,9 +1,8 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 #
 # A helper class for to show routes for a running app.
 # 
-require 'tty-table'
 
 module Gloo
   module WebSvr
@@ -77,11 +76,9 @@ module Gloo
         # Show the Routes title.
         # 
         def show_table
-          @log.show "\n\tRoutes in Running Web App\n", :white
-
-          table = TTY::Table.new( headers, @found_routes )
-          renderer = TTY::Table::Renderer::Unicode.new( table, padding: [0,1] )
-          puts renderer.render
+          puts RETURN
+          title = "Routes in Running Web App"
+          @engine.platform.table.show headers, @found_routes, title
           puts RETURN
         end
 

data/lib/gloo/web_svr/server.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 20124 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
 # 
 # Starting work on web server inside gloo.
 #