schemaless_rest_api 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49fba7a856b268a6077d6597c20687d0d056cce2049fb5c0590da046acebf91f
-  data.tar.gz: 2ac45839af0b7d4e273812bcf6a4a9d3f750d958285c3f9fcfccf143ee4d8c57
+  metadata.gz: 9f0bc22701cb597ffc52c1e9544b6537546001748ce65e92456e5af32e99fbdd
+  data.tar.gz: c40d93389fbfe7f98fa7d05f262b2da7b806dced3223f13643122f0359c522b0
 SHA512:
-  metadata.gz: 5c545f176d807dff6894b10a54aba45737968157247261b1a973ae471ec60155834a8847a43edb3c2ee50ad2a2b562846f5513479112402f3013b7da6a84a0c2
-  data.tar.gz: 35f4ed2bc211ac4bf163296b69c29362a7d13a3c705898e7a5a07438d3c8b071907acfd0792fb9b84e81519e74b6cfd95276156948ae422d27886a13ebb7421c
+  metadata.gz: ed664da78bf2832449243ef73597521432e6f71dddbddb34a0c3cbcfd3ab9de105b215ad83e7775380a9cf103d966981f2c4036f3215c1eb500a668ee8e0f736
+  data.tar.gz: 27438bf5b3196e88c7dc79171bc4baefd537fb0b049fa796207c7fb2ba131781680ca931b79f9660c5a4d325bfd0cc5f9cb26d41a4090b251b374e4675105dc2

data/lib/schemaless_rest_api/entities.rb

@@ -1,9 +1,60 @@
 # frozen_string_literal: true
 
+# typed: true
+
 # Entities mapped by environment variables
 class Entities
   @models = {}
   class << self
+    # @return [Hash] Hash of models
     attr_accessor :models
+
+    def page_data(model, params, values)
+      page = params[:page].to_i.positive? ? params[:page].to_i : 1
+      page_size = params[:page_size].to_i.positive? ? params[:page_size].to_i : 10
+      total_count = values.count
+      total_pages = (total_count / page_size.to_f).ceil
+      page_res = {
+        current_page: page,
+        page_size: page_size,
+        total_count: total_count,
+        total_pages: total_pages,
+        _links: {
+          self: { href: "/#{model}?page=#{page}&page_size=#{page_size}" }
+        }
+      }
+      page_res[:_links][:next] = { href: "/#{model}?page=#{page + 1}&page_size=#{page_size}" } if page < total_pages
+      page_res[:_links][:prev] = { href: "/#{model}?page=#{page - 1}&page_size=#{page_size}" } if page > 1
+      page_res
+    end
+
+    def query_from_params(params)
+      query = params.dup
+      query.delete(:page)
+      query.delete(:page_size)
+      query
+    end
+
+    # Find all values for given model querying via params
+    def find_all(model, params)
+      query = query_from_params params
+      total_items = if query == {}
+                      Entities.models[model].values
+                    else
+                      Entities.models[model].values.find_all do |val|
+                        val[query.keys[0].to_s].to_s == query.values[0]
+                      end
+                    end
+      pagination = page_data(model, params, total_items)
+      skip = (pagination[:current_page] - 1) * pagination[:page_size]
+
+      items = total_items.drop(skip).take(pagination[:page_size])
+      response = {
+        _embedded: {},
+        pagination: pagination
+      }
+      response[:_embedded][model.to_sym] = items
+      response
+    end
   end
 end

data/lib/schemaless_rest_api/mongo_client.rb

@@ -1,7 +1,10 @@
-require "mongo"
+# frozen_string_literal: true
 
 # typed: false - MongoClient new
 
+require "mongo"
+
+# Client to talk to Mongo database
 module MongoClient
   class << self
     # @return Client to work with MongoDb
@@ -13,25 +16,62 @@ module MongoClient
     end
 
     def find(model, id)
-      find_all(model, { id: id })
+      find_all(model, { id: id }, false)[:items]
     end
 
-    def get_all(model)
-      collection = MongoClient.client[model]
-      collection.find.collect do |match|
-        match.delete("_id")
-        match
-      end
+    def page_data(model, params, collection)
+      page = params[:page].to_i.positive? ? params[:page].to_i : 1
+      page_size = params[:page_size].to_i.positive? ? params[:page_size].to_i : 10
+      total_count = collection.count_documents({})
+      total_pages = (total_count / page_size.to_f).ceil
+      page_res = {
+        current_page: page,
+        page_size: page_size,
+        total_count: total_count,
+        total_pages: total_pages,
+        _links: {
+          self: { href: "/#{model}?page=#{page}&page_size=#{page_size}" }
+        }
+      }
+      page_res[:_links][:next] = { href: "/#{model}?page=#{page + 1}&page_size=#{page_size}" } if page < total_pages
+      page_res[:_links][:prev] = { href: "/#{model}?page=#{page - 1}&page_size=#{page_size}" } if page > 1
+      page_res
     end
 
