RubyGems - gloo-web - Versions diffs - 1.0 - Mend

gloo-web 1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

checksums.yaml +7 -0
data/lib/gloo-web.rb +48 -0
data/lib/objs/element.rb +252 -0
data/lib/objs/field.rb +428 -0
data/lib/objs/form.rb +269 -0
data/lib/objs/page.rb +560 -0
data/lib/objs/partial.rb +208 -0
data/lib/objs/svr.rb +711 -0
data/lib/routing/resource_router.rb +43 -0
data/lib/routing/router.rb +228 -0
data/lib/routing/show_routes.rb +90 -0
data/lib/web_svr/asset.rb +405 -0
data/lib/web_svr/asset_info.rb +114 -0
data/lib/web_svr/config.rb +55 -0
data/lib/web_svr/embedded_renderer.rb +152 -0
data/lib/web_svr/handler.rb +152 -0
data/lib/web_svr/request.rb +141 -0
data/lib/web_svr/request_params.rb +179 -0
data/lib/web_svr/response.rb +175 -0
data/lib/web_svr/response_code.rb +67 -0
data/lib/web_svr/server.rb +102 -0
data/lib/web_svr/session.rb +213 -0
data/lib/web_svr/table_renderer.rb +149 -0
data/lib/web_svr/web_method.rb +52 -0
metadata +81 -0

data/lib/web_svr/response.rb ADDED Viewed

@@ -0,0 +1,175 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# The Response for a web Request.
+#
+module WebSvr
+  class Response
+    #
+    # SEE: https://stackoverflow.com/questions/23714383/what-are-all-the-possible-values-for-http-content-type-header#48704300
+    #  for a list of content types.
+    #
+    CONTENT_TYPE = 'Content-Type'.freeze
+    TEXT_TYPE = 'text/plain'.freeze
+    JSON_TYPE = 'application/json'.freeze
+    HTML_TYPE = 'text/html'.freeze
+    attr_reader :code, :type, :data
+    attr_accessor :location
+    attr_accessor :file_name
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+    #
+    # Set up the web server.
+    #
+    def initialize( engine = nil,
+      code = WebSvr::ResponseCode::SUCCESS,
+      type = HTML_TYPE,
+      data = nil,
+      assetCache = false,
+      file_name = nil,
+      download = false )
+      @engine = engine
+      @log = @engine.log if @engine
+      @code = code
+      @type = type
+      @data = data
+      @assetCache = assetCache
+      @location = nil
+      @file_name = file_name
+      @download = download
+    end
+    # ---------------------------------------------------------------------
+    #    Static Helper Functions
+    # ---------------------------------------------------------------------
+    #
+    # Helper to create a successful JSON response with the given data.
+    #
+    def self.json_response( engine, data,
+      code = WebSvr::ResponseCode::SUCCESS )
+      return WebSvr::Response.new( engine, code, JSON_TYPE, data )
+    end
+    #
+    # Helper to create a successful text response with the given data.
+    #
+    def self.text_response( engine, data,
+      code = WebSvr::ResponseCode::SUCCESS )
+      return WebSvr::Response.new( engine, code, TEXT_TYPE, data )
+    end
+    #
+    # Helper to create a successful web response with the given data.
+    #
+    def self.html_response( engine, data,
+      code = WebSvr::ResponseCode::SUCCESS )
+      return WebSvr::Response.new( engine, code, HTML_TYPE, data )
+    end
+    #
+    # Helper to create a redirect response.
+    #
+    def self.redirect_response( engine, target )
+      code = WebSvr::ResponseCode::FOUND
+      data = <<~TEXT
+      <head>
+        <html>
+          <body><a href="#{target}">target is here</a></body>
+        </html>
+      </head>
+      TEXT
+      response = WebSvr::Response.new( engine, code, HTML_TYPE, data )
+      response.location = target
+      return response
+    end
+    # ---------------------------------------------------------------------
+    #    Data Functions
+    # ---------------------------------------------------------------------
+    #
+    # Add content to the payload.
+    #
+    def add content
+      @data = '' if @data.nil?
+      @data << content
+    end
+    #
+    # Get the headers for the response.
+    #
+    def headers
+      #
+      # 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 }
+      if @location
+        headers[ 'Location' ] = @location
+      end
+      if @assetCache || @file_name
+        headers[ 'Cache-Control' ] = 'public, max-age=604800'
+        headers[ 'Expires' ] = (Time.now.utc + 604800).to_s
+      end
+      if @file_name
+        disp = @download ? 'attachment' : 'inline'
+        headers[ 'Content-Disposition' ] = "#{disp}; filename=#{@file_name}"
+        headers[ 'Content-Length' ] = @data.length.to_s
+      end
+      session = @engine&.running_app&.obj&.session
+      headers = session.add_session_for_response( headers ) if session
+      # Clear out session data after the response is prepared.
+      @engine&.running_app&.obj&.reset_session_data
+      return headers
+    end
+    #
+    # Get the final result that will be returned as the
+    # response to the web request.
+    #
+    def result
+      return [ @code, headers, @data ]
+    end
+    # ---------------------------------------------------------------------
+    #    Helper functions
+    # ---------------------------------------------------------------------
+    #
+    # Write the result information to the log.
+    #
+    def log
+      return unless @log
+      @log.info "Response #{@code} #{@type}"
+    end
+  end
+end

