file_sv 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7177e3a064f21ddcd10c0e939d9557460e23a260d247cfbed515a94a5b9265a3
-  data.tar.gz: e5cc7b549e0d6264a2a357a00de1d85ef18b7aafa757c621c0eeb647bc6db332
+  metadata.gz: 85dad645586f82345f25060f4866f1ac3a6e520ae9ebe635c26f56e37511e3e7
+  data.tar.gz: 86386a9473897c0425781759eac4ceddf96a253ba661d0e387c2e4e21d9c21cb
 SHA512:
-  metadata.gz: 61d515119cc7b4d3cefca1f8231c2d85f51394518e448013b4457271f01dddffd370426a5f4077bd5c05f7a446085643524c2968a443b0a1fd8fd86a5b3a6276
-  data.tar.gz: 96c064f198dbea63b6c5f251f4b2758856759f604cf8b3f3e31ccbb80fc895ee9d8861fe486e605d6a01feaab5f848a46d81501beadd1f1fee975d7bec9de146
+  metadata.gz: db63c4da96123bf37a186e49abb2f1e4f45f7721ee50031f08c5ca7fdb4c71ca57f32a2fda2d3059019dc03c99c080cea93722dac7ec0b98a2d5ce841e398d5a
+  data.tar.gz: c8efa0355463b2cb4f5cf09380035e08b9b2494ec324c5749bd7b65ec4f978f53c5351c1609ef37007bd8cf3b2ed88422dc1623d33028107a07cc24464684f00

data/lib/file_sv/har_generator.rb

@@ -26,7 +26,7 @@ class HarGenerator
 	parsed = JSON.parse(self.content)
 	pages = parsed['log']['pages']
 	self.entries = parsed['log']['entries']
-	puts "Found #{self.entries.count} entries in #{self.har_file_location}"
+	FileSv.logger.info "Found #{self.entries.count} entries in #{self.har_file_location}"
   end
 
   def generate

data/lib/file_sv/planned_endpoint.rb

@@ -130,19 +130,6 @@ class PlannedEndpoint
     ERB.new(File.read(serving_file_name)).result(binding)
   end
 
-  # Log when API is called
-  def log_call(params)
-    if params.keys.count > 0
-      show_params = []
-      params.each do |key, value|
-        show_params << "#{key}=#{value}"
-      end
-      "#{self.method} #{self.path}?#{show_params.join('&')}"
-    else 
-      "#{self.method} #{self.path}"
-    end
-  end
-
   def short_description
     desc = self.status_code.to_s
     desc += " (delay #{self.delay} sec)" if self.delay > 0

data/lib/file_sv/server_utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# typed: false
+
+# Helper methods added to RestServer
+module ServerUtils
+  def log(messages)
+    if FileSv.log_type == :ougai
+      log_structured(messages)
+    else
+      message = messages.values.join(", ")
+      FileSv.logger.info "#{message}, #{request.request_method} #{request.fullpath}, CorrelationId: #{@request_id}"
+    end
+  end
+
+  private def log_structured(messages)
+    log_msg = {
+      method: request.request_method,
+      path: request.fullpath,
+      correlationId: @request_id
+    }
+    messages.each do |key, value|
+      log_msg[key] = value
+    end
+    FileSv.logger.info(log_msg)
+  end
+end

data/lib/file_sv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FileSv
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/file_sv/virtual_server.rb

@@ -8,8 +8,9 @@ require "openssl"
 # Virtual server hosting virtual service defined through files
 class VirtualServer < Sinatra::Base
   set :server, :puma
-  enable :logging if ENV['debug'] == "true"
+  enable :logging if ENV["debug"] == "true"
   set :bind, "0.0.0.0"
+  helpers ServerUtils
 
   register Sinatra::DocDsl
 
@@ -20,6 +21,13 @@ class VirtualServer < Sinatra::Base
 for more details'
   end
 
+  before do
+    @request_id = SecureRandom.uuid
+    headers["X-Correlation-Id"] = @request_id
+    headers["Access-Control-Allow-Origin"] = "*"
+    log({ msg: "Request" }) if request.fullpath != "/"
+  end
+
   get "/favicon.ico" do
     send_file File.join(__dir__, "file_sv.ico")
   end
@@ -33,26 +41,26 @@ for more details'
   end
 
   def append_content_type(endpoint)
-    if (endpoint.file_path.end_with? '.json')
+    if endpoint.file_path.end_with? ".json"
       content_type :json
-    elsif endpoint.file_path.end_with? '.xml'
+    elsif endpoint.file_path.end_with? ".xml"
       content_type :xml
-    elsif endpoint.file_path.end_with? '.css'
+    elsif endpoint.file_path.end_with? ".css"
       content_type :css
-    elsif endpoint.file_path.end_with? '.js'
-      content_type :js    
+    elsif endpoint.file_path.end_with? ".js"
+      content_type :js
     end
   end
 
   # Log endpoint. Return content and status code defined by endpoint
   # @param [PlannedEndpoint] endpoint Planned endpoint to serve