-    def find_all(model, query)
+    def find_all(model, params, paginate: true)
       collection = MongoClient.client[model]
-      collection.find(query).collect do |match|
+      pagination = page_data(model, params, collection)
+      skip = (pagination[:current_page] - 1) * pagination[:page_size]
+      query = query_from_params params
+
+      items = get_items collection, query, skip, pagination[:page_size]
+      results = { _embedded: {} }
+      results[:_embedded][model.to_sym] = items
+      results[:pagination] = pagination if paginate
+      results
+    end
+
+    def get_items(collection, query, skip, page_size)
+      if query == {}
+        return collection.find.skip(skip).limit(page_size).collect do |match|
+          match.delete("_id")
+          match
+        end
+      end
+
+      collection.find(query).skip(skip).limit(page_size).collect do |match|
         match.delete("_id")
         match
       end
     end
 
+    def query_from_params(params)
+      query = params.dup
+      query.delete(:page)
+      query.delete(:page_size)
+      query
+    end
+
     def update(model, id, data)
       collection = MongoClient.client[model]
       collection.update_one({ id: id }, { id: id, **data })

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
@@ -29,7 +33,7 @@ class RestServer < Sinatra::Base
   end
 
   SWAGGER_FILES = %w[index.css swagger.html swagger-initializer.js swagger-ui-bundle.js swagger-ui-standalone-preset.js
-                     swagger-ui.css]
+                     swagger-ui.css].freeze
 
   SWAGGER_FILES.each do |filename|
     get "/#{filename.gsub(".html", "")}" do
@@ -50,25 +54,18 @@ class RestServer < Sinatra::Base
     SwaggerBuilder.build_swagger_for(Entities.models, request.host_with_port)
   end
 
-  def has_id?(model, id)
-    Entities.models[model].key?(id)
-  end
-
-  def not_have(id)
-    [404, JSON.generate({ error: "'#{id}' not found" })]
-  end
-
   get "/" do
     summary = { models: Entities.models.keys.to_s,
-                docs_url: "<a href=/swagger>Swagger docs</a>" }
-    summary[:db] = MongoClient.client.summary.to_s if ENV["mongodb"]
-    JSON.generate(summary)
+                docs_url: "<a href='#{ENV["base_path"]}/swagger'>Swagger docs</a>" }
+    summary[:db] = MongoClient.client.options if ENV["mongodb"]
+    summary.to_json
   rescue StandardError => e
     [500, e.message]
   end
 
   Entities.models.each_key do |model|
     post "/#{model.downcase}" do
+      content_type :json
       request_body = request.body.read
       data = {}
       data = JSON.parse(request_body) unless request_body.empty?
@@ -95,34 +92,28 @@ class RestServer < Sinatra::Base
     end
 
     get "/#{model.downcase}" do
+      content_type :json
       if ENV["mongodb"]
-        if params == {}
-          JSON.generate(MongoClient.get_all(model))
-        else
-          [200, JSON.generate(MongoClient.find_all(model, params))]
-        end
+        MongoClient.find_all(model, params).to_json
       else
-        return JSON.generate(Entities.models[model].values) if params == {}
-
-        matching_values = Entities.models[model].values.find_all do |val|
-          val[params.keys[0]].to_s == params.values[0]
-        end
-        return JSON.generate(matching_values)
+        matching_values = Entities.find_all(model, params)
+        return matching_values.to_json
       end
     rescue StandardError => e
       [404, "Nothing found using #{params}. Only first param considered. #{e.message}"]
     end
 
     get "/#{model.downcase}/:id" do |id|
+      content_type :json
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
 
-        JSON.generate(results.first)
+        results.first.to_json
       else
-        return not_have(id) unless has_id?(model, id)
+        return not_have(id) unless id?(model, id)
 
-        JSON.generate(Entities.models[model][id])
+        Entities.models[model][id].to_json
       end
     end
 
@@ -134,6 +125,7 @@ class RestServer < Sinatra::Base
     end
 
     put "/#{model.downcase}/:id" do |id|
