schemaless_rest_api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 772e554afa1851f8a505754ce97e174218f28b2fdfa7cb8cea9e20483fe1a0a0
-  data.tar.gz: 442745cdc52411aa5e2db5d20fc9474188314ef94282db4b620675114a84f1ba
+  metadata.gz: a86e21c3979d2542206f5c993491444ee5e91e38d348eaaf4cc4a6a242eaf11f
+  data.tar.gz: 2c82b7556b1ed4ce916224bdcc9404efe20283d7a7c7f2564bc750968b9f9cc3
 SHA512:
-  metadata.gz: 9c5f723fba1e431ee358afadfb6ed5d96bd081f8849d565fd23e31474c720c2ecf39b3f7e43e2eecef8bb896686e0e4d4a8a4837b4a1a35c565c253ab95015c1
-  data.tar.gz: cb903faf022ce6d7605ae3ea60e570a548f2db2b5c246d67a1fff1c405b85854d49b4dde11b89390b7f2b855dcbf75f7e0ec74cfd3dc99b90c0f5ad2cdec902b
+  metadata.gz: abfb1f463d723d366327e16067e751e2e616d7026adabd83365ddf0f5841e69f422ebcfbb1a8b7a6c756606241b8d400052ac496bbf011e9bd807ced28c0ebfb
+  data.tar.gz: 37a864e55ffd3740404a7ce7d632c3496c9d1e546d4e9a75092a5dfe3655e127a69f2a82c0253f7dccff5faaa7dcb5559549e702f0da760aaad36696300f55a5

data/lib/schemaless_rest_api/rest_server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "sinatra"
+require 'docdsl'
 require "puma"
 require 'route_downcaser'
 
@@ -10,6 +11,17 @@ class RestServer < Sinatra::Base
   set :bind, "0.0.0.0"
   use RouteDowncaser::DowncaseRouteMiddleware
 
+  register Sinatra::DocDsl
+
+  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")}"
+  end
+
+  doc_endpoint "/docs"
+
   def has_id?(model, id)
     Entities.models[model].key?(id)
   end
@@ -18,8 +30,12 @@ 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 }
+    summary = { models: Entities.models.keys.to_s,
+                docs_url: '<a href=/docs>/docs</a>' }
     summary[:db] = MongoClient.client.summary.to_s if ENV['mongodb']
     JSON.generate(summary)
   rescue Exception => e
@@ -27,6 +43,11 @@ class RestServer < Sinatra::Base
   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
       id = SecureRandom.uuid
       data = JSON.parse(request.body.read)
@@ -38,6 +59,11 @@ class RestServer < Sinatra::Base
       [201, id]
     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
       puts request.path.downcase
       if ENV['mongodb']
@@ -55,6 +81,11 @@ class RestServer < Sinatra::Base
       [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|
       puts request.path.downcase
       if ENV['mongodb']
@@ -68,6 +99,12 @@ class RestServer < Sinatra::Base
       end
     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|
       puts request.path.downcase
       data = JSON.parse(request.body.read)
@@ -83,6 +120,10 @@ 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|
       puts request.path.downcase
       if ENV['mongodb']

data/lib/schemaless_rest_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchemalessRestApi
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schemaless_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Samuel Garratt