-  def serve(endpoint, id = nil)    
+  def serve(endpoint, id = nil)
     @id = id
     append_content_type(endpoint)
-    if ENV['debug'] == "true"
+    if ENV["debug"] == "true"
       message = "Using endpoint based on file #{endpoint.serving_file_name}."
       message += " Using param '#{@id}'" if id
-      puts message
+      FileSv.logger.debug message
     end
     sleep endpoint.delay if endpoint.delay > 0
     [endpoint.status_code, output_for(endpoint, binding)]
@@ -69,7 +77,7 @@ for more details'
           response["Access-Control-Allow-Origin"] = "*"
           endpoint = endpoints.sample
           @params = params
-          puts endpoint.log_call(@params)
+          log({ msg: "Response", status: response.status, endpoint: endpoint.serving_file_name }) if request.fullpath != "/"
           serve endpoint, id
         end
       else
@@ -77,14 +85,15 @@ for more details'
           response["Access-Control-Allow-Origin"] = "*"
           endpoint = endpoints.sample
           @params = params
-          puts endpoint.log_call(@params) unless ENV['ignore_path'] && ("/#{ENV['ignore_path']}" == endpoint_base.path)
+          unless ENV["ignore_path"] && ("/#{ENV["ignore_path"]}" == endpoint_base.path)
+            log({ msg: "Response", status: response.status, endpoint: endpoint.serving_file_name }) if request.fullpath != "/"
+          end
           serve endpoint
         end
       end
     end
     # options endpoint for CORS
     options endpoint_path do
-      puts "options: #{endpoint_path}"
       response["Allow"] = "*"
       response["Access-Control-Allow-Origin"] = "*"
       response["Access-Control-Allow-Methods"] = "*"

data/lib/file_sv.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "logger"
+require "ougai"
 require_relative "file_sv/version"
 require_relative "file_sv/global_settings"
 require_relative "file_sv/sv_plan"
 require_relative "file_sv/service_loader"
 require_relative "file_sv/planned_endpoint"
+require_relative "file_sv/server_utils"
+
+ENV["APP_ENV"] ||= "production"
 
 # Create Service Virtualization from a simple file system
 module FileSv
@@ -15,6 +20,17 @@ module FileSv
   # Error related to incorrect format of filename
   class FileNameError < Error; end
 
+  if ENV["Log"] == "structured"
+    @logger = Ougai::Logger.new($stdout)
+    @log_type = :ougai
+  else
+    @logger = Logger.new($stdout)
+    @log_type = :basic
+  end
+  LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
+  log_level ||= LOGLEVELS.index ENV.fetch("LOG_LEVEL","INFO")
+  @logger.level = log_level
+
   class << self
     # @return [Hash] Mapping of REST method names to setting classes
     def rest_methods
@@ -23,6 +39,12 @@ module FileSv
         delete: DeleteSettings, put: PutSettings
       }
     end
+
+    # @return [Logger] Logger
+    attr_accessor :logger
+
+    # @return Logger type
+    attr_accessor :log_type
   end
 end
 
@@ -31,17 +53,17 @@ CONFIG_FILE = "file_sv.yaml"
 # Set values in global settings based on config
 def load_default_config(file_path)
   unless File.exist? file_path
-    puts "No config found at #{file_path}" if ENV['debug'] == "true"
+    FileSv.logger.debug "No config found at #{file_path}" if ENV["debug"] == "true"
     return
   end
-  puts "Loading config from #{file_path}" if ENV['debug'] == "true"
+  FileSv.logger.debug "Loading config from #{file_path}" if ENV["debug"] == "true"
 
   config = YAML.load_file file_path
   return unless config # Handle empty YAML file
 
-  puts "Config #{config}" if ENV['debug'] == "true"
+  FileSv.logger.debug "Config #{config}" if ENV["debug"] == "true"
   config["global"]&.each do |key, value|
-    puts "Setting #{key} to #{value}" if ENV['debug'] == "true"
+    FileSv.logger.debug "Setting #{key} to #{value}" if ENV["debug"] == "true"
     GlobalSettings.send("#{key}=", value)
   end
 
@@ -60,7 +82,7 @@ def set_based_on_env_vars
   GlobalSettings.instance_variables.each do |setting|
     setting_name = setting.to_s[1..]
     if ENV[setting_name]
-      puts "Setting #{setting_name} to #{ENV[setting_name]}"
+      FileSv.logger.debug "Setting #{setting_name} to #{ENV[setting_name]}"
       GlobalSettings.send("#{setting_name}=", ENV[setting_name])
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_sv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-20 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rackup
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +126,7 @@ files:
 - lib/file_sv/har_generator.rb
 - lib/file_sv/planned_endpoint.rb
 - lib/file_sv/render_file.rb
+- lib/file_sv/server_utils.rb
 - lib/file_sv/service_loader.rb
 - lib/file_sv/sv_plan.rb
 - lib/file_sv/version.rb