data/lib/web_svr/response_code.rb ADDED Viewed

@@ -0,0 +1,67 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Standard Response Codes.
+#
+# See:
+#    https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
+#    https://www.geeksforgeeks.org/10-most-common-http-status-codes/
+#
+module WebSvr
+  class ResponseCode
+    # WebSvr::ResponseCode::SUCCESS
+    SUCCESS = 200.freeze
+    CODE_200 = 'Success/OK'.freeze
+    CREATED = 201.freeze
+    CODE_201 = 'Created'.freeze
+    ACCEPTED = 202.freeze
+    CODE_202 = 'Accepted'.freeze
+    NO_CONTENT = 204.freeze
+    CODE_204 = 'No Content'.freeze
+    PARTIAL_CONTENT = 206.freeze
+    CODE_206 = 'Partial Content'.freeze
+    MOVED_PERM = 301.freeze
+    CODE_301 = 'Moved Permanently'.freeze
+    FOUND = 302.freeze
+    CODE_302 = 'Found'.freeze
+    SEE_OTHER = 303.freeze
+    CODE_303 = 'See Other'.freeze
+    NOT_MODIFIED = 304.freeze
+    CODE_304 = 'Not Modified'.freeze
+    TEMP_REDIRECT = 307.freeze
+    CODE_307 = 'Temporary Redirect'.freeze
+    PERM_REDIRECT = 308.freeze
+    CODE_308 = 'Permanent Redirect'.freeze
+    BAD_REQUEST = 400.freeze
+    CODE_400 = 'Bad Request'.freeze
+    UNAUTHORIZED = 401.freeze
+    CODE_401 = 'Unauthorized'.freeze
+    FORBIDDEN = 403.freeze
+    CODE_403 = 'Forbidden'.freeze
+    NOT_FOUND = 404.freeze
+    CODE_404 = 'Not Found'.freeze
+    SERVER_ERR = 500.freeze
+    CODE_500 = 'Internal Server Error'.freeze
+    NOT_IMPLEMENTED = 501.freeze
+    CODE_501 = 'Not Implemented'.freeze
+  end
+end

data/lib/web_svr/server.rb ADDED Viewed

@@ -0,0 +1,102 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Starting work on web server inside gloo.
+#
+#  UNDER CONSTRUCTION!
+#
+# Simple tests:
+#   > curl http://localhost:8087/test/
+#   > curl http://localhost:8087/web/
+#   > curl http://localhost:8087/test/1
+#   > curl http://localhost:8087/test?param=123
+#
+# Run in loop:
+#  for i in {1..99}; do curl http://localhost:8087/; done
+#
+# Links:
+#   https://github.com/rack/rack
+#   https://github.com/rack/rack/blob/main/lib/rack/builder.rb
+#   https://thoughtbot.com/blog/ruby-rack-tutorial
+#   https://www.rubydoc.info/gems/rack/1.5.5/Rack/Runtime
+#
+require 'rack'
+module WebSvr
+  class Server
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, handler, config = nil, ssl_config = nil )
+      @config = config ? config : WebSvr::Config.new
+      @ssl_config = ssl_config
+      @engine = engine
+      @log = @engine.log
+      @handler = handler
+      @log.debug 'Gloo web server intialized…'
+    end
+    # ---------------------------------------------------------------------
+    #    Start and Stop the server.
+    # ---------------------------------------------------------------------
+    #
+    # Start the web server.
+    #
+    def start
+      opts = {
+        :Port => @config.port,
+        :Host => @config.host
+      }
+      Thread.abort_on_exception = true
+      @server_thread = Thread.new {
+        Rack::Handler::Thin.run( self, **options=opts ) do |server|
+          if @ssl_config
+            server.ssl = true
+            server.ssl_options = @ssl_config
+          end
+        end
+      }
+      @log.debug 'Web server has started.'
+    end
+    #
+    # Stop the web server
+    #
+    def stop
+      @log.debug 'Stopping the web server…'
+      @server_thread.kill
+      @log.debug 'The web server has been stopped.'
+    end
+    # ---------------------------------------------------------------------
+    #    Handle events
+    # ---------------------------------------------------------------------
+    #
+    # Handle a request for a resource.
+    #
+    def call( env )
+      request = WebSvr::Request.new( @engine, @handler, env )
+      request.log
+      response = request.process
+      response.log if response
+      return response ? response.result : nil
+    end
+  end
+end

