schemaless_rest_api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80f60796bfe046a8af8d4e4068ae847379ab7a6a2f78b03e06732f2b6b1d8a6
-  data.tar.gz: 1473a6597e940ad4949b306d6cb72b5b49badda3ec3b16b2e118407eaefaa45d
+  metadata.gz: 3ab21f348c0122fbfa54365f8f1ed20c80bcf2f110e522bf8e782315414419e9
+  data.tar.gz: a5ac30ed8f1efe06561474fed073f9e270788b74502e85dfcf8e61b11131a21d
 SHA512:
-  metadata.gz: b9d2068d71bef0434faa40fe237864fcb6fbebedbb0109013d995055a26975ca4109817215840b2cc22b178efdb3cdc1924e19d1450fcdda251f2ef5aad89e6a
-  data.tar.gz: ad9734ec4b544a6a686e791cacbb45cd70234e071f6af8d6d2ced82624e401d03a7d77ba33001a2cd0529a0ace33205c28eed296b853a8e728ed396c2ff0a7b1
+  metadata.gz: a63738895a1ae2c01ecf3a0d81d70978231f3c92493a13f9a72cb111d1b41a6f90fde28f9dddd2de662c9fe7d3e270bdd1f7462870c02516e1a042957f950169
+  data.tar.gz: aa2e4411f2aace139b6b9d40edb672e32513d6dcc07a4e6359b2338191dd3bf583f433d9d239f3d7263fde38eb169990290d73e31aa2d2df51b9e7074f55480e

data/lib/schemaless_rest_api/rest_server.rb

@@ -3,6 +3,7 @@
 require "sinatra"
 require "puma"
 require "route_downcaser"
+require_relative "server_utils"
 
 # Server with endpoints generated based on Entities with CRUD operations for them
 class RestServer < Sinatra::Base
@@ -10,12 +11,23 @@ class RestServer < Sinatra::Base
   enable :logging if ENV["debug"] == "true"
   set :bind, "0.0.0.0"
   use RouteDowncaser::DowncaseRouteMiddleware
+  helpers ServerUtils
+
+  before do
+    @request_id = SecureRandom.uuid 
+    headers["X-Request-Id"] = @request_id    
+    headers["Access-Control-Allow-Origin"] = "*"
+    log({ msg: "Request"}) if (request.fullpath != "")
+  end
+
+  after do    
+    log({ msg: "Response", status: response.status }) if (request.fullpath != "")
+  end
 
   SWAGGER_FILES = %w[index.css swagger.html swagger-initializer.js swagger-ui-bundle.js swagger-ui-standalone-preset.js swagger-ui.css]
 
   SWAGGER_FILES.each do |filename|
     get "/#{filename.gsub(".html", "")}" do
-      response["Access-Control-Allow-Origin"] = "*"
       if filename.end_with? '.json'
         content_type :json
       elsif filename.end_with? '.css'
@@ -29,7 +41,6 @@ class RestServer < Sinatra::Base
   end
 
   get "/swagger.json" do
-    response["Access-Control-Allow-Origin"] = "*"
     content_type :json
     SwaggerBuilder.build_swagger_for(Entities.models, request.host_with_port)
   end
@@ -53,11 +64,6 @@ class RestServer < Sinatra::Base
 
   Entities.models.each_key do |model|
     post "/#{model.downcase}" do
-      response["Access-Control-Allow-Origin"] = "*"
-      request_id = SecureRandom.uuid 
-      headers["X-Request-Id"] = request_id
-      SchemalessRestApi.logger.info env
-      SchemalessRestApi.logger.info "POST #{request.fullpath}, CorrelationId: #{request_id}"
       request_body = request.body.read
       data = {}
       data = JSON.parse(request_body) unless request_body.empty?
@@ -73,20 +79,17 @@ class RestServer < Sinatra::Base
       else
         Entities.models[model][id] = data
       end
-      SchemalessRestApi.logger.info "Created #{id}, CorrelationId: #{request_id}"
+      log "Created #{id}"
       [201, JSON.generate({ id: id })]
     end
 
     options "/#{model.downcase}" do
       response["Allow"] = "*"
-      response["Access-Control-Allow-Origin"] = "*"
       response["Access-Control-Allow-Methods"] = "*"
       response["Access-Control-Allow-Headers"] = "*"
     end
 
     get "/#{model.downcase}" do
-      response["Access-Control-Allow-Origin"] = "*"
-      SchemalessRestApi.logger.info "GET #{request.fullpath}"
       if ENV["mongodb"]
         if params == {}
           JSON.generate(MongoClient.get_all(model))
@@ -106,8 +109,6 @@ class RestServer < Sinatra::Base
     end
 
     get "/#{model.downcase}/:id" do |id|
-      response["Access-Control-Allow-Origin"] = "*"
-      SchemalessRestApi.logger.info "GET #{request.fullpath}"
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
@@ -128,8 +129,6 @@ class RestServer < Sinatra::Base
     end
 
     put "/#{model.downcase}/:id" do |id|
-      response["Access-Control-Allow-Origin"] = "*"
-      SchemalessRestApi.logger.info "PUT #{request.fullpath}"
       data = JSON.parse(request.body.read)
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
@@ -145,8 +144,6 @@ class RestServer < Sinatra::Base
     end
 
     delete "/#{model.downcase}/:id" do |id|
-      response["Access-Control-Allow-Origin"] = "*"
-      SchemalessRestApi.logger.info "DEL #{request.fullpath}"
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first

data/lib/schemaless_rest_api/server_utils.rb

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

data/lib/schemaless_rest_api/version.rb

@@ -3,5 +3,5 @@
 # typed: true
 
 module SchemalessRestApi
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/schemaless_rest_api.rb

@@ -7,16 +7,26 @@ require_relative "schemaless_rest_api/entities"
 require_relative "schemaless_rest_api/swagger_builder"
 require "tapioca"
 require "logger"
-
+require "ougai"
 require "json"
 require "securerandom"
 
 # Global params for Schemalass REST API
 module SchemalessRestApi
-  @logger = Logger.new($stdout)
+  if ENV["Log"] == 'structured'
+    @logger = Ougai::Logger.new($stdout)
+    @log_type = :ougai
+  else
+    @logger = Logger.new($stdout)
+    @log_type = :basic
+  end
+  
   class << self
     # @return Logger
     attr_accessor :logger
+
+    # @return Logger type
+    attr_accessor :log_type
   end
 
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -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: puma
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,7 @@ files:
 - lib/schemaless_rest_api/entities.rb
 - lib/schemaless_rest_api/mongo_client.rb
 - lib/schemaless_rest_api/rest_server.rb
+- lib/schemaless_rest_api/server_utils.rb
 - lib/schemaless_rest_api/swagger/index.css
 - lib/schemaless_rest_api/swagger/swagger-initializer.js
 - lib/schemaless_rest_api/swagger/swagger-ui-bundle.js