schemaless_rest_api 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fba7a856b268a6077d6597c20687d0d056cce2049fb5c0590da046acebf91f
-  data.tar.gz: 2ac45839af0b7d4e273812bcf6a4a9d3f750d958285c3f9fcfccf143ee4d8c57
+  metadata.gz: 6f42e7bccaab28e6dc750c4351e18500689d1fb13a72bda6d0f1417cc5cef630
+  data.tar.gz: d47a29830a56c986c04bdc92c0c07758efcbe197de71a0183552af628ee66dc0
 SHA512:
-  metadata.gz: 5c545f176d807dff6894b10a54aba45737968157247261b1a973ae471ec60155834a8847a43edb3c2ee50ad2a2b562846f5513479112402f3013b7da6a84a0c2
-  data.tar.gz: 35f4ed2bc211ac4bf163296b69c29362a7d13a3c705898e7a5a07438d3c8b071907acfd0792fb9b84e81519e74b6cfd95276156948ae422d27886a13ebb7421c
+  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,6 +13,8 @@ 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
@@ -60,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

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.1"
+  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.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-19 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