data/lib/web_svr/session.rb ADDED Viewed

@@ -0,0 +1,213 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# Helpers for getting and setting session data.
+#
+# Resources:
+#   https://www.rubydoc.info/gems/rack/1.5.5/Rack/Request#cookies-instance_method
+#   https://rubydoc.info/github/rack/rack/Rack/Utils#set_cookie_header-class_method
+#   https://en.wikipedia.org/wiki/HTTP_cookie
+#
+require 'base64'
+module WebSvr
+  class Session
+    SESSION_CONTAINER = 'session'.freeze
+    SESSION_ID_NAME = 'session_id'.freeze
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+    #
+    # Set up the web server.
+    #
+    def initialize( engine, server_obj )
+      @engine = engine
+      @log = @engine.log
+      @server_obj = server_obj
+      @include_in_response = false
+      @clearing_session = false
+    end
+    # ---------------------------------------------------------------------
+    #    Set Session Data for Request
+    # ---------------------------------------------------------------------
+    #
+    # Get the session data from the encrypted cookie.
+    # Add it to the session container.
+    #
+    def set_session_data_for_request( env )
+      begin
+        cookie_hash = Rack::Utils.parse_cookies( env )
+        # Are we using sessions?
+        if @server_obj.use_session?
+          data = cookie_hash[ session_name ]
+          if data
+            data = decode_decrypt( data )
+            return unless data
+            @session_id = data[ SESSION_ID_NAME ]
+            data.each do |key, value|
+              unless key == SESSION_ID_NAME
+                @server_obj.set_session_var( key, value )
+              end
+            end
+          end
+        end
+      rescue => e
+        @engine.log_exception e
+      end
+    end
+    # ---------------------------------------------------------------------
+    #    Set Session Data for Response
+    # ---------------------------------------------------------------------
+    #
+    # Temporarily set the flag to add the session data to the response.
+    # Once this is done, the flag will be cleared and it will not
+    # be added to the next request unless specifically set.
+    #
+    def add_session_to_response
+      @include_in_response = true
+    end
+    def init_session_id
+      @session_id = Gloo::Objs::CsrfToken.generate_csrf_token
+      return @session_id
+    end
+    #
+    # Initialize the session id and add it to the data.
+    # Use the current session ID if it is there.
+    #
+    def get_session_id
+      if @clearing_session
+        @clearing_session = false
+        return nil
+      end
+      init_session_id if @session_id.blank?
+      return @session_id
+    end
+    #
+    # Clear out the session Id.
+    # Set the flag to add the session data to the response.
+    #
+    def clear_session_data
+      @session_id = nil
+      @clearing_session = true
+      add_session_to_response
+    end
+    #
+    # If there is session data, encrypt and add it to the response.
+    # Once done, clear out the session data.
+    #
+    def add_session_for_response( headers )
+      # Are we using sessions?
+      if @server_obj.use_session? && @include_in_response
+        # Reset the flag because we are adding to the session data now
+        @include_in_response = false
+        # Build and add encrypted session data
+        data = @server_obj.get_session_data
+        data[ SESSION_ID_NAME ] = get_session_id
+        unless data.empty?
+          data = encrypt_encode( data )
+          session_hash = {
+            value: data,
+            path: cookie_path,
+            expires: cookie_expires,
+            http_only: true }
+          if secure_cookie?
+            session_hash[ :secure ] = true
+          end
+          Rack::Utils.set_cookie_header!( headers, session_name, session_hash )
+        end
+      end
+      return headers
+    end
+    # ---------------------------------------------------------------------
+    #    Helper functions
+    # ---------------------------------------------------------------------
+    #
+    # Encrypt and encode the session data.
+    #
+    def encrypt_encode( data )
+      return Gloo::Objs::Cipher.encrypt( data.to_json, key, iv )
+    end
+    #
+    # Decode and decrypt the session data.
+    #
+    def decode_decrypt( data )
+      return nil unless data && key && iv
+      data = Gloo::Objs::Cipher.decrypt( data, key, iv )
+      return JSON.parse( data )
+    end
+    #
+    # Get the session cookie name.
+    #
+    def session_name
+      return @server_obj.session_name
+    end
+    #
+    # Get the key for the encryption cipher.
+    #
+    def key
+      return @server_obj.encryption_key
+    end
+    #
+    # Get the initialization vector for the cipher.
+    #
+    def iv
+      return @server_obj.encryption_iv
+    end
+    #
+    # Get the path for the session cookie.
+    #
+    def cookie_path
+      return @server_obj.session_cookie_path
+    end
+    #
+    # Get the expiration time for the session cookie.
+    #
+    def cookie_expires
+      return @server_obj.session_cookie_expires
+    end
+    #
+    # Should the session cookie be secure?
+    #
+    def secure_cookie?
+      return @server_obj.session_cookie_secure
+    end
+  end
+end

