schemaless_rest_api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd0875a0972ff3b33119a209a1e0a4a338e89cc52949c3014f12e9193315fbc
-  data.tar.gz: 5a15b247ae28b9ec1329637dac2649bc6104425d4f576a77d0ca4725b3a1ae0d
+  metadata.gz: 6f42e7bccaab28e6dc750c4351e18500689d1fb13a72bda6d0f1417cc5cef630
+  data.tar.gz: d47a29830a56c986c04bdc92c0c07758efcbe197de71a0183552af628ee66dc0
 SHA512:
-  metadata.gz: da922d8ce69b812d26fa7f6887e604190a22c4f9924a9fb2d33a93c5de4a52aca09c92c0b172674d51970704abb09fec1e26851d8254009ba96f56df4e8966be
-  data.tar.gz: 3aeb83be262190ef8273dc1fcf521b11ee637f6ccbb7e389b7e379be528fc3a593cdb31497652016225484b222af2a4e1cd539ab2d301af798c7893061041baa
+  metadata.gz: 366cd2cf898fc3cca3ba5b90d29d44fa08e43b5a0a8154eec309c21d9a7012a8c2498912818f2251e664bf2568bfdbcead72ac59e6d837f6a844fd43b64b2a07
+  data.tar.gz: 65cfacda5630298c9e50165b3a2a5420ecf6965347f32f92226afcb6137716207732377714d9b59d7bdda228e5aacc6f23adb39a97ea0be062bc269804b61568

data/lib/schemaless_rest_api/entities.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+# typed: true
+
 # Entities mapped by environment variables
 class Entities
   @models = {}
   class << self
+    # @return [Hash] Hash of models
     attr_accessor :models
   end
 end

data/lib/schemaless_rest_api/mongo_client.rb

@@ -2,6 +2,7 @@ require "mongo"
 
 # typed: false - MongoClient new
 
+# Client to talk to Mongo database
 module MongoClient
   class << self
     # @return Client to work with MongoDb

data/lib/schemaless_rest_api/rest_server.rb

@@ -3,6 +3,8 @@
 require "sinatra"
 require "puma"
 require "route_downcaser"
+require "prometheus/middleware/collector"
+require "prometheus/middleware/exporter"
 require_relative "server_utils"
 
 # Server with endpoints generated based on Entities with CRUD operations for them
@@ -11,32 +13,39 @@ class RestServer < Sinatra::Base
   enable :logging if ENV["debug"] == "true"
   set :bind, "0.0.0.0"
   use RouteDowncaser::DowncaseRouteMiddleware
+  use Prometheus::Middleware::Collector
+  use Prometheus::Middleware::Exporter
   helpers ServerUtils
 
   before do
-    @request_id = SecureRandom.uuid 
-    headers["X-Request-Id"] = @request_id    
+    @request_id = SecureRandom.uuid
+    headers["X-Correlation-Id"] = @request_id
     headers["Access-Control-Allow-Origin"] = "*"
-    log({ msg: "Request"}) if (request.fullpath != "")
+    log({ msg: "Request" }) if request.fullpath != ""
   end
 
-  after do    
-    log({ msg: "Response", status: response.status }) if (request.fullpath != "")
+  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]
+  get "/favicon.ico" do
+    send_file File.join(__dir__, "rest.ico")
+  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
-      if filename.end_with? '.json'
+      if filename.end_with? ".json"
         content_type :json
-      elsif filename.end_with? '.css'
+      elsif filename.end_with? ".css"
         content_type :css
-      elsif filename.end_with? '.js'
+      elsif filename.end_with? ".js"
         content_type :js
       end
 
-      File.read("./lib/schemaless_rest_api/swagger/#{filename}")
+      File.read(File.join(__dir__, "swagger", filename))
     end
   end
 
@@ -55,7 +64,7 @@ class RestServer < Sinatra::Base
 
   get "/" do
     summary = { models: Entities.models.keys.to_s,
-                docs_url: "<a href=/swagger>Swagger docs</a>" }
+                docs_url: "<a href='#{ENV["base_path"]}/swagger'>Swagger docs</a>" }
     summary[:db] = MongoClient.client.summary.to_s if ENV["mongodb"]
     JSON.generate(summary)
   rescue StandardError => e
@@ -79,7 +88,7 @@ class RestServer < Sinatra::Base
       else
         Entities.models[model][id] = data
       end
-      log({msg: "Created #{id}"})
+      log({ msg: "Created #{id}" })
       [201, JSON.generate({ id: id })]
     end
 

data/lib/schemaless_rest_api/swagger_builder.rb

@@ -13,7 +13,7 @@ class SwaggerBuilder
       doc["info"] = build_info(models)
       doc["host"] = host_with_port
       doc["schemes"] = "http"
-      doc["basePath"] = "/"
+      doc["basePath"] = "/#{ENV["base_path"]}"
       doc["paths"] = generate_paths_for models
       JSON.generate(doc)
     end
@@ -57,7 +57,7 @@ class SwaggerBuilder
           }
         },
         get: {
-          parameters: [ 
+          parameters: [
             {
               name: "params",
               description: "Any key can be used to filter #{model} by",
@@ -94,7 +94,7 @@ class SwaggerBuilder
     end
 
     def paths_at_id(model)
-      {        
+      {
         get: {
           description: "Data of #{model} at passed id",
           parameters: id_params(model),

data/lib/schemaless_rest_api/version.rb

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

data/lib/schemaless_rest_api.rb

@@ -12,6 +12,7 @@ require "json"
 require "securerandom"
 
 ENV["APP_ENV"] ||= "production"
+ENV["base_path"] ||= ""
 
 # Global params for Schemalass REST API
 module SchemalessRestApi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  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
@@ -122,6 +136,7 @@ files:
 - lib/schemaless_rest_api.rb
 - lib/schemaless_rest_api/entities.rb
 - lib/schemaless_rest_api/mongo_client.rb
+- lib/schemaless_rest_api/rest.ico
 - lib/schemaless_rest_api/rest_server.rb
 - lib/schemaless_rest_api/server_utils.rb
 - lib/schemaless_rest_api/swagger/index.css