schemaless_rest_api 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6884db983603d3fe99853d2daf2448c5a112535d427c4dcf93085c03d0d572
-  data.tar.gz: 233cf6a115128268144a612ff02e5de53c32b4f1dc0cb3e46a53f15ebc776e9d
+  metadata.gz: 3ab21f348c0122fbfa54365f8f1ed20c80bcf2f110e522bf8e782315414419e9
+  data.tar.gz: a5ac30ed8f1efe06561474fed073f9e270788b74502e85dfcf8e61b11131a21d
 SHA512:
-  metadata.gz: 6fddf98f70498d9efee708f86ba28a3ddc4da8b53c029886c964ba8be2078d8bc459d025c50236bb11c9992a8a4ef5edd62d3a05491d8686ac481c2d6a61238a
-  data.tar.gz: ad73ffe9c66723853b0e0a9dc6ecaeb30371b7b12ceb33267715de10dcac052bb3d2107ad3fd4d93bff978239077d2a9434e526b8a32dc550676145b4d0b7db9
+  metadata.gz: a63738895a1ae2c01ecf3a0d81d70978231f3c92493a13f9a72cb111d1b41a6f90fde28f9dddd2de662c9fe7d3e270bdd1f7462870c02516e1a042957f950169
+  data.tar.gz: aa2e4411f2aace139b6b9d40edb672e32513d6dcc07a4e6359b2338191dd3bf583f433d9d239f3d7263fde38eb169990290d73e31aa2d2df51b9e7074f55480e

data/lib/schemaless_rest_api/rest_server.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "sinatra"
-require "docdsl"
 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
@@ -11,17 +11,39 @@ class RestServer < Sinatra::Base
   enable :logging if ENV["debug"] == "true"
   set :bind, "0.0.0.0"
   use RouteDowncaser::DowncaseRouteMiddleware
+  helpers ServerUtils
 
-  register Sinatra::DocDsl
+  before do
+    @request_id = SecureRandom.uuid 
+    headers["X-Request-Id"] = @request_id    
+    headers["Access-Control-Allow-Origin"] = "*"
+    log({ msg: "Request"}) if (request.fullpath != "")
+  end
 
-  page do
-    title "Schmaless REST API"
-    header "REST API using models #{Entities.models.keys}"
-    introduction "REST APIs allowing CRUD on:
-#{Entities.models.keys.join("\n")}"
+  after do    
+    log({ msg: "Response", status: response.status }) if (request.fullpath != "")
   end
 
-  doc_endpoint "/docs"
+  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'
+        content_type :json
+      elsif filename.end_with? '.css'
+        content_type :css
+      elsif filename.end_with? '.js'
+        content_type :js
+      end
+
+      File.read("./lib/schemaless_rest_api/swagger/#{filename}")
+    end
+  end
+
+  get "/swagger.json" do
+    content_type :json
+    SwaggerBuilder.build_swagger_for(Entities.models, request.host_with_port)
+  end
 
   def has_id?(model, id)
     Entities.models[model].key?(id)
@@ -31,28 +53,20 @@ class RestServer < Sinatra::Base
     [404, JSON.generate({ error: "'#{id}' not found" })]
   end
 
-  documentation "Get summary" do
-    response "Basic basic summary of API"
-  end
   get "/" do
     summary = { models: Entities.models.keys.to_s,
-                docs_url: "<a href=/docs>/docs</a>" }
+                docs_url: "<a href=/swagger>Swagger docs</a>" }
     summary[:db] = MongoClient.client.summary.to_s if ENV["mongodb"]
     JSON.generate(summary)
-  rescue Exception => e
+  rescue StandardError => e
     [500, e.message]
   end
 
   Entities.models.each_key do |model|
-    documentation "Create instance of #{model}" do
-      payload "Whatever JSON you want. Needs to be valid JSON"
-      response "Id of created #{model}"
-      status 201
-    end
     post "/#{model.downcase}" do
-      response["Access-Control-Allow-Origin"] = "*"
-      SchemalessRestApi.logger.info "POST #{request.fullpath}"
-      data = JSON.parse(request.body.read)
+      request_body = request.body.read
+      data = {}
+      data = JSON.parse(request_body) unless request_body.empty?
       id = ""
       if data["id"]
         id = data["id"].to_s
@@ -65,24 +79,17 @@ class RestServer < Sinatra::Base
       else
         Entities.models[model][id] = data
       end
+      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
 
-    documentation "Retrieve all instances of #{model} or filtered by query param" do
-      response "Data in #{model}"
-      query_param :key_to_search_in_data, "Value of key"
-      status 200
-    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))
@@ -97,18 +104,11 @@ class RestServer < Sinatra::Base
         end
         return JSON.generate(matching_values)
       end
-    rescue Exception => e
+    rescue StandardError => e
       [404, "Nothing found using #{params}. Only first param considered. #{e.message}"]
     end
 
-    documentation "Retrieve specific instance of #{model} by id" do
-      response "Data in #{model}"
-      status 200
-      status 404
-    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,15 +128,7 @@ class RestServer < Sinatra::Base
       response["Access-Control-Allow-Headers"] = "*"
     end
 
-    documentation "Update id of #{model} to be provided data" do
-      payload "Whatever JSON you want updated to be. Needs to be valid JSON"
-      response "Data in #{model}"
-      status 204
-      status 404
-    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)
@@ -151,13 +143,7 @@ class RestServer < Sinatra::Base
       204
     end
 
-    documentation "Update id of #{model} to be deleted" do
-      response "Empty"
-      status 204
-    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/swagger/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

data/lib/schemaless_rest_api/swagger/swagger-initializer.js

@@ -0,0 +1,19 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  window.ui = SwaggerUIBundle({
+    url: "./swagger.json", 
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};