data/lib/web_svr/table_renderer.rb ADDED Viewed

@@ -0,0 +1,149 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2024 Eric Crane.  All rights reserved.
+#
+# A helper class used to render HTML tables.
+#
+module WebSvr
+  class TableRenderer
+    TABLE = 'table'.freeze
+    THEAD = 'thead'.freeze
+    HEAD_CELL = 'head_cell'.freeze
+    ROW = 'row'.freeze
+    CELL = 'cell'.freeze
+    NO_DATA_FOUND = "<p>No data found.</p>".freeze
+    # ---------------------------------------------------------------------
+    #    Initialization
+    # ---------------------------------------------------------------------
+    #
+    # Set up the web server.
+    #
+    def initialize( engine )
+      @engine = engine
+      @log = @engine.log
+    end
+    # ---------------------------------------------------------------------
+    #    Container Renderer
+    # ---------------------------------------------------------------------
+    #
+    # Render the query result set to an HTML table.
+    #
+    # params = {
+    #   head: head,
+    #   cols: result[0],
+    #   rows: rows,
+    #   styles: self.styles,
+    #   cell_renderers: self.cell_renderers
+    # }
+    #
+    def data_to_table params
+      data = params[ :rows ]
+      return NO_DATA_FOUND if data.nil? || ( data.length == 0 )
+      single_row = true if ( data.length == 1 )
+      single_row = false if params[ :always_rows ]
+      if single_row
+        return data_to_single_row_table( params )
+      else
+        return data_to_table_rows( params )
+      end
+    end
+    #
+    # Show in single-row (form) format.
+    #
+    def data_to_single_row_table( params )
+      styles = params[ :styles ]
+      str = "<table class='#{styles[ TABLE ]}'> <tbody>"
+      row = params[ :rows ].first
+      params[ :columns ].each do |head|
+        next unless head[ :visible ]
+        cell = row[ head[ :data_index ] ]
+        if head[ :cell_renderer ]
+          cell_value = render_cell( row, head, params[ :columns ] )
+        else
+          cell_value = cell
+        end
+        str += "<tr class='#{styles[ ROW ]}'>"
+        str += "<th class='#{styles[ HEAD_CELL ]}'>#{head[ :title ]}</th>"
+        str += "<td class='#{styles[ CELL ]}'>#{cell_value}</td>"
+        str += "</tr>"
+      end
+      str += "</tbody></table>"
+      return str
+    end
+    #
+    # Show in normal, multi-row format.
+    #
+    def data_to_table_rows( params )
+      styles = params[ :styles ]
+      # headers = params[ :head ]
+      str = "<table class='#{styles[ TABLE ]}'>"
+      str << "<thead class='#{styles[ THEAD ]}'><tr>"
+      params[ :columns ].each do |head|
+        next unless head[ :visible ]
+        str += "<th class='#{styles[ HEAD_CELL ]}'>#{head[ :title ]}</th>"
+      end
+      str << "</tr></thead><tbody>"
+      params[ :rows ].each do |row|
+        str += "<tr class='#{styles[ ROW ]}'>"
+        # row.each_with_index do |cell, i|
+        params[ :columns ].each do |head|
+          next unless head[ :visible ]
+          cell = row[ head[ :data_index ] ]
+          this_col_name = head[ :name ]
+          if head[ :cell_renderer ]
+            cell_value = render_cell( row, head, params[ :columns ] )
+          else
+            cell_value = cell
+          end
+          str += "<td class='#{styles[ CELL ]}'>#{cell_value}</td>"
+        end
+        str += "</tr>"
+      end
+      str += "</tbody></table>"
+      return str
+    end
+    #
+    # Render a cell using the cell renderer and the given
+    # context data (the row's values).
+    #
+    def render_cell row, col, cols
+      params = {}
+      cols.each_with_index do |c, i|
+        params[ c[ :name ] ] = row[ c[ :data_index ] ]
+      end
+      content = col[ :cell_renderer ]
+      content = @engine.running_app.obj.embedded_renderer.render content, params
+      # renderer = ERB.new( col[ :cell_renderer ] )
+      # content = renderer.result_with_hash( params )
+      return content
+    end
+  end
+end