+      content_type :json
       data = JSON.parse(request.body.read)
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
@@ -141,7 +133,7 @@ class RestServer < Sinatra::Base
 
         MongoClient.update(model, id, data)
       else
-        return not_have(id) unless has_id?(model, id)
+        return not_have(id) unless id?(model, id)
 
         Entities.models[model][id] = data
       end
@@ -149,13 +141,14 @@ class RestServer < Sinatra::Base
     end
 
     delete "/#{model.downcase}/:id" do |id|
+      content_type :json
       if ENV["mongodb"]
         results = MongoClient.find(model, id)
         return not_have(id) unless results.first
 
         MongoClient.delete(model, id)
       else
-        return not_have(id) unless has_id?(model, id)
+        return not_have(id) unless id?(model, id)
 
         Entities.models[model].delete(id)
       end

data/lib/schemaless_rest_api/seed.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# typed: true
+
+def init_based_on_seed
+  return if ENV["mongodb"]
+
+  puts "Seeding db based on '#{SEED_FILE}'"
+  seed_data = JSON.parse(File.read(SEED_FILE))
+  seed_data.each do |entity, values|
+    Entities.models[entity.to_sym] = {} unless Entities.models[entity.to_sym]
+    seed_in_memory_data(entity, values)
+  end
+end
+
+def seed_in_memory_data(entity, values)
+  unless values.is_a? Array
+    SchemalessRestApi.logger.warning "Entity '#{entity}' doesn't have array, skipping"
+    return
+  end
+
+  values.each do |value|
+    next unless value["id"]
+
+    Entities.models[entity.to_sym][value["id"].to_s] = value
+  end
+end

data/lib/schemaless_rest_api/server_utils.rb

@@ -13,7 +13,15 @@ module ServerUtils
     end
   end
 
-  private def log_structured(messages)
+  def id?(model, id)
+    Entities.models[model].key?(id)
+  end
+
+  def not_have(id)
+    [404, JSON.generate({ error: "'#{id}' not found" })]
+  end
+
+  def log_structured(messages)
     log_msg = {
       method: request.request_method,
       path: request.fullpath,
@@ -24,4 +32,6 @@ module ServerUtils
     end
     SchemalessRestApi.logger.info(log_msg)
   end
+
+  private :log_structured
 end

data/lib/schemaless_rest_api/swagger/swagger.html

@@ -6,8 +6,7 @@
     <title>Swagger UI</title>
     <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
     <link rel="stylesheet" type="text/css" href="index.css" />
-    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
-    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
+    <link rel="icon" type="image/png" href="./favicon.ico" sizes="32x32" />
   </head>
 
   <body>

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.7.0"
 end

data/lib/schemaless_rest_api.rb

@@ -5,6 +5,7 @@
 require_relative "schemaless_rest_api/version"
 require_relative "schemaless_rest_api/entities"
 require_relative "schemaless_rest_api/swagger_builder"
+require_relative "schemaless_rest_api/seed"
 require "tapioca"
 require "logger"
 require "ougai"
@@ -12,6 +13,7 @@ require "json"
 require "securerandom"
 
 ENV["APP_ENV"] ||= "production"
+ENV["base_path"] ||= ""
 
 # Global params for Schemalass REST API
 module SchemalessRestApi
@@ -22,6 +24,9 @@ module SchemalessRestApi
     @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 Logger
@@ -52,22 +57,7 @@ end
 
 SEED_FILE = "db.json"
 
-if File.exist? SEED_FILE
-  puts "Seeding db based on '#{SEED_FILE}'"
-  seed_data = JSON.parse(File.read(SEED_FILE))
-  seed_data.each do |entity, values|
-    Entities.models[entity.to_sym] = {} unless Entities.models[entity.to_sym]
-    if values.is_a? Array
-      values.each do |value|
-        next unless value["id"]
-
-        Entities.models[entity.to_sym][value["id"].to_s] = value
-      end
-    else
-      puts "Entity 'entity' doesn't have array, skipping"
-    end
-  end
-end
+init_based_on_seed if File.exist? SEED_FILE
 
 extract_models.each do |model|
   Entities.models[model.to_sym] = {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-18 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
@@ -124,6 +138,7 @@ files:
 - lib/schemaless_rest_api/mongo_client.rb
 - lib/schemaless_rest_api/rest.ico
 - lib/schemaless_rest_api/rest_server.rb
+- lib/schemaless_rest_api/seed.rb
 - lib/schemaless_rest_api/server_utils.rb
 - lib/schemaless_rest_api/swagger/index.css
 - lib/schemaless_rest_api/swagger/swagger-initializer.js